FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

test_runner: delegate stderr and stdout formatting to reporter · nodejs/node@2b797a6 · GitHub

/ node Public

Commit 2b797a6

Browse files
HinataKah0
authored and
targos
committed
test_runner: delegate stderr and stdout formatting to reporter
Introduce new `TestsStream` events `test:stderr` and `test:stdout` to delegate `stderr` and `stdout` (e.g. `console.log()`) formatting to the reporter. And patch existing reporters to: - Spec: output the message as it is - TAP: stay the same with existing `test:diagnostic` PR-URL: #48045 Fixes: #48011 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 23d310b commit 2b797a6

5 files changed

Lines changed: 37 additions & 7 deletions

File tree

‎doc/api/test.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,6 +1519,24 @@ Emitted when all subtests have completed for a given test.
15191519

15201520
Emitted when a test starts.
15211521

1522+
### Event: `'test:stderr'`
1523+
1524+
* `data` {Object}
1525+
* `file` {string} The path of the test file.
1526+
* `message` {string} The message written to `stderr`.
1527+
1528+
Emitted when a running test writes to `stderr`.
1529+
This event is only emitted if `--test` flag is passed.
1530+
1531+
### Event: `'test:stdout'`
1532+
1533+
* `data` {Object}
1534+
* `file` {string} The path of the test file.
1535+
* `message` {string} The message written to `stdout`.
1536+
1537+
Emitted when a running test writes to `stdout`.
1538+
This event is only emitted if `--test` flag is passed.
1539+
15221540
## Class: `TestContext`
15231541

15241542
<!-- YAML

‎lib/internal/test_runner/reporter/spec.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ class SpecReporter extends Transform {
117117
case 'test:start':
118118
ArrayPrototypeUnshift(this.#stack, { __proto__: null, data, type });
119119
break;
120+
case 'test:stderr':
121+
case 'test:stdout':
122+
return `${data.message}\n`;
120123
case 'test:diagnostic':
121124
return `${colors[type]}${this.#indent(data.nesting)}${symbols[type]}${data.message}${white}\n`;
122125
case 'test:coverage':

‎lib/internal/test_runner/reporter/tap.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ async function * tapReporter(source) {
4545
case 'test:start':
4646
yield `${indent(data.nesting)}# Subtest: ${tapEscape(data.name)}\n`;
4747
break;
48+
case 'test:stderr':
49+
case 'test:stdout':
4850
case 'test:diagnostic':
4951
yield `${indent(data.nesting)}# ${tapEscape(data.message)}\n`;
5052
break;

‎lib/internal/test_runner/runner.js‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,8 @@ class FileTest extends Test {
285285
const message = messages[i];
286286
this.addToReport({
287287
__proto__: null,
288-
type: 'test:diagnostic',
289-
data: { __proto__: null, nesting: 0, file: this.name, message },
288+
type: 'test:stdout',
289+
data: { __proto__: null, file: this.name, message },
290290
});
291291
}
292292
}
@@ -357,13 +357,12 @@ function runTestFile(path, root, inspectPort, filesWatcher, testNamePatterns) {
357357
}
358358

359359
// stderr cannot be treated as TAP, per the spec. However, we want to
360-
// surface stderr lines as TAP diagnostics to improve the DX. Inject
361-
// each line into the test output as an unknown token as if it came
362-
// from the TAP parser.
360+
// surface stderr lines to improve the DX. Inject each line into the
361+
// test output as an unknown token as if it came from the TAP parser.
363362
subtest.addToReport({
364363
__proto__: null,
365-
type: 'test:diagnostic',
366-
data: { __proto__: null, nesting: 0, file: path, message: line },
364+
type: 'test:stderr',
365+
data: { __proto__: null, file: path, message: line },
367366
});
368367
});
369368

‎lib/internal/test_runner/tests_stream.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ class TestsStream extends Readable {
5757
this[kEmitMessage]('test:diagnostic', { __proto__: null, nesting, file, message });
5858
}
5959

60+
stderr(file, message) {
61+
this[kEmitMessage]('test:stderr', { __proto__: null, file, message });
62+
}
63+
64+
stdout(file, message) {
65+
this[kEmitMessage]('test:stdout', { __proto__: null, file, message });
66+
}
67+
6068
coverage(nesting, file, summary) {
6169
this[kEmitMessage]('test:coverage', { __proto__: null, nesting, file, summary });
6270
}

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL