@travetto/test 3.0.0-rc.3 → 3.0.0-rc.6

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/test/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/test/DOC.ts and execute "npx trv doc" to rebuild -->
 # Testing
 ## Declarative test framework
 
@@ -19,13 +19,13 @@ This module provides unit testing functionality that integrates with the framewo
 
 ## 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#L11) 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#L20) decorator.  All tests intrinsically support `async`/`await`.
 
 A simple example would be:
 
 **Code: Example Test Suite**
 ```typescript
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
 
@@ -56,7 +56,7 @@ A common aspect of the tests themselves are the assertions that are made.  [Node
 
 **Code: Example assertion for deep comparison**
 ```typescript
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
 
@@ -73,28 +73,28 @@ class SimpleTest {
 would translate to:
 
 **Code: Transpiled test Code**
-```doc/javascript
+```javascript
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const ᚕ_check_1 = require("@travetto/test/src/assert/check");
-const ᚕ_decorator_1 = require("@travetto/registry/src/decorator");
-const assert = require("assert");
+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"));
+const assert_1 = tslib_1.__importDefault(require("assert"));
 const test_1 = require("@travetto/test");
 let SimpleTest = class SimpleTest {
-    static ᚕinit = ᚕ_decorator_1.Register.initMeta(SimpleTest, ᚕsrc(__filename), 1887908328, { test: { hash: 102834457 } }, false, false);
+    static Ⲑinit = Ⲑ_root_index_1.RootIndex.registerFunction(SimpleTest, __filename, 1887908328, { test: { hash: 102834457 } }, false, false);
     async test() {
-        ᚕ_check_1.AssertCheck.check({ file: ᚕsrc(__filename), line: 10, text: "{ size: 20, address: { state: 'VA' } }", operator: "deepStrictEqual" }, true, { size: 20, address: { state: 'VA' } }, {});
+        Ⲑ_check_1.AssertCheck.check({ file: __filename, line: 10, text: "{ size: 20, address: { state: 'VA' } }", operator: "deepStrictEqual" }, true, { size: 20, address: { state: 'VA' } }, {});
     }
 };
 tslib_1.__decorate([
-    (0, test_1.Test)({ lines: { start: 8, end: 11, codeStart: 10 } })
+    (0, test_1.Test)({ ident: "@Test()", lines: { start: 8, end: 11, codeStart: 10 } })
 ], SimpleTest.prototype, "test", null);
 SimpleTest = tslib_1.__decorate([
-    ᚕ_decorator_1.Register(),
-    (0, test_1.Suite)({ lines: {} })
+    Ⲑ_decorator_1.Register(),
+    (0, test_1.Suite)({ ident: "@Suite()", lines: { start: 5, end: 12 } })
 ], SimpleTest);
-Object.defineProperty(exports, 'ᚕtrv', { configurable: true, value: true });
 ```
 
 This would ultimately produce the error like:
@@ -128,7 +128,7 @@ In addition to the standard operations, there is support for throwing/rejecting
      
    **Code: Throws vs Does Not Throw**
    ```typescript
-   import * as assert from 'assert';
+   import assert from 'assert';
    
    import { Suite, Test } from '@travetto/test';
    
@@ -154,7 +154,7 @@ In addition to the standard operations, there is support for throwing/rejecting
      
    **Code: Rejects vs Does Not Reject**
    ```typescript
-   import * as assert from 'assert';
+   import assert from 'assert';
    
    import { Suite, Test } from '@travetto/test';
    
@@ -185,7 +185,7 @@ Additionally, the `throws`/`rejects` assertions take in a secondary parameter to
 
 **Code: Example of different Error matching paradigms**
 ```typescript
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
 
@@ -228,9 +228,10 @@ Usage:  test [options] [regexes...]
 Options:
   -f, --format <format>            Output format for test results (default: "tap")
   -c, --concurrency <concurrency>  Number of tests to run concurrently (default: 4)
-  -i, --isolated                   Isolated mode
   -m, --mode <mode>                Test run mode (default: "standard")
   -h, --help                       display help for command
+
+
 ```
 
 The regexes are the patterns of tests you want to run, and all tests must be found under the `test/` folder.

package/{index.ts → __index__.ts}

@@ -4,3 +4,5 @@ export * from './src/model/suite';
 export * from './src/model/test';
 export * from './src/model/event';
 export * from './src/registry/suite';
+export * from './src/fixture';
+export * from './src/consumer/types';

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/test",
-  "displayName": "Testing",
-  "version": "3.0.0-rc.3",
+  "version": "3.0.0-rc.6",
   "description": "Declarative test framework",
   "keywords": [
     "unit-testing",
@@ -18,32 +17,40 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
-    "bin",
     "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.0-rc.1",
-    "@travetto/transformer": "^3.0.0-rc.3",
-    "@travetto/registry": "^3.0.0-rc.3",
-    "@travetto/watch": "^3.0.0-rc.1",
-    "@travetto/worker": "^3.0.0-rc.1",
-    "@travetto/yaml": "^3.0.0-rc.1"
+    "@travetto/base": "^3.0.0-rc.4",
+    "@travetto/registry": "^3.0.0-rc.6",
+    "@travetto/terminal": "^3.0.0-rc.4",
+    "@travetto/worker": "^3.0.0-rc.4",
+    "@travetto/yaml": "^3.0.0-rc.4"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.0-rc.1"
+    "@travetto/cli": "^3.0.0-rc.4",
+    "@travetto/transformer": "^3.0.0-rc.6"
   },
   "peerDependenciesMeta": {
+    "@travetto/transformer": {
+      "optional": true
+    },
     "@travetto/cli": {
       "optional": true
     }
   },
+  "travetto": {
+    "displayName": "Testing",
+    "profiles": [
+      "test"
+    ]
+  },
   "publishConfig": {
     "access": "public"
   }

package/src/assert/capture.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+
 import { Assertion, TestConfig } from '../model/test';
 
 export interface CaptureAssert extends Partial<Assertion> {

package/src/assert/check.ts

@@ -1,7 +1,7 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
-import { PathUtil } from '@travetto/boot';
-import { Util, AppError, ClassInstance, Class } from '@travetto/base';
+import { RootIndex } from '@travetto/manifest';
+import { ObjectUtil, AppError, ClassInstance, Class } from '@travetto/base';
 
 import { ThrowableError, TestConfig, Assertion } from '../model/test';
 import { AssertCapture, CaptureAssert } from './capture';
@@ -30,6 +30,8 @@ export class AssertCheck {
    * @param args The arguments passed in
    */
   static check(assertion: CaptureAssert, positive: boolean, ...args: unknown[]): void {
+    assertion.file = RootIndex.getSourceFile(assertion.file);
+
     let fn = assertion.operator;
     assertion.operator = ASSERT_FN_OPERATOR[fn];
 
@@ -191,7 +193,7 @@ export class AssertCheck {
     shouldThrow: ThrowableError | undefined,
     assertion: CaptureAssert
   ): void {
-    if (Util.isPrimitive(err)) {
+    if (ObjectUtil.isPrimitive(err)) {
       err = new Error(`${err}`);
     }
     if (!(err instanceof Error)) {
@@ -225,10 +227,12 @@ export class AssertCheck {
   ): void {
     let missed: Error | undefined;
 
+    assertion.file = RootIndex.getSourceFile(assertion.file);
+
     try {
       action();
       if (!positive) {
-        if (!Util.isPrimitive(shouldThrow)) {
+        if (!ObjectUtil.isPrimitive(shouldThrow)) {
           shouldThrow = shouldThrow?.name;
         }
         throw (missed = new AppError(`No error thrown, but expected ${shouldThrow ?? 'an error'}`));
@@ -257,6 +261,8 @@ export class AssertCheck {
   ): Promise<void> {
     let missed: Error | undefined;
 
+    assertion.file = RootIndex.getSourceFile(assertion.file);
+
     try {
       if ('then' in action) {
         await action;
@@ -264,7 +270,7 @@ export class AssertCheck {
         await action();
       }
       if (!positive) {
-        if (!Util.isPrimitive(shouldThrow)) {
+        if (!ObjectUtil.isPrimitive(shouldThrow)) {
           shouldThrow = shouldThrow?.name;
         }
         throw (missed = new AppError(`No error thrown, but expected ${shouldThrow ?? 'an error'} `));
@@ -286,7 +292,7 @@ export class AssertCheck {
     }
 
     AssertCapture.add({
-      file: test.file.replace(`${PathUtil.cwd}/`, ''),
+      file: test.file,
       line,
       operator: 'throws',
       error: err,

package/src/assert/util.ts

@@ -1,7 +1,7 @@
-import * as util from 'util';
+import util from 'util';
 
-import { PathUtil } from '@travetto/boot';
-import { Class, ClassInstance, Util } from '@travetto/base';
+import { path, RootIndex } from '@travetto/manifest';
+import { Class, ClassInstance, ObjectUtil } from '@travetto/base';
 
 import { TestConfig, Assertion, TestResult } from '../model/test';
 import { SuiteConfig } from '../model/suite';
@@ -22,14 +22,14 @@ export class AssertUtil {
     if (isCleanable(val)) {
       return val.toClean();
     } else if (val === null || val === undefined
-      || (!(val instanceof RegExp) && Util.isPrimitive(val))
-      || Util.isPlainObject(val) || Array.isArray(val)
+      || (!(val instanceof RegExp) && ObjectUtil.isPrimitive(val))
+      || ObjectUtil.isPlainObject(val) || Array.isArray(val)
     ) {
       return JSON.stringify(val);
     } else {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       const subV = val as (Class | ClassInstance);
-      if (subV.ᚕid || !subV.constructor || (!subV.constructor.ᚕid && Util.isFunction(subV))) { // If a function, show name
+      if (subV.Ⲑid || !subV.constructor || (!subV.constructor.Ⲑid && ObjectUtil.isFunction(subV))) { // If a function, show name
         return subV.name;
       } else { // Else inspect
         return util.inspect(val, false, 1).replace(/\n/g, ' ');
@@ -41,16 +41,16 @@ export class AssertUtil {
    * Determine file location for a given error and the stack trace
    */
   static getPositionOfError(err: Error, filename: string): { file: string, line: number } {
-    const lines = (err.stack ?? new Error().stack!)
-      .replace(/[\\]/g, '/')
+    const cwd = path.cwd();
+    const lines = path.toPosix(err.stack ?? new Error().stack!)
       .split('\n')
       // Exclude node_modules, target self
-      .filter(x => x.includes(PathUtil.cwd) && (!x.includes('node_modules') || x.includes('/test-support/')));
+      .filter(x => x.includes(cwd) && (!x.includes('node_modules') || x.includes('/support/')));
 
     let best = lines.filter(x => x.includes(filename))[0];
 
     if (!best) {
-      [best] = lines.filter(x => x.includes(`${PathUtil.cwd}/test`));
+      [best] = lines.filter(x => x.includes(`${cwd}/test`));
     }
 
     if (!best) {
@@ -72,7 +72,7 @@ export class AssertUtil {
       line = -1;
     }
 
-    const outFileParts = file.split(PathUtil.cwd.replace(/^[A-Za-z]:/, ''));
+    const outFileParts = file.split(cwd.replace(/^[A-Za-z]:/, ''));
 
     const outFile = outFileParts.length > 1 ? outFileParts[1].replace(/^[\/]/, '') : filename;
 
@@ -94,7 +94,7 @@ export class AssertUtil {
 
     const msg = error.message.split(/\n/)[0];
 
-    const core = { file, classId: suite.classId, methodName };
+    const core = { file, classId: suite.classId, methodName, module: RootIndex.manifest.mainModule };
     const coreAll = { ...core, description: msg, lines: { start: line, end: line, codeStart: line } };
 
     const assert: Assertion = {

package/src/consumer/enhancer.ts

@@ -1,26 +1,18 @@
-import { ColorUtil } from '@travetto/boot';
+import { GlobalTerminal } from '@travetto/terminal';
 
-export const COLOR_ENHANCER = {
-  assertDescription: ColorUtil.makeColorer('white'),
-  testDescription: ColorUtil.makeColorer('white', 'faint', 'bold'),
-  success: ColorUtil.makeColorer('green', 'faint', 'bold'),
-  failure: ColorUtil.makeColorer('red', 'faint', 'bold'),
-  assertNumber: ColorUtil.makeColorer('blue', 'bold'),
-  testNumber: ColorUtil.makeColorer('blue', 'bold'),
-  assertFile: ColorUtil.makeColorer('cyan'),
-  assertLine: ColorUtil.makeColorer('yellow'),
-  objectInspect: ColorUtil.makeColorer('magenta'),
-  suiteName: ColorUtil.makeColorer('yellow', 'faint', 'bold'),
-  testName: ColorUtil.makeColorer('cyan', 'bold'),
-  total: ColorUtil.makeColorer('white', 'bold')
-};
+export const CONSOLE_ENHANCER = GlobalTerminal.palette({
+  assertDescription: 'lightGray',
+  testDescription: 'white',
+  success: 'green',
+  failure: 'red',
+  assertNumber: 'brightCyan',
+  testNumber: 'dodgerBlue',
+  assertFile: 'lightGreen',
+  assertLine: 'lightYellow',
+  objectInspect: 'magenta',
+  suiteName: 'yellow',
+  testName: 'cyan',
+  total: 'white'
+});
 
-export type TestResultsEnhancer = typeof COLOR_ENHANCER;
-
-/**
- * Dummy enhancer does nothing
- */
-export const DUMMY_ENHANCER: TestResultsEnhancer = [
-  Object.keys(COLOR_ENHANCER)
-    .reduce<Partial<TestResultsEnhancer>>((acc, k) => (acc[k] = (x: unknown): string => `${x}`) && acc, {})
-].filter((x): x is TestResultsEnhancer => !!x)[0];
+export type TestResultsEnhancer = typeof CONSOLE_ENHANCER;

package/src/consumer/registry.ts

@@ -12,7 +12,7 @@ class $TestConsumerRegistry {
    * Manual initialization when running outside of the bootstrap process
    */
   async manualInit(): Promise<void> {
-    await import('./types/index');
+    await import('./types/all.js');
   }
 
   /**
@@ -40,7 +40,10 @@ class $TestConsumerRegistry {
    * Get a consumer instance that supports summarization
    * @param consumer The consumer identifier or the actual consumer
    */
-  getInstance(consumer: string | TestConsumer): TestConsumer {
+  async getInstance(consumer: string | TestConsumer): Promise<TestConsumer> {
+    // TODO: Fix consumer registry init
+    await this.manualInit();
+
     return typeof consumer === 'string' ?
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       new ((this.get(consumer) ?? this.#primary) as ConcreteClass)() :

package/src/consumer/types/{index.ts → all.ts}

@@ -5,6 +5,6 @@ import './json';
 import './noop';
 import './runnable';
 import './summarizer';
-import './tap-summary';
+import './tap-streamed';
 import './tap';
 import './xunit';

package/src/consumer/types/cumulative.ts

@@ -1,3 +1,5 @@
+import fs from 'fs';
+
 import { Class } from '@travetto/base';
 
 import { TestConsumer } from '../types';
@@ -25,16 +27,19 @@ export class CumulativeSummaryConsumer implements TestConsumer {
    * state
    */
   summarizeSuite(test: TestResult): SuiteResult {
-    try {
-      // TODO: Load asynchronously
-      require(test.file);
+    // Was only loading to verify existence (TODO: double-check)
+    if (fs.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 =>
-        x.ᚕid === test.classId
+        x.Ⲑid === test.classId
       )!;
-      return this.computeTotal(SuiteCls);
-    } catch {
+      if (SuiteCls) {
+        return this.computeTotal(SuiteCls);
+      } else {
+        return this.removeClass(test.classId);
+      }
+    } else {
       return this.removeClass(test.classId);
     }
   }

package/src/consumer/types/runnable.ts

@@ -10,8 +10,8 @@ export class RunnableTestConsumer implements TestConsumer {
   /**
    * Build a runnable test consumer given a format or a full consumer
    */
-  static get(consumer: string | TestConsumer): RunnableTestConsumer {
-    return new RunnableTestConsumer(TestConsumerRegistry.getInstance(consumer));
+  static async get(consumer: string | TestConsumer): Promise<RunnableTestConsumer> {
+    return new RunnableTestConsumer(await TestConsumerRegistry.getInstance(consumer));
   }
 
   #consumers: TestConsumer[];
@@ -27,11 +27,9 @@ export class RunnableTestConsumer implements TestConsumer {
     }
   }
 
-  onStart(): void {
+  async onStart(files: string[]): Promise<void> {
     for (const c of this.#consumers) {
-      if (c.onStart) {
-        c.onStart();
-      }
+      await c.onStart?.(files);
     }
   }
 
@@ -44,19 +42,17 @@ export class RunnableTestConsumer implements TestConsumer {
     }
   }
 
-  summarize(): TestResultsSummarizer | undefined {
+  async summarize(): Promise<TestResultsSummarizer | undefined> {
     if (this.#results) {
       for (const c of this.#consumers) {
-        if (c.onSummary) {
-          c.onSummary(this.#results.summary);
-        }
+        await c.onSummary?.(this.#results.summary);
       }
       return this.#results;
     }
   }
 
-  summarizeAsBoolean(): boolean {
-    const result = this.summarize();
+  async summarizeAsBoolean(): Promise<boolean> {
+    const result = await this.summarize();
     if (result) {
       return result.summary.failed <= 0;
     } else {

package/src/consumer/types/tap-streamed.ts

@@ -0,0 +1,92 @@
+import { GlobalTerminal, TermStyleInput, Terminal } from '@travetto/terminal';
+import { ManualAsyncIterator } from '@travetto/worker';
+import { RootIndex } from '@travetto/manifest';
+
+import { SuitesSummary, TestConsumer } from '../types';
+import { Consumable } from '../registry';
+
+import { TestEvent } from '../../model/event';
+import { TestResult } from '../../model/test';
+import { SuiteRegistry } from '../../registry/suite';
+import { TapEmitter } from './tap';
+
+/**
+ * Streamed summary results
+ */
+@Consumable('tap-streamed')
+export class TapStreamedEmitter implements TestConsumer {
+
+  static makeProgressBar(term: Terminal, total: number): (t: TestResult, idx: number) => string {
+    let failed = 0;
+    const palette: TermStyleInput[] = [
+      { text: 'white', background: 'darkGreen' },
+      { text: 'white', background: 'darkRed' }
+    ];
+    const styles = palette.map(s => GlobalTerminal.colorer(s));
+
+    return (t: TestResult, idx: number): string => {
+      if (t.status === 'failed') {
+        failed += 1;
+      }
+      const i = idx + 1;
+      const digits = total.toString().length;
+      const paddedI = `${i}`.padStart(digits);
+      const paddedFailed = `${failed}`.padStart(digits);
+      const line = `Tests ${paddedI}/${total} [${paddedFailed} failed] -- ${t.classId}`.padEnd(term.width);
+      const pos = Math.trunc(line.length * (i / total));
+      const colorer = styles[Math.min(failed, styles.length - 1)];
+      return `${colorer(line.substring(0, pos))}${line.substring(pos)}`;
+    };
+  }
+
+  #terminal: Terminal;
+  #results = new ManualAsyncIterator<TestResult>();
+  #progress: Promise<unknown> | undefined;
+  #consumer: TapEmitter;
+
+  constructor(terminal: Terminal = new Terminal({ output: process.stderr })) {
+    this.#terminal = terminal;
+    this.#consumer = new TapEmitter(this.#terminal);
+  }
+
+  async onStart(files: string[]): Promise<void> {
+    this.#consumer.onStart();
+
+    // Load all tests
+    for (const file of files) {
+      await import(RootIndex.getFromSource(file)!.import);
+    }
+
+    await SuiteRegistry.init();
+
+    const suites = SuiteRegistry.getClasses();
+    const total = suites
+      .map(c => SuiteRegistry.get(c))
+      .filter(c => !RootIndex.getFunctionMetadata(c.class)?.abstract)
+      .reduce((acc, c) => acc + (c.tests?.length ?? 0), 0);
+
+    this.#progress = this.#terminal.streamToPosition(this.#results,
+      TapStreamedEmitter.makeProgressBar(this.#terminal, total),
+      { position: 'bottom' }
+    );
+  }
+
+  onEvent(ev: TestEvent): void {
+    if (ev.type === 'test' && ev.phase === 'after') {
+      const { test } = ev;
+      this.#results.add(test);
+      if (test.status === 'failed') {
+        this.#consumer.onEvent(ev);
+      }
+    }
+  }
+
+  /**
+   * Summarize all results
+   */
+  async onSummary(summary: SuitesSummary): Promise<void> {
+    this.#results.close();
+    await this.#progress;
+    await this.#consumer.onSummary?.(summary);
+  }
+}