@travetto/test 7.1.4 → 8.0.0-alpha.0

package/src/model/suite.ts

@@ -1,8 +1,12 @@
-import type { Class } from '@travetto/runtime';
+import type { Any, Class } from '@travetto/runtime';
 
-import type { Assertion, TestConfig, TestResult, TestStatus } from './test.ts';
+import type { TestConfig, TestResult, TestStatus } from './test.ts';
 import type { Skip, SuiteCore } from './common.ts';
 
+export type SuitePhase = 'beforeAll' | 'beforeEach' | 'afterAll' | 'afterEach';
+
+export type SuitePhaseHandler<T extends object> = Partial<Record<SuitePhase, (instance: T) => Promise<unknown> | unknown>>;
+
 /**
  * Suite configuration
  */
@@ -24,21 +28,9 @@ export interface SuiteConfig extends SuiteCore {
    */
   tests: Record<string, TestConfig>;
   /**
-   * Before all handlers
-   */
-  beforeAll: Function[];
-  /**
-   * Before each handlers
+   * Phase handlers
    */
-  beforeEach: Function[];
-  /**
-   * After each handlers
-   */
-  afterEach: Function[];
-  /**
-   * After all handlers
-   */
-  afterAll: Function[];
+  phaseHandlers: SuitePhaseHandler<Any>[];
 }
 
 /**
@@ -48,6 +40,7 @@ export interface Counts {
   passed: number;
   skipped: number;
   failed: number;
+  errored: number;
   unknown: number;
   total: number;
 }
@@ -68,14 +61,4 @@ export interface SuiteResult extends Counts, SuiteCore {
    * Overall status
    */
   status: TestStatus;
-}
-
-/**
- * A total suite failure
- */
-export interface SuiteFailure {
-  assert: Assertion;
-  testResult: TestResult;
-  test: TestConfig;
-  suite: SuiteConfig;
-}
+}

package/src/model/test.ts

@@ -10,7 +10,7 @@ export type TestDiffSource = Record<string, {
   methods: Record<string, number>;
 }>;
 
-export type TestStatus = 'passed' | 'skipped' | 'failed' | 'unknown';
+export type TestStatus = 'passed' | 'skipped' | 'errored' | 'failed' | 'unknown';
 
 /**
  * Specific configuration for a test
@@ -116,6 +116,10 @@ export interface TestResult extends TestCore {
    * Logging output
    */
   output: TestLog[];
+  /**
+   * Know where the suite started for this test
+   */
+  suiteLineStart: number;
 }
 
 /**

package/src/model/util.ts

@@ -3,6 +3,12 @@ import type { TestStatus } from './test.ts';
 
 export class TestModelUtil {
   static countsToTestStatus(counts: Counts): TestStatus {
-    return counts.failed ? 'failed' : (counts.passed ? 'passed' : counts.skipped ? 'skipped' : 'unknown');
+    switch (true) {
+      case counts.errored > 0: return 'errored';
+      case counts.failed > 0: return 'failed';
+      case counts.skipped > 0: return 'skipped';
+      case counts.unknown > 0: return 'unknown';
+      default: return 'passed';
+    }
   }
 }

package/src/registry/registry-adapter.ts

@@ -1,5 +1,5 @@
 import type { RegistryAdapter } from '@travetto/registry';
-import { AppError, asFull, type Class, describeFunction, Runtime, safeAssign } from '@travetto/runtime';
+import { RuntimeError, asFull, type Class, describeFunction, Runtime, safeAssign } from '@travetto/runtime';
 import { SchemaRegistryIndex } from '@travetto/schema';
 
 import type { SuiteConfig } from '../model/suite.ts';
@@ -7,28 +7,19 @@ import type { TestConfig } from '../model/test.ts';
 
 function combineClasses(baseConfig: SuiteConfig, ...subConfig: Partial<SuiteConfig>[]): SuiteConfig {
   for (const config of subConfig) {
-    if (config.beforeAll) {
-      baseConfig.beforeAll = [...baseConfig.beforeAll, ...config.beforeAll];
-    }
-    if (config.beforeEach) {
-      baseConfig.beforeEach = [...baseConfig.beforeEach, ...config.beforeEach];
-    }
-    if (config.afterAll) {
-      baseConfig.afterAll = [...baseConfig.afterAll, ...config.afterAll];
-    }
-    if (config.afterEach) {
-      baseConfig.afterEach = [...baseConfig.afterEach, ...config.afterEach];
-    }
     if (config.tags) {
       baseConfig.tags = [...baseConfig.tags ?? [], ...config.tags];
     }
     baseConfig.skip = config.skip ?? baseConfig.skip;
 
+    if (config.phaseHandlers) {
+      baseConfig.phaseHandlers = [...(baseConfig.phaseHandlers ?? []), ...config.phaseHandlers];
+    }
+
     if (config.tests) {
       for (const [key, test] of Object.entries(config.tests ?? {})) {
         baseConfig.tests[key] = {
           ...test,
-          sourceImport: Runtime.getImport(baseConfig.class),
           class: baseConfig.class,
           classId: baseConfig.classId,
           import: baseConfig.import,
@@ -74,10 +65,7 @@ export class SuiteRegistryAdapter implements RegistryAdapter<SuiteConfig> {
         lineEnd: lines?.[1],
         sourceHash: hash,
         tests: {},
-        beforeAll: [],
-        beforeEach: [],
-        afterAll: [],
-        afterEach: []
+        phaseHandlers: [],
       });
     }
     combineClasses(this.#config, ...data);
@@ -93,6 +81,7 @@ export class SuiteRegistryAdapter implements RegistryAdapter<SuiteConfig> {
         class: this.#cls,
         tags: [],
         skip: false,
+        declarationImport: Runtime.getImport(this.#cls),
         import: Runtime.getImport(this.#cls),
         lineStart: lines?.[0],
         lineEnd: lines?.[1],
@@ -126,7 +115,7 @@ export class SuiteRegistryAdapter implements RegistryAdapter<SuiteConfig> {
   getMethod(method: string): TestConfig {
     const test = this.#config.tests[method];
     if (!test) {
-      throw new AppError(`Test not registered: ${String(method)} on ${this.#cls.name}`);
+      throw new RuntimeError(`Test not registered: ${String(method)} on ${this.#cls.name}`);
     }
     return test;
   }

package/src/registry/registry-index.ts

@@ -1,4 +1,4 @@
-import { AppError, type Class, Runtime, describeFunction } from '@travetto/runtime';
+import { RuntimeError, type Class, Runtime, describeFunction } from '@travetto/runtime';
 import { type RegistryIndex, RegistryIndexStore, Registry } from '@travetto/registry';
 
 import type { SuiteConfig } from '../model/suite.ts';
@@ -83,7 +83,7 @@ export class SuiteRegistryIndex implements RegistryIndex {
       if (methodNames.length) {
         const cls = this.getValidClasses().find(type => type.Ⲑid === clsId);
         if (!cls) {
-          throw new AppError('Unable to find suite for class ID', { details: { classId: clsId } });
+          throw new RuntimeError('Unable to find suite for class ID', { details: { classId: clsId } });
         }
         const suite = this.getConfig(cls);
         const tests = sortedTests(suite).filter(config => methodNames.includes(config.methodName));
@@ -91,7 +91,7 @@ export class SuiteRegistryIndex implements RegistryIndex {
       } else if (clsId) {
         const cls = this.getValidClasses().find(type => type.Ⲑid === clsId)!;
         if (!cls) {
-          throw new AppError('Unable to find suite for class ID', { details: { classId: clsId } });
+          throw new RuntimeError('Unable to find suite for class ID', { details: { classId: clsId } });
         }
         const suite = this.getConfig(cls);
         return suite ? [{ suite, tests: sortedTests(suite) }] : [];

package/src/worker/child.ts

@@ -1,12 +1,11 @@
 import { createWriteStream } from 'node:fs';
 
-import { ConsoleManager, Env, Runtime } from '@travetto/runtime';
+import { JSONUtil, ConsoleManager, Env, Runtime } from '@travetto/runtime';
 import { IpcChannel } from '@travetto/worker';
 
 import { RunUtil } from '../execute/run.ts';
 import { TestWorkerEvents } from './types.ts';
 import type { TestRun } from '../model/test.ts';
-import { CommunicationUtil } from '../communication.ts';
 
 /**
  * Child Worker for the Test Runner.  Receives events as commands
@@ -25,7 +24,7 @@ export class TestChildWorker extends IpcChannel<TestRun> {
         throw error;
       }
       // Mark as errored out
-      this.send(type, CommunicationUtil.serializeToObject({ error }));
+      this.send(type, JSONUtil.cloneForTransmit(error));
     }
   }
 

package/src/worker/standard.ts

@@ -1,13 +1,12 @@
 import { fork } from 'node:child_process';
 
-import { Env, RuntimeIndex } from '@travetto/runtime';
+import { JSONUtil, Env, RuntimeIndex } from '@travetto/runtime';
 import { IpcChannel } from '@travetto/worker';
 
 import { TestWorkerEvents, type TestLogEvent } from './types.ts';
 import type { TestConsumerShape } from '../consumer/types.ts';
 import type { TestEvent, TestRemoveEvent } from '../model/event.ts';
 import type { TestDiffInput, TestRun } from '../model/test.ts';
-import { CommunicationUtil } from '../communication.ts';
 
 const log = (message: string | TestLogEvent): void => {
   const event: TestLogEvent = typeof message === 'string' ? { type: 'log', message } : message;
@@ -18,7 +17,7 @@ const log = (message: string | TestLogEvent): void => {
  *  Produce a handler for the child worker
  */
 export async function buildStandardTestManager(consumer: TestConsumerShape, run: TestRun | TestDiffInput): Promise<void> {
-  log(`Worker Input ${JSON.stringify(run)}`);
+  log(`Worker Input ${JSONUtil.toUTF8(run)}`);
 
   const channel = new IpcChannel<TestEvent & { error?: Error }>(
     fork(
@@ -34,19 +33,19 @@ export async function buildStandardTestManager(consumer: TestConsumerShape, run:
   );
 
   await channel.once(TestWorkerEvents.READY); // Wait for the child to be ready
-  await channel.send(TestWorkerEvents.INIT); // Initialize
+  channel.send(TestWorkerEvents.INIT); // Initialize
   await channel.once(TestWorkerEvents.INIT_COMPLETE); // Wait for complete
 
   channel.on('*', async event => {
     try {
-      const parsed: TestEvent | TestRemoveEvent | TestLogEvent = CommunicationUtil.deserializeFromObject(event);
+      const parsed: TestEvent | TestRemoveEvent | TestLogEvent = JSONUtil.cloneFromTransmit(event);
       if (parsed.type === 'log') {
         log(parsed);
       } else if (parsed.type === 'removeTest') {
-        log(`Received remove event ${JSON.stringify(event)}@${consumer.constructor.name}`);
-        await consumer.onRemoveEvent?.(parsed); // Forward remove events
+        log(`Received remove event ${JSONUtil.toUTF8(event)}@${consumer.constructor.name}`);
+        consumer.onRemoveEvent?.(parsed); // Forward remove events
       } else {
-        await consumer.onEvent(parsed);  // Forward standard events
+        consumer.onEvent(parsed);  // Forward standard events
       }
     } catch {
       // Do nothing
@@ -60,7 +59,7 @@ export async function buildStandardTestManager(consumer: TestConsumerShape, run:
 
   // Wait for complete
   const completedEvent = await complete;
-  const result: { error?: unknown } = await CommunicationUtil.deserializeFromObject(completedEvent);
+  const result: { error?: unknown } = JSONUtil.cloneFromTransmit(completedEvent);
 
   // Kill on complete
   await channel.destroy();

package/support/cli.test_diff.ts

@@ -1,3 +1,5 @@
+import fs from 'node:fs/promises';
+
 import { Env, JSONUtil, RuntimeIndex } from '@travetto/runtime';
 import { CliCommand, CliUtil } from '@travetto/cli';
 import { IsPrivate } from '@travetto/schema';
@@ -29,7 +31,7 @@ export class TestDiffCommand {
   }
 
   async main(importOrFile: string, diff: string): Promise<void> {
-    const diffSource: TestDiffSource = await JSONUtil.readFile(diff);
+    const diffSource = await fs.readFile(diff).then(JSONUtil.fromBinaryArray<TestDiffSource>);
     const importPath = RuntimeIndex.getFromImportOrSource(importOrFile)?.import!;
 
     return runTests(

package/support/cli.test_digest.ts

@@ -1,5 +1,5 @@
 import { CliCommand } from '@travetto/cli';
-import { Env, Runtime, describeFunction } from '@travetto/runtime';
+import { JSONUtil, Env, Runtime, describeFunction } from '@travetto/runtime';
 import { Registry } from '@travetto/registry';
 import { IsPrivate } from '@travetto/schema';
 
@@ -19,7 +19,7 @@ export class TestDigestCommand {
 
   async main(globs: string[] = ['**/*']) {
     // Load all tests
-    for await (const imp of await RunUtil.getTestImports(globs)) {
+    for await (const imp of RunUtil.getTestImports(globs)) {
       try {
         await Runtime.importFrom(imp);
       } catch (error) {
@@ -40,7 +40,7 @@ export class TestDigestCommand {
       });
 
     if (this.output === 'json') {
-      console.log(JSON.stringify(all));
+      console.log(JSONUtil.toUTF8(all));
     } else {
       for (const item of all) {
         console.log(`${item.classId}#${item.methodName}`, item.tags?.join('|') ?? '');

package/src/communication.ts

@@ -1,66 +0,0 @@
-import { AppError, hasToJSON, JSONUtil } from '@travetto/runtime';
-
-/**
- * Tools for communication serialization/deserialization especially with errors
- */
-export class CommunicationUtil {
-
-  /**
-   * Serialize to JSON
-   */
-  static serialize<T>(out: T): string {
-    return JSON.stringify(out, function (key, value) {
-      const objectValue = this[key];
-      if (objectValue && objectValue instanceof Error) {
-        return {
-          $: true,
-          ...hasToJSON(objectValue) ? objectValue.toJSON() : objectValue,
-          name: objectValue.name,
-          message: objectValue.message,
-          stack: objectValue.stack,
-        };
-      } else if (typeof value === 'bigint') {
-        return `${value.toString()}$n`;
-      } else {
-        return value;
-      }
-    });
-  }
-
-  /**
-   * Serialize to a standard object, instead of a string
-   */
-  static serializeToObject<R = Record<string, unknown>, T = unknown>(out: T): R {
-    return JSONUtil.parseSafe(this.serialize(out));
-  }
-
-  /**
-   * Deserialize from JSON
-   */
-  static deserialize<T = unknown>(input: string): T {
-    return JSONUtil.parseSafe(input, function (key, value) {
-      if (value && typeof value === 'object' && '$' in value) {
-        const error = AppError.fromJSON(value) ?? new Error();
-        if (!(error instanceof AppError)) {
-          const { $: _, ...rest } = value;
-          Object.assign(error, rest);
-        }
-        error.message = value.message;
-        error.stack = value.stack;
-        error.name = value.name;
-        return error;
-      } else if (typeof value === 'string' && /^\d+[$]n$/.test(value)) {
-        return BigInt(value.split('$')[0]);
-      } else {
-        return value;
-      }
-    });
-  }
-
-  /**
-   * Deserialize from a standard object, instead of a string
-   */
-  static deserializeFromObject<R = unknown, T = R>(input: T): R {
-    return this.deserialize<R>(JSON.stringify(input));
-  }
-}

package/src/execute/error.ts

@@ -1,11 +0,0 @@
-import { AppError } from '@travetto/runtime';
-
-/**
- * Represents an execution error
- */
-export class ExecutionError extends AppError { }
-
-/**
- * Timeout execution error
- */
-export class TimeoutError extends ExecutionError { }