@testomatio/reporter 2.0.1-beta.3 → 2.0.1-beta.5-timestamp

package/src/adapter/cucumber/legacy.js

@@ -1,158 +0,0 @@
-// import { Formatter } from 'cucumber';
-
-// import pc from 'picocolors';
-// import { getTestomatIdFromTestTitle, fileSystem } from '../../utils/utils.js';
-// import { STATUS, TESTOMAT_TMP_STORAGE_DIR } from '../../constants.js';
-// import TestomatClient from '../../client.js';
-// import {config} from '../../config.js';
-
-// const createTestomatFormatter = apiKey => {
-//   if (!apiKey || apiKey === '') {
-//     console.log(pc.red('TESTOMATIO key is empty, ignoring reports'));
-//   }
-
-//   const documents = {};
-//   const dataTableMap = {};
-
-//   const addDocument = gherkinDocument => {
-//     documents[gherkinDocument.uri] = gherkinDocument.document;
-//   };
-
-//   const getTitle = scenario => {
-//     let { name } = scenario;
-//     if (scenario.tags.length) {
-//       let tags = '';
-//       for (const tag of scenario.tags) {
-//         tags = `${tags} ${tag.name}`;
-//       }
-//       name = `${name}${tags}`;
-//     }
-//     return name;
-//   };
-
-//   const getFeature = uri => documents[uri].feature;
-
-//   const getScenario = location => {
-//     const { children } = getFeature(location.uri);
-//     for (const scenario of children) {
-//       if (scenario.type === 'Scenario' && scenario.location.line === location.line) {
-//         return scenario;
-//       }
-//       if (scenario.type === 'ScenarioOutline') {
-//         for (const example of scenario.examples) {
-//           for (const tableBody of example.tableBody) {
-//             if (tableBody.location.line === location.line) {
-//               return scenario;
-//             }
-//           }
-//         }
-//       }
-//     }
-
-//     return null;
-//   };
-
-//   const loadDataTable = (scenario, uri) => {
-//     if (scenario.type === 'ScenarioOutline') {
-//       for (const example of scenario.examples) {
-//         for (const tableBody of example.tableBody) {
-//           const dataMap = example.tableHeader.cells.reduce((acc, cell, index) => {
-//             acc[cell.value] = tableBody.cells[index].value;
-//             return acc;
-//           }, {});
-
-//           dataTableMap[`${uri}:${tableBody.location.line}`] = JSON.stringify(dataMap);
-//         }
-//       }
-//     }
-//   };
-
-//   const getDataTableMap = (scenario, sourceLocation) => {
-//     const key = `${sourceLocation.uri}:${sourceLocation.line}`;
-//     if (!dataTableMap[key]) {
-//       loadDataTable(scenario, sourceLocation.uri);
-//     }
-
-//     return dataTableMap[key] || '';
-//   };
-
-//   const getTestId = scenario => {
-//     if (scenario) {
-//       for (const tag of scenario.tags) {
-//         const testId = getTestomatIdFromTestTitle(tag.name);
-//         if (testId) return testId;
-//       }
-//     }
-
-//     return null;
-//   };
-
-//   return class TestomatFormatter extends Formatter {
-//     constructor(options) {
-//       super(options);
-
-//       if (!apiKey) return;
-
-//       this.client = new TestomatClient({ apiKey });
-//       this.status = STATUS.PASSED.toString();
-
-//       options.eventBroadcaster.on('gherkin-document', addDocument);
-//       options.eventBroadcaster.on('test-run-started', () => {
-//         fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-//         this?.client?.createRun();
-//       });
-//       options.eventBroadcaster.on('test-case-finished', this.onTestCaseFinished.bind(this));
-//       options.eventBroadcaster.on('test-case-started', this.onTestCaseStarted.bind(this));
-//       // @ts-ignore
-//       options.eventBroadcaster.on('test-run-finished', () => this?.client?.updateRunStatus(this.status));
-
-//       global.testomatioRunningEnvironment = 'cucumber:legacy';
-//     }
-
-//     onTestCaseStarted(event) {
-//       const scenario = getScenario(event.sourceLocation);
-//       const testId = getTestId(scenario);
-
-//       if (!global.testomatioDataStore) global.testomatioDataStore = {};
-//       global.testomatioDataStore.currentlyRunningTestId = testId;
-//     }
-
-//     onTestCaseFinished(event) {
-//       const scenario = getScenario(event.sourceLocation);
-//       const testId = getTestId(scenario);
-//       const status = event.result.status === 'undefined' ? STATUS.SKIPPED : event.result.status;
-
-//       let example = getDataTableMap(scenario, event.sourceLocation);
-//       if (example) example = JSON.parse(example);
-
-//       if (!scenario.name) return;
-
-//       const message = '';
-//       const cliMessage = `- ${scenario.name}: ${pc.bold(status.toUpperCase())}`;
-
-//       // if (event.result.status === 'undefined') {
-//       //   cliMessage += pc.yellow(
-//       //     ' (undefined steps. Run Cucumber without this formatter and implement missing steps)',
-//       //   );
-//       //   message = 'Undefined steps. Implement missing steps and rerun this scenario';
-//       // }
-//       console.log(cliMessage);
-//       if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
-//         this.status = STATUS.FAILED;
-//       }
-
-//       this.client?.addTestRun(status, {
-//         error: event.result.exception instanceof Error ? event.result.exception : undefined,
-//         message,
-//         example,
-//         test_id: testId,
-//         title: getTitle(scenario),
-//         suite_title: getTitle(getFeature(event.sourceLocation.uri)),
-//       });
-//     }
-//   };
-// };
-
-// const CucumberLegacyReporter = createTestomatFormatter(config.TESTOMATIO);
-// export { CucumberLegacyReporter };
-// export default CucumberLegacyReporter;

package/src/adapter/cucumber.js

@@ -1,4 +0,0 @@
-import { CucumberReporter } from './cucumber/current.js';
-// import { CucumberLegacyReporter } from './cucumber/legacy.js';
-
-export default CucumberReporter;

package/src/adapter/cypress-plugin/index.js

@@ -1,110 +0,0 @@
-import { STATUS } from '../../constants.js';
-import { getTestomatIdFromTestTitle, parseSuite } from '../../utils/utils.js';
-import TestomatClient from '../../client.js';
-import { config } from '../../config.js';
-
-const testomatioReporter = on => {
-  if (!config.TESTOMATIO) {
-    console.log('TESTOMATIO key is empty, ignoring reports');
-    return;
-  }
-  const client = new TestomatClient({ apiKey: config.TESTOMATIO });
-
-  on('before:run', async () => {
-    // TODO: looks like client.env does not exist
-    // if (!client.env) {
-    //   client.env = `${run.browser.displayName},${run.system.osName}`;
-    // }
-    await client.createRun();
-  });
-
-  on('after:spec', async (_spec, results) => {
-    const addSpecTestsPromises = [];
-
-    const videos = [results.video];
-
-    for (const test of results.tests) {
-      const lastAttemptIndex = test.attempts.length - 1;
-      const latestAttempt = test.attempts[lastAttemptIndex];
-
-      // latestAttempt.duration && latestAttempt.error were available in adapters version up to 13 JFYI
-      const time = latestAttempt.duration || latestAttempt.wallClockDuration || test.duration;
-      let error = latestAttempt.error;
-
-      let title = test.title.pop();
-      const examples = title.match(/\(example (#\d+)\)/);
-      let example = null;
-      if (examples && examples[1]) example = { example: examples[1] };
-      title = title.replace(/\(example #\d+\)/, '').trim();
-
-      const suiteTitle = test.title.pop();
-
-      const testId = getTestomatIdFromTestTitle(title);
-      const suiteId = parseSuite(suiteTitle);
-
-      if (!error && test.displayError) {
-        error = { message: test.displayError };
-        error.inspect = function () {
-          return this.message;
-        };
-      }
-
-      const formattedError = error
-        ? {
-            message: error.message,
-            name: error.name,
-            inspect:
-              error.inspect ||
-              function () {
-                return this.message;
-              },
-          }
-        : undefined;
-
-      const screenshots = Array.isArray(results.screenshots)
-        ? results.screenshots
-            .filter(screenshot => screenshot?.path && screenshot?.path.includes(title) && screenshot?.takenAt)
-            .map(screenshot => screenshot.path)
-        : [];
-
-      const files = [...videos, ...screenshots];
-
-      let state;
-      switch (test.state) {
-        case 'passed':
-          state = STATUS.PASSED;
-          break;
-        case 'failed':
-          state = STATUS.FAILED;
-          break;
-        case 'skipped':
-        case 'pending':
-        default:
-          state = STATUS.SKIPPED;
-      }
-
-      addSpecTestsPromises.push(
-        client.addTestRun(state, {
-          title,
-          time,
-          example,
-          error: formattedError,
-          files,
-          suite_title: suiteTitle,
-          test_id: testId,
-          suite_id: suiteId,
-        }),
-      );
-    }
-
-    await Promise.all(addSpecTestsPromises);
-  });
-
-  on('after:run', async results => {
-    const status = results.totalFailed ? STATUS.FAILED : STATUS.PASSED;
-    // @ts-ignore
-    await client.updateRunStatus(status);
-  });
-};
-
-export default testomatioReporter;

package/src/adapter/jasmine.js

@@ -1,60 +0,0 @@
-import TestomatClient from '../client.js';
-import { getTestomatIdFromTestTitle, ansiRegExp } from '../utils/utils.js';
-import { STATUS } from '../constants.js';
-
-class JasmineReporter {
-  constructor(options) {
-    this.testTimeMap = {};
-    this.client = new TestomatClient({ apiKey: options?.apiKey });
-    this.client.createRun();
-  }
-
-  getDuration(test) {
-    if (this.testTimeMap[test.id]) {
-      return Date.now() - this.testTimeMap[test.id];
-    }
-
-    return 0;
-  }
-
-  specStarted(result) {
-    this.testTimeMap[result.id] = Date.now();
-  }
-
-  specDone(result) {
-    if (!this.client) return;
-
-    const title = result.description;
-    const { status } = result;
-    let errorMessage = '';
-
-    for (let i = 0; i < result.failedExpectations.length; i += 1) {
-      errorMessage = `${errorMessage}Failure: ${result.failedExpectations[i].message}\n`;
-      errorMessage = `${errorMessage}\n ${result.failedExpectations[i].stack}`;
-    }
-    console.log(`${title} : ${STATUS.PASSED}`);
-    console.log(errorMessage);
-    const testId = getTestomatIdFromTestTitle(title);
-    errorMessage = errorMessage.replace(ansiRegExp(), '');
-    this.client.addTestRun(status, {
-      error: result.failedExpectations[0],
-      message: errorMessage,
-      test_id: testId,
-      title,
-      time: this.getDuration(result),
-    });
-  }
-
-  jasmineDone(suiteInfo, done) {
-    if (!this.client) return;
-
-    const { overallStatus } = suiteInfo;
-    const status = overallStatus === 'failed' ? STATUS.FAILED : STATUS.PASSED;
-
-    // @ts-ignore
-    this.client.updateRunStatus(status).then(() => done);
-  }
-}
-
-export { JasmineReporter };
-export default JasmineReporter;

package/src/adapter/jest.js

@@ -1,107 +0,0 @@
-import pc from 'picocolors';
-import TestomatClient from '../client.js';
-import { TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
-import { getTestomatIdFromTestTitle, ansiRegExp, fileSystem } from '../utils/utils.js';
-import { services } from '../services/index.js';
-import path from 'path';
-import createDebugMessages from 'debug';
-
-const debug = createDebugMessages('@testomatio/reporter:adapter-jest');
-
-export class JestReporter {
-  constructor(globalConfig, options) {
-    this._globalConfig = globalConfig;
-    this._options = options;
-
-    this.client = new TestomatClient({ apiKey: options?.apiKey });
-    this.client.createRun();
-  }
-
-  onRunStart() {
-    // clear tmp dir
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-  }
-
-  // start of test file (including beforeAll)
-  onTestStart(testFile) {
-    debug('Start running test file:', testFile.path);
-    services.setContext(testFile.path);
-  }
-
-  // start of the test (including beforeEach)
-  onTestCaseStart(test, testCase) {
-    debug('Start running test:', testCase.fullName);
-    services.setContext(testCase.fullName);
-  }
-
-  // end of test file! (there is also onTestCaseResult listener)
-  onTestResult(test, testResult) {
-    if (!this.client) return;
-
-    const { testResults } = testResult;
-    for (const result of testResults) {
-      let error;
-      let steps;
-      const { status, title, duration, failureMessages } = result;
-      if (failureMessages[0]) {
-        let errorMessage = failureMessages[0].replace(ansiRegExp(), '');
-        errorMessage = errorMessage.split('\n')[0];
-        error = new Error(errorMessage);
-        steps = failureMessages[0];
-      }
-      const testId = getTestomatIdFromTestTitle(title);
-
-      // suite titles from most outer to most inner, separated by space
-      let fullSuiteTitle = testResult.ancestorTitles?.join(' ');
-      // if no suite titles, use file name
-      if (!fullSuiteTitle && testResult.testFilePath) fullSuiteTitle = path.basename(testResult.testFilePath);
-
-      const logs = getTestLogs(result);
-      const artifacts = services.artifacts.get(result.fullName);
-      const keyValues = services.keyValues.get(result.fullName);
-
-      const deducedStatus = status === 'pending' ? 'skipped' : status;
-      // In jest if test is not matched with test name pattern it is considered as skipped.
-      // So adding a check if it is skipped for real or because of test pattern
-      if (!this._globalConfig.testNamePattern || deducedStatus !== 'skipped') {
-        this.client.addTestRun(deducedStatus, {
-          test_id: testId,
-          suite_title: fullSuiteTitle,
-          error,
-          steps,
-          title,
-          time: duration,
-          logs,
-          manuallyAttachedArtifacts: artifacts,
-          meta: keyValues,
-        });
-      }
-    }
-  }
-
-  onRunComplete(contexts, results) {
-    if (!this.client) return;
-
-    const { numFailedTests } = results;
-    const status = numFailedTests === 0 ? 'passed' : 'failed';
-    this.client.updateRunStatus(status);
-  }
-}
-
-function getTestLogs(testResult) {
-  const suiteLogsArr = services.logger.getLogs(testResult.testFilePath);
-  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
-  const testLogsArr = services.logger.getLogs(testResult.fullName);
-  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
-
-  let logs = '';
-  if (suiteLogs) {
-    logs += `${pc.bold('\t--- Suite ---')}\n${suiteLogs}`;
-  }
-  if (testLogs) {
-    logs += `\n${pc.bold('\t--- Test ---')}\n${testLogs}`;
-  }
-  return logs;
-}
-
-export default JestReporter;

package/src/adapter/mocha.cjs

@@ -1,2 +0,0 @@
-const MochaReporter = require('../../../lib/adapter/mocha.js');
-module.exports = MochaReporter;

package/src/adapter/mocha.js

@@ -1,156 +0,0 @@
-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());
-
-    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,
-    });
-  });
-
-  runner.on(EVENT_TEST_PENDING, test => {
-    skipped += 1;
-    console.log('skip: %s', test.fullTitle());
-    const testId = getTestomatIdFromTestTitle(test.title);
-    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,
-    });
-  });
-
-  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);
-
-    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,
-    });
-  });
-
-  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;

package/src/adapter/nightwatch.js

@@ -1,88 +0,0 @@
-import TestomatClient from '../client.js';
-import { config } from '../config.js';
-import { STATUS } from '../constants.js';
-import { getTestomatIdFromTestTitle } from '../utils/utils.js';
-
-const apiKey = config.TESTOMATIO;
-const client = new TestomatClient({ apiKey });
-
-export default {
-  write: async (results, options, done) => {
-    await client.createRun();
-
-    const testFiles = results.modules;
-
-    for (const fileName in testFiles) {
-      // in nightwatch: object containing tests from a single file
-      const testModule = testFiles[fileName];
-
-      // passed and failed tests (tests with assertions)
-      const completedTests = testModule.completed;
-
-      // skipped tests (skipped by user or tests without assertions)
-      const skippedTests = testModule.skipped;
-
-      const tags = testModule.tags || [];
-
-      // if test file contains multiple suites, the last suite name is used as a name 🤷‍♂️
-      // no other places which contain suite name (even inside test object)
-      const suiteTitle = testModule.name;
-
-      for (const testTitle in completedTests) {
-        const test = completedTests[testTitle];
-        let status;
-        switch (test.status) {
-          case 'pass':
-            status = STATUS.PASSED;
-            break;
-          case 'fail':
-            status = STATUS.FAILED;
-            break;
-          // probably not required (because skipped tests are in separate array), but just in case
-          case 'skip':
-            status = STATUS.SKIPPED;
-            console.info('Skipped test is in completed tests array:', test, 'Not expected behavior.');
-            break;
-          default:
-            console.error('Test status processing error:', test.status);
-        }
-
-        const testId = getTestomatIdFromTestTitle(testTitle);
-
-        client.addTestRun(status, {
-          error: { name: test.assertions?.[0]?.name, message: test.assertions?.[0]?.message, stack: test.stackTrace },
-          file: testModule.modulePath?.replace(process.cwd(), ''),
-          message: test.assertions?.[0]?.message,
-          rid: `${testModule.uuid || ''}_${testTitle || ''}`,
-          stack: test.stackTrace,
-          suite_title: suiteTitle,
-          tags,
-          test_id: testId,
-          time: test.timeMs,
-          title: testTitle,
-        });
-      }
-
-      // just array with skipped tests titles, no any other info
-      for (const testTitle of skippedTests) {
-        client.addTestRun(STATUS.SKIPPED, {
-          suite_title: suiteTitle,
-          tags,
-          rid: `${testModule.uuid || ''}_${testTitle || ''}`,
-          title: testTitle,
-        });
-      }
-    }
-
-    /**
-     * @type {'passed' | 'failed' | 'finished'}
-     */
-    let runStatus = 'finished';
-    if (results.failed) runStatus = 'failed';
-    else if (results.passed) runStatus = 'passed';
-
-    await client.updateRunStatus(runStatus);
-
-    done();
-  },
-};