@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/lib/adapter/vitest.js

@@ -1,122 +1,123 @@
-const chalk = require('chalk');
-const { TestomatioClient } = require('../client');
-const { STATUS } = require('../constants');
-const { getTestomatIdFromTestTitle } = require('../utils/utils');
-const debug = require('debug')('@testomatio/reporter:adapter:vitest');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VitestReporter = void 0;
+const picocolors_1 = __importDefault(require("picocolors"));
+const client_js_1 = require("../client.js");
+const constants_js_1 = require("../constants.js");
+const utils_js_1 = require("../utils/utils.js");
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('@testomatio/reporter:adapter-jest');
 /**
- * @typedef {import('../../types').VitestTest} VitestTest
- * @typedef {import('../../types').VitestTestFile} VitestTestFile
- * @typedef {import('../../types').VitestSuite} VitestSuite
- * @typedef {import('../../types').VitestTestLogs} VitestTestLogs
- * @typedef {import('../../vitest.types').ErrorWithDiff} ErrorWithDiff
- * @typedef {typeof import('../constants').STATUS} STATUS
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').VitestTest} VitestTest
+ * @typedef {import('../../types/types.js').VitestTestFile} VitestTestFile
+ * @typedef {import('../../types/types.js').VitestSuite} VitestSuite
+ * @typedef {import('../../types/types.js').VitestTestLogs} VitestTestLogs
+ * @typedef {import('../../types/vitest.types.js').ErrorWithDiff} ErrorWithDiff
+ * @typedef {typeof import('../constants.js').STATUS} STATUS
+ * @typedef {import('../../types/types.js').TestData} TestData
  */
-
 class VitestReporter {
-  constructor(config = {}) {
-    this.client = new TestomatioClient({ apiKey: config?.apiKey });
+    constructor(config = {}) {
+        this.client = new client_js_1.Client({ apiKey: config?.apiKey });
+        /**
+         * @type {(TestData & {status: string})[]} tests
+         */
+        this.tests = [];
+    }
+    // on run start
+    onInit() {
+        this.client.createRun();
+    }
     /**
-     * @type {(TestData & {status: string})[]} tests
+     * @param {VitestTestFile[] | undefined} files // array with results;
+     * @param {unknown[] | undefined} errors // errors does not contain errors from tests; probably its testrunner errors
      */
-    this.tests = [];
-  }
-
-  // on run start
-  onInit() {
-    this.client.createRun();
-  }
-
-  /**
-   * @param {VitestTestFile[] | undefined} files // array with results;
-   * @param {unknown[] | undefined} errors // errors does not contain errors from tests; probably its testrunner errors
-   */
-  async onFinished(files, errors) {
-    if (!files || !files.length) console.info('No tests executed');
-
-    files.forEach(file => {
-      // task could be test or suite
-      file.tasks.forEach(taskOrSuite => {
-        if (taskOrSuite.type === 'test') {
-          const test = taskOrSuite;
-          this.tests.push(this.#getDataFromTest(test));
-        } else if (taskOrSuite.type === 'suite') {
-          const suite = taskOrSuite;
-          this.#processTasksOfSuite(suite);
-        } else {
-          throw new Error('Unprocessed case. Unknown task type');
+    async onFinished(files, errors) {
+        if (!files || !files.length)
+            console.info('No tests executed');
+        files.forEach(file => {
+            // task could be test or suite
+            file.tasks.forEach(taskOrSuite => {
+                if (taskOrSuite.type === 'test') {
+                    const test = taskOrSuite;
+                    this.tests.push(this.#getDataFromTest(test));
+                }
+                else if (taskOrSuite.type === 'suite') {
+                    const suite = taskOrSuite;
+                    this.#processTasksOfSuite(suite);
+                }
+                else {
+                    throw new Error('Unprocessed case. Unknown task type');
+                }
+            });
+        });
+        debug(this.tests.length, 'tests collected');
+        // send tests to Testomat.io
+        for (const test of this.tests) {
+            await this.client.addTestRun(test.status, test);
         }
-      });
-    });
-
-    debug(this.tests.length, 'tests collected');
-
-    // send tests to Testomat.io
-    for (const test of this.tests) {
-      await this.client.addTestRun(test.status, test);
+        console.log('finished');
+        if (errors.length)
+            console.error('Vitest adapter errors:', errors);
+        await this.client.updateRunStatus(getRunStatusFromResults(files));
+    }
+    /* non-used listeners
+    onUserConsoleLog(log) {}
+    onPathsCollected(paths) {} // paths array to files with tests
+    onCollected(files) {} // files array with tests (but without results)
+    onTaskUpdate(packs) {} // some updates come here on afterAll block execution
+    onTestRemoved(trigger) {}
+    onWatcherStart(files, errors) {}
+    onWatcherRerun(files, trigger) {}
+    onServerRestart(reason) {}
+    onProcessTimeout() {}
+    */
+    /**
+     * Recursively gets all tasks from suite and pushes them to "tests" array
+     *
+     * @param {VitestSuite} suite
+     */
+    #processTasksOfSuite(suite) {
+        suite.tasks.forEach(taskOrSuite => {
+            if (taskOrSuite.type === 'test') {
+                const test = taskOrSuite;
+                this.tests.push(this.#getDataFromTest(test));
+            }
+            else if (taskOrSuite.type === 'suite') {
+                const theSuite = taskOrSuite;
+                this.#processTasksOfSuite(theSuite);
+            }
+            else {
+                throw new Error('Unprocessed case. Unknown task type');
+            }
+        });
+    }
+    /**
+     * Processes task and returns test data ready to be sent to Testomat.io
+     *
+     * @param {VitestTest} test
+     *
+     * @returns {TestData & {status: string}}
+     */
+    #getDataFromTest(test) {
+        return {
+            error: test.result?.errors ? test.result.errors[0] : undefined,
+            file: test.file.name,
+            logs: test.logs ? transformLogsToString(test.logs) : '',
+            meta: test.meta,
+            status: getTestStatus(test),
+            suite_title: test.suite.name || test.file?.name,
+            test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(test.name),
+            time: test.result?.duration || 0,
+            title: test.name,
+            // testomatio functions (artifacts, logs, steps, meta) are not supported
+        };
     }
-
-    console.log('finished');
-    if (errors.length) console.error('Vitest adapter errors:', errors);
-
-    await this.client.updateRunStatus(getRunStatusFromResults(files));
-  }
-
-  /* non-used listeners
-  onUserConsoleLog(log) {}
-  onPathsCollected(paths) {} // paths array to files with tests
-  onCollected(files) {} // files array with tests (but without results)
-  onTaskUpdate(packs) {} // some updates come here on afterAll block execution
-  onTestRemoved(trigger) {}
-  onWatcherStart(files, errors) {}
-  onWatcherRerun(files, trigger) {}
-  onServerRestart(reason) {}
-  onProcessTimeout() {}
-  */
-
-  /**
-   * Recursively gets all tasks from suite and pushes them to "tests" array
-   *
-   * @param {VitestSuite} suite
-   */
-  #processTasksOfSuite(suite) {
-    suite.tasks.forEach(taskOrSuite => {
-      if (taskOrSuite.type === 'test') {
-        const test = taskOrSuite;
-        this.tests.push(this.#getDataFromTest(test));
-      } else if (taskOrSuite.type === 'suite') {
-        const theSuite = taskOrSuite;
-        this.#processTasksOfSuite(theSuite);
-      } else {
-        throw new Error('Unprocessed case. Unknown task type');
-      }
-    });
-  }
-
-  /**
-   * Processes task and returns test data ready to be sent to Testomat.io
-   *
-   * @param {VitestTest} test
-   *
-   * @returns {TestData & {status: string}}
-   */
-  #getDataFromTest(test) {
-    return {
-      error: test.result?.errors ? test.result.errors[0] : undefined,
-      file: test.file.name,
-      logs: test.logs ? transformLogsToString(test.logs) : '',
-      meta: test.meta,
-      status: getTestStatus(test),
-      suite_title: test.suite.name || test.file?.name,
-      test_id: getTestomatIdFromTestTitle(test.name),
-      time: test.result?.duration || 0,
-      title: test.name,
-      // testomatio functions (artifacts, logs, steps, meta) are not supported
-    };
-  }
 }
-
+exports.VitestReporter = VitestReporter;
 /**
  * Returns run status based on test results
  *
@@ -124,32 +125,28 @@ class VitestReporter {
  * @returns {'passed' | 'failed' | 'finished'}
  */
 function getRunStatusFromResults(files) {
-  /**
-   * @type {'passed' | 'failed' | 'finished'}
-   */
-  let status = 'finished'; // default status (if no failed or passed tests)
-
-  files.forEach(file => {
-    // search for failed tests
-    file.tasks.forEach(taskOrSuite => {
-      if (taskOrSuite.result?.state === 'fail') {
-        status = 'failed'; // set status to failed if any test failed
-      }
-    });
-
-    // if there are no failed tests > search for passed tests
-    if (status !== 'failed') {
-      file.tasks.forEach(taskOrSuite => {
-        if (taskOrSuite.result?.state === 'pass') {
-          status = 'passed'; // set status to passed if any test passed (and there are no failed tests)
+    /**
+     * @type {'passed' | 'failed' | 'finished'}
+     */
+    let status = 'finished'; // default status (if no failed or passed tests)
+    files.forEach(file => {
+        // search for failed tests
+        file.tasks.forEach(taskOrSuite => {
+            if (taskOrSuite.result?.state === 'fail') {
+                status = 'failed'; // set status to failed if any test failed
+            }
+        });
+        // if there are no failed tests > search for passed tests
+        if (status !== 'failed') {
+            file.tasks.forEach(taskOrSuite => {
+                if (taskOrSuite.result?.state === 'pass') {
+                    status = 'passed'; // set status to passed if any test passed (and there are no failed tests)
+                }
+            });
         }
-      });
-    }
-  });
-
-  return status;
+    });
+    return status;
 }
-
 /**
  * Returns test status in Testomat.io format
  *
@@ -157,26 +154,30 @@ function getRunStatusFromResults(files) {
  * @returns 'passed' | 'failed' | 'skipped'
  */
 function getTestStatus(test) {
-  if (test.result?.state === 'fail') return STATUS.FAILED;
-  if (test.result?.state === 'pass') return STATUS.PASSED;
-  if (!test.result && test.mode === 'skip') return STATUS.SKIPPED;
-  console.error(chalk.red('Unprocessed case for defining test status. Contact dev team. Test:'), test);
+    if (test.result?.state === 'fail')
+        return constants_js_1.STATUS.FAILED;
+    if (test.result?.state === 'pass')
+        return constants_js_1.STATUS.PASSED;
+    if (!test.result && test.mode === 'skip')
+        return constants_js_1.STATUS.SKIPPED;
+    console.error(picocolors_1.default.red('Unprocessed case for defining test status. Contact dev team. Test:'), test);
 }
-
 /**
  * @param {VitestTestLogs[]} logs
  * @returns string
  */
 function transformLogsToString(logs) {
-  if (!logs) return '';
-  let logsStr = '';
-  logs.forEach(log => {
-    if (log.type === 'stdout') logsStr += `${log.content}\n`;
-    if (log.type === 'stderr') logsStr += `${chalk.red(log.content)}\n`;
-  });
-  return logsStr;
+    if (!logs)
+        return '';
+    let logsStr = '';
+    logs.forEach(log => {
+        if (log.type === 'stdout')
+            logsStr += `${log.content}\n`;
+        if (log.type === 'stderr')
+            logsStr += `${picocolors_1.default.red(log.content)}\n`;
+    });
+    return logsStr;
 }
+module.exports = VitestReporter;
 
 module.exports.VitestReporter = VitestReporter;
-module.exports.default = VitestReporter;
-module.exports = VitestReporter;

package/lib/adapter/webdriver.d.ts

@@ -0,0 +1,24 @@
+export default WebdriverReporter;
+declare class WebdriverReporter extends WDIOReporter {
+    constructor(options: any);
+    client: TestomatClient;
+    _addTestPromises: any[];
+    _isSynchronising: boolean;
+    /**
+     *
+     * @param {RunnerStats} runData
+     */
+    onRunnerEnd(runData: RunnerStats): Promise<void>;
+    onRunnerStart(): void;
+    onTestStart(test: any): void;
+    onTestEnd(test: any): void;
+    onSuiteEnd(scerario: any): void;
+    addTest(test: any): Promise<void>;
+    /**
+     * @param {import('../../types/types.js').WebdriverIOScenario} scenario
+     */
+    addBddScenario(scenario: import("../../types/types.js").WebdriverIOScenario): Promise<import("../../types/types.js").PipeResult[]>;
+}
+import WDIOReporter from '@wdio/reporter';
+import TestomatClient from '../client.js';
+import { RunnerStats } from '@wdio/reporter';

package/lib/adapter/webdriver.js

@@ -1,130 +1,145 @@
-// eslint-disable-next-line global-require, import/no-extraneous-dependencies
-const WDIOReporter = require('@wdio/reporter').default;
-const TestomatClient = require('../client');
-const { getTestomatIdFromTestTitle, fileSystem } = require('../utils/utils');
-const { services } = require('../services');
-const { TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
-
-class WebdriverReporter extends WDIOReporter {
-  constructor(options) {
-    super(options);
-
-    this.client = new TestomatClient({ apiKey: options?.apiKey });
-    options = Object.assign(options, { stdout: true });
-
-    this._addTestPromises = [];
-
-    this._isSynchronising = false;
-  }
-
-  onRunnerStart() {
-    // clear dir with artifacts/logs
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-  }
-
-  onTestStart(test) {
-    services.setContext(test.fullTitle);
-  }
-
-  get isSynchronised() {
-    return this._isSynchronising === false;
-  }
-
-  async onRunnerEnd() {
-    this._isSynchronising = true;
-
-    await Promise.all(this._addTestPromises);
-
-    this._isSynchronising = false;
-  }
-
-  onTestEnd(test) {
-    test.suite = test.parent;
-    const logs = getTestLogs(test.fullTitle);
-    // TODO: FIX: artifacts for some reason leads to empty report on Testomat.io
-    // const artifacts = services.artifacts.get(test.fullTitle);
-    // const keyValues = services.keyValues.get(test.fullTitle);
-    test.logs = logs;
-    // test.artifacts = artifacts;
-    // test.meta = keyValues;
-    this._addTestPromises.push(this.addTest(test));
-  }
-
-  // wdio-cucumber does not trigger onTestEnd hook, thus, using this one
-  onSuiteEnd(scerario) {
-    if (scerario.type === 'scenario') {
-      this._addTestPromises.push(this.addBddScenario(scerario));
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-  }
-
-  async addTest(test) {
-    if (!this.client) return;
-
-    const { title, _duration: duration, state, error, output } = test;
-
-    const testId = getTestomatIdFromTestTitle(title);
-
-    const screenshotEndpoint = '/session/:sessionId/screenshot';
-    const screenshotsBuffers = output
-      .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
-      .map(el => Buffer.from(el.result.value, 'base64'));
-
-    await this.client.addTestRun(state, {
-      manuallyAttachedArtifacts: test.artifacts,
-      error,
-      logs: test.logs,
-      meta: test.meta,
-      title,
-      test_id: testId,
-      time: duration,
-      filesBuffers: screenshotsBuffers,
-    });
-  }
-
-  /**
-   * @param {import('../../types').WebdriverIOScenario} scenario
-   */
-  addBddScenario(scenario) {
-    if (!this.client) return;
-
-    const { title, _duration: duration } = scenario;
-
-    const testId = getTestomatIdFromTestTitle(title || scenario.tags.map(tag => tag.name).join(' '));
-
-    let scenarioState = scenario.tests.every(test => test.state === 'passed') ? 'passed' : 'failed';
-    if (scenario.tests.every(test => test.state === 'skipped')) {
-      scenarioState = 'skipped';
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line
+const reporter_1 = __importStar(require("@wdio/reporter"));
+const client_js_1 = __importDefault(require("../client.js"));
+const utils_js_1 = require("../utils/utils.js");
+const index_js_1 = require("../services/index.js");
+const constants_js_1 = require("../constants.js");
+class WebdriverReporter extends reporter_1.default {
+    constructor(options) {
+        super(options);
+        this.client = new client_js_1.default({ apiKey: options?.apiKey });
+        options = Object.assign(options, { stdout: true });
+        this._addTestPromises = [];
+        this._isSynchronising = false;
+        // NOTE: new functionality; may break everything
+        this.client.createRun();
+    }
+    get isSynchronised() {
+        return this._isSynchronising === false;
+    }
+    /**
+     *
+     * @param {RunnerStats} runData
+     */
+    async onRunnerEnd(runData) {
+        this._isSynchronising = true;
+        await Promise.all(this._addTestPromises);
+        this._isSynchronising = false;
+        // NOTE: new functionality; may break everything
+        // also this may require additional status mapping
+        await this.client.updateRunStatus(runData.failures ? 'failed' : 'passed');
+    }
+    onRunnerStart() {
+        // clear dir with artifacts/logs
+        //
+        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
+    }
+    onTestStart(test) {
+        index_js_1.services.setContext(test.fullTitle);
+    }
+    onTestEnd(test) {
+        test.suite = test.parent;
+        const logs = getTestLogs(test.fullTitle);
+        // TODO: FIX: artifacts for some reason leads to empty report on Testomat.io
+        // const artifacts = services.artifacts.get(test.fullTitle);
+        // const keyValues = services.keyValues.get(test.fullTitle);
+        test.logs = logs;
+        // test.artifacts = artifacts;
+        // test.meta = keyValues;
+        this._addTestPromises.push(this.addTest(test));
+    }
+    // wdio-cucumber does not trigger onTestEnd hook, thus, using this one
+    onSuiteEnd(scerario) {
+        if (scerario.type === 'scenario') {
+            this._addTestPromises.push(this.addBddScenario(scerario));
+        }
+    }
+    async addTest(test) {
+        if (!this.client)
+            return;
+        const { title, _duration: duration, state, error, output } = test;
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(title);
+        const screenshotEndpoint = '/session/:sessionId/screenshot';
+        const screenshotsBuffers = output
+            .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
+            .map(el => Buffer.from(el.result.value, 'base64'));
+        await this.client.addTestRun(state, {
+            manuallyAttachedArtifacts: test.artifacts,
+            error,
+            logs: test.logs,
+            meta: test.meta,
+            title,
+            test_id: testId,
+            time: duration,
+            filesBuffers: screenshotsBuffers,
+        });
+    }
+    /**
+     * @param {import('../../types/types.js').WebdriverIOScenario} scenario
+     */
+    addBddScenario(scenario) {
+        if (!this.client)
+            return;
+        const { title, _duration: duration } = scenario;
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(title || scenario.tags.map(tag => tag.name).join(' '));
+        let scenarioState = scenario.tests.every(test => test.state === 'passed') ? 'passed' : 'failed';
+        if (scenario.tests.every(test => test.state === 'skipped')) {
+            scenarioState = 'skipped';
+        }
+        const errors = scenario.tests
+            .filter(test => test.state === 'failed')
+            .map(test => test.error?.stack)
+            .filter(Boolean);
+        const error = errors.join('\n');
+        const tags = scenario.tags.map(tag => tag.name);
+        return this.client.addTestRun(scenarioState, {
+            error: error ? Error(error) : null,
+            title,
+            test_id: testId,
+            time: duration,
+            tags,
+            file: scenario.file,
+            // filesBuffers: screenshotsBuffers,
+        });
     }
-    const errors = scenario.tests
-      .filter(test => test.state === 'failed')
-      .map(test => test.error?.stack)
-      .filter(Boolean);
-    const error = errors.join('\n');
-
-    const tags = scenario.tags.map(tag => tag.name);
-
-    return this.client.addTestRun(scenarioState, {
-      error: error ? Error(error) : null,
-      title,
-      test_id: testId,
-      time: duration,
-      tags,
-      file: scenario.file,
-      // filesBuffers: screenshotsBuffers,
-    });
-  }
 }
-
 /**
  *
  * @param {*} fullTestTitle
  * @returns string
  */
 function getTestLogs(fullTestTitle) {
-  const logsArr = services.logger.getLogs(fullTestTitle);
-  // remove duplicates (for some reason, logs are duplicated several times)
-  const logs = logsArr ? Array.from(new Set(logsArr)).join('\n').trim() : '';
-  return logs;
+    const logsArr = index_js_1.services.logger.getLogs(fullTestTitle);
+    // remove duplicates (for some reason, logs are duplicated several times)
+    const logs = logsArr ? Array.from(new Set(logsArr)).join('\n').trim() : '';
+    return logs;
 }
-
 module.exports = WebdriverReporter;

package/lib/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};