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

package/lib/adapter/jest.js

@@ -1,103 +1,105 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JestReporter = void 0;
-const picocolors_1 = __importDefault(require("picocolors"));
-const client_js_1 = __importDefault(require("../client.js"));
-const constants_js_1 = require("../constants.js");
-const utils_js_1 = require("../utils/utils.js");
-const index_js_1 = require("../services/index.js");
-const path_1 = __importDefault(require("path"));
-const debug_1 = __importDefault(require("debug"));
-const debug = (0, debug_1.default)('@testomatio/reporter:adapter-jest');
+const chalk = require('chalk');
+const TestomatClient = require('../client');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
+const { getTestomatIdFromTestTitle, ansiRegExp, fileSystem } = require('../utils/utils');
+const { services } = require('../services');
+const debug = require('debug')('@testomatio/reporter:adapter-jest');
+const path = require('path');
+
 class JestReporter {
-    constructor(globalConfig, options) {
-        this._globalConfig = globalConfig;
-        this._options = options;
-        this.client = new client_js_1.default({ apiKey: options?.apiKey });
-        this.client.createRun();
-    }
-    onRunStart() {
-        // clear tmp dir
-        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
-    }
-    // start of test file (including beforeAll)
-    onTestStart(testFile) {
-        debug('Start running test file:', testFile.path);
-        index_js_1.services.setContext(testFile.path);
-    }
-    // start of the test (including beforeEach)
-    onTestCaseStart(test, testCase) {
-        debug('Start running test:', testCase.fullName);
-        index_js_1.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((0, utils_js_1.ansiRegExp)(), '');
-                errorMessage = errorMessage.split('\n')[0];
-                error = new Error(errorMessage);
-                steps = failureMessages[0];
-            }
-            const testId = (0, utils_js_1.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_1.default.basename(testResult.testFilePath);
-            const logs = getTestLogs(result);
-            const artifacts = index_js_1.services.artifacts.get(result.fullName);
-            const keyValues = index_js_1.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);
+  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 ? STATUS.PASSED : STATUS.FAILED;
+    this.client.updateRunStatus(status);
+  }
 }
-exports.JestReporter = JestReporter;
+
 function getTestLogs(testResult) {
-    const suiteLogsArr = index_js_1.services.logger.getLogs(testResult.testFilePath);
-    const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
-    const testLogsArr = index_js_1.services.logger.getLogs(testResult.fullName);
-    const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
-    let logs = '';
-    if (suiteLogs) {
-        logs += `${picocolors_1.default.bold('\t--- Suite ---')}\n${suiteLogs}`;
-    }
-    if (testLogs) {
-        logs += `\n${picocolors_1.default.bold('\t--- Test ---')}\n${testLogs}`;
-    }
-    return logs;
+  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 += `${chalk.bold('\t--- Suite ---')}\n${suiteLogs}`;
+  }
+  if (testLogs) {
+    logs += `\n${chalk.bold('\t--- Test ---')}\n${testLogs}`;
+  }
+  return logs;
 }
-module.exports = JestReporter;
 
-module.exports.JestReporter = JestReporter;
+module.exports = JestReporter;

package/lib/adapter/mocha.js

@@ -1,125 +1,154 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const mocha_1 = __importDefault(require("mocha"));
-const client_js_1 = __importDefault(require("../client.js"));
-const constants_js_1 = require("../constants.js");
-const utils_js_1 = require("../utils/utils.js");
-const config_js_1 = require("../config.js");
-const index_js_1 = require("../services/index.js");
-const picocolors_1 = __importDefault(require("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_1.default.Runner.constants;
+// eslint-disable-next-line global-require, import/no-extraneous-dependencies
+const Mocha = require('mocha');
+const chalk = require('chalk');
+const TestomatClient = require('../client');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
+const { getTestomatIdFromTestTitle, fileSystem } = require('../utils/utils');
+const config = require('../config');
+const { services } = require('../services');
+
+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_1.default.reporters.Base.call(this, runner);
-    let passes = 0;
-    let failures = 0;
-    let skipped = 0;
-    // let artifactStore;
-    const apiKey = opts?.reporterOptions?.apiKey || config_js_1.config.TESTOMATIO;
-    const client = new client_js_1.default({ apiKey });
-    runner.on(EVENT_RUN_BEGIN, () => {
-        client.createRun();
-        // clear dir with artifacts/logs
-        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
+  Mocha.reporters.Base.call(this, runner);
+  let passes = 0;
+  let failures = 0;
+  let skipped = 0;
+
+  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(chalk.bold.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_SUITE_BEGIN, async (suite) => {
-        index_js_1.services.setContext(suite.fullTitle());
+  });
+
+  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_SUITE_END, async () => {
-        index_js_1.services.setContext(null);
-    });
-    runner.on(EVENT_TEST_BEGIN, async (test) => {
-        index_js_1.services.setContext(test.fullTitle());
-    });
-    runner.on(EVENT_TEST_END, async () => {
-        index_js_1.services.setContext(null);
-    });
-    runner.on(EVENT_TEST_PASS, async (test) => {
-        passes += 1;
-        console.log(picocolors_1.default.bold(picocolors_1.default.green('✔')), test.fullTitle());
-        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        const logs = getTestLogs(test);
-        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
-        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
-        client.addTestRun(constants_js_1.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 = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        client.addTestRun(constants_js_1.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(picocolors_1.default.bold(picocolors_1.default.red('✖')), test.fullTitle(), picocolors_1.default.gray(err.message));
-        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        const logs = getTestLogs(test);
-        client.addTestRun(constants_js_1.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 ? constants_js_1.STATUS.PASSED : constants_js_1.STATUS.FAILED;
-        console.log(picocolors_1.default.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
-        // @ts-ignore
-        client.updateRunStatus(status);
+  });
+
+  runner.on(EVENT_TEST_FAIL, async (test, err) => {
+    failures += 1;
+    console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.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(chalk.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
+    client.updateRunStatus(status);
+  });
 }
+
 function getTestLogs(test) {
-    const suiteLogsArr = index_js_1.services.logger.getLogs(test.parent.fullTitle());
-    const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
-    const testLogsArr = index_js_1.services.logger.getLogs(test.fullTitle());
-    const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
-    let logs = '';
-    if (suiteLogs) {
-        logs += `${picocolors_1.default.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
-    }
-    if (testLogs) {
-        logs += `\n${picocolors_1.default.bold('\t--- Test ---')}\n${testLogs}`;
-    }
-    return logs;
+  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 += `${chalk.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
+  }
+  if (testLogs) {
+    logs += `\n${chalk.bold('\t--- Test ---')}\n${testLogs}`;
+  }
+  return logs;
 }
+
+// To have this reporter "extend" a built-in reporter uncomment the following line:
+Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);
+
+module.exports = MochaReporter;
+
 function getSuiteTitle(test, pathArr = []) {
-    if (test.parent.parent)
-        getSuiteTitle(test.parent, pathArr);
-    pathArr.push(test.parent.title);
-    return pathArr.filter(t => !!t)[0];
+  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(), '');
+  return test.parent.file?.replace(process.cwd(), '');
 }
+
 function getTestName(test) {
-    if (process.env.TESTOMATIO_CREATE === 'fulltitle')
-        return test.fullTitle();
-    return test.title;
+  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_1.default.utils.inherits(MochaReporter, mocha_1.default.reporters.Spec);
-module.exports = MochaReporter;