test_runner: support defining test reporter in NODE_OPTIONS

Adds --test-reporter and --test-reporter-destination as allowable options in NODE_OPTIONS. Also adds the CLI flag --test-child-process to allow forcing the default test-reporter for inter-process communication. Fixes: #46484
nodejs · Feb 23, 2023 · 15803a0 · 15803a0
1 parent 9e06ef0
commit 15803a0
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 16 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -1272,6 +1272,12 @@ added: v19.6.0
 The destination for the corresponding test reporter. See the documentation on
 [test reporters][] for more details.
 
+### `--test-child-process`
+
+A flag to identify the process as a child of another test process to ensure
+that test reporting is formatted correctly to be parsed by a parent test
+process.
+
 ### `--test-only`
 
 <!-- YAML
@@ -1952,6 +1958,8 @@ Node.js options that are allowed are:
 * `--secure-heap`
 * `--snapshot-blob`
 * `--test-only`
+* `--test-reporter-destination`
+* `--test-reporter`
 * `--throw-deprecation`
 * `--title`
 * `--tls-cipher-list`

diff --git a/lib/internal/test_runner/runner.js b/lib/internal/test_runner/runner.js
@@ -4,10 +4,12 @@ const {
   ArrayPrototypeFilter,
   ArrayPrototypeForEach,
   ArrayPrototypeIncludes,
+  ArrayPrototypeJoin,
   ArrayPrototypePush,
   ArrayPrototypeSlice,
   ArrayPrototypeSome,
   ArrayPrototypeSort,
+  ArrayPrototypeUnshift,
   FunctionPrototypeCall,
   Number,
   ObjectAssign,
@@ -21,6 +23,7 @@ const {
   SafeSet,
   StringPrototypeIndexOf,
   StringPrototypeSlice,
+  StringPrototypeSplit,
   StringPrototypeStartsWith,
 } = primordials;
 
@@ -143,6 +146,8 @@ function getRunArgs({ path, inspectPort }) {
     ArrayPrototypePush(argv, `--inspect-port=${getInspectPort(inspectPort)}`);
   }
   ArrayPrototypePush(argv, path);
+  ArrayPrototypeUnshift(argv, '--test-child-process');
+
   return argv;
 }
 

diff --git a/lib/internal/test_runner/utils.js b/lib/internal/test_runner/utils.js
@@ -166,25 +166,31 @@ function parseCommandLine() {
 
   const isTestRunner = getOptionValue('--test');
   const coverage = getOptionValue('--experimental-test-coverage');
-  const destinations = getOptionValue('--test-reporter-destination');
-  const reporters = getOptionValue('--test-reporter');
+  let destinations = getOptionValue('--test-reporter-destination');
+  let reporters = getOptionValue('--test-reporter');
+  const isChildProcess = getOptionValue('--test-child-process');
   let testNamePatterns;
   let testOnlyFlag;
 
-  if (reporters.length === 0 && destinations.length === 0) {
-    ArrayPrototypePush(reporters, kDefaultReporter);
-  }
+  if (isChildProcess) {
+    reporters = [kDefaultReporter];
+    destinations = [kDefaultDestination];
+  } else {
+    if (reporters.length === 0 && destinations.length === 0) {
+      ArrayPrototypePush(reporters, kDefaultReporter);
+    }
 
-  if (reporters.length === 1 && destinations.length === 0) {
-    ArrayPrototypePush(destinations, kDefaultDestination);
-  }
+    if (reporters.length === 1 && destinations.length === 0) {
+      ArrayPrototypePush(destinations, kDefaultDestination);
+    }
 
-  if (destinations.length !== reporters.length) {
-    throw new ERR_INVALID_ARG_VALUE(
-      '--test-reporter',
-      reporters,
-      'must match the number of specified \'--test-reporter-destination\'',
-    );
+    if (destinations.length !== reporters.length) {
+      throw new ERR_INVALID_ARG_VALUE(
+        '--test-reporter',
+        reporters,
+        'must match the number of specified \'--test-reporter-destination\'',
+      );
+    }
   }
 
   if (isTestRunner) {

diff --git a/src/node_options.cc b/src/node_options.cc
@@ -569,10 +569,14 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             &EnvironmentOptions::test_name_pattern);
   AddOption("--test-reporter",
             "report test output using the given reporter",
-            &EnvironmentOptions::test_reporter);
+            &EnvironmentOptions::test_reporter,
+            kAllowedInEnvvar);
   AddOption("--test-reporter-destination",
             "report given reporter to the given destination",
-            &EnvironmentOptions::test_reporter_destination);
+            &EnvironmentOptions::test_reporter_destination,
+            kAllowedInEnvvar);
+  AddOption("--test-child-process", "",  // for internal use by test runner
+            &EnvironmentOptions::test_child_process);
   AddOption("--test-only",
             "run tests with 'only' option set",
             &EnvironmentOptions::test_only,

diff --git a/src/node_options.h b/src/node_options.h
@@ -158,6 +158,7 @@ class EnvironmentOptions : public Options {
   std::vector<std::string> test_name_pattern;
   std::vector<std::string> test_reporter;
   std::vector<std::string> test_reporter_destination;
+  bool test_child_process = false;
   bool test_only = false;
   bool test_udp_no_try_send = false;
   bool throw_deprecation = false;