jest-allure2-reporter/src/runtime/modules/CoreModule.ts

Idiomatic Jest reporter for Allure Framework

import type {
  LabelName,
  Link,
  Parameter,
  Primitive,
  Status,
  StatusDetails,
} from 'jest-allure2-reporter';

import type { AllureTestItemMetadataProxy } from '../../metadata';
import type { AllureRuntimeContext } from '../AllureRuntimeContext';

export type CoreModuleContext = {
  readonly metadata: AllureTestItemMetadataProxy;
};

export class CoreModule {
  constructor(protected readonly context: CoreModuleContext) {}

  static create(context: AllureRuntimeContext): CoreModule {
    return new CoreModule({
      get metadata() {
        return context.getCurrentMetadata();
      },
    });
  }

  // region Universal (test, hook, step) metadata

  displayName(value: string) {
    this.context.metadata.set('displayName', value);
  }

  parameter(parameter: Parameter) {
    this.context.metadata.push('parameters', [parameter]);
  }

  status(status: Status) {
    this.context.metadata.set('status', status);
  }

  statusDetails(statusDetails: StatusDetails) {
    this.context.metadata.set('statusDetails', statusDetails);
  }

  // endregion

  // region Test-only metadata

  description(value: string) {
    this.context.metadata.$bind(null).push('description', [value]);
  }

  descriptionHtml(value: string) {
    this.context.metadata.$bind(null).push('descriptionHtml', [value]);
  }

  fullName(value: string) {
    this.context.metadata.$bind(null).set('fullName', value);
  }

  historyId(value: Primitive) {
    this.context.metadata.$bind(null).set('historyId', value);
  }

  label(name: LabelName, value: string) {
    this.context.metadata.$bind(null).push('labels', [{ name, value }]);
  }

  link(link: Link) {
    this.context.metadata.$bind(null).push('links', [link]);
  }

  // endregion
}