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

Fail a test if its callback returns a promise that rejects #441

Merged
merged 1 commit into from
Dec 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
93 changes: 93 additions & 0 deletions test/promise_fail.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
var tap = require('tap');
var path = require('path');
var spawn = require('child_process').spawn;
var concat = require('concat-stream');

var stripFullStack = require('./common').stripFullStack;

tap.test('callback returning rejected promise should cause that test (and only that test) to fail', function (tt) {
tt.plan(1);

var ps = spawn(process.execPath, [path.join(__dirname, 'promises', 'fail.js')]);

ps.stdout.pipe(concat(function (rows) {
var rowsString = rows.toString('utf8');

if (/^skip\n$/.test(rowsString)) {
return tt.pass('the test file indicated it should be skipped');
}

strippedString = stripFullStack(rowsString);

// hack for consistency across all versions of node
// some versions produce a longer stack trace for some reason
// since this doesn't affect the validity of the test, the extra line is removed if present
// the regex just removes the lines "at <anonymous>" and "[... stack stripped ...]" if they occur together
strippedString = strippedString.replace(/.+at <anonymous>\n.+\[\.\.\. stack stripped \.\.\.\]\n/, '');

tt.same(strippedString, [
'TAP version 13',
'# promise',
'not ok 1 Error: rejection message',
' ---',
' operator: fail',
' stack: |-',
' Error: Error: rejection message',
' [... stack stripped ...]',
' ...',
'# after',
'ok 2 should be truthy',
'',
'1..2',
'# tests 2',
'# pass 1',
'# fail 1',
'',
''
].join('\n'));
}));
});

tap.test('subtest callback returning rejected promise should cause that subtest (and only that subtest) to fail', function (tt) {
tt.plan(1);

var ps = spawn(process.execPath, [path.join(__dirname, 'promises', 'subTests.js')]);

ps.stdout.pipe(concat(function (rows) {
var rowsString = rows.toString('utf8');

if (/^skip\n$/.test(rowsString)) {
return tt.pass('the test file indicated it should be skipped');
}

strippedString = stripFullStack(rowsString);

// hack for consistency across all versions of node
// some versions produce a longer stack trace for some reason
// since this doesn't affect the validity of the test, the extra line is removed if present
// the regex just removes the lines "at <anonymous>" and "[... stack stripped ...]" if they occur together
strippedString = strippedString.replace(/.+at <anonymous>\n.+\[\.\.\. stack stripped \.\.\.\]\n/, '');

tt.same(strippedString, [
'TAP version 13',
'# promise',
'# sub test that should fail',
'not ok 1 Error: rejection message',
' ---',
' operator: fail',
' stack: |-',
' Error: Error: rejection message',
' [... stack stripped ...]',
' ...',
'# sub test that should pass',
'ok 2 should be truthy',
'',
'1..2',
'# tests 2',
'# pass 1',
'# fail 1',
'',
''
].join('\n'));
}));
});
17 changes: 17 additions & 0 deletions test/promises/fail.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
var test = require('../../');

if (typeof Promise === 'function' && typeof Promise.resolve === 'function') {
test('promise', function (t) {
return new Promise(function (resolve, reject) {
reject(new Error('rejection message'));
});
});

test('after', function (t) {
t.plan(1);
t.ok(true);
});
} else {
// if promises aren't supported pass the node-tap test
console.log('skip');
}
18 changes: 18 additions & 0 deletions test/promises/subTests.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
var test = require('../../');

if (typeof Promise === 'function' && typeof Promise.resolve === 'function') {
test('promise', function (t) {
t.test('sub test that should fail', function (t) {
return new Promise(function (resolve, reject) {
reject(new Error('rejection message'));
});
});
t.test('sub test that should pass', function (t) {
t.plan(1);
t.ok(true);
});
});
} else {
// if promises aren't supported pass the node-tap test
console.log('skip');
}