@travetto/test 3.3.6 → 3.4.0-rc.1

package/README.md

@@ -79,6 +79,7 @@ would translate to:
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const Ⲑ_util_1 = tslib_1.__importStar(require("@travetto/test/src/execute/util.js"));
 const Ⲑ_check_1 = tslib_1.__importStar(require("@travetto/test/src/assert/check.js"));
 const Ⲑ_root_index_1 = tslib_1.__importStar(require("@travetto/manifest/src/root-index.js"));
 const Ⲑ_decorator_1 = tslib_1.__importStar(require("@travetto/registry/src/decorator.js"));
@@ -88,6 +89,8 @@ const test_1 = require("@travetto/test");
 let SimpleTest = class SimpleTest {
     static Ⲑinit = Ⲑ_root_index_1.RootIndex.registerFunction(SimpleTest, ᚕf, 1887908328, { test: { hash: 102834457 } }, false, false);
     async test() {
+        if (Ⲑ_util_1.RunnerUtil.tryDebugger)
+            debugger;
         Ⲑ_check_1.AssertCheck.check({ file: ᚕf, line: 10, text: "{ size: 20, address: { state: 'VA' } }", operator: "deepStrictEqual" }, true, { size: 20, address: { state: 'VA' } }, {});
     }
 };
@@ -224,7 +227,7 @@ Usage: test [options] [first:string] [regexes...:string]
 
 Options:
   -f, --format <string>         Output format for test results (default: "tap")
-  -c, --concurrency <number>    Number of tests to run concurrently (default: 7)
+  -c, --concurrency <number>    Number of tests to run concurrently (default: 4)
   -m, --mode <single|standard>  Test run mode (default: "standard")
   -h, --help                    display help for command
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/test",
-  "version": "3.3.6",
+  "version": "3.4.0-rc.1",
   "description": "Declarative test framework",
   "keywords": [
     "unit-testing",
@@ -27,15 +27,15 @@
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/base": "^3.3.4",
-    "@travetto/registry": "^3.3.4",
-    "@travetto/terminal": "^3.3.1",
-    "@travetto/worker": "^3.3.4",
-    "@travetto/yaml": "^3.3.4"
+    "@travetto/base": "^3.4.0-rc.1",
+    "@travetto/registry": "^3.4.0-rc.1",
+    "@travetto/terminal": "^3.4.0-rc.0",
+    "@travetto/worker": "^3.4.0-rc.1",
+    "@travetto/yaml": "^3.4.0-rc.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.3.6",
-    "@travetto/transformer": "^3.3.2"
+    "@travetto/cli": "^3.4.0-rc.2",
+    "@travetto/transformer": "^3.4.0-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {
@@ -47,7 +47,7 @@
   },
   "travetto": {
     "displayName": "Testing",
-    "profiles": [
+    "roles": [
       "test"
     ]
   },

package/src/consumer/types/cumulative.ts

@@ -1,4 +1,4 @@
-import fs from 'fs';
+import { existsSync } from 'fs';
 
 import { Class } from '@travetto/base';
 
@@ -28,7 +28,7 @@ export class CumulativeSummaryConsumer implements TestConsumer {
    */
   summarizeSuite(test: TestResult): SuiteResult {
     // Was only loading to verify existence (TODO: double-check)
-    if (fs.existsSync(test.file)) {
+    if (existsSync(test.file)) {
       this.#state[test.classId] = this.#state[test.classId] ?? {};
       this.#state[test.classId][test.methodName] = test.status;
       const SuiteCls = SuiteRegistry.getClasses().find(x =>

package/src/execute/runner.ts

@@ -30,7 +30,7 @@ export class Runner {
   async runFiles(): Promise<boolean> {
     const consumer = await RunnableTestConsumer.get(this.#state.consumer ?? this.#state.format);
 
-    const files = (await RunnerUtil.getTestFiles(this.patterns));
+    const files = (await RunnerUtil.getTestFiles(this.patterns)).map(f => f.sourceFile);
 
     console.debug('Running', { files, patterns: this.patterns });
 

package/src/execute/util.ts

@@ -2,7 +2,7 @@ import { createReadStream } from 'fs';
 import readline from 'readline';
 
 import { ExecUtil, ShutdownManager, TimeUtil } from '@travetto/base';
-import { RootIndex } from '@travetto/manifest';
+import { IndexedFile, RootIndex } from '@travetto/manifest';
 
 /**
  * Simple Test Utilities
@@ -36,12 +36,16 @@ export class RunnerUtil {
   /**
    * Find all valid test files given the globs
    */
-  static async getTestFiles(globs: RegExp[]): Promise<string[]> {
-    const files = RootIndex.findTest({})
-      .filter(f => globs.some(g => g.test(f.import)));
+  static async getTestFiles(globs?: RegExp[]): Promise<IndexedFile[]> {
+    const files = RootIndex.find({
+      module: m => m.roles.includes('test') || m.roles.includes('std'),
+      folder: f => f === 'test',
+      file: f => f.role === 'test'
+    })
+      .filter(f => globs?.some(g => g.test(f.import)) ?? true);
 
     const validFiles = files
-      .map(f => this.isTestFile(f.sourceFile).then(valid => ({ file: f.sourceFile, valid })));
+      .map(f => this.isTestFile(f.sourceFile).then(valid => ({ file: f, valid })));
 
     return (await Promise.all(validFiles))
       .filter(x => x.valid)
@@ -61,4 +65,14 @@ export class RunnerUtil {
     }
     return countRes.valid ? +countRes.stdout : 0;
   }
+
+  /**
+   * Determine if we should invoke the debugger
+   */
+  static get tryDebugger(): boolean {
+    if (process.env.TRV_TEST_BREAK_ENTRY === '1') {
+      return true;
+    }
+    return false;
+  }
 }

package/src/execute/watcher.ts

@@ -8,6 +8,7 @@ import { buildStandardTestManager } from '../worker/standard';
 import { TestConsumerRegistry } from '../consumer/registry';
 import { CumulativeSummaryConsumer } from '../consumer/types/cumulative';
 import { RunEvent } from '../worker/types';
+import { RunnerUtil } from './util';
 
 function isRunEvent(ev: unknown): ev is RunEvent {
   return ObjectUtil.isPlainObject(ev) && 'type' in ev && typeof ev.type === 'string' && ev.type === 'run-test';
@@ -78,7 +79,7 @@ export class TestWatcher {
     process.send?.('ready');
 
     if (runAllOnStart) {
-      for (const test of await RootIndex.findTest({})) {
+      for (const test of await RunnerUtil.getTestFiles()) {
         await import(test.import);
         itr.add(test.sourceFile);
       }

package/src/worker/child.ts

@@ -1,6 +1,6 @@
-import fs from 'fs/promises';
+import { createWriteStream } from 'fs';
 
-import { path } from '@travetto/manifest';
+import { ManifestFileUtil, RootIndex } from '@travetto/manifest';
 import { ConsoleManager, ErrorUtil, TimeUtil } from '@travetto/base';
 import { ChildCommChannel } from '@travetto/worker';
 
@@ -32,9 +32,7 @@ export class TestChildWorker extends ChildCommChannel<RunEvent> {
    */
   async activate(): Promise<void> {
     if (/\b@travetto[/]test\b/.test(process.env.DEBUG ?? '')) {
-      const handle = await fs.open(path.resolve(`.trv-test-worker.${process.pid}.log`), 'a');
-      const stdout = handle.createWriteStream();
-
+      const stdout = createWriteStream(ManifestFileUtil.toolPath(RootIndex, `test-worker.${process.pid}.log`), { 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 {
@@ -61,7 +59,6 @@ export class TestChildWorker extends ChildCommChannel<RunEvent> {
     if (event.type === Events.INIT) { // On request to init, start initialization
       await this.#exec(() => this.onInitCommand(), Events.INIT_COMPLETE);
     } else if (event.type === Events.RUN) { // On request to run, start running
-      console.log!(process.stdout.isTTY && process.stdout.getColorDepth());
       await this.#exec(() => this.onRunCommand(event), Events.RUN_COMPLETE);
     }
 

package/src/worker/standard.ts

@@ -39,7 +39,7 @@ export function buildStandardTestManager(consumer: TestConsumer): () => Worker<s
 
       const channel = new ParentCommChannel<TestEvent & { error?: Error }>(
         ExecUtil.fork(
-          RootIndex.resolveFileImport('@travetto/cli/support/entry.cli'),
+          RootIndex.resolveFileImport('@travetto/cli/support/entry.trv'),
           ['test:child'],
           {
             cwd,

package/support/cli.test.ts

@@ -18,7 +18,7 @@ export class TestCommand implements CliCommandShape {
   format: TestFormat = 'tap';
   /** Number of tests to run concurrently */
   @Min(1) @Max(WorkPool.MAX_SIZE)
-  concurrency: number = WorkPool.MAX_SIZE;
+  concurrency: number = WorkPool.DEFAULT_SIZE;
   /** Test run mode */
   mode: TestMode = 'standard';
 

package/support/cli.test_count.ts

@@ -19,9 +19,9 @@ export class TestCountCommand {
     // Load all tests
     for (const file of files) {
       try {
-        await import(RootIndex.getFromSource(file)!.import);
+        await import(file.import);
       } catch (err) {
-        console.error('Failed to import', file, err);
+        console.error('Failed to import', file.sourceFile, err);
       }
     }
 

package/support/cli.test_watch.ts

@@ -1,5 +1,5 @@
 import { GlobalEnvConfig } from '@travetto/base';
-import { CliCommand } from '@travetto/cli';
+import { CliCommand, CliUtil } from '@travetto/cli';
 
 import { TestFormat } from './bin/types';
 
@@ -17,6 +17,10 @@ export class TestWatcherCommand {
   }
 
   async main(): Promise<void> {
+    if (await CliUtil.runWithRestart(this)) {
+      return;
+    }
+
     // Quit on parent disconnect
     if (process.send) {
       process.on('disconnect', () => process.exit(0));
@@ -24,9 +28,7 @@ export class TestWatcherCommand {
 
     try {
       const { TestWatcher } = await import('../src/execute/watcher.js');
-      console.log('Starting');
       await TestWatcher.watch(this.format, this.mode === 'all');
-      console.log('Done');
     } catch (err) {
       console.error(err);
     }

package/support/transformer.annotate.ts

@@ -4,18 +4,40 @@ import {
   TransformerState, DecoratorMeta, OnMethod, OnClass, CoreUtil, DecoratorUtil
 } from '@travetto/transformer';
 
+const RUN_UTIL = 'RunnerUtil';
+
+const RunUtilⲐ = Symbol.for('@travetto/test:runner');
+
+/**
+ * Annotate transformation state
+ */
+interface AnnotateState {
+  [RunUtilⲐ]?: ts.Expression;
+}
+
 /**
  * Annotate tests and suites for better diagnostics
  */
 export class AnnotationTransformer {
 
+
+  /**
+   * Initialize transformer state
+   */
+  static initState(state: TransformerState & AnnotateState): void {
+    if (!state[RunUtilⲐ]) {
+      const runUtil = state.importFile('@travetto/test/src/execute/util').ident;
+      state[RunUtilⲐ] = CoreUtil.createAccess(state.factory, runUtil, RUN_UTIL, 'tryDebugger');
+    }
+  }
+
   /**
    * Build source annotation, indicating line ranges
    * @param state
    * @param node
    * @param dec
   */
-  static buildAnnotation(state: TransformerState, node: ts.Node, dec: ts.Decorator, expression: ts.CallExpression): ts.Decorator {
+  static buildAnnotation(state: TransformerState & AnnotateState, node: ts.Node, dec: ts.Decorator, expression: ts.CallExpression): ts.Decorator {
     const ogN = (CoreUtil.hasOriginal(node) ? node.original : node);
     const n = ts.isMethodDeclaration(ogN) ? ogN : undefined;
 
@@ -40,7 +62,7 @@ export class AnnotationTransformer {
   }
 
   @OnClass('Suite')
-  static annotateSuiteDetails(state: TransformerState, node: ts.ClassDeclaration, dm?: DecoratorMeta): ts.ClassDeclaration {
+  static annotateSuiteDetails(state: TransformerState & AnnotateState, node: ts.ClassDeclaration, dm?: DecoratorMeta): ts.ClassDeclaration {
     const dec = dm?.dec;
 
     if (dec && ts.isCallExpression(dec.expression)) {
@@ -57,7 +79,9 @@ export class AnnotationTransformer {
   }
 
   @OnMethod('Test')
-  static annotateTestDetails(state: TransformerState, node: ts.MethodDeclaration, dm?: DecoratorMeta): ts.MethodDeclaration {
+  static annotateTestDetails(state: TransformerState & AnnotateState, node: ts.MethodDeclaration, dm?: DecoratorMeta): ts.MethodDeclaration {
+    this.initState(state);
+
     const dec = dm?.dec;
 
     if (dec && ts.isCallExpression(dec.expression)) {
@@ -70,7 +94,11 @@ export class AnnotationTransformer {
         node.typeParameters,
         node.parameters,
         node.type,
-        node.body
+        node.body ? state.factory.updateBlock(node.body, [
+          state.factory.createIfStatement(state[RunUtilⲐ]!,
+            state.factory.createExpressionStatement(state.factory.createIdentifier('debugger'))),
+          ...node.body.statements
+        ]) : node.body
       );
     }
     return node;