test: wait for stream finish when --test-force-exit

nodejs · Sep 15, 2024 · 016dddf · 016dddf
1 parent a65105e
commit 016dddf
Show file tree

Hide file tree

Showing 10 changed files with 210 additions and 6 deletions.
diff --git a/lib/internal/test_runner/test.js b/lib/internal/test_runner/test.js
@@ -1,5 +1,6 @@
 'use strict';
 const {
+  ArrayPrototypeMap,
   ArrayPrototypePush,
   ArrayPrototypePushApply,
   ArrayPrototypeReduce,
@@ -20,6 +21,7 @@ const {
   RegExpPrototypeExec,
   SafeMap,
   SafePromiseAll,
+  SafePromiseAllReturnVoid,
   SafePromisePrototypeFinally,
   SafePromiseRace,
   SafeSet,
@@ -64,6 +66,7 @@ const { setTimeout } = require('timers');
 const { TIMEOUT_MAX } = require('internal/timers');
 const { fileURLToPath } = require('internal/url');
 const { availableParallelism } = require('os');
+const { finished } = require('stream/promises');
 const { bigint: hrtime } = process.hrtime;
 const kCallbackAndPromisePresent = 'callbackAndPromisePresent';
 const kCancelledByParent = 'cancelledByParent';
@@ -963,7 +966,8 @@ 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', () => {
+      this.reporter.once('close', async () => {
+        await SafePromiseAllReturnVoid(ArrayPrototypeMap(this.reporter.streams, (stream) => finished(stream)));
         process.exit();
       });
       this.harness.teardown();

diff --git a/lib/internal/test_runner/tests_stream.js b/lib/internal/test_runner/tests_stream.js
@@ -18,6 +18,7 @@ class TestsStream extends Readable {
       objectMode: true,
       highWaterMark: NumberMAX_SAFE_INTEGER,
     });
+    this.streams = [];
     this.#buffer = [];
     this.#canPush = true;
   }

diff --git a/lib/internal/test_runner/utils.js b/lib/internal/test_runner/utils.js
@@ -297,7 +297,9 @@ function parseCommandLine() {
 
     for (let i = 0; i < reportersMap.length; i++) {
       const { reporter, destination } = reportersMap[i];
-      compose(rootReporter, reporter).pipe(destination);
+      const stream = compose(rootReporter, reporter);
+      stream.pipe(destination);
+      ArrayPrototypePush(rootReporter.streams, stream);
     }
   });
 

diff --git a/test-runner-force-exit-dot.snapshot b/test-runner-force-exit-dot.snapshot
@@ -0,0 +1,24 @@
+X.X
+
+Failed tests:
+
+✖ Failing test (1.601959ms)
+  AssertionError [ERR_ASSERTION]: Failed
+      *
+      *
+      *
+      *
+      *
+      *
+      at new Promise (<anonymous>)
+      *
+      *
+      at Array.map (<anonymous>) {
+    generatedMessage: true,
+    code: 'ERR_ASSERTION',
+    actual: undefined,
+    expected: undefined,
+    operator: 'fail'
+  }
+✖ Suite (3.340613ms)
+  '1 subtest failed'
diff --git a/test-runner-force-exit-junit.snapshot b/test-runner-force-exit-junit.snapshot
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<testsuites>
+	<testsuite name="Suite" time="0.003332" disabled="0" errors="0" tests="2" failures="1" skipped="0" hostname="Jedi8-KALI">
+		<testcase name="Failing test" time="0.001619" classname="test" failure="Failed">
+			<failure type="testCodeFailure" message="Failed">
+Error [ERR_TEST_FAILURE]: Failed
+    at new Promise (&lt;anonymous>)
+    at Array.map (&lt;anonymous>) {
+  code: 'ERR_TEST_FAILURE',
+  failureType: 'testCodeFailure',
+  cause: AssertionError [ERR_ASSERTION]: Failed
+      *
+      *
+      *
+      *
+      *
+      *
+      at new Promise (&lt;anonymous>)
+      *
+      *
+      at Array.map (&lt;anonymous>) {
+    generatedMessage: true,
+    code: 'ERR_ASSERTION',
+    actual: undefined,
+    expected: undefined,
+    operator: 'fail'
+  }
+}
+			</failure>
+		</testcase>
+		<testcase name="Passing test" time="0.000220" classname="test"/>
+	</testsuite>
+	<!-- tests 2 -->
+	<!-- suites 1 -->
+	<!-- pass 1 -->
+	<!-- fail 1 -->
+	<!-- cancelled 0 -->
+	<!-- skipped 0 -->
+	<!-- todo 0 -->
+	<!-- duration_ms * -->
+</testsuites>
diff --git a/test-runner-force-exit-spec.snapshot b/test-runner-force-exit-spec.snapshot
@@ -0,0 +1,52 @@
+▶ Suite
+  ✖ Failing test (2.788262ms)
+    AssertionError [ERR_ASSERTION]: Failed
+        *
+        *
+        *
+        *
+        *
+        *
+        at new Promise (<anonymous>)
+        *
+        *
+        at Array.map (<anonymous>) {
+      generatedMessage: true,
+      code: 'ERR_ASSERTION',
+      actual: undefined,
+      expected: undefined,
+      operator: 'fail'
+    }
+
+  ✔ Passing test (0.261558ms)
+▶ Suite (4.670433ms)
+ℹ tests 2
+ℹ suites 1
+ℹ pass 1
+ℹ fail 1
+ℹ cancelled 0
+ℹ skipped 0
+ℹ todo 0
+ℹ duration_ms *
+
+✖ failing tests:
+
+*
+✖ Failing test (2.788262ms)
+  AssertionError [ERR_ASSERTION]: Failed
+      *
+      *
+      *
+      *
+      *
+      *
+      at new Promise (<anonymous>)
+      *
+      *
+      at Array.map (<anonymous>) {
+    generatedMessage: true,
+    code: 'ERR_ASSERTION',
+    actual: undefined,
+    expected: undefined,
+    operator: 'fail'
+  }
diff --git a/test-runner-force-exit-tap.snapshot b/test-runner-force-exit-tap.snapshot
@@ -0,0 +1,48 @@
+TAP version 13
+# Subtest: Suite
+    # Subtest: Failing test
+    not ok 1 - Failing test
+      ---
+      duration_ms: *
+      location: '/test/fixtures/test-runner/output/test-runner-force-exit.js:(LINE):5'
+      failureType: 'testCodeFailure'
+      error: 'Failed'
+      code: 'ERR_ASSERTION'
+      name: 'AssertionError'
+      operator: 'fail'
+      stack: |-
+        *
+        *
+        *
+        *
+        *
+        *
+        new Promise (<anonymous>)
+        *
+        *
+        Array.map (<anonymous>)
+      ...
+    # Subtest: Passing test
+    ok 2 - Passing test
+      ---
+      duration_ms: *
+      ...
+    1..2
+not ok 1 - Suite
+  ---
+  duration_ms: *
+  type: 'suite'
+  location: '/test/fixtures/test-runner/output/test-runner-force-exit.js:(LINE):1'
+  failureType: 'subtestsFailed'
+  error: '1 subtest failed'
+  code: 'ERR_TEST_FAILURE'
+  ...
+1..1
+# tests 2
+# suites 1
+# pass 1
+# fail 1
+# cancelled 0
+# skipped 0
+# todo 0
+# duration_ms *
diff --git a/test/common/assertSnapshot.js b/test/common/assertSnapshot.js
@@ -72,7 +72,7 @@ async function assertSnapshot(actual, filename = process.argv[1]) {
  * @param {boolean} [options.tty] - whether to spawn the process in a pseudo-tty
  * @returns {Promise<void>}
  */
-async function spawnAndAssert(filename, transform = (x) => x, { tty = false, ...options } = {}) {
+async function spawnAndAssert(filename, transform = (x) => x, { tty = false, ...options } = {}, snapshot = filename) {
   if (tty && common.isWindows) {
     test({ skip: 'Skipping pseudo-tty tests, as pseudo terminals are not available on Windows.' });
     return;
@@ -88,7 +88,7 @@ async function spawnAndAssert(filename, transform = (x) => x, { tty = false, ...
       [path.join(__dirname, '../..', 'tools/pseudo-tty.py'), process.execPath, ...flags, filename] :
       [...flags, filename];
   const { stdout, stderr } = await common.spawnPromisified(executable, args, options);
-  await assertSnapshot(transform(`${stdout}${stderr}`), filename);
+  await assertSnapshot(transform(`${stdout}${stderr}`), snapshot);
 }
 
 module.exports = {

diff --git a/test/fixtures/test-runner/output/test-runner-force-exit.js b/test/fixtures/test-runner/output/test-runner-force-exit.js
@@ -0,0 +1,12 @@
+const { describe, test } = require('node:test');
+const assert = require('node:assert');
+
+describe('Suite', () => {
+    test('Failing test', () => {
+        assert.fail()
+    })
+
+    test('Passing test', () => {
+        assert.ok(true)
+    })
+});
diff --git a/test/parallel/test-runner-output.mjs b/test/parallel/test-runner-output.mjs
@@ -219,6 +219,26 @@ const tests = [
     name: 'test-runner/output/test-runner-plan.js',
     flags: ['--test-reporter=tap'],
   },
+  {
+    name: 'test-runner/output/test-runner-force-exit.js',
+    flags: ['--test-reporter=dot'],
+    snapshotPath: 'test-runner-force-exit-dot'
+  },
+  {
+    name: 'test-runner/output/test-runner-force-exit.js',
+    flags: ['--test-reporter=junit'],
+    snapshotPath: 'test-runner-force-exit-junit'
+  },
+  {
+    name: 'test-runner/output/test-runner-force-exit.js',
+    flags: ['--test-reporter=spec'],
+    snapshotPath: 'test-runner-force-exit-spec'
+  },
+  {
+    name: 'test-runner/output/test-runner-force-exit.js',
+    flags: ['--test-reporter=tap'],
+    snapshotPath: 'test-runner-force-exit-tap'
+  },
   process.features.inspector ? {
     name: 'test-runner/output/coverage_failure.js',
     flags: ['--test-reporter=tap'],
@@ -261,10 +281,10 @@ const tests = [
   } : false,
 ]
 .filter(Boolean)
-.map(({ flags, name, tty, transform }) => ({
+.map(({ flags, name, tty, transform, snapshotPath }) => ({
   name,
   fn: common.mustCall(async () => {
-    await snapshot.spawnAndAssert(fixtures.path(name), transform ?? defaultTransform, { tty, flags });
+    await snapshot.spawnAndAssert(fixtures.path(name), transform ?? defaultTransform, { tty, flags }, snapshotPath);
   }),
 }));