jest-allure2-reporter/src/options/default/testFile.ts

Idiomatic Jest reporter for Allure Framework

import path from 'node:path';

import type { TestCaseCustomizer, TestFileExtractorContext } from 'jest-allure2-reporter';

import { getStatusDetails } from '../../utils';
import * as custom from '../custom';
import { compose2 } from '../common';

export const testFile: TestCaseCustomizer<TestFileExtractorContext> = {
  ignored: ({ testFile }) => !testFile.testExecError,
  historyId: ({ testFileMetadata, result }) => testFileMetadata.historyId ?? result.fullName,
  displayName: ({ testFileMetadata, filePath }) =>
    testFileMetadata.displayName ?? filePath.join(path.sep),
  fullName: ({ filePath }) => filePath.join('/'),
  description: ({ testFileMetadata }) => testFileMetadata.description?.join('\n\n') ?? '',
  descriptionHtml: ({ testFileMetadata }) => testFileMetadata.descriptionHtml?.join('\n') ?? '',
  start: ({ testFileMetadata }) => testFileMetadata.start!,
  stop: ({ testFileMetadata }) => testFileMetadata.stop!,
  stage: ({ testFileMetadata, testFile }) =>
    testFileMetadata.stage ?? (testFile.testExecError == null ? 'finished' : 'interrupted'),
  status: ({ testFileMetadata, testFile }) => testFileMetadata.status ?? getStatus(testFile),
  statusDetails: ({ $, testFile, testFileMetadata }) =>
    testFileMetadata.statusDetails ?? $.stripAnsi(getStatusDetails(testFile.testExecError)),
  attachments: ({ testFileMetadata }) => testFileMetadata.attachments ?? [],
  parameters: ({ testFileMetadata }) => testFileMetadata.parameters ?? [],
  labels: compose2(
    custom.labels<TestFileExtractorContext>({
      suite: '(test file execution)',
    }),
    ({ testFileMetadata }) => testFileMetadata.labels ?? [],
  ),
  links: ({ testFileMetadata }) => testFileMetadata.links ?? [],
};

function getStatus(testFile: TestFileExtractorContext['testFile']) {
  if (testFile.testExecError != null) {
    return 'broken';
  }

  return testFile.numFailingTests > 0 ? 'failed' : 'passed';
}