Skip to content

Refactor reporter to ink #88

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
tolauwae merged 5 commits into from
Aug 11, 2026
Merged

Refactor reporter to ink #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d1a43f3
Refactor reporter to ink
tolauwae Aug 11, 2026
ab799c4
Linting
tolauwae Aug 11, 2026
7b06592
Remove `Style`
tolauwae Aug 11, 2026
4f791c0
Fix ink exit
tolauwae Aug 11, 2026
f6dccc4
Delete dead code
tolauwae Aug 11, 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
626 changes: 610 additions & 16 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
},
"dependencies": {
"@thi.ng/leb128": "^3.1.90",
"ansi-colors": "^4.1.3",
"ieee754": "^1.2.1",
"ink": "^3.2.0",
"json-with-bigint": "^3.5.8",
"ora": "^9.4.0",
"react": "^17.0.2",
"source-map": "^0.7.6",
"ts-node": "^10.9.2",
"tslib": "^2.8.1"
Expand All @@ -41,6 +41,7 @@
"@types/chai": "^5.2.3",
"@types/mocha": "^10.0.10",
"@types/node": "^25.9.1",
"@types/react": "^17.0.83",
"@types/uuid": "^11.0.0",
"@types/ws": "^8.18.1",
"@typescript-eslint/eslint-plugin": "^8.60.1",
Expand All @@ -49,18 +50,15 @@
"convert-extension": "^0.3.0",
"eslint": "^10.4.1",
"globals": "^17.6.0",
"ink-testing-library": "^2.1.0",
"mqtt": "^5.15.1",
"serialport": "^13.0.0",
"typescript": "^6.0.3",
"typescript-eslint": "^8.60.1"
},
"ava": {
"files": [
"out/tests/unit/describers.test.js",
"out/tests/unit/messaging.test.js",
"out/tests/unit/parsing.test.js",
"out/tests/unit/sourcemap.test.js",
"out/tests/unit/util.test.js"
"out/tests/unit/**/*.test.js"
],
"typescript": {
"compile": false,
Expand Down
185 changes: 119 additions & 66 deletions src/framework/Framework.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import {TestbedSpecification} from '../testbeds/TestbedSpecification';

import {SuiteResult} from '../reporter/Results';
import {Reporter} from '../reporter/Reporter';
import {Outcome} from "../reporter/describers/Describer";
import {Outcome} from "../reporter/Outcome";
import {InkReporter} from '../reporter/ink/InkReporter';

export interface TesteeOptions {
disabled?: boolean;
Expand Down Expand Up @@ -51,7 +52,7 @@ export class Framework {

private scheduled: Suite[] = [];

public readonly reporter: Reporter = new Reporter();
public readonly reporter: Reporter = new InkReporter();

private constructor() {
}
Expand All @@ -65,89 +66,103 @@ export class Framework {
}

public async sequential(suites: Suite[]) {
this.scheduled.concat(suites);
this.reporter.general();
this.scheduled = this.scheduled.concat(suites);
this.reporter.start();
const t0 = performance.now();
for (const suite of suites) {
for (const testee of suite.testees) {
const order: TestScenario[] = suite.scheduler.sequential(suite);
const result: SuiteResult = new SuiteResult(suite);

const first: TestScenario = order[0];
await timeout<Object | void>('Initialize testbed', testee.connector.timeout, testee.initialize(first.program, first.args ?? []).catch((e: Error) => result.error(e.message)));

await this.runSuite(result, testee, order);
this.reporter.report(result);
try {
let executionIndex = 0;
for (const suite of suites) {
for (const testee of suite.testees) {
const order: TestScenario[] = suite.scheduler.sequential(suite);
await this.executeSuite(suite, testee, order, ++executionIndex);
}
}
}
const t1 = performance.now();
this.reporter.results(t1 - t0);

await Promise.all(suites.map(suite => suite.testees.map(async (testee: Testee) => {
await timeout<Object | void>('Shutdown testbed', testee.timeout, testee.shutdown());
})))
await this.shutdown(suites);
} finally {
const t1 = performance.now();
this.reporter.finish(t1 - t0);
await this.reporter.close();
}
}

public async run(suites: Suite[]): Promise<boolean> {
let success: boolean = true;

this.scheduled.concat(suites);
this.reporter.general();
this.scheduled = this.scheduled.concat(suites);
this.reporter.start();
const t0 = performance.now();
await Promise.all(suites.map(async (suite: Suite) => {
await Promise.all(suite.testees.map(async (testee: Testee) => {
const order: TestScenario[] = suite.scheduler.sequential(suite);
const result: SuiteResult = new SuiteResult(suite);

const first: TestScenario = order[0];
await timeout<Object | void>('Initialize testbed', testee.connector.timeout, testee.initialize(first.program, first.args ?? []).catch((e: Error) => result.error(e.message)));

await this.runSuite(result, testee, order);
this.reporter.report(result);
success = success && result.outcome === Outcome.succeeded;
try {
let executionIndex = 0;
await Promise.all(suites.map(async (suite: Suite) => {
await Promise.all(suite.testees.map(async (testee: Testee) => {
const order: TestScenario[] = suite.scheduler.sequential(suite);
const result = await this.executeSuite(suite, testee, order, ++executionIndex);
success = success && result.outcome === Outcome.succeeded;
}))
}))
}))
const t1 = performance.now();
this.reporter.results(t1 - t0);

await Promise.all(suites.map(suite => suite.testees.map(async (testee: Testee) => {
await timeout<Object | void>('Shutdown testbed', testee.timeout, testee.shutdown());
})))
await this.shutdown(suites);

return success;
return success;
} finally {
const t1 = performance.now();
this.reporter.finish(t1 - t0);
await this.reporter.close();
}
}

public async parallel(suites: Suite[]) {
this.scheduled.concat(suites);
this.reporter.general();
this.scheduled = this.scheduled.concat(suites);
this.reporter.start();
const t0 = performance.now();
await Promise.all(suites.map(async (suite: Suite) => {
const order: TestScenario[][] = suite.scheduler.parallel(suite, suite.testees.length);
await Promise.all(suite.testees.map(async (testee: Testee, i: number) => {
// console.log(`scheduling on ${testee.name}`)
const result: SuiteResult = new SuiteResult(suite);

const first: TestScenario = order[i][0];
await timeout<Object | void>('Initialize testbed', testee.connector.timeout, testee.initialize(first.program, first.args ?? []).catch((e: Error) => result.error(e.message)));

for (let j = i; j < order.length; j += suite.testees.length) {
await this.runSuite(result, testee, order[j]);
}
this.reporter.report(result);
try {
let executionIndex = 0;
await Promise.all(suites.map(async (suite: Suite) => {
const order: TestScenario[][] = suite.scheduler.parallel(suite, suite.testees.length);
await Promise.all(suite.testees.map(async (testee: Testee, i: number) => {
const result: SuiteResult = new SuiteResult(suite);
const runId = this.runId(suite, testee, ++executionIndex);

this.reporter.suiteStarted({
id: runId,
suite: result,
suiteTitle: suite.title,
testeeName: testee.name,
executionIndex,
startedAt: Date.now(),
plannedScenarios: order.flat().length,
plannedActions: order.flat().flatMap((scenario) => scenario.steps ?? []).length
});

try {
const first: TestScenario = order[i][0];
await timeout<Object | void>('Initialize testbed', testee.connector.timeout, testee.initialize(first.program, first.args ?? []).catch((e: Error) => result.error(e.message)));

for (let j = i; j < order.length; j += suite.testees.length) {
await this.runSuite(result, testee, order[j], runId);
}
} catch (e) {
result.error(e instanceof Error ? e.message : `${e}`);
} finally {
this.reporter.suiteFinished(runId, result);
}
}))

await Promise.all(suite.testees.map(async (testee: Testee) => {
await timeout<Object | void>('Shutdown testbed', testee.timeout, testee.shutdown());
}))
}))

await Promise.all(suite.testees.map(async (testee: Testee) => {
await timeout<Object | void>('Shutdown testbed', testee.timeout, testee.shutdown());
}))
}))

const t1 = performance.now();
this.reporter.results(t1 - t0);
} finally {
const t1 = performance.now();
this.reporter.finish(t1 - t0);
await this.reporter.close();
}
}

private async runSuite(result: SuiteResult, testee: Testee, order: TestScenario[]) {
private async runSuite(result: SuiteResult, testee: Testee, order: TestScenario[], runId: string) {
for (const test of order) {
await testee.describe(test, result, this.runs);
await testee.describe(test, result, runId, this.runs);
}
}

Expand All @@ -156,11 +171,49 @@ export class Framework {
this.run(suite).then((success: boolean) => process.exit(success ? 0 : 1));
}

private async executeSuite(suite: Suite, testee: Testee, order: TestScenario[], executionIndex: number): Promise<SuiteResult> {
const result: SuiteResult = new SuiteResult(suite);
const runId = this.runId(suite, testee, executionIndex);

this.reporter.suiteStarted({
id: runId,
suite: result,
suiteTitle: suite.title,
testeeName: testee.name,
executionIndex,
startedAt: Date.now(),
plannedScenarios: order.length,
plannedActions: order.flatMap((scenario) => scenario.steps ?? []).length
});

try {
const first: TestScenario = order[0];
await timeout<Object | void>('Initialize testbed', testee.connector.timeout, testee.initialize(first.program, first.args ?? []).catch((e: Error) => result.error(e.message)));
await this.runSuite(result, testee, order, runId);
} catch (e) {
result.error(e instanceof Error ? e.message : `${e}`);
} finally {
this.reporter.suiteFinished(runId, result);
}

return result;
}

private async shutdown(suites: Suite[]) {
await Promise.all(suites.flatMap(suite => suite.testees.map(async (testee: Testee) => {
await timeout<Object | void>('Shutdown testbed', testee.timeout, testee.shutdown());
})));
}

private runId(suite: Suite, testee: Testee, executionIndex: number): string {
return `${suite.title}:${testee.name}:${executionIndex}`;
}

public static getImplementation() {
if (!Framework.implementation) {
Framework.implementation = new Framework();
}

return Framework.implementation;
}
}
}
Loading
Loading