@testomatio/reporter/src/adapter/mocha.js

Testomatio Reporter Client

import Mocha from 'mocha';
import TestomatClient from '../client.js';
import { STATUS, TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
import { config } from '../config.js';
import { services } from '../services/index.js';
import pc from 'picocolors';

const {
  EVENT_RUN_BEGIN,
  EVENT_RUN_END,
  EVENT_TEST_FAIL,
  EVENT_TEST_PASS,
  EVENT_TEST_PENDING,
  EVENT_SUITE_BEGIN,
  EVENT_SUITE_END,
  EVENT_TEST_BEGIN,
  EVENT_TEST_END,
} = Mocha.Runner.constants;

function MochaReporter(runner, opts) {
  Mocha.reporters.Base.call(this, runner);
  let passes = 0;
  let failures = 0;
  let skipped = 0;
  // let artifactStore;

  const apiKey = opts?.reporterOptions?.apiKey || config.TESTOMATIO;

  const client = new TestomatClient({ apiKey });

  runner.on(EVENT_RUN_BEGIN, () => {
    client.createRun();

    // clear dir with artifacts/logs
    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
  });

  runner.on(EVENT_SUITE_BEGIN, async suite => {
    services.setContext(suite.fullTitle());
  });

  runner.on(EVENT_SUITE_END, async () => {
    services.setContext(null);
  });

  runner.on(EVENT_TEST_BEGIN, async test => {
    services.setContext(test.fullTitle());
  });

  runner.on(EVENT_TEST_END, async () => {
    services.setContext(null);
  });

  runner.on(EVENT_TEST_PASS, async test => {
    passes += 1;

    console.log(pc.bold(pc.green('✔')), test.fullTitle());
    const testId = getTestomatIdFromTestTitle(test.title);

    const logs = getTestLogs(test);
    const artifacts = services.artifacts.get(test.fullTitle());
    const keyValues = services.keyValues.get(test.fullTitle());
    const links = services.links.get(test.fullTitle());

    client.addTestRun(STATUS.PASSED, {
      test_id: testId,
      suite_title: getSuiteTitle(test),
      title: getTestName(test),
      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
      file: getFile(test),
      time: test.duration,
      logs,
      manuallyAttachedArtifacts: artifacts,
      meta: keyValues,
      links,
    });
  });

  runner.on(EVENT_TEST_PENDING, test => {
    skipped += 1;
    console.log('skip: %s', test.fullTitle());
    const testId = getTestomatIdFromTestTitle(test.title);
    const artifacts = services.artifacts.get(test.fullTitle());
    const keyValues = services.keyValues.get(test.fullTitle());
    const links = services.links.get(test.fullTitle());
    
    client.addTestRun(STATUS.SKIPPED, {
      title: getTestName(test),
      suite_title: getSuiteTitle(test),
      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
      file: getFile(test),
      test_id: testId,
      time: test.duration,
      manuallyAttachedArtifacts: artifacts,
      meta: keyValues,
      links,
    });
  });

  runner.on(EVENT_TEST_FAIL, async (test, err) => {
    failures += 1;
    console.log(pc.bold(pc.red('✖')), test.fullTitle(), pc.gray(err.message));
    const testId = getTestomatIdFromTestTitle(test.title);

    const logs = getTestLogs(test);
    const artifacts = services.artifacts.get(test.fullTitle());
    const keyValues = services.keyValues.get(test.fullTitle());
    const links = services.links.get(test.fullTitle());

    client.addTestRun(STATUS.FAILED, {
      error: err,
      suite_title: getSuiteTitle(test),
      file: getFile(test),
      test_id: testId,
      title: getTestName(test),
      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
      time: test.duration,
      logs,
      manuallyAttachedArtifacts: artifacts,
      meta: keyValues,
      links,
    });
  });

  runner.on(EVENT_RUN_END, () => {
    const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
    console.log(pc.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
    // @ts-ignore
    client.updateRunStatus(status);
  });
}

function getTestLogs(test) {
  const suiteLogsArr = services.logger.getLogs(test.parent.fullTitle());
  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
  const testLogsArr = services.logger.getLogs(test.fullTitle());
  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';

  let logs = '';
  if (suiteLogs) {
    logs += `${pc.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
  }
  if (testLogs) {
    logs += `\n${pc.bold('\t--- Test ---')}\n${testLogs}`;
  }
  return logs;
}

function getSuiteTitle(test, pathArr = []) {
  if (test.parent.parent) getSuiteTitle(test.parent, pathArr);

  pathArr.push(test.parent.title);

  return pathArr.filter(t => !!t)[0];
}

function getFile(test) {
  return test.parent.file?.replace(process.cwd(), '');
}

function getTestName(test) {
  if (process.env.TESTOMATIO_CREATE === 'fulltitle') return test.fullTitle();
  return test.title;
}

// To have this reporter "extend" a built-in reporter uncomment the following line:
// @ts-ignore
Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);

export default MochaReporter;