Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add module require tests for certain package.json errors #23285

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions test/fixtures/packages/missing-main/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

exports.ok = 'ok';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, can you remove all the copyright boilerplate for this file? That copyright boilerplate is only necessary for files that already have it or new files that are substantially derived from existing files with the copyright. Since this is just one line, I think we're in the clear.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Uh, unless you did in fact copy this from an existing file, in which case, leave the copyright. :-D )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:) I left it since it is identical to several other files (so that the tests are consistent in design) and at least arguably is a copy of them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:) I left it since it is identical to several other files (so that the tests are consistent in design) and at least arguably is a copy of them.

Sounds good to me. Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New files should not contain the notice.

Copy link
Member

@Trott Trott Oct 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New files that, like this one, are exact copies of existing files should preserve the notice.

This file is an exact copy of test/fixtures/packages/main/package-main-module.js and test/fixtures/packages/main-index/package-main-module/index.js.

4 changes: 4 additions & 0 deletions test/fixtures/packages/missing-main/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "missingmain",
"main": "doesnotexist.js"
}
4 changes: 4 additions & 0 deletions test/fixtures/packages/unparseable/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"main": "therain" "inspain"
}

11 changes: 11 additions & 0 deletions test/sequential/test-module-loading.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,15 @@ const d2 = require('../fixtures/b/d');
assert.strictEqual(require('../fixtures/packages/index').ok, 'ok');
assert.strictEqual(require('../fixtures/packages/main').ok, 'ok');
assert.strictEqual(require('../fixtures/packages/main-index').ok, 'ok');
assert.strictEqual(require('../fixtures/packages/missing-main').ok, 'ok');

let unparseableErrorThrown = false;
try {
require('../fixtures/packages/unparseable');
} catch (e) {
unparseableErrorThrown = true;
assert.strictEqual(/^Error parsing .*/.test(e.message), true);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 109 through 115 and line 330 should probably be removed and replaced with a call to assert.throws():

assert.throws(
  () => { require('../fixtures/packages/unparseable'); },
  /^Error parsing /
);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


{
console.error('test cycles containing a .. path');
Expand Down Expand Up @@ -267,6 +276,7 @@ try {
'fixtures/packages/index/index.js': {},
'fixtures/packages/main/package-main-module.js': {},
'fixtures/packages/main-index/package-main-module/index.js': {},
'fixtures/packages/missing-main/index.js': {},
'fixtures/cycles/root.js': {
'fixtures/cycles/folder/foo.js': {}
},
Expand Down Expand Up @@ -317,6 +327,7 @@ process.on('exit', function() {
assert.strictEqual(d2.D(), 'D done');

assert.strictEqual(errorThrown, true);
assert.strictEqual(unparseableErrorThrown, true);

console.log('exit');
});
Expand Down