@travetto/test 8.0.0-alpha.0 → 8.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/test",
-  "version": "8.0.0-alpha.0",
+  "version": "8.0.0-alpha.2",
   "type": "module",
   "description": "Declarative test framework",
   "keywords": [
@@ -28,15 +28,15 @@
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/registry": "^8.0.0-alpha.0",
-    "@travetto/runtime": "^8.0.0-alpha.0",
-    "@travetto/terminal": "^8.0.0-alpha.0",
-    "@travetto/worker": "^8.0.0-alpha.0",
+    "@travetto/registry": "^8.0.0-alpha.2",
+    "@travetto/runtime": "^8.0.0-alpha.2",
+    "@travetto/terminal": "^8.0.0-alpha.2",
+    "@travetto/worker": "^8.0.0-alpha.2",
     "yaml": "^2.8.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.0",
-    "@travetto/transformer": "^8.0.0-alpha.0"
+    "@travetto/cli": "^8.0.0-alpha.3",
+    "@travetto/transformer": "^8.0.0-alpha.2"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/assert/util.ts

@@ -40,15 +40,13 @@ export class AssertUtil {
    * Determine file location for a given error and the stack trace
    */
   static getPositionOfError(error: Error): { import: string, line: number } | undefined {
-    const stack = error.stack ?? new Error().stack!;
-    const frames = Util.stackTraceToParts(stack)
+    const frames = Util.stackTraceToParts(error.stack ?? new Error().stack!)
       .map(frame => {
-        const imp = (RuntimeIndex.getFromSource(frame.filename) ?? RuntimeIndex.getEntry(frame.filename))?.import;
-        return { ...frame, import: imp! };
-      })
-      .filter(frame => !!frame.import);
+        const entry = RuntimeIndex.getEntry(frame.filename);
+        return { ...frame, import: entry?.import!, line: entry?.type === 'ts' ? frame.line : 1 };
+      });
 
-    return frames[0];
+    return frames.find(frame => frame.import);
   }
 
   /**

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

@@ -99,7 +99,7 @@ export class TapSummaryEmitter implements TestConsumerShape {
           total[value.status] += 1;
           total.count += 1;
           const statusLine = `${total.failed} failed, ${total.errored} errored, ${total.skipped} skipped`;
-          return { value: `Tests %idx/%total [${statusLine}] -- ${value.classId}`, total: state.testCount, idx: total.count };
+          return { value: `Tests %idx/%total [${statusLine}] -- ${value.classId}`, total: state.testCount, idx: total.passed };
 
         },
         TerminalUtil.progressBarUpdater(this.#terminal, { style: () => ({ complete: (total.failed || total.errored) ? fail : success }) })

package/src/decorator/suite.ts

@@ -1,4 +1,4 @@
-import { castTo, type Class, type ClassInstance, describeFunction, getClass } from '@travetto/runtime';
+import { castTo, type Class, type ClassInstance, getClass } from '@travetto/runtime';
 
 import type { SuiteConfig } from '../model/suite.ts';
 import { SuiteRegistryIndex } from '../registry/registry-index.ts';
@@ -15,11 +15,9 @@ export function Suite(...rest: Partial<SuiteConfig>[]): ClassDecorator;
 export function Suite(description: string, ...rest: Partial<SuiteConfig>[]): ClassDecorator;
 export function Suite(description?: string | Partial<SuiteConfig>, ...rest: Partial<SuiteConfig>[]): ClassDecorator {
   const decorator = (cls: Class): typeof cls => {
-    const isAbstract = describeFunction(cls).abstract;
     SuiteRegistryIndex.getForRegister(cls).register(
       ...(typeof description !== 'string' && description ? [description] : []),
       ...rest,
-      ...isAbstract ? [{ skip: true }] : [],
       ...(typeof description === 'string' ? [{ description }] : []),
     );
     return cls;

package/src/execute/executor.ts

@@ -92,7 +92,7 @@ export class TestExecutor {
   /**
    * An empty suite result based on a suite config
    */
-  createSuiteResult(suite: SuiteConfig): SuiteResult {
+  createSuiteResult(suite: SuiteConfig, override?: Partial<SuiteResult>): SuiteResult {
     return {
       passed: 0,
       failed: 0,
@@ -107,7 +107,8 @@ export class TestExecutor {
       classId: suite.classId,
       sourceHash: suite.sourceHash,
       duration: 0,
-      tests: {}
+      tests: {},
+      ...override
     };
   }
 
@@ -176,7 +177,20 @@ export class TestExecutor {
 
     suite.instance = classConstruct(suite.class);
 
-    if (!tests.length || await this.#shouldSkip(suite, suite.instance)) {
+    const shouldSkip = await this.#shouldSkip(suite, suite.instance);
+
+    if (shouldSkip) {
+      this.#consumer.onEvent({
+        phase: 'after', type: 'suite',
+        suite: this.createSuiteResult(suite, {
+          status: 'skipped',
+          skipped: tests.length,
+          total: tests.length
+        })
+      });
+    }
+
+    if (shouldSkip || !tests.length) {
       return;
     }
 

package/src/registry/registry-adapter.ts

@@ -8,7 +8,7 @@ import type { TestConfig } from '../model/test.ts';
 function combineClasses(baseConfig: SuiteConfig, ...subConfig: Partial<SuiteConfig>[]): SuiteConfig {
   for (const config of subConfig) {
     if (config.tags) {
-      baseConfig.tags = [...baseConfig.tags ?? [], ...config.tags];
+      baseConfig.tags = [...new Set([...baseConfig.tags ?? [], ...config.tags])];
     }
     baseConfig.skip = config.skip ?? baseConfig.skip;
 
@@ -30,6 +30,21 @@ function combineClasses(baseConfig: SuiteConfig, ...subConfig: Partial<SuiteConf
   return baseConfig;
 }
 
+function combineWithParent(baseConfig: SuiteConfig, parentConfig: SuiteConfig): SuiteConfig {
+  baseConfig.tags = [...parentConfig.tags ?? [], ...baseConfig.tags ?? []];
+  baseConfig.skip = baseConfig.skip ?? parentConfig.skip;
+  baseConfig.phaseHandlers = [...(parentConfig.phaseHandlers ?? []), ...(baseConfig.phaseHandlers ?? [])];
+  for (const [key, test] of Object.entries(parentConfig.tests ?? {})) {
+    baseConfig.tests[key] = {
+      ...test,
+      class: baseConfig.class,
+      classId: baseConfig.classId,
+      import: baseConfig.import,
+    };
+  }
+  return baseConfig;
+}
+
 function combineMethods(suite: SuiteConfig, baseConfig: TestConfig, ...subConfig: Partial<TestConfig>[]): TestConfig {
   baseConfig.classId = suite.classId;
   baseConfig.import = suite.import;
@@ -54,12 +69,12 @@ export class SuiteRegistryAdapter implements RegistryAdapter<SuiteConfig> {
 
   register(...data: Partial<SuiteConfig>[]): SuiteConfig {
     if (!this.#config) {
-      const { lines, hash } = describeFunction(this.#cls) ?? {};
+      const { lines, hash, abstract: isAbstract } = describeFunction(this.#cls) ?? {};
       this.#config = asFull<SuiteConfig>({
         class: this.#cls,
         classId: this.#cls.Ⲑid,
         tags: [],
-        skip: false,
+        skip: isAbstract,
         import: Runtime.getImport(this.#cls),
         lineStart: lines?.[0],
         lineEnd: lines?.[1],
@@ -99,11 +114,11 @@ export class SuiteRegistryAdapter implements RegistryAdapter<SuiteConfig> {
 
   finalize(parent?: SuiteConfig): void {
     if (parent) {
-      combineClasses(this.#config, parent);
+      combineWithParent(this.#config, parent);
     }
 
     for (const test of Object.values(this.#config.tests)) {
-      test.tags = [...test.tags ?? [], ...this.#config.tags ?? []];
+      test.tags = [...new Set([...test.tags ?? [], ...this.#config.tags ?? []])];
       test.description ||= SchemaRegistryIndex.get(this.#cls).getMethod(test.methodName).description;
     }
   }

package/support/bin/run.ts

@@ -1,7 +1,3 @@
-import { getClass, Runtime } from '@travetto/runtime';
-import { SchemaRegistryIndex } from '@travetto/schema';
-
-import { TestConsumerRegistryIndex } from '../../src/consumer/registry-index.ts';
 import type { TestConsumerConfig } from '../../src/execute/types.ts';
 import type { TestRunInput } from '../../src/model/test.ts';
 
@@ -21,17 +17,4 @@ export async function runTests(state: TestConsumerConfig, input: TestRunInput):
   }
 }
 
-export async function selectConsumer(instance: { format?: string }) {
-  if (instance.format?.includes('/')) {
-    await Runtime.importFrom(instance.format);
-  }
-
-  const types = await TestConsumerRegistryIndex.getTypes();
-
-  SchemaRegistryIndex.getForRegister(getClass(instance), true).registerField('format', {
-    enum: {
-      message: `{path} is only allowed to be "${types.join('" or "')}"`,
-      values: types
-    }
-  });
-}
+export type TestConsumerType = 'tap' | 'tap-summary' | 'json' | 'exec' | 'event' | 'xunit' | 'custom';

package/support/cli.test.ts

@@ -5,6 +5,8 @@ import { type CliCommandShape, CliCommand, CliUtil } from '@travetto/cli';
 import { WorkPool } from '@travetto/worker';
 import { Max, Min } from '@travetto/schema';
 
+import type { TestConsumerType } from './bin/run.ts';
+
 /**
  * Launch test framework and execute tests
  */
@@ -12,7 +14,7 @@ import { Max, Min } from '@travetto/schema';
 export class TestCommand implements CliCommandShape {
 
   /** Output format for test results */
-  format: string = 'tap';
+  format: TestConsumerType = 'tap';
 
   /** Number of tests to run concurrently */
   @Min(1) @Max(WorkPool.MAX_SIZE)
@@ -30,7 +32,7 @@ export class TestCommand implements CliCommandShape {
    */
   formatOptions?: string[];
 
-  preMain(): void {
+  finalize(): void {
     EventEmitter.defaultMaxListeners = 1000;
     Env.TRV_ROLE.set('test');
     Env.DEBUG.set(false);
@@ -38,11 +40,6 @@ export class TestCommand implements CliCommandShape {
     Env.TRV_LOG_TIME.clear();
   }
 
-  async preValidate(): Promise<void> {
-    const { selectConsumer } = await import('./bin/run.ts');
-    await selectConsumer(this);
-  }
-
   async main(first: string = '**/*', globs: string[] = []): Promise<void> {
     const { runTests } = await import('./bin/run.ts');
 

package/support/cli.test_diff.ts

@@ -4,7 +4,7 @@ import { Env, JSONUtil, RuntimeIndex } from '@travetto/runtime';
 import { CliCommand, CliUtil } from '@travetto/cli';
 import { IsPrivate } from '@travetto/schema';
 
-import { runTests, selectConsumer } from './bin/run.ts';
+import { runTests, type TestConsumerType } from './bin/run.ts';
 import type { TestDiffSource } from '../src/model/test.ts';
 
 /**  Direct test invocation */
@@ -12,7 +12,8 @@ import type { TestDiffSource } from '../src/model/test.ts';
 @IsPrivate()
 export class TestDiffCommand {
 
-  format: string = 'tap';
+  /** Output format for test results */
+  format: TestConsumerType = 'tap';
 
   /**
    * Format options
@@ -20,10 +21,6 @@ export class TestDiffCommand {
    */
   formatOptions?: string[];
 
-  async preValidate(): Promise<void> {
-    await selectConsumer(this);
-  }
-
   preMain(): void {
     Env.TRV_ROLE.set('test');
     Env.TRV_LOG_PLAIN.set(true);

package/support/cli.test_direct.ts

@@ -2,14 +2,15 @@ import { Env, RuntimeIndex } from '@travetto/runtime';
 import { CliCommand, CliUtil } from '@travetto/cli';
 import { IsPrivate } from '@travetto/schema';
 
-import { runTests, selectConsumer } from './bin/run.ts';
+import { runTests, type TestConsumerType } from './bin/run.ts';
 
 /**  Direct test invocation */
 @CliCommand()
 @IsPrivate()
 export class TestDirectCommand {
 
-  format: string = 'tap';
+  /** Output format for test results */
+  format: TestConsumerType = 'tap';
 
   /**
    * Format options
@@ -17,10 +18,6 @@ export class TestDirectCommand {
    */
   formatOptions?: string[];
 
-  async preValidate(): Promise<void> {
-    await selectConsumer(this);
-  }
-
   preMain(): void {
     Env.TRV_ROLE.set('test');
     Env.TRV_LOG_PLAIN.set(true);

package/support/cli.test_watch.ts

@@ -1,7 +1,7 @@
 import { Env } from '@travetto/runtime';
 import { CliCommand } from '@travetto/cli';
 
-import { selectConsumer } from './bin/run.ts';
+import type { TestConsumerType } from './bin/run.ts';
 
 /**
  * Invoke the test watcher
@@ -9,12 +9,10 @@ import { selectConsumer } from './bin/run.ts';
 @CliCommand()
 export class TestWatcherCommand {
 
-  format: string = 'tap';
-  mode: 'all' | 'change' = 'all';
+  /** Output format for test results */
+  format: TestConsumerType = 'tap';
 
-  async preValidate(): Promise<void> {
-    await selectConsumer(this);
-  }
+  mode: 'all' | 'change' = 'all';
 
   preMain(): void {
     Env.TRV_ROLE.set('test');