Skip to content

test(test-runner-core): migrate tests to node:test #3094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bashmish merged 4 commits into from
Jun 17, 2026
+218 −265
Merged

test(test-runner-core): migrate tests to node:test #3094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e55c915
test(test-runner-core): migrate tests from mocha/chai/hanbi to node:test
bennypowers Jun 2, 2026
c5b9909
fix(test-runner-core): increase timing margins for CI runners
bennypowers Jun 2, 2026
a0f3e7f
test: readd watch
bashmish Jun 16, 2026
d9768c9
test: simplify browser stubs code
bashmish Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/test-runner-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
},
"scripts": {
"build": "tsc",
"test:node": "mocha test/**/*.test.ts --require ts-node/register --reporter dot",
"test:watch": "mocha test/**/*.test.ts --require ts-node/register --watch --watch-files src,test"
"test:node": "node --experimental-strip-types --test --test-force-exit test/**/*.test.ts",
"test:watch": "node --experimental-strip-types --test --test-force-exit --watch test/**/*.test.ts"
},
"files": [
"*.d.ts",
Expand Down
158 changes: 69 additions & 89 deletions packages/test-runner-core/test/src/runner/TestRunner.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,27 @@
import * as hanbi from 'hanbi';
import { expect } from 'chai';
import portfinder from 'portfinder';
import path from 'path';

import { BrowserLauncher } from '../../../src/browser-launcher/BrowserLauncher.js';
import { TestRunnerCoreConfig } from '../../../src/config/TestRunnerCoreConfig.js';
import { TestRunner } from '../../../src/runner/TestRunner.js';
import { Logger } from '../../../src/logger/Logger.js';
import { SESSION_STATUS } from '../../../src/test-session/TestSessionStatus.js';
import { TestRunnerGroupConfig } from '../../../src/index.js';
import assert from 'node:assert/strict';
import path from 'node:path';
import { describe, it, mock } from 'node:test';

interface BrowserStubs {
stop: hanbi.Stub<Exclude<BrowserLauncher['stop'], undefined>>;
startDebugSession: hanbi.Stub<BrowserLauncher['startDebugSession']>;
startSession: hanbi.Stub<BrowserLauncher['startSession']>;
stopSession: hanbi.Stub<BrowserLauncher['stopSession']>;
isActive: hanbi.Stub<BrowserLauncher['isActive']>;
getBrowserUrl: hanbi.Stub<BrowserLauncher['getBrowserUrl']>;
}
import portfinder from 'portfinder';

function createBrowserStub(): [BrowserStubs, BrowserLauncher] {
const spies = {
stop: hanbi.spy(),
getBrowserUrl: hanbi.spy(),
startDebugSession: hanbi.spy(),
startSession: hanbi.spy(),
stopSession: hanbi.spy(),
isActive: hanbi.spy(),
import type { BrowserLauncher } from '../../../dist/browser-launcher/BrowserLauncher.js';
import type { TestRunnerCoreConfig } from '../../../dist/config/TestRunnerCoreConfig.js';
import { TestRunner } from '../../../dist/runner/TestRunner.js';
import type { Logger } from '../../../dist/logger/Logger.js';
import { SESSION_STATUS } from '../../../dist/test-session/TestSessionStatus.js';
import type { TestRunnerGroupConfig } from '../../../dist/index.js';

function createBrowserStub(): BrowserLauncher {
return {
name: 'myBrowser',
type: 'myBrowser',
stop: mock.fn(() => Promise.resolve()),
getBrowserUrl: mock.fn(() => ''),
startDebugSession: mock.fn(() => Promise.resolve()),
startSession: mock.fn(() => Promise.resolve()),
stopSession: mock.fn(() => Promise.resolve({})),
isActive: mock.fn(() => true),
};
spies.stop.returns(Promise.resolve());
spies.getBrowserUrl.returns('');
spies.startDebugSession.returns(Promise.resolve());
spies.startSession.returns(Promise.resolve());
spies.stopSession.returns(Promise.resolve({}));
spies.isActive.returns(true);
return [
spies,
{
name: 'myBrowser',
type: 'myBrowser',
stop: spies.stop.handler,
getBrowserUrl: spies.getBrowserUrl.handler,
startDebugSession: spies.startDebugSession.handler,
startSession: spies.startSession.handler,
stopSession: spies.stopSession.handler,
isActive: spies.isActive.handler,
},
];
}

const logger: Logger = {
Expand All @@ -67,15 +42,15 @@ async function createTestRunner(
port: 9000 + Math.floor(Math.random() * 1000),
});

const [browserStubs, browser] = createBrowserStub();
const browser = createBrowserStub();

console.log(path.resolve(__dirname, '..', '..', '..', '..', '..'));
console.log(path.resolve(import.meta.dirname, '..', '..', '..', '..', '..'));

const config: TestRunnerCoreConfig = {
files: [path.resolve(__dirname, '..', '..', 'fixtures', 'a.test.js')],
files: [path.resolve(import.meta.dirname, '..', '..', 'fixtures', 'a.test.js')],
reporters: [],
logger,
rootDir: path.resolve(__dirname, '..', '..', '..', '..', '..'),
rootDir: path.resolve(import.meta.dirname, '..', '..', '..', '..', '..'),
testFramework: { path: 'my-framework.js' },
concurrentBrowsers: 2,
concurrency: 10,
Expand All @@ -94,24 +69,24 @@ async function createTestRunner(
...extraConfig,
};
const runner = new TestRunner(config, groupConfigs);
return { runner, browser, browserStubs };
return { runner, browser };
}

describe('TestRunner', function () {
it('can run a single test file', async () => {
const { runner, browserStubs } = await createTestRunner();
const { runner, browser } = await createTestRunner();

await runner.start();
expect(runner.started).to.equal(true, 'runner is started');
expect(browserStubs.startSession.callCount).to.equal(1);
assert.equal(runner.started, true, 'runner is started');
assert.equal(browser.startSession.mock.callCount(), 1);

const sessions = Array.from(runner.sessions.all());
expect(sessions.length).to.equal(1, 'one session is created');
assert.equal(sessions.length, 1, 'one session is created');
await runner.stop();
});

it('closes test runner for a successful test', async () => {
const { runner, browserStubs } = await createTestRunner();
const { runner, browser } = await createTestRunner();
let resolveStopped: (passed: boolean) => void;
const stopped = new Promise<boolean>(resolve => {
resolveStopped = resolve;
Expand All @@ -130,13 +105,13 @@ describe('TestRunner', function () {

const passed = await stopped;

expect(browserStubs.stopSession.callCount).to.equal(1, 'browser session is stopped');
expect(browserStubs.stop.callCount).to.equal(1, 'browser is stopped');
expect(passed).to.equal(true, 'test runner quits with true');
assert.equal(browser.stopSession.mock.callCount(), 1, 'browser session is stopped');
assert.equal(browser.stop.mock.callCount(), 1, 'browser is stopped');
assert.equal(passed, true, 'test runner quits with true');
});

it('closes test runner for a failed test', async () => {
const { runner, browserStubs } = await createTestRunner();
const { runner, browser } = await createTestRunner();
let resolveStopped: (passed: boolean) => void;
const stopped = new Promise<boolean>(resolve => {
resolveStopped = resolve;
Expand All @@ -154,28 +129,28 @@ describe('TestRunner', function () {
runner.sessions.updateStatus({ ...sessions[0], passed: false }, SESSION_STATUS.TEST_FINISHED);
const passed = await stopped;

expect(browserStubs.stopSession.callCount).to.equal(1, 'browser session is stopped');
expect(browserStubs.stop.callCount).to.equal(1, 'browser is stopped');
expect(passed).to.equal(false, 'test runner quits with false');
assert.equal(browser.stopSession.mock.callCount(), 1, 'browser session is stopped');
assert.equal(browser.stop.mock.callCount(), 1, 'browser is stopped');
assert.equal(passed, false, 'test runner quits with false');
});

describe('groups', () => {
it('can create a group in addition to the default group', async () => {
const { runner } = await createTestRunner(undefined, [
{
name: 'a',
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-a', '*.test.js')],
files: [path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-a', '*.test.js')],
},
]);

const sessions = Array.from(runner.sessions.all());
expect(sessions.length).to.equal(3);
expect(sessions.filter(s => s.group.name === 'default').length).to.equal(1);
expect(sessions.filter(s => s.group.name === 'a').length).to.equal(2);
assert.equal(sessions.length, 3);
assert.equal(sessions.filter(s => s.group.name === 'default').length, 1);
assert.equal(sessions.filter(s => s.group.name === 'a').length, 2);
});

it('can create a group with a custom browser, inheriting test files', async () => {
const [, groupBrowser] = createBrowserStub();
const groupBrowser = createBrowserStub();
const { browser, runner } = await createTestRunner(undefined, [
{
name: 'a',
Expand All @@ -184,15 +159,15 @@ describe('TestRunner', function () {
]);

const sessions = Array.from(runner.sessions.all());
expect(sessions.length).to.equal(2);
expect(sessions.filter(s => s.group.name === 'default').length).to.equal(1);
expect(sessions.filter(s => s.group.name === 'a').length).to.equal(1);
assert.equal(sessions.length, 2);
assert.equal(sessions.filter(s => s.group.name === 'default').length, 1);
assert.equal(sessions.filter(s => s.group.name === 'a').length, 1);

const sessionDefault = sessions.find(s => s.group.name === 'default')!;
const sessionA = sessions.find(s => s.group.name === 'a')!;
expect(sessionDefault.testFile).to.equal(sessionA.testFile);
expect(sessionDefault.browser).to.equal(browser);
expect(sessionA.browser).to.equal(groupBrowser);
assert.equal(sessionDefault.testFile, sessionA.testFile);
assert.equal(sessionDefault.browser, browser);
assert.equal(sessionA.browser, groupBrowser);
});

it('can create test groups inheriting browser', async () => {
Expand All @@ -203,49 +178,53 @@ describe('TestRunner', function () {
[
{
name: 'a',
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-a', '*.test.js')],
files: [path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-a', '*.test.js')],
},
{
name: 'b',
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-b', '*.test.js')],
files: [path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-b', '*.test.js')],
},
{
name: 'c',
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-c', '*.test.js')],
files: [path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-c', '*.test.js')],
},
],
);

const sessions = Array.from(runner.sessions.all());
expect(sessions.length).to.equal(6);
expect(sessions.filter(s => s.group.name === 'a').length).to.equal(2);
expect(sessions.filter(s => s.group.name === 'b').length).to.equal(2);
expect(sessions.filter(s => s.group.name === 'c').length).to.equal(2);
assert.equal(sessions.length, 6);
assert.equal(sessions.filter(s => s.group.name === 'a').length, 2);
assert.equal(sessions.filter(s => s.group.name === 'b').length, 2);
assert.equal(sessions.filter(s => s.group.name === 'c').length, 2);
});

it('can create test groups with custom browsers', async () => {
const [, browserB] = createBrowserStub();
const browserB = createBrowserStub();
const { browser, runner } = await createTestRunner(
{
files: undefined,
},
[
{
name: 'a',
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-a', 'a-1.test.js')],
files: [
path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-a', 'a-1.test.js'),
],
},
{
name: 'b',
browsers: [browserB],
files: [path.join(__dirname, '..', '..', 'fixtures', 'group-b', 'b-1.test.js')],
files: [
path.join(import.meta.dirname, '..', '..', 'fixtures', 'group-b', 'b-1.test.js'),
],
},
],
);

const sessions = Array.from(runner.sessions.all());
expect(sessions.length).to.equal(2);
expect(sessions.find(s => s.group.name === 'a')!.browser).to.equal(browser);
expect(sessions.find(s => s.group.name === 'b')!.browser).to.equal(browserB);
assert.equal(sessions.length, 2);
assert.equal(sessions.find(s => s.group.name === 'a')!.browser, browser);
assert.equal(sessions.find(s => s.group.name === 'b')!.browser, browserB);
});

it('can ignore files via string[] globs', async () => {
Expand All @@ -255,8 +234,9 @@ describe('TestRunner', function () {
});

const sessions = Array.from(runner.sessions.all());
const allFiles = sessions.flatMap(x => path.relative(__dirname, x.testFile));
expect(allFiles).to.deep.equal(
const allFiles = sessions.flatMap(x => path.relative(import.meta.dirname, x.testFile));
assert.deepEqual(
allFiles,
[
'../../fixtures/a.test.js',
'../../fixtures/group-a/a-1.test.js',
Expand Down
Loading
Loading