creevey/src/server/reporters/teamcity.ts

Cross-browser screenshot testing tool for Storybook with fancy UI Runner

import { FakeTest, Images, isDefined, TEST_EVENTS } from '../../types.js';
import EventEmitter from 'events';

export class TeamcityReporter {
  constructor(runner: EventEmitter, options: { reportDir: string }) {
    const { reportDir } = options;

    console.log("##teamcity[testRetrySupport enabled='true']");

    runner.on(TEST_EVENTS.TEST_BEGIN, (test: FakeTest) => {
      const flowId = test.creevey.workerId;
      const [testName, ...testPath] = test
        .titlePath()
        .map((title: string) => this.escape(title))
        .reverse();

      for (const title of testPath.reverse()) {
        console.log(`##teamcity[testSuiteStarted name='${title}' flowId='${flowId}']`);
      }
      console.log(`##teamcity[testStarted name='${testName}' flowId='${flowId}']`);
    });

    runner.on(TEST_EVENTS.TEST_PASS, (test: FakeTest) => {
      const flowId = test.creevey.workerId;
      const [testName, ...testPath] = test
        .titlePath()
        .map((title: string) => this.escape(title))
        .reverse();
      const duration = test.duration ?? 0;
      console.log(`##teamcity[testFinished name='${testName}' flowId='${flowId}' duration='${duration}']`);
      for (const title of testPath.reverse()) {
        console.log(`##teamcity[testSuiteFinished name='${title}' flowId='${flowId}']`);
      }
    });

    runner.on(TEST_EVENTS.TEST_FAIL, (test: FakeTest, error: Error) => {
      const flowId = test.creevey.workerId;
      const duration = test.duration ?? 0;
      const [testName, ...testPath] = test
        .titlePath()
        .map((title: string) => this.escape(title))
        .reverse();
      const browserName = this.escape(test.creevey.browserName);
      const messageStr = error instanceof Error ? error.message : String(error);
      const detailsStr = error instanceof Error ? (error.stack ?? '') : '';
      Object.entries(test.creevey.images).forEach(([name, image]) => {
        if (!image) return;
        const filePath = test
          .titlePath()
          .slice(0, -1)
          .concat(name == browserName ? [] : [browserName])
          .map(this.escape)
          .join('/');

        const { error: _, ...rest } = image;
        Object.values(rest as Partial<Images>)
          .filter(isDefined)
          .forEach((fileName) => {
            console.log(`##teamcity[publishArtifacts '${reportDir}/${filePath}/${fileName} => report/${filePath}']`);
            console.log(
              `##teamcity[testMetadata type='image' value='report/${filePath}/${fileName}' flowId='${flowId}']`,
            );
          });
      });

      console.log(
        `##teamcity[testFailed name='${testName}' message='${this.escape(
          messageStr,
        )}' details='${this.escape(detailsStr)}' flowId='${flowId}' duration='${duration}']`,
      );
      console.log(`##teamcity[testFinished name='${testName}' flowId='${flowId}' duration='${duration}']`);
      for (const title of testPath.reverse()) {
        console.log(`##teamcity[testSuiteFinished name='${title}' flowId='${flowId}']`);
      }
    });
  }

  private escape = (str: string): string => {
    if (!str) return '';
    return (
      str
        .toString()
        // Remove ANSI SGR color sequences
        .replace(new RegExp(String.fromCharCode(27) + '\\[[0-9;]*m', 'g'), '')
        // TeamCity escapes
        .replace(/\|/g, '||')
        .replace(/\n/g, '|n')
        .replace(/\r/g, '|r')
        .replace(/\[/g, '|[')
        .replace(/\]/g, '|]')
        .replace(/\u0085/g, '|x')
        .replace(/\u2028/g, '|l')
        .replace(/\u2029/g, '|p')
        .replace(/'/g, "|'")
    );
  };
}