From 3e524374e10d065d92ce2038b405b5799d501355 Mon Sep 17 00:00:00 2001
From: Sergey Chernyshev <schernyshev@openjdk.org>
Date: Thu, 25 Apr 2024 04:22:17 +0200
Subject: [PATCH] test_runner, cli: add --test-concurrency flag

This commit adds a new --test-concurrency CLI flag that controls
the parallelism of the test runner CLI.

PR-URL: https://github.com/nodejs/node/pull/49996
Fixes: https://github.com/nodejs/node/issues/49487
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
---
 graal-nodejs/doc/api/cli.md                   |  9 ++++
 graal-nodejs/doc/api/test.md                  | 12 ++---
 graal-nodejs/doc/node.1                       |  4 ++
 graal-nodejs/lib/internal/main/test_runner.js |  2 +-
 graal-nodejs/src/node_options.cc              |  3 ++
 graal-nodejs/src/node_options.h               |  1 +
 .../parallel/test-runner-cli-concurrency.js   | 45 +++++++++++++++++++
 7 files changed, 70 insertions(+), 6 deletions(-)
 create mode 100644 graal-nodejs/test/parallel/test-runner-cli-concurrency.js

diff --git a/graal-nodejs/doc/api/cli.md b/graal-nodejs/doc/api/cli.md
index 83d9c5182e1..a0d3cbcd8ef 100644
--- a/graal-nodejs/doc/api/cli.md
+++ b/graal-nodejs/doc/api/cli.md
@@ -1298,6 +1298,15 @@ Starts the Node.js command line test runner. This flag cannot be combined with
 See the documentation on [running tests from the command line][]
 for more details.
 
+### `--test-concurrency`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+The maximum number of test files that the test runner CLI will execute
+concurrently. The default value is `os.availableParallelism() - 1`.
+
 ### `--test-name-pattern`
 
 <!-- YAML
diff --git a/graal-nodejs/doc/api/test.md b/graal-nodejs/doc/api/test.md
index df908a6e557..62f25689634 100644
--- a/graal-nodejs/doc/api/test.md
+++ b/graal-nodejs/doc/api/test.md
@@ -367,11 +367,12 @@ When searching for test files to execute, the test runner behaves as follows:
     automatically executed by the test runner, but are supported if explicitly
     provided on the command line.
 
-Each matching test file is executed in a separate child process. If the child
-process finishes with an exit code of 0, the test is considered passing.
-Otherwise, the test is considered to be a failure. Test files must be
-executable by Node.js, but are not required to use the `node:test` module
-internally.
+Each matching test file is executed in a separate child process. The maximum
+number of child processes running at any time is controlled by the
+[`--test-concurrency`][] flag. If the child process finishes with an exit code
+of 0, the test is considered passing. Otherwise, the test is considered to be a
+failure. Test files must be executable by Node.js, but are not required to use
+the `node:test` module internally.
 
 Each test file is executed as if it was a regular script. That is, if the test
 file itself uses `node:test` to define tests, all of those tests will be
@@ -2449,6 +2450,7 @@ added: v18.7.0
 [TAP]: https://testanything.org/
 [TTY]: tty.md
 [`--experimental-test-coverage`]: cli.md#--experimental-test-coverage
+[`--test-concurrency`]: cli.md#--test-concurrency
 [`--test-name-pattern`]: cli.md#--test-name-pattern
 [`--test-only`]: cli.md#--test-only
 [`--test-reporter-destination`]: cli.md#--test-reporter-destination
diff --git a/graal-nodejs/doc/node.1 b/graal-nodejs/doc/node.1
index 362e9bfdc29..ea2a9dab11e 100644
--- a/graal-nodejs/doc/node.1
+++ b/graal-nodejs/doc/node.1
@@ -400,6 +400,10 @@ Specify the minimum allocation from the OpenSSL secure heap. The default is 2. T
 .It Fl -test
 Starts the Node.js command line test runner.
 .
+.It Fl -test-concurrency
+The maximum number of test files that the test runner CLI will execute
+concurrently.
+.
 .It Fl -test-name-pattern
 A regular expression that configures the test runner to only execute tests
 whose name matches the provided pattern.
diff --git a/graal-nodejs/lib/internal/main/test_runner.js b/graal-nodejs/lib/internal/main/test_runner.js
index 9413c8c93c7..d9fe116cfc3 100644
--- a/graal-nodejs/lib/internal/main/test_runner.js
+++ b/graal-nodejs/lib/internal/main/test_runner.js
@@ -21,7 +21,7 @@ const {
 prepareMainThreadExecution(false);
 markBootstrapComplete();
 
-let concurrency = true;
+let concurrency = getOptionValue('--test-concurrency') || true;
 let inspectPort;
 
 if (isUsingInspector()) {
diff --git a/graal-nodejs/src/node_options.cc b/graal-nodejs/src/node_options.cc
index a49ddf125dc..a3a85a60463 100644
--- a/graal-nodejs/src/node_options.cc
+++ b/graal-nodejs/src/node_options.cc
@@ -571,6 +571,9 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
   AddOption("--test",
             "launch test runner on startup",
             &EnvironmentOptions::test_runner);
+  AddOption("--test-concurrency",
+            "specify test runner concurrency",
+            &EnvironmentOptions::test_runner_concurrency);
   AddOption("--experimental-test-coverage",
             "enable code coverage in the test runner",
             &EnvironmentOptions::test_runner_coverage);
diff --git a/graal-nodejs/src/node_options.h b/graal-nodejs/src/node_options.h
index 9a05f80eeb5..743e19f58d5 100644
--- a/graal-nodejs/src/node_options.h
+++ b/graal-nodejs/src/node_options.h
@@ -156,6 +156,7 @@ class EnvironmentOptions : public Options {
   std::string redirect_warnings;
   std::string diagnostic_dir;
   bool test_runner = false;
+  uint64_t test_runner_concurrency = 0;
   bool test_runner_coverage = false;
   std::vector<std::string> test_name_pattern;
   std::vector<std::string> test_reporter;
diff --git a/graal-nodejs/test/parallel/test-runner-cli-concurrency.js b/graal-nodejs/test/parallel/test-runner-cli-concurrency.js
new file mode 100644
index 00000000000..9d8dd4f8ce2
--- /dev/null
+++ b/graal-nodejs/test/parallel/test-runner-cli-concurrency.js
@@ -0,0 +1,45 @@
+'use strict';
+const common = require('../common');
+const tmpdir = require('../common/tmpdir');
+const { deepStrictEqual, strictEqual } = require('node:assert');
+const { spawnSync } = require('node:child_process');
+const { readdirSync, writeFileSync } = require('node:fs');
+const { join } = require('node:path');
+const { beforeEach, test } = require('node:test');
+
+function createTestFile(name) {
+  writeFileSync(join(tmpdir.path, name), `
+    const fs = require('node:fs');
+
+    fs.unlinkSync(__filename);
+    setTimeout(() => {}, 1_000_000_000);
+  `);
+}
+
+beforeEach(() => {
+  tmpdir.refresh();
+  createTestFile('test-1.js');
+  createTestFile('test-2.js');
+});
+
+test('concurrency of one', () => {
+  const cp = spawnSync(process.execPath, ['--test', '--test-concurrency=1'], {
+    cwd: tmpdir.path,
+    timeout: common.platformTimeout(1000),
+  });
+
+  strictEqual(cp.stderr.toString(), '');
+  strictEqual(cp.error.code, 'ETIMEDOUT');
+  deepStrictEqual(readdirSync(tmpdir.path), ['test-2.js']);
+});
+
+test('concurrency of two', () => {
+  const cp = spawnSync(process.execPath, ['--test', '--test-concurrency=2'], {
+    cwd: tmpdir.path,
+    timeout: common.platformTimeout(1000),
+  });
+
+  strictEqual(cp.stderr.toString(), '');
+  strictEqual(cp.error.code, 'ETIMEDOUT');
+  deepStrictEqual(readdirSync(tmpdir.path), []);
+});