@travetto/test/src/decorator/test.ts

Declarative test framework

import { type ClassInstance, getClass } from '@travetto/runtime';

import type { TestConfig, ThrowableError } from '../model/test.ts';
import { SuiteRegistryIndex } from '../registry/registry-index.ts';

type MethodDecorator = (instance: ClassInstance, property: string, descriptor: PropertyDescriptor) => PropertyDescriptor | void;

/**
 * The `@AssertCheck` indicates that a function's assert calls should be transformed
 * @augments `@travetto/test:AssertCheck`
 * @kind decorator
 */
export function AssertCheck(): MethodDecorator {
  return (instance: ClassInstance, property: string, descriptor: PropertyDescriptor) => descriptor;
}

/**
 * The `@Test` decorator register a test to be run as part of the enclosing suite.
 * @param description The test description
 * @augments `@travetto/schema:Method`
 * @augments `@travetto/test:AssertCheck`
 * @augments `@travetto/runtime:DebugBreak`
 * @kind decorator
 */
export function Test(): MethodDecorator;
export function Test(...rest: Partial<TestConfig>[]): MethodDecorator;
export function Test(description: string, ...rest: Partial<TestConfig>[]): MethodDecorator;
export function Test(description?: string | Partial<TestConfig>, ...rest: Partial<TestConfig>[]): MethodDecorator {
  return (instance: ClassInstance, property: string, descriptor: PropertyDescriptor) => {
    SuiteRegistryIndex.getForRegister(getClass(instance)).registerTest(property, descriptor.value,
      ...(typeof description !== 'string' && description) ? [description] : [],
      ...rest,
      ...(typeof description === 'string') ? [{ description }] : []
    );
    return descriptor;
  };
}

/**
 * Marks a method as should throw to indicate a lack of throwing is a problem
 * @param state The parameters to use for checking if the response is valid
 * @kind decorator
 */
export function ShouldThrow(state: ThrowableError): MethodDecorator {
  return (instance: ClassInstance, property: string, descriptor: PropertyDescriptor) => {
    SuiteRegistryIndex.getForRegister(getClass(instance)).registerTest(property, descriptor.value, { shouldThrow: state });
    return descriptor;
  };
}

/**
 * Sets the full timeout window for a given test
 * @param ms Max time to wait
 * @kind decorator
 */
export function Timeout(ms: number): MethodDecorator {
  return (instance: ClassInstance, property: string, descriptor: PropertyDescriptor) => {
    SuiteRegistryIndex.getForRegister(getClass(instance)).registerTest(property, descriptor.value, { timeout: ms });
    return descriptor;
  };
}