Skip to content

Commit

Permalink
test_runner: report failing tests after summary
Browse files Browse the repository at this point in the history
Re-output failing tests after summary has been printed.
This behavior follows other popular test runners
(e.g. jest, mocha, etc...).

Updated SpecReporter:
1. When there is a 'test:fail' event, the test will be
stored.
2. After no more input, all the failed tests will be
flushed.
3. Extract the logic for formatting a test report
into a re-usable function.

Fixes: #47110
  • Loading branch information
HinataKah0 committed Mar 21, 2023
1 parent 30d92e8 commit abd6ef9
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 17 deletions.
58 changes: 41 additions & 17 deletions lib/internal/test_runner/reporter/spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
const {
ArrayPrototypeJoin,
ArrayPrototypePop,
ArrayPrototypePush,
ArrayPrototypeShift,
ArrayPrototypeUnshift,
hardenRegExp,
Expand Down Expand Up @@ -36,6 +37,7 @@ class SpecReporter extends Transform {
#stack = [];
#reported = [];
#indentMemo = new SafeMap();
#failedTests = [];

constructor() {
super({ writableObjectMode: true });
Expand All @@ -57,15 +59,29 @@ class SpecReporter extends Transform {
RegExpPrototypeSymbolSplit(
hardenRegExp(/\r?\n/),
inspectWithNoCustomRetry(err, inspectOptions),
), `\n${indent} `);
return `\n${indent} ${message}\n`;
), indent !== undefined ? `\n${indent} ` : '');
return `${indent !== undefined ? `\n${indent} ` : '\n'}${message}\n`;
}
#handleEvent({ type, data }) {
#formatTestReport(type, data, prefix = '', indent = undefined, hasChildren = false, skippedSubtest = false, showFilePath = false) {
let color = colors[type] ?? white;
let symbol = symbols[type] ?? ' ';

const duration_ms = data.details?.duration_ms ? ` ${gray}(${data.details.duration_ms}ms)${white}` : '';
const title = `${showFilePath ? `${data.file} ` : ''}${data.name}${duration_ms}${skippedSubtest ? ' # SKIP' : ''}`;
if (hasChildren) {
// If this test has had children - it was already reported, so slightly modify the output
return `${prefix}${indent ?? ''}${color}${symbols['arrow:right']}${white}${title}\n`;
}
const error = this.#formatError(data.details?.error, indent);
if (skippedSubtest) {
color = gray;
symbol = symbols['hyphen:minus'];
}
return `${prefix}${indent ?? ''}${color}${symbol}${title}${error}${white}`;
}
#handleEvent({ type, data }) {
switch (type) {
case 'test:fail':
ArrayPrototypePush(this.#failedTests, data);
case 'test:pass': {
const subtest = ArrayPrototypeShift(this.#stack); // This is the matching `test:start` event
if (subtest) {
Expand All @@ -82,32 +98,40 @@ class SpecReporter extends Transform {
ArrayPrototypeUnshift(this.#reported, msg);
prefix += `${this.#indent(msg.nesting)}${symbols['arrow:right']}${msg.name}\n`;
}
const skippedSubtest = subtest && data.skip && data.skip !== undefined;
const indent = this.#indent(data.nesting);
const duration_ms = data.details?.duration_ms ? ` ${gray}(${data.details.duration_ms}ms)${white}` : '';
const title = `${data.name}${duration_ms}${skippedSubtest ? ' # SKIP' : ''}`;
let hasChildren = false;
if (this.#reported[0] && this.#reported[0].nesting === data.nesting && this.#reported[0].name === data.name) {
// If this test has had children - it was already reported, so slightly modify the output
ArrayPrototypeShift(this.#reported);
return `${prefix}${indent}${color}${symbols['arrow:right']}${white}${title}\n\n`;
}
const error = this.#formatError(data.details?.error, indent);
if (skippedSubtest) {
color = gray;
symbol = symbols['hyphen:minus'];
hasChildren = true;
}
return `${prefix}${indent}${color}${symbol}${title}${error}${white}\n`;
const skippedSubtest = subtest && data.skip && data.skip !== undefined;
const indent = this.#indent(data.nesting);
return `${this.#formatTestReport(type, data, prefix, indent, hasChildren, skippedSubtest)}\n`;
}
case 'test:start':
ArrayPrototypeUnshift(this.#stack, { __proto__: null, data, type });
break;
case 'test:diagnostic':
return `${color}${this.#indent(data.nesting)}${symbol}${data.message}${white}\n`;
return `${colors[type]}${this.#indent(data.nesting)}${symbols[type]}${data.message}${white}\n`;
}
}
_transform({ type, data }, encoding, callback) {
callback(null, this.#handleEvent({ type, data }));
}
_flush(callback) {
const results = [`\n${colors['test:fail']}${symbols['test:fail']}failing tests:${white}\n`];
for (let i = 0; i < this.#failedTests.length; i++) {
ArrayPrototypePush(results, this.#formatTestReport(
'test:fail',
this.#failedTests[i],
'',
undefined,
false,
false,
true,
));
}
callback(null, ArrayPrototypeJoin(results, ''));
}
}

module.exports = SpecReporter;
62 changes: 62 additions & 0 deletions test/message/test_runner_output_spec_reporter.out
Original file line number Diff line number Diff line change
Expand Up @@ -282,3 +282,65 @@
skipped 10
todo 5
duration_ms *

failing tests:
* sync fail todo (*ms)
*
* sync fail todo with message (*ms)
*
* sync throw fail (*ms)
*
* async throw fail (*ms)
*
* async skip fail (*ms)
*
* async assertion fail (*ms)
*
* reject fail (*ms)
*
* +sync throw fail (*ms)
*
* subtest sync throw fail (*ms)
'1 subtest failed'
* sync throw non-error fail (*ms)
Symbol(thrown symbol from sync throw non-error fail)
* +long running (*ms)
'test did not finish before its parent and was cancelled'
* top level (*ms)
'1 subtest failed'
* sync skip option is false fail (*ms)
*
* callback fail (*ms)
*
* callback also returns a Promise (*ms)
'passed a callback but also returned a Promise'
* callback throw (*ms)
*
* callback called twice (*ms)
'callback invoked multiple times'
* callback called twice in future tick (*ms)
*
* callback async throw (*ms)
*
* custom inspect symbol fail (*ms)
customized
* custom inspect symbol that throws fail (*ms)
{ foo: 1, [Symbol(nodejs.util.inspect.custom)]: [Function: [nodejs.util.inspect.custom]] }
* sync throw fails at first (*ms)
*
* sync throw fails at second (*ms)
*
* subtest sync throw fails (*ms)
'2 subtests failed'
* timed out async test (*ms)
'test timed out after 5ms'
* timed out callback test (*ms)
'test timed out after 5ms'
* rejected thenable (*ms)
'custom error'
* unfinished test with uncaughtException (*ms)
*
* unfinished test with unhandledRejection (*ms)
*
* invalid subtest fail (*ms)
'test could not be started because its parent finished'
5 changes: 5 additions & 0 deletions test/pseudo-tty/test_runner_default_reporter.out
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,8 @@
[34m* skipped 1[39m
[34m* todo 0[39m
[34m* duration_ms *[39m

[31m* failing tests:[39m
[31m* should fail [90m(*ms)[39m
*
[39m

0 comments on commit abd6ef9

Please sign in to comment.