import * as common from '../common/index.mjs';
import * as fixtures from '../common/fixtures.mjs';
import { basename, join } from 'node:path';
import { describe, it, run } from 'node:test';
import { dot, spec, tap } from 'node:test/reporters';
import consumers from 'node:stream/consumers';
import assert from 'node:assert';
import util from 'node:util';
const testFixtures = fixtures.path('test-runner');
const rerunStateFile = join(testFixtures, 'rerun-state.json');
describe('require(\'node:test\').run', { concurrency: true }, () => {
it('should run with no tests', async () => {
const stream = run({ files: [] });
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustNotCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should fail with non existing file', async () => {
const stream = run({ files: ['a-random-file-that-does-not-exist.js'] });
stream.on('test:fail', common.mustCall(1));
stream.on('test:pass', common.mustNotCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should succeed with a file', async () => {
const stream = run({ files: [join(testFixtures, 'default-behavior/test/random.cjs')] });
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall(1));
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should emit diagnostic events with level parameter', async () => {
const diagnosticEvents = [];
const stream = run({
files: [join(testFixtures, 'coverage.js')],
reporter: 'spec',
});
stream.on('test:diagnostic', (event) => {
diagnosticEvents.push(event);
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
assert(diagnosticEvents.length > 0, 'No diagnostic events were emitted');
const infoEvent = diagnosticEvents.find((e) => e.level === 'info');
assert(infoEvent, 'No diagnostic events with level "info" were emitted');
});
const argPrintingFile = join(testFixtures, 'print-arguments.js');
it('should allow custom arguments via execArgv', async () => {
const result = await run({ files: [argPrintingFile], execArgv: ['-p', '"Printed"'] }).compose(spec).toArray();
assert.strictEqual(result[0].toString(), 'Printed\n');
});
it('should allow custom arguments via argv', async () => {
const stream = run({ files: [argPrintingFile], argv: ['--a-custom-argument'] });
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should run same file twice', async () => {
const stream = run({
files: [
join(testFixtures, 'default-behavior/test/random.cjs'),
join(testFixtures, 'default-behavior/test/random.cjs'),
]
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall(2));
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should run a failed test', async () => {
const stream = run({ files: [testFixtures] });
stream.on('test:fail', common.mustCall(1));
stream.on('test:pass', common.mustNotCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should support timeout', async () => {
const stream = run({ timeout: 50, files: [
fixtures.path('test-runner', 'run-timeout.mjs'),
] });
stream.on('test:fail', common.mustCall((data) => {
assert.strictEqual(data.details.error.failureType, 'testTimeoutFailure');
}, 2));
stream.on('test:pass', common.mustNotCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
for (const isolation of ['process', 'none']) {
it(`should preserve cancelled queued subtest order without randomization (${isolation})`, async () => {
const stream = run({
files: [fixtures.path('test-runner', 'cancelled-report-order.mjs')],
isolation,
});
const cancelledFailures = [];
stream.on('test:fail', ({ name, details }) => {
if (name === 'second' || name === 'third') {
cancelledFailures.push({
name,
failureType: details.error.failureType,
});
}
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
assert.deepStrictEqual(cancelledFailures, [
{ name: 'second', failureType: 'cancelledByParent' },
{ name: 'third', failureType: 'cancelledByParent' },
]);
});
}
it('should be piped with dot', async () => {
const result = await run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')]
}).compose(dot).toArray();
assert.strictEqual(result.length, 2);
assert.strictEqual(util.stripVTControlCharacters(result[0]), '.');
assert.strictEqual(result[1], '\n');
});
describe('should be piped with spec reporter', () => {
it('new spec', async () => {
const specReporter = new spec();
const result = await consumers.text(run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')]
}).compose(specReporter));
assert.match(result, /this should pass/);
assert.match(result, /tests 1/);
assert.match(result, /pass 1/);
});
it('spec()', async () => {
const specReporter = spec();
const result = await consumers.text(run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')]
}).compose(specReporter));
assert.match(result, /this should pass/);
assert.match(result, /tests 1/);
assert.match(result, /pass 1/);
});
it('spec', async () => {
const result = await consumers.text(run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')]
}).compose(spec));
assert.match(result, /this should pass/);
assert.match(result, /tests 1/);
assert.match(result, /pass 1/);
});
});
it('should be piped with tap', async () => {
const result = await run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')]
}).compose(tap).toArray();
assert.strictEqual(result.length, 13);
assert.strictEqual(result[0], 'TAP version 13\n');
assert.strictEqual(result[1], '# Subtest: this should pass\n');
assert.strictEqual(result[2], 'ok 1 - this should pass\n');
assert.match(result[3], /duration_ms: \d+\.?\d*/);
assert.strictEqual(result[4], '1..1\n');
assert.strictEqual(result[5], '# tests 1\n');
assert.strictEqual(result[6], '# suites 0\n');
assert.strictEqual(result[7], '# pass 1\n');
assert.strictEqual(result[8], '# fail 0\n');
assert.strictEqual(result[9], '# cancelled 0\n');
assert.strictEqual(result[10], '# skipped 0\n');
assert.strictEqual(result[11], '# todo 0\n');
assert.match(result[12], /# duration_ms \d+\.?\d*/);
});
it('should skip tests not matching testNamePatterns - RegExp', async () => {
const result = await run({
files: [join(testFixtures, 'default-behavior/test/skip_by_name.cjs')],
testNamePatterns: [/executed/]
})
.compose(tap)
.toArray();
assert.strictEqual(result[2], 'ok 1 - this should be executed\n');
assert.strictEqual(result[4], '1..1\n');
assert.strictEqual(result[5], '# tests 1\n');
});
it('should skip tests not matching testNamePatterns - string', async () => {
const result = await run({
files: [join(testFixtures, 'default-behavior/test/skip_by_name.cjs')],
testNamePatterns: ['executed']
})
.compose(tap)
.toArray();
assert.strictEqual(result[2], 'ok 1 - this should be executed\n');
assert.strictEqual(result[4], '1..1\n');
assert.strictEqual(result[5], '# tests 1\n');
});
it('should pass only to children', async () => {
const result = await run({
files: [join(testFixtures, 'test_only.js')],
only: true
})
.compose(tap)
.toArray();
assert.strictEqual(result[2], 'ok 1 - this should be executed\n');
assert.strictEqual(result[4], '1..1\n');
assert.strictEqual(result[5], '# tests 1\n');
});
it('should emit "test:watch:drained" event on watch mode', async () => {
const controller = new AbortController();
await run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')],
watch: true,
signal: controller.signal,
}).on('data', function({ type }) {
if (type === 'test:watch:drained') {
controller.abort();
}
});
});
it('should include test type in enqueue, dequeue events', async (t) => {
const stream = await run({
files: [join(testFixtures, 'default-behavior/test/suite_and_test.cjs')],
});
t.plan(4);
stream.on('test:enqueue', common.mustCall((data) => {
if (data.name === 'this is a suite') {
t.assert.strictEqual(data.type, 'suite');
}
if (data.name === 'this is a test') {
t.assert.strictEqual(data.type, 'test');
}
}, 3));
stream.on('test:dequeue', common.mustCall((data) => {
if (data.name === 'this is a suite') {
t.assert.strictEqual(data.type, 'suite');
}
if (data.name === 'this is a test') {
t.assert.strictEqual(data.type, 'test');
}
}, 3));
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
describe('AbortSignal', () => {
it('should accept a signal', async () => {
const stream = run({ signal: AbortSignal.timeout(50), files: [
fixtures.path('test-runner', 'never_ending_sync.js'),
fixtures.path('test-runner', 'never_ending_async.js'),
] });
stream.on('test:fail', common.mustCall(2));
stream.on('test:pass', common.mustNotCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should stop watch mode when abortSignal aborts', async () => {
const controller = new AbortController();
const result = await run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')],
watch: true,
signal: controller.signal,
})
.compose(async function* (source) {
let waitForCancel = 2;
for await (const chunk of source) {
if (chunk.type === 'test:watch:drained' ||
(chunk.type === 'test:diagnostic' && chunk.data.message.startsWith('duration_ms'))) {
waitForCancel--;
}
if (waitForCancel === 0) {
controller.abort();
}
if (chunk.type === 'test:pass') {
yield chunk.data.name;
}
}
})
.toArray();
assert.deepStrictEqual(result, ['this should pass']);
});
it('should abort when test succeeded', async () => {
const stream = run({
files: [
fixtures.path(
'test-runner',
'aborts',
'successful-test-still-call-abort.js'
),
],
});
let passedTestCount = 0;
let failedTestCount = 0;
let output = '';
for await (const data of stream) {
if (data.type === 'test:stdout') {
output += data.data.message.toString();
}
if (data.type === 'test:fail') {
failedTestCount++;
}
if (data.type === 'test:pass') {
passedTestCount++;
}
}
assert.match(output, /abort called for test 1/);
assert.match(output, /abort called for test 2/);
assert.strictEqual(failedTestCount, 0, new Error('no tests should fail'));
assert.strictEqual(passedTestCount, 2);
});
it('should abort when test failed', async () => {
const stream = run({
files: [
fixtures.path(
'test-runner',
'aborts',
'failed-test-still-call-abort.js'
),
],
});
let passedTestCount = 0;
let failedTestCount = 0;
let output = '';
for await (const data of stream) {
if (data.type === 'test:stdout') {
output += data.data.message.toString();
}
if (data.type === 'test:fail') {
failedTestCount++;
}
if (data.type === 'test:pass') {
passedTestCount++;
}
}
assert.match(output, /abort called for test 1/);
assert.match(output, /abort called for test 2/);
assert.strictEqual(passedTestCount, 0, new Error('no tests should pass'));
assert.strictEqual(failedTestCount, 2);
});
});
const shardsTestsFixtures = fixtures.path('test-runner', 'shards');
const internalOrderTestFile = join(testFixtures, 'randomize', 'internal-order.cjs');
const shardFileNames = [
'a.cjs',
'b.cjs',
'c.cjs',
'd.cjs',
'e.cjs',
'f.cjs',
'g.cjs',
'h.cjs',
'i.cjs',
'j.cjs',
];
const internalTestNames = ['a', 'b', 'c', 'd', 'e'];
const shardsTestsFiles = shardFileNames.map((file) => join(shardsTestsFixtures, file));
async function getExecutedShardOrder(options = {}) {
const stream = run({
files: shardsTestsFiles,
concurrency: false,
...options,
});
const executedTestFiles = [];
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', (passedTest) => {
if (passedTest.nesting === 0) {
executedTestFiles.push(basename(passedTest.file));
}
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
return executedTestFiles;
}
async function getExecutedInternalOrder(options = {}) {
const stream = run({
files: [internalOrderTestFile],
concurrency: false,
...options,
});
const executionOrder = [];
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', (passedTest) => {
if (passedTest.file === internalOrderTestFile && passedTest.name.startsWith('internal ')) {
executionOrder.push(passedTest.name.slice('internal '.length));
}
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
return executionOrder;
}
describe('sharding', () => {
describe('validation', () => {
it('should require shard.total when having shard option', () => {
assert.throws(() => run({ files: shardsTestsFiles, shard: {} }), {
name: 'TypeError',
code: 'ERR_INVALID_ARG_TYPE',
message: 'The "options.shard.total" property must be of type number. Received undefined'
});
});
it('should require shard.index when having shards option', () => {
assert.throws(() => run({
files: shardsTestsFiles,
shard: {
total: 5
}
}), {
name: 'TypeError',
code: 'ERR_INVALID_ARG_TYPE',
message: 'The "options.shard.index" property must be of type number. Received undefined'
});
});
it('should require shard.total to be greater than 0 when having shard option', () => {
assert.throws(() => run({
files: shardsTestsFiles,
shard: {
total: 0,
index: 1
}
}), {
name: 'RangeError',
code: 'ERR_OUT_OF_RANGE',
message:
'The value of "options.shard.total" is out of range. It must be >= 1 && <= 9007199254740991. Received 0'
});
});
it('should require shard.index to be greater than 0 when having shard option', () => {
assert.throws(() => run({
files: shardsTestsFiles,
shard: {
total: 6,
index: 0
}
}), {
name: 'RangeError',
code: 'ERR_OUT_OF_RANGE',
message: 'The value of "options.shard.index" is out of range. It must be >= 1 && <= 6. Received 0'
});
});
it('should require shard.index to not be greater than the shards total when having shard option', () => {
assert.throws(() => run({
files: shardsTestsFiles,
shard: {
total: 6,
index: 7
}
}), {
name: 'RangeError',
code: 'ERR_OUT_OF_RANGE',
message: 'The value of "options.shard.index" is out of range. It must be >= 1 && <= 6. Received 7'
});
});
it('should require watch mode to be disabled when having shard option', () => {
assert.throws(() => run({
files: shardsTestsFiles,
watch: true,
shard: {
total: 6,
index: 1
}
}), {
name: 'TypeError',
code: 'ERR_INVALID_ARG_VALUE',
message: 'The property \'options.shard\' shards not supported with watch mode. Received true'
});
});
});
it('should run only the tests files matching the shard index', async () => {
const stream = run({
files: shardsTestsFiles,
shard: {
total: 5,
index: 1
}
});
const executedTestFiles = [];
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', (passedTest) => {
executedTestFiles.push(passedTest.file);
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
assert.deepStrictEqual(executedTestFiles, [
join(shardsTestsFixtures, 'a.cjs'),
join(shardsTestsFixtures, 'f.cjs'),
]);
});
it('different shards should not run the same file', async () => {
const executedTestFiles = [];
const testStreams = [];
const shards = 5;
for (let i = 1; i <= shards; i++) {
const stream = run({
files: shardsTestsFiles,
shard: {
total: shards,
index: i
}
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', (passedTest) => {
executedTestFiles.push(passedTest.file);
});
testStreams.push(stream);
}
await Promise.all(testStreams.map(async (stream) => {
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
}));
assert.deepStrictEqual(executedTestFiles, [...new Set(executedTestFiles)]);
});
it('combination of all shards should be all the tests', async () => {
const executedTestFiles = [];
const testStreams = [];
const shards = 5;
for (let i = 1; i <= shards; i++) {
const stream = run({
files: shardsTestsFiles,
shard: {
total: shards,
index: i
}
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', (passedTest) => {
executedTestFiles.push(passedTest.file);
});
testStreams.push(stream);
}
await Promise.all(testStreams.map(async (stream) => {
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
}));
assert.deepStrictEqual(executedTestFiles.sort(), [...shardsTestsFiles].sort());
});
});
describe('randomization', () => {
it('should randomize file order deterministically when using the same seed', async () => {
const firstOrder = await getExecutedShardOrder({ randomize: true, randomSeed: 12345 });
const secondOrder = await getExecutedShardOrder({ randomize: true, randomSeed: 12345 });
assert.deepStrictEqual(firstOrder, secondOrder);
assert.deepStrictEqual([...firstOrder].sort(), [...shardFileNames].sort());
});
it('should randomize file order differently with different seeds', async () => {
const firstOrder = await getExecutedShardOrder({ randomize: true, randomSeed: 11111 });
const secondOrder = await getExecutedShardOrder({ randomize: true, randomSeed: 22222 });
assert.notDeepStrictEqual(firstOrder, secondOrder);
assert.deepStrictEqual([...firstOrder].sort(), [...shardFileNames].sort());
assert.deepStrictEqual([...secondOrder].sort(), [...shardFileNames].sort());
});
it('should randomize file order when only randomSeed is provided', async () => {
const firstOrder = await getExecutedShardOrder({ randomSeed: 24680 });
const secondOrder = await getExecutedShardOrder({ randomSeed: 24680 });
assert.deepStrictEqual(firstOrder, secondOrder);
assert.deepStrictEqual([...firstOrder].sort(), [...shardFileNames].sort());
});
it('should randomize internal test order deterministically when using the same seed', async () => {
const firstOrder = await getExecutedInternalOrder({ randomSeed: 12345 });
const secondOrder = await getExecutedInternalOrder({ randomSeed: 12345 });
assert.deepStrictEqual(firstOrder, secondOrder);
assert.deepStrictEqual([...firstOrder].sort(), [...internalTestNames].sort());
});
it('should randomize internal test order differently across seeds', async () => {
const orders = [];
for (const seed of [11111, 22222, 33333, 44444]) {
const order = await getExecutedInternalOrder({ randomSeed: seed });
assert.deepStrictEqual([...order].sort(), [...internalTestNames].sort());
orders.push(order.join(','));
}
assert.notStrictEqual(new Set(orders).size, 1);
});
it('should emit the randomization seed as a diagnostic message', async () => {
const stream = run({
files: shardsTestsFiles,
concurrency: false,
randomize: true,
});
const diagnostics = [];
stream.on('test:diagnostic', ({ message }) => {
diagnostics.push(message);
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream) ;
assert(
diagnostics.some((message) => /Randomized test order seed: \d+/.test(message)),
`Missing randomization seed diagnostic. Received diagnostics: ${diagnostics.join(', ')}`,
);
});
});
describe('validation', () => {
it('should only allow array in options.files', async () => {
[Symbol(), {}, () => {}, 0, 1, 0n, 1n, '', '1', Promise.resolve([]), true, false]
.forEach((files) => assert.throws(() => run({ files }), {
code: 'ERR_INVALID_ARG_TYPE'
}));
});
it('should only allow array in options.globPatterns', async () => {
[Symbol(), {}, () => {}, 0, 1, 0n, 1n, '', '1', Promise.resolve([]), true, false]
.forEach((globPatterns) => assert.throws(() => run({ globPatterns }), {
code: 'ERR_INVALID_ARG_TYPE'
}));
});
it('should only allow object in options.env', () => {
[Symbol(), [], () => {}, 0, 1, 0n, 1n, '', '1', true, false]
.forEach((env) => assert.throws(() => run({ files: [], env }), {
code: 'ERR_INVALID_ARG_TYPE',
message: /The "options\.env" property must be of type object\./
}));
});
it('should not allow files and globPatterns used together', () => {
assert.throws(() => run({ files: ['a.js'], globPatterns: ['*.js'] }), {
code: 'ERR_INVALID_ARG_VALUE'
});
});
it('should not allow randomize with watch mode', () => {
assert.throws(() => run({ watch: true, randomize: true }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.randomize' is not supported with watch mode\./,
});
});
it('should not allow randomSeed with watch mode', () => {
assert.throws(() => run({ watch: true, randomSeed: 12345 }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.randomSeed' is not supported with watch mode\./,
});
});
it('should not allow randomize with rerunFailuresFilePath', () => {
assert.throws(() => run({ randomize: true, rerunFailuresFilePath: rerunStateFile }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.randomize' is not supported with rerun failures mode\./,
});
});
it('should not allow randomSeed with rerunFailuresFilePath', () => {
assert.throws(() => run({ randomSeed: 12345, rerunFailuresFilePath: rerunStateFile }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.randomSeed' is not supported with rerun failures mode\./,
});
});
it('should not allow decimal randomSeed values', () => {
assert.throws(() => run({ randomSeed: 1.5 }), {
code: 'ERR_OUT_OF_RANGE',
});
});
it('should only allow a string in options.cwd', async () => {
[Symbol(), {}, [], () => {}, 0, 1, 0n, 1n, true, false]
.forEach((cwd) => assert.throws(() => run({ cwd }), {
code: 'ERR_INVALID_ARG_TYPE'
}));
});
it('should only allow object as options', () => {
[Symbol(), [], () => {}, 0, 1, 0n, 1n, '', '1', true, false]
.forEach((options) => assert.throws(() => run(options), {
code: 'ERR_INVALID_ARG_TYPE'
}));
});
it('should pass instance of stream to setup', async () => {
const stream = run({
files: [join(testFixtures, 'default-behavior/test/random.cjs')],
setup: common.mustCall((root) => {
assert.strictEqual(root.constructor.name, 'TestsStream');
}),
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall());
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
});
it('should avoid running recursively', async () => {
const stream = run({ files: [join(testFixtures, 'recursive_run.js')] });
let stderr = '';
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall(1));
stream.on('test:stderr', (c) => { stderr += c.message; });
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
assert.match(stderr, /Warning: node:test run\(\) is being called recursively/);
});
it('should run with different cwd', async () => {
const stream = run({
cwd: fixtures.path('test-runner', 'cwd')
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall(1));
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
});
it('should handle a non-existent directory being provided as cwd', async () => {
const diagnostics = [];
const stream = run({
cwd: fixtures.path('test-runner', 'cwd', 'non-existing')
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustNotCall());
stream.on('test:stderr', common.mustNotCall());
stream.on('test:diagnostic', ({ message }) => {
diagnostics.push(message);
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
for (const entry of [
'tests 0',
'suites 0',
'pass 0',
'fail 0',
'cancelled 0',
'skipped 0',
'todo 0',
]
) {
assert.strictEqual(diagnostics.includes(entry), true);
}
});
it('should handle a non-existent file being provided as cwd', async () => {
const diagnostics = [];
const stream = run({
cwd: fixtures.path('test-runner', 'default-behavior', 'test', 'random.cjs')
});
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustNotCall());
stream.on('test:stderr', common.mustNotCall());
stream.on('test:diagnostic', ({ message }) => {
diagnostics.push(message);
});
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
for (const entry of [
'tests 0',
'suites 0',
'pass 0',
'fail 0',
'cancelled 0',
'skipped 0',
'todo 0',
]
) {
assert.strictEqual(diagnostics.includes(entry), true);
}
});
});
describe('env', () => {
it('should allow env variables to be configured', async () => {
// Need to inherit some process.env variables so it runs reliably across different environments.
const env = { ...process.env, FOOBAR: 'FUZZBUZZ' };
// Set a variable on main process env and test it does not exist within test env.
process.env.ABC = 'XYZ';
const stream = run({ files: [join(testFixtures, 'process-env.js')], env });
stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall(1));
// eslint-disable-next-line no-unused-vars
for await (const _ of stream);
delete process.env.ABC;
});
it('should throw error when env is specified with isolation=none', async () => {
assert.throws(() => run({ env: { foo: 'bar' }, isolation: 'none' }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.env' is not supported with isolation='none'\. Received { foo: 'bar' }/
});
});
});
describe('forceExit', () => {
it('throws for non-boolean values', () => {
[Symbol(), {}, 0, 1, '1', Promise.resolve([])].forEach((forceExit) => {
assert.throws(() => run({ forceExit }), {
code: 'ERR_INVALID_ARG_TYPE',
message: /The "options\.forceExit" property must be of type boolean\./
});
});
});
it('throws if enabled with watch mode', () => {
assert.throws(() => run({ forceExit: true, watch: true }), {
code: 'ERR_INVALID_ARG_VALUE',
message: /The property 'options\.forceExit' is not supported with watch mode\./
});
});
});
describe('with isolation="none"', () => {
const isolationNoneFixture = fixtures.path('test-runner', 'test-runner-isolation-none.mjs');
it('should pass only to children', async () => {
const child = await common.spawnPromisified(process.execPath, [
isolationNoneFixture,
'--file', join(testFixtures, 'test_only.js'),
'--only',
]);
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
assert.match(child.stdout, /ok 1 - this should be executed/);
assert.match(child.stdout, /# tests 1/);
});
it('should skip tests not matching testNamePatterns - RegExp', async () => {
const child = await common.spawnPromisified(process.execPath, [
isolationNoneFixture,
'--file', join(testFixtures, 'default-behavior/test/skip_by_name.cjs'),
'--name-pattern', 'executed',
]);
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
assert.match(child.stdout, /ok 1 - this should be executed/);
assert.match(child.stdout, /# tests 1/);
});
it('should skip tests matching testSkipPatterns - RegExp', async () => {
const child = await common.spawnPromisified(process.execPath, [
isolationNoneFixture,
'--file', join(testFixtures, 'default-behavior/test/skip_by_name.cjs'),
'--skip-pattern', 'skipped',
]);
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
assert.match(child.stdout, /ok 1 - this should be executed/);
assert.match(child.stdout, /# tests 1/);
});
});
// exitHandler doesn't run until after the tests / after hooks finish.
process.on('exit', () => {
assert.strictEqual(process.listeners('uncaughtException').length, 0);
assert.strictEqual(process.listeners('unhandledRejection').length, 0);
assert.strictEqual(process.listeners('beforeExit').length, 0);
assert.strictEqual(process.listeners('SIGINT').length, 0);
assert.strictEqual(process.listeners('SIGTERM').length, 0);
});