☕️ Classic, reliable, trusted test framework for Node.js and the browser
feat(parallel): assign each worker a worker-id (#4813)
Quentin Barbe8b089a2997a7
diff --git a/docs/index.md b/docs/index.mdindex 3abf41ca..be27aa9a 100644--- a/docs/index.md+++ b/docs/index.md@@ -1379,6 +1379,12 @@ Free-tier cloud CI services may not provide a suitable multi-core container or VIt's unlikely (but not impossible) to see a performance gain from a [job count](#-jobs-count-j-count) _greater than_ the number of available CPU cores. That said, _play around with the job count_--there's no one-size-fits all, and the unique characteristics of your tests will determine the optimal number of jobs; it may even be that fewer is faster!+### Parallel Mode Worker IDs++> _New in v9.2.0_++Each process launched by parallel mode is assigned a unique id, from 0 for the first process to be launched, to N-1 for the Nth process. This worker id may be accessed in tests via the environment variable `MOCHA_WORKER_ID`. It can be used for example to assign a different database, service port, etc for each test process.+## Root Hook Plugins> _New in v8.0.0_diff --git a/lib/nodejs/buffered-worker-pool.js b/lib/nodejs/buffered-worker-pool.jsindex 9b0d4516..fe4abf94 100644--- a/lib/nodejs/buffered-worker-pool.js+++ b/lib/nodejs/buffered-worker-pool.js@@ -75,7 +75,23 @@ class BufferedWorkerPool {process.execArgv.join(' '));- this.options = {...WORKER_POOL_DEFAULT_OPTS, opts, maxWorkers};+ let counter = 0;+ const onCreateWorker = ({forkOpts}) => {+ return {+ forkOpts: {+ ...forkOpts,+ // adds an incremental id to all workers, which can be useful to allocate resources for each process+ env: {...process.env, MOCHA_WORKER_ID: counter++}+ }+ };+ };++ this.options = {+ ...WORKER_POOL_DEFAULT_OPTS,+ ...opts,+ maxWorkers,+ onCreateWorker+ };this._pool = workerpool.pool(WORKER_PATH, this.options);}diff --git a/package-lock.json b/package-lock.jsonindex 09fae06f..7b5c3a2e 100644--- a/package-lock.json+++ b/package-lock.json@@ -29,7 +29,7 @@"strip-json-comments": "3.1.1","supports-color": "8.1.1","which": "2.0.2",- "workerpool": "6.1.5",+ "workerpool": "6.2.0","yargs": "16.2.0","yargs-parser": "20.2.4","yargs-unparser": "2.0.0"@@ -25120,9 +25120,9 @@}},"node_modules/workerpool": {- "version": "6.1.5",- "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.1.5.tgz",- "integrity": "sha512-XdKkCK0Zqc6w3iTxLckiuJ81tiD/o5rBE/m+nXpRCB+/Sq4DqkfXZ/x0jW02DG1tGsfUGXbTJyZDP+eu67haSw=="+ "version": "6.2.0",+ "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.0.tgz",+ "integrity": "sha512-Rsk5qQHJ9eowMH28Jwhe8HEbmdYDX4lwoMWshiCXugjtHqMD9ZbiqSDLxcsfdqsETPzVUtX5s1Z5kStiIM6l4A=="},"node_modules/wrap-ansi": {"version": "7.0.0",@@ -45239,9 +45239,9 @@}},"workerpool": {- "version": "6.1.5",- "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.1.5.tgz",- "integrity": "sha512-XdKkCK0Zqc6w3iTxLckiuJ81tiD/o5rBE/m+nXpRCB+/Sq4DqkfXZ/x0jW02DG1tGsfUGXbTJyZDP+eu67haSw=="+ "version": "6.2.0",+ "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.0.tgz",+ "integrity": "sha512-Rsk5qQHJ9eowMH28Jwhe8HEbmdYDX4lwoMWshiCXugjtHqMD9ZbiqSDLxcsfdqsETPzVUtX5s1Z5kStiIM6l4A=="},"wrap-ansi": {"version": "7.0.0",diff --git a/package.json b/package.jsonindex 4f585450..bf20f911 100644--- a/package.json+++ b/package.json@@ -72,7 +72,7 @@"strip-json-comments": "3.1.1","supports-color": "8.1.1","which": "2.0.2",- "workerpool": "6.1.5",+ "workerpool": "6.2.0","yargs": "16.2.0","yargs-parser": "20.2.4","yargs-unparser": "2.0.0"diff --git a/test/integration/fixtures/parallel/testworkerid1.mjs b/test/integration/fixtures/parallel/testworkerid1.mjsnew file mode 100644index 00000000..2e1f55e6--- /dev/null+++ b/test/integration/fixtures/parallel/testworkerid1.mjs@@ -0,0 +1,7 @@+import assert from 'assert';++describe('test1', () => {+ it('should always run on worker with id 0', () => {+ assert.ok(process.env.MOCHA_WORKER_ID === '0');+ });+});diff --git a/test/integration/fixtures/parallel/testworkerid2.mjs b/test/integration/fixtures/parallel/testworkerid2.mjsnew file mode 100644index 00000000..c9bf710c--- /dev/null+++ b/test/integration/fixtures/parallel/testworkerid2.mjs@@ -0,0 +1,7 @@+import assert from 'assert';++describe('test2', () => {+ it('should always run on worker with id 1', () => {+ assert.ok(process.env.MOCHA_WORKER_ID === '1');+ });+});diff --git a/test/integration/fixtures/parallel/testworkerid3.mjs b/test/integration/fixtures/parallel/testworkerid3.mjsnew file mode 100644index 00000000..40a1ab43--- /dev/null+++ b/test/integration/fixtures/parallel/testworkerid3.mjs@@ -0,0 +1,9 @@+import assert from 'assert';++describe('test3', () => {+ it('should run on worker with either id 0 or 1', () => {+ assert.ok(+ process.env.MOCHA_WORKER_ID === '0' || process.env.MOCHA_WORKER_ID === '1'+ );+ });+});diff --git a/test/integration/parallel.spec.js b/test/integration/parallel.spec.jsindex b0193074..3cdecfcf 100644--- a/test/integration/parallel.spec.js+++ b/test/integration/parallel.spec.js@@ -18,4 +18,16 @@ describe('parallel run', () => {assert.strictEqual(result.stats.failures, 1);assert.strictEqual(result.stats.passes, 2);});++ it('should correctly set worker ids for each process', async () => {+ const result = await runMochaJSONAsync('parallel/testworkerid3.mjs', [+ '--parallel',+ '--jobs',+ '2',+ require.resolve('./fixtures/parallel/testworkerid1.mjs'),+ require.resolve('./fixtures/parallel/testworkerid2.mjs')+ ]);+ assert.strictEqual(result.stats.failures, 0);+ assert.strictEqual(result.stats.passes, 3);+ });});