@testomatio/reporter 1.4.5 → 1.4.6

package/lib/adapter/vitest.js

@@ -0,0 +1,182 @@
+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');
+
+/**
+ * @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
+ */
+
+class VitestReporter {
+  constructor(config = {}) {
+    this.client = new TestomatioClient({ apiKey: config?.apiKey });
+    /**
+     * @type {(TestData & {status: string})[]} tests
+     */
+    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');
+        }
+      });
+    });
+
+    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: getTestomatIdFromTestTitle(test.name),
+      time: test.result?.duration || 0,
+      title: test.name,
+      // testomatio functions (artifacts, logs, steps, meta) are not supported
+    };
+  }
+}
+
+/**
+ * Returns run status based on test results
+ *
+ * @param {VitestTestFile[]} files
+ * @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)
+        }
+      });
+    }
+  });
+
+  return status;
+}
+
+/**
+ * Returns test status in Testomat.io format
+ *
+ * @param {VitestTest} test
+ * @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);
+}
+
+/**
+ * @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;
+}
+
+module.exports.VitestReporter = VitestReporter;
+module.exports.default = VitestReporter;
+module.exports = VitestReporter;

package/lib/bin/reportXml.js

@@ -44,10 +44,15 @@ program
 
     let timeoutTimer;
     if (opts.timelimit) {
-      timeoutTimer = setTimeout(() => {
-        console.log(`⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`);
-        process.exit(0);
-      }, parseInt(opts.timelimit, 10) * 1000);
+      timeoutTimer = setTimeout(
+        () => {
+          console.log(
+            `⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`,
+          );
+          process.exit(0);
+        },
+        parseInt(opts.timelimit, 10) * 1000,
+      );
     }
 
     try {

package/lib/client.js

@@ -123,7 +123,7 @@ class Client {
     if (isTestShouldBeExculedFromReport(testData)) return [];
 
     if (status === STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
-      debug('Skipping test from report', testData?.title)
+      debug('Skipping test from report', testData?.title);
       return []; // do not log skipped tests
     }
 
@@ -133,10 +133,13 @@ class Client {
         suite_title: 'Unknown suite',
       };
 
+    /**
+     * @type {TestData}
+     */
     const {
       rid,
       error = null,
-      time = '',
+      time = 0,
       example = null,
       files = [],
       filesBuffers = [],
@@ -198,7 +201,7 @@ class Client {
       suite_id,
       test_id,
       message,
-      run_time: parseFloat(time),
+      run_time: typeof time === 'number' ? time : parseFloat(time),
       artifacts,
       meta,
     };
@@ -224,7 +227,8 @@ class Client {
   /**
    *
    * Updates the status of the current test run and finishes the run.
-   * @param {RunStatus} status - The status of the current test run. Must be one of "passed", "failed", or "finished"
+   * @param {'passed' | 'failed' | 'finished'} status - The status of the current test run.
+   * Must be one of "passed", "failed", or "finished"
    * @param {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
    * @returns {Promise<any>} - A Promise that resolves when finishes the run.
    */
@@ -286,13 +290,23 @@ class Client {
     if (!message) message = error.message;
     if (error.inspect) message = error.inspect() || '';
 
-    let stack = `${message}\n`;
+    let stack = '';
+    if (error.name) stack += `${chalk.red(error.name)}`;
+    if (error.operator) stack += ` (${chalk.red(error.operator)})`;
+    // add new line if something was added to stack
+    if (stack) stack += ': ';
 
-    // diffs for mocha, cypress, codeceptjs style
-    if (error.actual && error.expected) {
+    stack += `${message}\n`;
+
+    if (error.diff) {
+      // diff for vitest 
+      stack += error.diff;
+      stack += '\n\n';
+    } else if (error.actual && error.expected && error.actual !== error.expected) {
+      // diffs for mocha, cypress, codeceptjs style
       stack += `\n\n${chalk.bold.green('+ expected')} ${chalk.bold.red('- actual')}`;
-      stack += `\n${chalk.red(`- ${error.actual.toString().split('\n').join('\n- ')}`)}`;
       stack += `\n${chalk.green(`+ ${error.expected.toString().split('\n').join('\n+ ')}`)}`;
+      stack += `\n${chalk.red(`- ${error.actual.toString().split('\n').join('\n- ')}`)}`;
       stack += '\n\n';
     }
 
@@ -365,3 +379,4 @@ function isTestShouldBeExculedFromReport(testData) {
 }
 
 module.exports = Client;
+module.exports.TestomatioClient = Client;

package/lib/pipe/gitlab.js

@@ -79,13 +79,13 @@ class GitLabPipe {
     let summary = `${this.hiddenCommentData}
     
   | [![Testomat.io Report](${testomatLogoURL})](https://testomat.io)  | ${statusEmoji(
-      runParams.status,
-    )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+    runParams.status,
+  )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
   | --- | --- |
   | Tests | ✔️  **${this.tests.length}** tests run  |
   | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
-      'passed',
-    )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
+    'passed',
+  )} **${passedCount}** passed; **${statusEmoji('skipped')}** ${skippedCount} skipped |
   | Duration | 🕐  **${humanizeDuration(
     parseInt(
       this.tests.reduce((a, t) => a + (t.run_time || 0), 0),

package/lib/pipe/testomatio.js

@@ -42,6 +42,10 @@ class TestomatioPipe {
       return;
     }
     debug('Testomatio Pipe: Enabled');
+
+    const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
+    const proxy = proxyUrl ? new URL(proxyUrl) : null;
+
     this.parallel = params.parallel;
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
@@ -53,6 +57,11 @@ class TestomatioPipe {
     this.axios = axios.create({
       baseURL: `${this.url.trim()}`,
       timeout: AXIOS_TIMEOUT,
+      proxy: proxy ? {
+        host: proxy.hostname,
+        port: proxy.port,
+        protocol: proxy.protocol,
+      } : false,
     });
 
     // Pass the axios instance to the retry function
@@ -341,7 +350,7 @@ class TestomatioPipe {
     if (!this.runId) return;
 
     // add test ID + run ID
-    data.rid = `${this.runId}-${data.rid}`;
+    if (data.rid) data.rid = `${this.runId}-${data.rid}`;
     data.api_key = this.apiKey;
     data.create = this.createNewTests;
 

package/lib/utils/utils.js

@@ -106,6 +106,7 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
 };
 
 const TEST_ID_REGEX = /@T([\w\d]{8})/;
+const SUITE_ID_REGEX = /@[Ss]([\w\d]{8})/;
 
 const fetchIdFromCode = (code, opts = {}) => {
   const comments = code
@@ -133,6 +134,10 @@ const fetchIdFromOutput = output => {
   return lines.find(c => c.match(TEST_ID_REGEX))?.match(TEST_ID_REGEX)?.[1];
 };
 
+const fetchSuiteId = (title) => {
+  return title.find(c => c.match(/@s/))?.match(TEST_ID_REGEX)?.[1];
+};
+
 const fetchSourceCode = (contents, opts = {}) => {
   if (!opts.title && !opts.line) return '';
 
@@ -248,7 +253,7 @@ const foundedTestLog = (app, tests) => {
 const humanize = text => {
   // if there are no spaces, decamelize
   if (!text.trim().includes(' ')) text = decamelize(text);
-  
+
   return text
     .replace(/_./g, match => ` ${match.charAt(1).toUpperCase()}`)
     .trim()

package/lib/xmlReader.js

@@ -528,4 +528,4 @@ function fetchProperties(item) {
     .filter(p => p.name === 'Category')
     .forEach(p => tags.push(p.value));
   return { title, tags };
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.4.5",
+  "version": "1.4.6",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -55,6 +55,7 @@
     "test:adapter:jasmine:example": "./tests/adapter/examples/jasmine/passReporterOpts.sh && jasmine './tests/adapter/examples/jasmine/index.test.js' --reporter=./../../../lib/adapter/jasmine.js",
     "test:adapter:codecept:example": "codeceptjs run --config='./tests/adapter/examples/codecept/codecept.conf.js'",
     "test:adapter:cucumber:example": "cd ./tests/adapter/examples/cucumber && npx cucumber-js",
+    "test:adapter:vitest:example": "vitest --config='./tests/adapter/examples/vitest/vitest.config.js'",
     "test:storage": "npx mocha tests-storage/artifact-storage.test.js && npx mocha tests-storage/data-storage.test.js && TESTOMATIO_INTERCEPT_CONSOLE_LOGS=true npx mocha tests-storage/logger.test.js && npx mocha tests-storage/logger-2.test.js && npx mocha tests-storage/reporter-functions.test.js"
   },
   "devDependencies": {