@travetto/test 5.0.0-rc.5 → 5.0.0-rc.7

package/README.md

@@ -18,7 +18,7 @@ This module provides unit testing functionality that integrates with the framewo
    *  [JSON](https://www.json.org), best for integrating with at a code level
    *  [xUnit](https://en.wikipedia.org/wiki/XUnit), standard format for CI/CD systems e.g. Jenkins, Bamboo, etc.
 
-**Note**: All tests should be under the `test/.*` folders.  The pattern for tests is defined as a regex and not standard globbing.
+**Note**: All tests should be under the `**/*` folders.  The pattern for tests is defined as as a standard glob using [Node](https://nodejs.org)'s built in globbing support.
 
 ## Definition
 A test suite is a collection of individual tests.  All test suites are classes with the [@Suite](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/suite.ts#L13) decorator. Tests are defined as methods on the suite class, using the [@Test](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/test.ts#L20) decorator.  All tests intrinsically support `async`/`await`. 
@@ -82,7 +82,7 @@ const tslib_1 = require("tslib");
 const Ⲑ_debug_1 = tslib_1.__importStar(require("@travetto/runtime/src/debug.js"));
 const Ⲑ_check_1 = tslib_1.__importStar(require("@travetto/test/src/assert/check.js"));
 const Ⲑ_function_1 = tslib_1.__importStar(require("@travetto/runtime/src/function.js"));
-var ᚕm = ["@travetto/test", "doc/assert-example"];
+var ᚕm = ["@travetto/test", "doc/assert-example.ts"];
 const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
 const test_1 = require("@travetto/test");
 let SimpleTest = class SimpleTest {

package/package.json

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

package/src/execute/executor.ts

@@ -258,9 +258,8 @@ export class TestExecutor {
    * Handle executing a suite's test/tests based on command line inputs
    */
   static async execute(consumer: TestConsumer, imp: string, ...args: string[]): Promise<void> {
-
     try {
-      await import(imp);
+      await Runtime.importFrom(imp);
     } catch (err) {
       if (!(err instanceof Error)) {
         throw err;

package/src/execute/runner.ts

@@ -29,7 +29,7 @@ export class Runner {
 
     const imports = await RunnerUtil.getTestImports(this.#state.args);
 
-    console.debug('Running', { imports, patterns: this.#state.args });
+    console.debug('Running', { patterns: this.#state.args });
 
     const testCount = await RunnerUtil.getTestCount(this.#state.args);
     await consumer.onStart({ testCount });

package/src/execute/util.ts

@@ -36,28 +36,30 @@ export class RunnerUtil {
   /**
    * Find all valid test files given the globs
    */
-  static async getTestImports(globs?: string[]): Promise<string[]> {
-    const files = new Set<string>();
-    // Collect globs
-    if (globs) {
-      for await (const item of fs.glob(globs)) {
-        files.add(Runtime.workspaceRelative(item));
-      }
-    }
-
-    const found = RuntimeIndex.find({
+  static async* getTestImports(globs?: string[]): AsyncIterable<string> {
+    const all = RuntimeIndex.find({
       module: m => m.roles.includes('test') || m.roles.includes('std'),
       folder: f => f === 'test',
       file: f => f.role === 'test'
-    })
-      .filter(f => files.size === 0 || files.has(f.sourceFile));
-
-    const validImports = found
-      .map(f => this.isTestFile(f.sourceFile).then(valid => ({ import: f.import, valid })));
+    });
 
-    return (await Promise.all(validImports))
-      .filter(x => x.valid)
-      .map(x => x.import);
+    // Collect globs
+    if (globs?.length) {
+      const allFiles = new Map(all.map(x => [x.sourceFile, x]));
+      for await (const item of fs.glob(globs)) {
+        const src = Runtime.workspaceRelative(item);
+        const match = allFiles.get(src);
+        if (match && await this.isTestFile(match.sourceFile)) {
+          yield match.import;
+        }
+      }
+    } else {
+      for await (const match of all) {
+        if (await this.isTestFile(match.sourceFile)) {
+          yield match.import;
+        }
+      }
+    }
   }
 
   /**

package/src/execute/watcher.ts

@@ -82,8 +82,8 @@ export class TestWatcher {
     process.send?.({ type: 'ready' });
 
     if (runAllOnStart) {
-      for (const imp of await RunnerUtil.getTestImports()) {
-        await import(imp);
+      for await (const imp of await RunnerUtil.getTestImports()) {
+        await Runtime.importFrom(imp);
         itr.add(imp);
       }
     }

package/src/worker/standard.ts

@@ -12,17 +12,19 @@ import { TestEvent } from '../model/event';
  *  Produce a handler for the child worker
  */
 export async function buildStandardTestManager(consumer: TestConsumer, imp: string | RunRequest): Promise<void> {
-  process.send?.({ type: 'log', message: `Worker Executing ${imp}` });
-
   let event: RunEvent;
+  process.send?.({ type: 'log', message: `Worker Input ${JSON.stringify(imp)}` });
+
   if (typeof imp === 'string') {
     event = { import: imp };
   } else if ('file' in imp) {
-    event = { import: RuntimeIndex.getFromSource(imp.file)?.sourceFile!, class: imp.class, method: imp.method };
+    event = { import: RuntimeIndex.getFromSource(imp.file)?.import!, class: imp.class, method: imp.method };
   } else {
     event = imp;
   }
 
+  process.send?.({ type: 'log', message: `Worker Executing ${event.import}` });
+
   const { module } = RuntimeIndex.getFromImport(event.import!)!;
   const suiteMod = RuntimeIndex.getModule(module);
 
@@ -64,7 +66,7 @@ export async function buildStandardTestManager(consumer: TestConsumer, imp: stri
   // Kill on complete
   await channel.destroy();
 
-  process.send?.({ type: 'log', message: `Worker Finished ${imp}` });
+  process.send?.({ type: 'log', message: `Worker Finished ${event.import}` });
 
   // If we received an error, throw it
   if (error) {

package/support/cli.test.ts

@@ -39,7 +39,7 @@ export class TestCommand implements CliCommandShape {
     return (await this.isFirstFile(first)) && rest.length === 0 ? 'single' : this.mode;
   }
 
-  async validate(first: string = 'test/.*', rest: string[]): Promise<CliValidationError | undefined> {
+  async validate(first: string = '**/*', rest: string[]): Promise<CliValidationError | undefined> {
 
     const mode = await this.resolvedMode(first, rest);
 
@@ -48,7 +48,7 @@ export class TestCommand implements CliCommandShape {
     }
   }
 
-  async main(first: string = 'test/.*', regexes: string[] = []): Promise<void> {
+  async main(first: string = '**/*', regexes: string[] = []): Promise<void> {
     const { runTests } = await import('./bin/run');
 
     return runTests({

package/support/cli.test_count.ts

@@ -1,5 +1,5 @@
 import { CliCommand } from '@travetto/cli';
-import { Env, describeFunction } from '@travetto/runtime';
+import { Env, Runtime, describeFunction } from '@travetto/runtime';
 
 import { SuiteRegistry } from '../src/registry/suite';
 import { RunnerUtil } from '../src/execute/util';
@@ -13,12 +13,10 @@ export class TestCountCommand {
   }
 
   async main(patterns: string[]) {
-    const imports = await RunnerUtil.getTestImports(patterns);
-
     // Load all tests
-    for (const imp of imports) {
+    for await (const imp of await RunnerUtil.getTestImports(patterns)) {
       try {
-        await import(imp);
+        await Runtime.importFrom(imp);
       } catch (err) {
         console.error('Failed to import', imp, err);
       }