@travetto/test 4.0.0-rc.0 → 4.0.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/test",
-  "version": "4.0.0-rc.0",
+  "version": "4.0.0-rc.1",
   "description": "Declarative test framework",
   "keywords": [
     "unit-testing",
@@ -27,15 +27,15 @@
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/base": "^4.0.0-rc.0",
-    "@travetto/registry": "^4.0.0-rc.0",
-    "@travetto/terminal": "^4.0.0-rc.0",
-    "@travetto/worker": "^4.0.0-rc.0",
-    "@travetto/yaml": "^4.0.0-rc.0"
+    "@travetto/base": "^4.0.0-rc.1",
+    "@travetto/registry": "^4.0.0-rc.1",
+    "@travetto/terminal": "^4.0.0-rc.1",
+    "@travetto/worker": "^4.0.0-rc.1",
+    "@travetto/yaml": "^4.0.0-rc.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^4.0.0-rc.0",
-    "@travetto/transformer": "^4.0.0-rc.0"
+    "@travetto/cli": "^4.0.0-rc.1",
+    "@travetto/transformer": "^4.0.0-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/assert/check.ts

@@ -115,7 +115,7 @@ export class AssertCheck {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         case 'greaterThanEqual': assertFn((actual as number) >= (expected as number), message); break;
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        case 'ok': assertFn.apply(null, args as [unknown, string]); break; // eslint-disable-line prefer-spread
+        case 'ok': assertFn(...args as [unknown, string]); break; // eslint-disable-line prefer-spread
         default:
           // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           if (fn && assert[fn as keyof typeof assert]) { // Assert call
@@ -161,11 +161,19 @@ export class AssertCheck {
 
       // If a string, check if error exists, and then see if the string is included in the message
       if (typeof shouldThrow === 'string' && (!err || !(err instanceof Error ? err.message : err).includes(shouldThrow))) {
-        return new assert.AssertionError({ message: `Expected error containing text '${shouldThrow}', but got ${actual}` });
+        return new assert.AssertionError({
+          message: `Expected error containing text '${shouldThrow}', but got ${actual}`,
+          actual,
+          expected: shouldThrow
+        });
       }
       // If a regexp, check if error exists, and then test the error message against the regex
       if (shouldThrow instanceof RegExp && (!err || !shouldThrow.test(typeof err === 'string' ? err : err.message))) {
-        return new assert.AssertionError({ message: `Expected error with message matching '${shouldThrow.source}', but got ${actual} ` });
+        return new assert.AssertionError({
+          message: `Expected error with message matching '${shouldThrow.source}', but got ${actual}`,
+          actual,
+          expected: shouldThrow.source
+        });
       }
       // If passing in a constructor
     } else if (shouldThrow === Error ||
@@ -173,7 +181,11 @@ export class AssertCheck {
       Object.getPrototypeOf(shouldThrow) !== Object.getPrototypeOf(Function)
     ) { // if not simple function, treat as class
       if (!err || !(err instanceof shouldThrow)) {
-        return new assert.AssertionError({ message: `Expected to throw ${shouldThrow.name}, but got ${err ?? 'nothing'} ` });
+        return new assert.AssertionError({
+          message: `Expected to throw ${shouldThrow.name}, but got ${err ?? 'nothing'}`,
+          actual: (err ?? 'nothing'),
+          expected: shouldThrow.name
+        });
       }
     } else {
       // Else treat as a simple function to build an error or not

package/src/consumer/error.ts

@@ -28,8 +28,8 @@ export class ErrorUtil {
       if (ObjectUtil.hasToJSON(e)) {
         Object.assign(error, e.toJSON());
       }
-      error.message ??= e.message;
-      error.stack ??= e.stack;
+      error.message ||= e.message;
+      error.stack ??= e.stack?.replace(/.*\[ERR_ASSERTION\]:\s*/, '');
     }
 
     return error;

package/src/execute/executor.ts

@@ -140,13 +140,15 @@ export class TestExecutor {
     // Run method and get result
     let error = await this.#executeTestMethod(test);
 
-    if (error) {
+    if (!error) {
+      error = AssertCheck.checkError(test.shouldThrow, error); // Rewrite error
+    } else {
       if (error instanceof AssertionError) {
-        // Pass
+        // Pass, do nothing
       } else if (error instanceof ExecutionError) { // Errors that are not expected
         AssertCheck.checkUnhandled(test, error);
-      } else if (test.shouldThrow) { // Errors that are
-        error = AssertCheck.checkError(test.shouldThrow!, error); // Rewrite error
+      } else if (test.shouldThrow) {
+        error = AssertCheck.checkError(test.shouldThrow, error); // Rewrite error
       } else if (error instanceof Error) {
         AssertCheck.checkUnhandled(test, error);
       }

package/src/execute/util.ts

@@ -1,3 +1,4 @@
+import { spawn } from 'node:child_process';
 import { createReadStream } from 'node:fs';
 import readline from 'node:readline';
 import timers from 'node:timers/promises';
@@ -43,7 +44,7 @@ export class RunnerUtil {
       folder: f => f === 'test',
       file: f => f.role === 'test'
     })
-      .filter(f => globs?.some(g => g.test(f.import)) ?? true);
+      .filter(f => globs?.some(g => g.test(f.sourceFile)) ?? true);
 
     const validFiles = files
       .map(f => this.isTestFile(f.sourceFile).then(valid => ({ file: f, valid })));
@@ -59,14 +60,12 @@ export class RunnerUtil {
    * @returns
    */
   static async getTestCount(patterns: string[]): Promise<number> {
-    const proc = ExecUtil.spawn('npx', ['trv', 'test:count', ...patterns],
-      {
-        stdio: 'pipe',
-        catchAsResult: true,
-        env: { ...Env.FORCE_COLOR.export(0), ...Env.NO_COLOR.export(true) }
-      }
+    const countRes = await ExecUtil.getResult(
+      spawn('npx', ['trv', 'test:count', ...patterns], {
+        env: { ...process.env, ...Env.FORCE_COLOR.export(0), ...Env.NO_COLOR.export(true) }
+      }),
+      { catch: true }
     );
-    const countRes = await proc.result;
     if (!countRes.valid) {
       throw new Error(countRes.stderr);
     }

package/src/execute/watcher.ts

@@ -9,11 +9,18 @@ import { TestConsumerRegistry } from '../consumer/registry';
 import { CumulativeSummaryConsumer } from '../consumer/types/cumulative';
 import { RunEvent } from '../worker/types';
 import { RunnerUtil } from './util';
+import { TestEvent } from '../model/event';
 
 function isRunEvent(ev: unknown): ev is RunEvent {
   return ObjectUtil.isPlainObject(ev) && 'type' in ev && typeof ev.type === 'string' && ev.type === 'run-test';
 }
 
+export type TestWatchEvent =
+  TestEvent |
+  { type: 'removeTest', method: string, file: string, classId: string } |
+  { type: 'ready' } |
+  { type: 'log', message: string };
+
 /**
  * Test Watcher.
  *
@@ -71,7 +78,7 @@ export class TestWatcher {
       }
     });
 
-    process.send?.('ready');
+    process.send?.({ type: 'ready' });
 
     if (runAllOnStart) {
       for (const test of await RunnerUtil.getTestFiles()) {

package/src/worker/child.ts

@@ -1,7 +1,7 @@
 import { createWriteStream } from 'node:fs';
 import timers from 'node:timers/promises';
 
-import { ManifestFileUtil, RuntimeIndex } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 import { ConsoleManager, Env, TimeUtil } from '@travetto/base';
 import { ChildCommChannel } from '@travetto/worker';
 
@@ -34,7 +34,8 @@ export class TestChildWorker extends ChildCommChannel<RunEvent> {
    */
   async activate(): Promise<void> {
     if (/\b@travetto[/]test\b/.test(Env.DEBUG.val ?? '')) {
-      const stdout = createWriteStream(ManifestFileUtil.toolPath(RuntimeIndex, `test-worker.${process.pid}.log`), { flags: 'a' });
+      const file = RuntimeContext.toolPath(`test-worker.${process.pid}.log`);
+      const stdout = createWriteStream(file, { flags: 'a' });
       const c = new console.Console({ stdout, inspectOptions: { depth: 4, colors: false } });
       ConsoleManager.set({ onLog: (ev) => c[ev.level](process.pid, ...ev.args) });
     } else {

package/src/worker/standard.ts

@@ -1,5 +1,7 @@
+import { fork } from 'node:child_process';
+
 import { RuntimeIndex } from '@travetto/manifest';
-import { Env, ExecUtil } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { ParentCommChannel, Worker } from '@travetto/worker';
 
 import { Events, RunEvent } from './types';
@@ -39,12 +41,12 @@ export function buildStandardTestManager(consumer: TestConsumer): Worker<string>
       const cwd = RuntimeIndex.getModule(module)!.sourcePath;
 
       const channel = new ParentCommChannel<TestEvent & { error?: Error }>(
-        ExecUtil.fork(
-          RuntimeIndex.resolveFileImport('@travetto/cli/support/entry.trv'),
-          ['test:child'],
+        fork(
+          RuntimeIndex.resolveFileImport('@travetto/cli/support/entry.trv'), ['test:child'],
           {
             cwd,
             env: {
+              ...process.env,
               ...Env.TRV_MANIFEST.export(RuntimeIndex.getModule(module)!.outputPath),
               ...Env.TRV_QUIET.export(true)
             },

package/support/bin/types.ts

@@ -1,2 +1,2 @@
-export type TestFormat = 'tap' | 'tap-streamed' | 'xunit' | 'event' | 'exec';
+export type TestFormat = 'tap' | 'tap-streamed' | 'xunit' | 'event' | 'exec' | 'json';
 export type TestMode = 'single' | 'standard';

package/support/cli.test.ts

@@ -45,8 +45,6 @@ export class TestCommand implements CliCommandShape {
 
     if (mode === 'single' && !await this.isFirstFile(first)) {
       return { message: 'You must specify a proper test file to run in single mode', source: 'arg' };
-    } else if (!/test\//.test(first)) {
-      return { message: 'Only files in the test/ folder are permitted to be run', source: 'arg' };
     }
   }
 

package/support/cli.test_child.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 
-import { Env, ExecUtil } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { CliCommand } from '@travetto/cli';
 
 /** Test child worker target */
@@ -17,7 +17,7 @@ export class TestChildWorkerCommand {
   }
 
   async main(): Promise<void> {
-    ExecUtil.exitOnDisconnect();
+    process.once('disconnect', () => process.exit());
     const { TestChildWorker } = await import('../src/worker/child.js');
     return new TestChildWorker().activate();
   }

package/support/cli.test_watch.ts

@@ -1,4 +1,4 @@
-import { Env, ExecUtil } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { CliCommand, CliUtil } from '@travetto/cli';
 
 import { TestFormat } from './bin/types';
@@ -22,7 +22,7 @@ export class TestWatcherCommand {
       return;
     }
 
-    ExecUtil.exitOnDisconnect();
+    process.once('disconnect', () => process.exit());
 
     try {
       const { TestWatcher } = await import('../src/execute/watcher.js');