node/test/parallel/test-runner-concurrency.js
Tobias Nießen 185d6090cd
doc,test: fix concurrency option of test()
The documentation appears to still be wrong w.r.t. the meaning of the
concurrency option of the test() function. The implementation appears to
default to Infinity when the option is set to true. Is that intended or
a good idea? I don't know. It certainly makes more sense than what the
documentation says (which is basing the number of concurrent tasks
within a single thread on the number of CPU cores).

This changes the documentation to hopefully match the implementation and
adds a test that rules out the (rather arbitrary) behavior described in
the documentation.

Refs: https://github.com/nodejs/node/issues/47365
Refs: https://github.com/nodejs/node/pull/47642
PR-URL: https://github.com/nodejs/node/pull/47734
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2023-05-03 08:34:23 +02:00

99 lines
3.1 KiB
JavaScript

'use strict';
const common = require('../common');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
const { describe, it, test } = require('node:test');
const assert = require('node:assert');
const path = require('node:path');
const fs = require('node:fs/promises');
const os = require('node:os');
const timers = require('node:timers/promises');
tmpdir.refresh();
describe('Concurrency option (boolean) = true', { concurrency: true }, () => {
let isFirstTestOver = false;
it('should start the first test', () => new Promise((resolve) => {
setImmediate(() => { isFirstTestOver = true; resolve(); });
}));
it('should start before the previous test ends', () => {
// Should work even on single core CPUs
assert.strictEqual(isFirstTestOver, false);
});
});
describe(
'Concurrency option (boolean) = false',
{ concurrency: false },
() => {
let isFirstTestOver = false;
it('should start the first test', () => new Promise((resolve) => {
setImmediate(() => { isFirstTestOver = true; resolve(); });
}));
it('should start after the previous test ends', () => {
assert.strictEqual(isFirstTestOver, true);
});
}
);
// Despite the docs saying so at some point, setting concurrency to true should
// not limit concurrency to the number of available CPU cores.
describe('concurrency: true implies Infinity', { concurrency: true }, () => {
// The factor 5 is intentionally chosen to be higher than the default libuv
// thread pool size.
const nTests = 5 * os.availableParallelism();
let nStarted = 0;
for (let i = 0; i < nTests; i++) {
it(`should run test ${i} concurrently`, async () => {
assert.strictEqual(nStarted++, i);
await timers.setImmediate();
assert.strictEqual(nStarted, nTests);
});
}
});
{
// Make sure tests run in order when root concurrency is 1 (default)
const tree = [];
const expectedTestTree = common.mustCall(() => {
assert.deepStrictEqual(tree, [
'suite 1', 'nested', 'suite 2',
'1', '2', 'nested 1', 'nested 2',
'test', 'test 1', 'test 2',
]);
});
describe('suite 1', () => {
tree.push('suite 1');
it('1', () => tree.push('1'));
it('2', () => tree.push('2'));
describe('nested', () => {
tree.push('nested');
it('nested 1', () => tree.push('nested 1'));
it('nested 2', () => tree.push('nested 2'));
});
});
test('test', async (t) => {
tree.push('test');
await t.test('test1', () => tree.push('test 1'));
await t.test('test 2', () => tree.push('test 2'));
});
describe('suite 2', () => {
tree.push('suite 2');
it('should run after other suites', expectedTestTree);
});
}
test('--test multiple files', { skip: os.availableParallelism() < 3 }, async () => {
await fs.writeFile(path.resolve(tmpdir.path, 'test-runner-concurrency'), '');
const { code, stderr } = await common.spawnPromisified(process.execPath, [
'--test',
fixtures.path('test-runner', 'concurrency', 'a.mjs'),
fixtures.path('test-runner', 'concurrency', 'b.mjs'),
]);
assert.strictEqual(stderr, '');
assert.strictEqual(code, 0);
});