Skip to content

Commit

Permalink
test_runner: close and flush destinations on forced exit
Browse files Browse the repository at this point in the history
This commit updates the test runner to explicitly close and flush
all destination file streams when the --test-force-exit flag is
used.

Fixes: #54327
  • Loading branch information
cjihrig committed Sep 24, 2024
1 parent ffe0dc5 commit e4d3286
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 4 deletions.
24 changes: 21 additions & 3 deletions lib/internal/test_runner/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ const {
NumberPrototypeToFixed,
ObjectDefineProperty,
ObjectSeal,
Promise,
PromisePrototypeThen,
PromiseResolve,
ReflectApply,
RegExpPrototypeExec,
SafeMap,
SafePromiseAll,
SafePromiseAllReturnVoid,
SafePromisePrototypeFinally,
SafePromiseRace,
SafeSet,
Expand All @@ -46,6 +48,7 @@ const {
createDeferredCallback,
countCompletedTest,
isTestFailureError,
reporterScope,
} = require('internal/test_runner/utils');
const {
createDeferredPromise,
Expand Down Expand Up @@ -973,10 +976,25 @@ class Test extends AsyncResource {
// any remaining ref'ed handles, then do that now. It is theoretically
// possible that a ref'ed handle could asynchronously create more tests,
// but the user opted into this behavior.
this.reporter.once('close', () => {
process.exit();
});
const promises = [];

for (let i = 0; i < reporterScope.reporters.length; i++) {
const { destination } = reporterScope.reporters[i];

ArrayPrototypePush(promises, new Promise((resolve) => {
destination.on('unpipe', () => {
if (!destination.closed && typeof destination.close === 'function') {
destination.close(resolve);
} else {
resolve();
}
});
}));
}

this.harness.teardown();
await SafePromiseAllReturnVoid(promises);
process.exit();
}
}

Expand Down
5 changes: 4 additions & 1 deletion lib/internal/test_runner/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ function shouldColorizeTestFiles(destinations) {

async function getReportersMap(reporters, destinations) {
return SafePromiseAllReturnArrayLike(reporters, async (name, i) => {
const destination = kBuiltinDestinations.get(destinations[i]) ?? createWriteStream(destinations[i]);
const destination = kBuiltinDestinations.get(destinations[i]) ??
createWriteStream(destinations[i], { __proto__: null, flush: true });

// Load the test reporter passed to --test-reporter
let reporter = tryBuiltinReporter(name);
Expand Down Expand Up @@ -301,6 +302,8 @@ function parseCommandLine() {
const { reporter, destination } = reportersMap[i];
compose(rootReporter, reporter).pipe(destination);
}

reporterScope.reporters = reportersMap;
});

globalTestOptions = {
Expand Down
49 changes: 49 additions & 0 deletions test/parallel/test-runner-force-exit-flush.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
'use strict';
require('../common');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
const { match, strictEqual } = require('node:assert');
const { spawnSync } = require('node:child_process');
const { readFileSync } = require('node:fs');
const { test } = require('node:test');

function runWithReporter(reporter) {
const destination = tmpdir.resolve(`${reporter}.out`);
const args = [
'--test-force-exit',
`--test-reporter=${reporter}`,
`--test-reporter-destination=${destination}`,
fixtures.path('test-runner', 'reporters.js'),
];
const child = spawnSync(process.execPath, args);
// strictEqual(child.stdout.toString(), '');
strictEqual(child.stderr.toString(), '');
strictEqual(child.status, 1);
return destination;
}

tmpdir.refresh();

test('junit reporter', () => {
const output = readFileSync(runWithReporter('junit'), 'utf8');
match(output, /<!-- tests 4 -->/);
match(output, /<!-- pass 2 -->/);
match(output, /<!-- fail 2 -->/);
match(output, /<!-- duration_ms/);
match(output, /<\/testsuites>/);
});

test('spec reporter', () => {
const output = readFileSync(runWithReporter('spec'), 'utf8');
match(output, /tests 4/);
match(output, /pass 2/);
match(output, /fail 2/);
});

test('tap reporter', () => {
const output = readFileSync(runWithReporter('tap'), 'utf8');
match(output, /# tests 4/);
match(output, /# pass 2/);
match(output, /# fail 2/);
match(output, /# duration_ms/);
});

0 comments on commit e4d3286

Please sign in to comment.