@travetto/test 4.0.0-rc.6 → 4.0.0-rc.8

package/README.md

@@ -21,7 +21,7 @@ This module provides unit testing functionality that integrates with the framewo
 **Note**: All tests should be under the `test/.*` folders.  The pattern for tests is defined as a regex and not standard globbing.
 
 ## 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#L14) 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`. 
+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#L14) 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#L19) decorator.  All tests intrinsically support `async`/`await`. 
 
 A simple example would be:
 
@@ -87,7 +87,7 @@ var ᚕf = "@travetto/test/doc/assert-example.js";
 const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
 const test_1 = require("@travetto/test");
 let SimpleTest = class SimpleTest {
-    static Ⲑinit = Ⲑ_runtime_1.RuntimeIndex.registerFunction(SimpleTest, ᚕf, 1887908328, { test: { hash: 102834457 } }, false, false);
+    static Ⲑinit = Ⲑ_runtime_1.RuntimeIndex.registerFunction(SimpleTest, ᚕf, { hash: 1887908328, lines: [5, 12] }, { test: { hash: 102834457, lines: [8, 11] } }, false, false);
     async test() {
         if (Ⲑ_util_1.RunnerUtil.tryDebugger)
             debugger;
@@ -95,11 +95,11 @@ let SimpleTest = class SimpleTest {
     }
 };
 tslib_1.__decorate([
-    (0, test_1.Test)({ ident: "@Test()", lines: { start: 8, end: 11, codeStart: 10 } })
+    (0, test_1.Test)({ ident: "@Test()", lineBodyStart: 10 })
 ], SimpleTest.prototype, "test", null);
 SimpleTest = tslib_1.__decorate([
     Ⲑ_decorator_1.Register(),
-    (0, test_1.Suite)({ ident: "@Suite()", lines: { start: 5, end: 12 } })
+    (0, test_1.Suite)({ ident: "@Suite()" })
 ], SimpleTest);
 ```
 

package/package.json

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

package/src/assert/check.ts

@@ -300,7 +300,7 @@ export class AssertCheck {
   static checkUnhandled(test: TestConfig, err: Error | assert.AssertionError): void {
     let line = AssertUtil.getPositionOfError(err, test.file).line;
     if (line === 1) {
-      line = test.lines.start;
+      line = test.lineStart;
     }
 
     AssertCapture.add({

package/src/assert/util.ts

@@ -88,14 +88,14 @@ export class AssertUtil {
     const { file, ...pos } = this.getPositionOfError(error, suite.file);
     let line = pos.line;
 
-    if (line === 1 && suite.lines) {
-      line = suite.lines.start;
+    if (line === 1 && suite.lineStart) {
+      line = suite.lineStart;
     }
 
     const msg = error.message.split(/\n/)[0];
 
     const core = { file, classId: suite.classId, methodName, module: RuntimeContext.main.name };
-    const coreAll = { ...core, description: msg, lines: { start: line, end: line, codeStart: line } };
+    const coreAll = { ...core, description: msg, lineStart: line, lineEnd: line, lineBodyStart: line };
 
     const assert: Assertion = {
       ...core,

package/src/decorator/test.ts

@@ -1,5 +1,4 @@
 import { ClassInstance } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
 
 import { SuiteRegistry } from '../registry/suite';
 import { TestConfig } from '../model/test';
@@ -26,15 +25,11 @@ export function Test(description?: string | Partial<TestConfig>, ...rest: Partia
     Object.assign(extra, description).description :
     description;
 
-  for (const r of rest) {
+  for (const r of [...rest, { description: descriptionString }]) {
     Object.assign(extra, r);
   }
   return (inst: ClassInstance, prop: string | symbol, descriptor: PropertyDescriptor) => {
-    SuiteRegistry.registerField(inst.constructor, descriptor.value, {
-      ...extra,
-      file: RuntimeIndex.getFunctionMetadata(inst.constructor)!.source,
-      description: descriptionString
-    });
+    SuiteRegistry.registerField(inst.constructor, descriptor.value, extra);
     return descriptor;
   };
 }

package/src/execute/console.ts

@@ -18,7 +18,7 @@ export class ConsoleCapture {
   static onLog({ level, args }: ConsoleEvent): void {
     (this.out[level] = this.out[level] ?? []).push(
       args
-        .map((x => typeof x === 'string' ? x : util.inspect(x, false, 4)))
+        .map((x => typeof x === 'string' ? x : util.inspect(x, false, 5)))
         .join(' ')
     );
   }

package/src/execute/executor.ts

@@ -71,7 +71,7 @@ export class TestExecutor {
     const name = path.basename(file);
     const classId = RuntimeIndex.getId(file, name);
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const suite = { class: { name }, classId, duration: 0, lines: { start: 1, end: 1 }, file, } as SuiteConfig & SuiteResult;
+    const suite = { class: { name }, classId, duration: 0, lineStart: 1, lineEnd: 1, file, } as SuiteConfig & SuiteResult;
     err.message = err.message.replaceAll(RuntimeIndex.mainModule.sourcePath, '.');
     const res = AssertUtil.generateSuiteError(suite, 'require', err);
     consumer.onEvent({ type: 'suite', phase: 'before', suite });
@@ -90,7 +90,8 @@ export class TestExecutor {
       failed: 0,
       skipped: 0,
       total: 0,
-      lines: { ...suite.lines },
+      lineStart: suite.lineStart,
+      lineEnd: suite.lineEnd,
       file: suite.file,
       classId: suite.classId,
       duration: 0,
@@ -113,7 +114,9 @@ export class TestExecutor {
       module: RuntimeContext.main.name,
       description: test.description,
       classId: test.classId,
-      lines: { ...test.lines },
+      lineStart: test.lineStart,
+      lineEnd: test.lineEnd,
+      lineBodyStart: test.lineBodyStart,
       file: test.file,
       status: 'skipped',
       assertions: [],

package/src/model/common.ts

@@ -22,17 +22,21 @@ export interface SuiteCore {
    */
   file: string;
   /**
-   * The lines within the file the tests overlaps
+   * The first line of the unit
    */
-  lines: { start: number, end: number };
+  lineStart: number;
+  /**
+   * The last line of the unit
+   */
+  lineEnd: number;
 }
 
 /**
- * Test core definition, adds codeStart
+ * Test core definition, adds start of body
  */
 export interface TestCore extends SuiteCore {
   /**
-   * The lines within the file the tests overlaps
+   * The first line of the unit body
    */
-  lines: { start: number, end: number, codeStart: number };
+  lineBodyStart: number;
 }

package/src/model/suite.ts

@@ -64,9 +64,13 @@ export interface SuiteResult extends Counts {
    */
   file: string;
   /**
-   * Lines of the suite
+   * Start of the suite
    */
-  lines: { start: number, end: number };
+  lineStart: number;
+  /**
+   * End of the suite
+   */
+  lineEnd: number;
   /**
    * ALl test results
    */

package/src/registry/suite.ts

@@ -18,11 +18,14 @@ class $SuiteRegistry extends MetadataRegistry<SuiteConfig, TestConfig> {
   }
 
   createPending(cls: Class): Partial<SuiteConfig> {
+    const meta = RuntimeIndex.getFunctionMetadata(cls)!;
     return {
       class: cls,
       module: RuntimeContext.main.name,
       classId: cls.Ⲑid,
-      file: RuntimeIndex.getFunctionMetadata(cls)!.source,
+      file: meta.source,
+      lineStart: meta.lines[0],
+      lineEnd: meta.lines[1],
       tests: [],
       beforeAll: [],
       beforeEach: [],
@@ -32,10 +35,14 @@ class $SuiteRegistry extends MetadataRegistry<SuiteConfig, TestConfig> {
   }
 
   override createPendingField(cls: Class, fn: Function): Partial<TestConfig> {
+    const meta = RuntimeIndex.getFunctionMetadata(cls)!;
+    const meth = meta.methods![fn.name];
     return {
       class: cls,
       module: RuntimeContext.main.name,
-      file: RuntimeIndex.getFunctionMetadata(cls)!.source,
+      file: meta.source,
+      lineStart: meth?.lines[0],
+      lineEnd: meth?.lines[1],
       methodName: fn.name
     };
   }
@@ -92,10 +99,10 @@ class $SuiteRegistry extends MetadataRegistry<SuiteConfig, TestConfig> {
     if (clsName && /^\d+$/.test(clsName)) { // If we only have a line number
       const line = parseInt(clsName, 10);
       const suites = this.getValidClasses().filter(cls => RuntimeIndex.getFunctionMetadata(cls)!.source === file).map(x => this.get(x)).filter(x => !x.skip);
-      const suite = suites.find(x => x.lines && (line >= x.lines.start && line <= x.lines.end));
+      const suite = suites.find(x => line >= x.lineStart && line <= x.lineEnd);
 
       if (suite) {
-        const test = suite.tests.find(x => x.lines && (line >= x.lines.start && line <= x.lines.end));
+        const test = suite.tests.find(x => line >= x.lineStart && line <= x.lineEnd);
         return test ? { suite, test } : { suite };
       } else {
         return { suites };

package/support/cli.test_child.ts

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

package/support/cli.test_watch.ts

@@ -18,12 +18,10 @@ export class TestWatcherCommand {
   }
 
   async main(): Promise<void> {
-    if (await CliUtil.runWithRestart(this)) {
+    if (await CliUtil.runWithRestart(this, true)) {
       return;
     }
 
-    process.once('disconnect', () => process.exit());
-
     try {
       const { TestWatcher } = await import('../src/execute/watcher.js');
       await TestWatcher.watch(this.format, this.mode === 'all');

package/support/transformer.annotate.ts

@@ -50,10 +50,7 @@ export class AnnotationTransformer {
           ...(expression.arguments ?? []),
           state.fromLiteral({
             ident: `@${DecoratorUtil.getDecoratorIdent(dec).text}()`,
-            lines: {
-              ...CoreUtil.getRangeOf(state.source, node),
-              codeStart: CoreUtil.getRangeOf(state.source, n?.body?.statements[0])?.start
-            }
+            lineBodyStart: CoreUtil.getRangeOf(state.source, n?.body?.statements[0])?.[0]
           })
         ]
       )