test: add test for loading read-only modules by billti · Pull Request #20138 · nodejs/node

billti · 2018-04-18T19:01:17Z

Adds a test-case to cover loading modules the user does not have permission
to write to.

Covers issue logged in #20112

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

CC @Trott @cjihrig @richardlau

Adds a test-case to cover loading modules the user does not have permission to write to. Covers issue logged in #20112

Trott

LGTM if CI passes once the necessary libuv patch lands on master. (Will label this "blocked" until that happens.)

richardlau · 2018-04-18T19:16:06Z

Let's start a CI anyway and check that it passes the linter, actually fails on Windows as expected (prior to the libuv fix) and is skipped everywhere else: https://ci.nodejs.org/job/node-test-pull-request/14368/

We'll obviously need to rerun the CI when the libuv fix lands and verify that the test then passes.

vsemozhetbyt

LGTM with some ignorable nits)

vsemozhetbyt · 2018-04-18T20:06:22Z

+const tmpdir = require('../common/tmpdir');
+tmpdir.refresh();
+
+if (common.isWindows) {


Maybe it would be more optimal to add this check at the beginning, something like:
constcommon=require('../common');// TODO: Similar checks on *nix-like systems (e.g using chmod or the like)if(!common.isWindows)common.skip('test only runs on Windows');constassert=require('assert');// ...
This way the test will not waste the time and resources loading all the other modules. common.skip() makes the script exit, so no else is required after it and we can save one indentation level as well.

vsemozhetbyt · 2018-04-18T20:11:12Z

+ // Create readOnlyMod.js and set to read only
+ const readOnlyMod = path.join(tmpdir.path, 'readOnlyMod');
+ const readOnlyModRelative = path.relative(__dirname, readOnlyMod);
+ const readOnlyModFullPath = readOnlyMod + '.js';


We usually prefer template literals in such cases, so maybe:
const readOnlyModFullPath = `${readOnlyMod}.js`;
but feel free to ignore this and next stylistic notes)

vsemozhetbyt · 2018-04-18T20:13:06Z

+ fs.writeFileSync(readOnlyModFullPath, 'module.exports = 42;');
+ // Removed any inherited ACEs, and any explicitly granted ACEs for the
+ // current user
+ cp.execSync('icacls.exe "' + readOnlyModFullPath +


Maybe:
cp.execSync(`icacls.exe "${readOnlyModFullPath}" /inheritance:r /remove "%USERNAME%"`);

I did originally have template literals, but a) I wasn't sure they were supported all the way back to all LTS releases (I see now they are), and b) One long string was exceeded the lint line limit (but I could wrap it as shown above). I can add them back if desired.

Personally, I find template literals in these cases more clear, they have less syntactic noise (operators, quotes), but this can be my personal taste, so you can decide freely) We did not set strict linting rule for this, but we had many PRs that have replaced concatenations with templates, so templates may be prevalent style in tests now.

vsemozhetbyt · 2018-04-18T20:14:22Z

+ '" /inheritance:r /remove "%USERNAME%"');
+
+ // Grant the current user read & execute only
+ cp.execSync('icacls.exe "' + readOnlyModFullPath +


Maybe:
cp.execSync(`icacls.exe "${readOnlyModFullPath}" /grant "%USERNAME%":RX`);

vsemozhetbyt · 2018-04-18T20:16:39Z

+ }
+
+ // Remove the expliclty granted rights, and reenable inheritance
+ cp.execSync('icacls.exe "' + readOnlyModFullPath +


Maybe:
cp.execSync(`icacls.exe "${readOnlyModFullPath}" /remove "%USERNAME%" /inheritance:e`);

Trott · 2018-04-18T20:59:01Z

CI seems to have come back exactly as expected. 🎉 (Everything is green except Windows because we haven't yet fixed the bug that this test is written for.)

vsemozhetbyt · 2018-04-18T20:59:39Z

It seems only Windows job failed in previous CI, so we can wait till #20129 is landed and run this variant then.

lpinca · 2018-04-19T06:31:58Z

+
+// Grant the current user read & execute only
+cp.execSync(`icacls.exe "${readOnlyModFullPath}" /grant "%USERNAME%":RX`);
+


Can't we simply end the test here with require(readOnlyModRelative);? Is the cleanup required?

Seeing as the test must explicitly remove any write access to the file, I figure clean up could potentially hit issues if I don't restore the default permissions afterwards (per line 42). Once that is done, removing the file isn't strictly necessary (line 46), but I see no harm in it (per the comment note above it).

~~Yes, nothing wrong with the tear down, I just think it's not needed as tmpdir.refresh() purges everything.~~

vsemozhetbyt · 2018-04-22T20:38:14Z

#20129 is landed.
Let's CI: https://ci.nodejs.org/job/node-test-pull-request/14427/

vsemozhetbyt · 2018-04-22T21:47:06Z

CI is green. Landing...

Adds a test-case to cover loading modules the user does not have permission to write to. Covers issue logged in #20112 PR-URL: #20138 Refs: #20112 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

vsemozhetbyt · 2018-04-22T22:04:54Z

Landed in 3ba81e3
Thank you, @billti!

Adds a test-case to cover loading modules the user does not have permission to write to. Covers issue logged in #20112 PR-URL: #20138 Refs: #20112 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Port test from nodejs/node#20138 to libuv. Refs: nodejs/node#20112 Refs: nodejs/node#20138

test: add test for loading read-only modules
767b86a
Adds a test-case to cover loading modules the user does not have permission to write to. Covers issue logged in #20112

nodejs-github-bot added the test Issues and PRs related to the tests. label Apr 18, 2018

billti mentioned this pull request Apr 18, 2018
test: check that modules backed by read-only files can load (win32) #20116
Closed
3 tasks

Trott approved these changes Apr 18, 2018
View reviewed changes

Trott added the blocked PRs that are blocked by other issues or PRs. label Apr 18, 2018

richardlau approved these changes Apr 18, 2018
View reviewed changes

vsemozhetbyt approved these changes Apr 18, 2018
View reviewed changes

test: updated formatting per feedback
ccab982

bzoz approved these changes Apr 19, 2018
View reviewed changes

lpinca reviewed Apr 19, 2018
View reviewed changes

lpinca approved these changes Apr 19, 2018
View reviewed changes

jasnell approved these changes Apr 19, 2018
View reviewed changes

vsemozhetbyt added this to the 10.0.0 milestone Apr 19, 2018

vsemozhetbyt closed this Apr 22, 2018

bzoz added a commit to JaneaSystems/libuv that referenced this pull request Apr 26, 2018
test: regression test for Node issue #20112
a4ca9e7
Port test from nodejs/node#20138 to libuv. Refs: nodejs/node#20112 Refs: nodejs/node#20138

bzoz mentioned this pull request Apr 26, 2018
test: regression test for Node issue #20112 libuv/libuv#1818
Closed


		// Grant the current user read & execute only
		cp.execSync(`icacls.exe "${readOnlyModFullPath}" /grant "%USERNAME%":RX`);

Uh oh!

Uh oh!

Conversation

billti commented Apr 18, 2018

Checklist

Uh oh!

Trott left a comment

Choose a reason for hiding this comment

Uh oh!

richardlau commented Apr 18, 2018

Uh oh!

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

billtiApr 18, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbytApr 18, 2018

Choose a reason for hiding this comment

Uh oh!

Trott commented Apr 18, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vsemozhetbyt commented Apr 18, 2018

Uh oh!

lpincaApr 19, 2018

Choose a reason for hiding this comment

Uh oh!

billtiApr 19, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lpincaApr 19, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt commented Apr 22, 2018

Uh oh!

vsemozhetbyt commented Apr 22, 2018

Uh oh!

vsemozhetbyt commented Apr 22, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

vsemozhetbytApr 18, 2018•
edited
Loading

vsemozhetbytApr 18, 2018•
edited
Loading

Trott commented Apr 18, 2018•
edited
Loading

billtiApr 19, 2018•
edited
Loading

lpincaApr 19, 2018•
edited
Loading