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

test_runner: report `entryFile` in `TestStream` events · nodejs/node@add1edb · GitHub

/ node Public

Commit add1edb

Browse files
MoLow
authored and
aduh95
committed
test_runner: report entryFile in TestStream events
Signed-off-by: Moshe Atlov <moshe@atlow.co.il> PR-URL: #64309 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
1 parent 949bc3c commit add1edb

7 files changed

Lines changed: 131 additions & 11 deletions

File tree

‎doc/api/test.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3430,6 +3430,10 @@ added:
34303430
- v18.9.0
34313431
- v16.19.0
34323432
changes:
3433+
- version: REPLACEME
3434+
pr-url: https://github.com/nodejs/node/pull/64309
3435+
description: Added `entryFile` to events forwarded from child processes
3436+
when tests run with process isolation.
34333437
- version: v24.19.0
34343438
pr-url: https://github.com/nodejs/node/pull/63435
34353439
description: Added `parentId` to test events that carry a `testId`.
@@ -3514,6 +3518,10 @@ Emitted when code coverage is enabled and all tests have completed.
35143518
* `cause` {Error} The actual error thrown by the test.
35153519
* `type` {string|undefined} The type of the test, used to denote whether
35163520
this is a suite.
3521+
* `entryFile` {string|undefined} The path of the test file that was
3522+
executed as the entry point of the child process that emitted this event.
3523+
Only present when tests run with process isolation. May differ from
3524+
`file` when the test is defined in a module imported by the entry file.
35173525
* `file` {string|undefined} The path of the test file,
35183526
`undefined` if test was run through the REPL.
35193527
* `line` {number|undefined} The line number where the test is defined, or
@@ -3543,6 +3551,10 @@ The corresponding declaration ordered events are `'test:pass'` and `'test:fail'`
35433551
* `data` {Object}
35443552
* `column` {number|undefined} The column number where the test is defined, or
35453553
`undefined` if the test was run through the REPL.
3554+
* `entryFile` {string|undefined} The path of the test file that was
3555+
executed as the entry point of the child process that emitted this event.
3556+
Only present when tests run with process isolation. May differ from
3557+
`file` when the test is defined in a module imported by the entry file.
35463558
* `file` {string|undefined} The path of the test file,
35473559
`undefined` if test was run through the REPL.
35483560
* `line` {number|undefined} The line number where the test is defined, or
@@ -3569,6 +3581,10 @@ defined. The corresponding declaration ordered event is `'test:start'`.
35693581
* `data` {Object}
35703582
* `column` {number|undefined} The column number where the test is defined, or
35713583
`undefined` if the test was run through the REPL.
3584+
* `entryFile` {string|undefined} The path of the test file that was
3585+
executed as the entry point of the child process that emitted this event.
3586+
Only present when tests run with process isolation. May differ from
3587+
`file` when the test is defined in a module imported by the entry file.
35723588
* `file` {string|undefined} The path of the test file,
35733589
`undefined` if test was run through the REPL.
35743590
* `line` {number|undefined} The line number where the test is defined, or
@@ -3590,6 +3606,10 @@ defined.
35903606
* `data` {Object}
35913607
* `column` {number|undefined} The column number where the test is defined, or
35923608
`undefined` if the test was run through the REPL.
3609+
* `entryFile` {string|undefined} The path of the test file that was
3610+
executed as the entry point of the child process that emitted this event.
3611+
Only present when tests run with process isolation. May differ from
3612+
`file` when the test is defined in a module imported by the entry file.
35933613
* `file` {string|undefined} The path of the test file,
35943614
`undefined` if test was run through the REPL.
35953615
* `line` {number|undefined} The line number where the test is defined, or
@@ -3622,6 +3642,10 @@ Emitted when a test is enqueued for execution.
36223642
this is a suite.
36233643
* `attempt` {number|undefined} The attempt number of the test run,
36243644
present only when using the [`--test-rerun-failures`][] flag.
3645+
* `entryFile` {string|undefined} The path of the test file that was
3646+
executed as the entry point of the child process that emitted this event.
3647+
Only present when tests run with process isolation. May differ from
3648+
`file` when the test is defined in a module imported by the entry file.
36253649
* `file` {string|undefined} The path of the test file,
36263650
`undefined` if test was run through the REPL.
36273651
* `line` {number|undefined} The line number where the test is defined, or
@@ -3685,6 +3709,10 @@ since the parent runner only knows about file-level tests. When using
36853709
present only when using the [`--test-rerun-failures`][] flag.
36863710
* `passed_on_attempt` {number|undefined} The attempt number the test passed on,
36873711
present only when using the [`--test-rerun-failures`][] flag.
3712+
* `entryFile` {string|undefined} The path of the test file that was
3713+
executed as the entry point of the child process that emitted this event.
3714+
Only present when tests run with process isolation. May differ from
3715+
`file` when the test is defined in a module imported by the entry file.
36883716
* `file` {string|undefined} The path of the test file,
36893717
`undefined` if test was run through the REPL.
36903718
* `line` {number|undefined} The line number where the test is defined, or
@@ -3714,6 +3742,10 @@ The corresponding execution ordered event is `'test:complete'`.
37143742
* `data` {Object}
37153743
* `column` {number|undefined} The column number where the test is defined, or
37163744
`undefined` if the test was run through the REPL.
3745+
* `entryFile` {string|undefined} The path of the test file that was
3746+
executed as the entry point of the child process that emitted this event.
3747+
Only present when tests run with process isolation. May differ from
3748+
`file` when the test is defined in a module imported by the entry file.
37173749
* `file` {string|undefined} The path of the test file,
37183750
`undefined` if test was run through the REPL.
37193751
* `line` {number|undefined} The line number where the test is defined, or
@@ -3730,6 +3762,10 @@ defined.
37303762
* `data` {Object}
37313763
* `column` {number|undefined} The column number where the test is defined, or
37323764
`undefined` if the test was run through the REPL.
3765+
* `entryFile` {string|undefined} The path of the test file that was
3766+
executed as the entry point of the child process that emitted this event.
3767+
Only present when tests run with process isolation. May differ from
3768+
`file` when the test is defined in a module imported by the entry file.
37333769
* `file` {string|undefined} The path of the test file,
37343770
`undefined` if test was run through the REPL.
37353771
* `line` {number|undefined} The line number where the test is defined, or
@@ -3754,6 +3790,9 @@ The corresponding execution ordered event is `'test:dequeue'`.
37543790
### Event: `'test:stderr'`
37553791

37563792
* `data` {Object}
3793+
* `entryFile` {string|undefined} The path of the test file that was
3794+
executed as the entry point of the child process that emitted this event.
3795+
Only present when tests run with process isolation.
37573796
* `file` {string} The path of the test file.
37583797
* `message` {string} The message written to `stderr`.
37593798

@@ -3765,6 +3804,9 @@ defined.
37653804
### Event: `'test:stdout'`
37663805

37673806
* `data` {Object}
3807+
* `entryFile` {string|undefined} The path of the test file that was
3808+
executed as the entry point of the child process that emitted this event.
3809+
Only present when tests run with process isolation.
37683810
* `file` {string} The path of the test file.
37693811
* `message` {string} The message written to `stdout`.
37703812

‎lib/internal/test_runner/runner.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,10 @@ class FileTest extends Test {
295295
ArrayPrototypeIncludes(kDiagnosticsFilterArgs, StringPrototypeSlice(comment, 0, firstSpaceIndex));
296296
}
297297
#handleReportItem(item) {
298+
// The name is empty when a single child process runs all test files.
299+
if (this.name !== '') {
300+
item.data.entryFile = this.loc.file;
301+
}
298302
const isTopLevel = item.data.nesting === 0;
299303
if (isTopLevel) {
300304
if (item.type === 'test:plan' && this.#skipReporting()) {

‎test/fixtures/test-runner/entry-file/a.test.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { test } from 'node:test';
2+
import { runShared } from './helper.mjs';
3+
test('backup A', async (t) => { await runShared(t, 'A'); });

‎test/fixtures/test-runner/entry-file/b.test.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { test } from 'node:test';
2+
import { runShared } from './helper.mjs';
3+
test('backup B', async (t) => { await runShared(t, 'B'); });

‎test/fixtures/test-runner/entry-file/helper.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export async function runShared(t, target) {
2+
await t.test(`restore ${target}`, async () => {});
3+
}

‎test/parallel/test-runner-entry-file.mjs‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import '../common/index.mjs';
2+
import * as fixtures from '../common/fixtures.mjs';
3+
import { describe, it, run } from 'node:test';
4+
import assert from 'node:assert';
5+
6+
const aPath = fixtures.path('test-runner', 'entry-file', 'a.test.mjs');
7+
const bPath = fixtures.path('test-runner', 'entry-file', 'b.test.mjs');
8+
const helperPath = fixtures.path('test-runner', 'entry-file', 'helper.mjs');
9+
10+
async function collectEvents(options) {
11+
const events = [];
12+
const stream = run({ files: [aPath, bPath], ...options });
13+
stream.on('test:fail', () => {});
14+
for await (const event of stream) {
15+
events.push(event);
16+
}
17+
return events;
18+
}
19+
20+
describe('entryFile attribution in reporter events', { concurrency: false }, () => {
21+
it('stamps entryFile on events forwarded from child processes', async () => {
22+
const events = await collectEvents({ isolation: 'process' });
23+
const checked = { __proto__: null, A: 0, B: 0 };
24+
25+
for (const { type, data } of events) {
26+
if (data?.name === 'restore A' || data?.name === 'restore B') {
27+
const target = data.name === 'restore A' ? 'A' : 'B';
28+
const expectedEntry = target === 'A' ? aPath : bPath;
29+
assert.strictEqual(data.file, helperPath,
30+
`${type} file should be the definition site`);
31+
assert.strictEqual(data.entryFile, expectedEntry,
32+
`${type} entryFile should be the entry file`);
33+
checked[target]++;
34+
}
35+
}
36+
37+
// Each subtest emits at least enqueue/dequeue/start/pass/complete.
38+
assert.ok(checked.A >= 4, `expected events for restore A, got ${checked.A}`);
39+
assert.ok(checked.B >= 4, `expected events for restore B, got ${checked.B}`);
40+
});
41+
42+
it('stamps entryFile on top-level tests forwarded from child processes', async () => {
43+
const events = await collectEvents({ isolation: 'process' });
44+
const pass = events.filter(({ type }) => type === 'test:pass');
45+
const backupA = pass.find(({ data }) => data.name === 'backup A');
46+
const backupB = pass.find(({ data }) => data.name === 'backup B');
47+
assert.strictEqual(backupA.data.entryFile, aPath);
48+
assert.strictEqual(backupB.data.entryFile, bPath);
49+
});
50+
51+
it('does not stamp entryFile with isolation none', async () => {
52+
const events = await collectEvents({ isolation: 'none' });
53+
for (const { data } of events) {
54+
if (data?.name === 'restore A' || data?.name === 'restore B') {
55+
assert.strictEqual(data.entryFile, undefined);
56+
}
57+
}
58+
});
59+
});

‎test/parallel/test-runner-v8-deserializer.mjs‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { describe, it, beforeEach } from 'node:test';
55
import assert from 'node:assert';
66
import { finished } from 'node:stream/promises';
77
import { DefaultSerializer } from 'node:v8';
8+
import { resolve } from 'node:path';
89
import serializer from 'internal/test_runner/reporter/v8-serializer';
910
import runner from 'internal/test_runner/runner';
1011

@@ -14,10 +15,15 @@ async function toArray(chunks) {
1415
return arr;
1516
}
1617

18+
const entryFile = resolve('filetest');
1719
const diagnosticEvent = {
1820
type: 'test:diagnostic',
1921
data: { nesting: 0, details: {}, message: 'diagnostic' },
2022
};
23+
const reportedDiagnosticEvent = {
24+
type: 'test:diagnostic',
25+
data: { ...diagnosticEvent.data, entryFile },
26+
};
2127
const chunks = await toArray(serializer([diagnosticEvent]));
2228
const defaultSerializer = new DefaultSerializer();
2329
defaultSerializer.writeHeader();
@@ -67,28 +73,28 @@ describe('v8 deserializer', common.mustCall(() => {
6773
it('should deserialize a chunk with no serialization', async () => {
6874
const reported = await collectReported([Buffer.from('unknown')]);
6975
assert.deepStrictEqual(reported, [
70-
{ data: { __proto__: null, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
76+
{ data: { __proto__: null, entryFile, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
7177
]);
7278
});
7379

7480
it('should deserialize a serialized chunk', async () => {
7581
const reported = await collectReported(chunks);
76-
assert.deepStrictEqual(reported, [diagnosticEvent]);
82+
assert.deepStrictEqual(reported, [reportedDiagnosticEvent]);
7783
});
7884

7985
it('should deserialize a serialized chunk after non-serialized chunk', async () => {
8086
const reported = await collectReported([Buffer.concat([Buffer.from('unknown'), ...chunks])]);
8187
assert.deepStrictEqual(reported, [
82-
{ data: { __proto__: null, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
83-
diagnosticEvent,
88+
{ data: { __proto__: null, entryFile, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
89+
reportedDiagnosticEvent,
8490
]);
8591
});
8692

8793
it('should deserialize a serialized chunk before non-serialized output', async () => {
8894
const reported = await collectReported([Buffer.concat([ ...chunks, Buffer.from('unknown')])]);
8995
assert.deepStrictEqual(reported, [
90-
diagnosticEvent,
91-
{ data: { __proto__: null, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
96+
reportedDiagnosticEvent,
97+
{ data: { __proto__: null, entryFile, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
9298
]);
9399
});
94100

@@ -131,7 +137,7 @@ describe('v8 deserializer', common.mustCall(() => {
131137
oversizedLengthHeader,
132138
...chunks,
133139
]);
134-
assert.deepStrictEqual(reported.at(-1), diagnosticEvent);
140+
assert.deepStrictEqual(reported.at(-1), reportedDiagnosticEvent);
135141
assert.strictEqual(reported.filter((event) => event.type === 'test:diagnostic').length, 1);
136142
assert.strictEqual(collectStdout(reported), oversizedLengthStdout);
137143
});
@@ -152,7 +158,7 @@ describe('v8 deserializer', common.mustCall(() => {
152158
const data = chunks[0];
153159
const reported = await collectReported([data.subarray(0, i), data.subarray(i)]);
154160
assert.deepStrictEqual(reported, [
155-
diagnosticEvent,
161+
reportedDiagnosticEvent,
156162
]);
157163
});
158164

@@ -163,9 +169,9 @@ describe('v8 deserializer', common.mustCall(() => {
163169
Buffer.concat([data.subarray(i), Buffer.from('unknown')]),
164170
]);
165171
assert.deepStrictEqual(reported, [
166-
{ data: { __proto__: null, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
167-
diagnosticEvent,
168-
{ data: { __proto__: null, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
172+
{ data: { __proto__: null, entryFile, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
173+
reportedDiagnosticEvent,
174+
{ data: { __proto__: null, entryFile, file: 'filetest', message: 'unknown' }, type: 'test:stdout' },
169175
]);
170176
}
171177
);

0 commit comments

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