@testomatio/reporter 0.8.0-beta.31 → 0.8.0-beta.32

package/lib/adapter/mocha.js

@@ -1,9 +1,9 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-const debug = require('debug')('@testomatio/reporter:adapter:mocha');
 const Mocha = require('mocha');
+const debug = require('debug')('@testomatio/reporter:adapter:mocha');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const TRConstants = require('../constants');
+const { STATUS } = require('../constants');
 const { parseTest, specificTestInfo } = require('../util');
 const ArtifactStorage = require('../ArtifactStorage');
 
@@ -26,12 +26,12 @@ function MochaReporter(runner, opts) {
     client.createRun();
 
     const params = { 
-      "toFile": true
+      toFile: true
     };
-
-    (runner._workerReporter !== undefined)
-      ? artifactStore = new ArtifactStorage(params)
-      : artifactStore = new ArtifactStorage();
+    
+    artifactStore = runner._workerReporter !== undefined
+      ? new ArtifactStorage(params)
+      : new ArtifactStorage();
   });
 
   runner.on(EVENT_TEST_PASS, async(test) => {
@@ -45,9 +45,9 @@ function MochaReporter(runner, opts) {
     debug(`test=${specificTest} content = `, content);
 
     client.addTestRun(
-      testId, 
-      TRConstants.PASSED, 
+      STATUS.PASSED, 
       {
+        test_id: testId,
         title: test.title,
         time: test.duration,
       },
@@ -59,8 +59,9 @@ function MochaReporter(runner, opts) {
     skipped += 1;
     console.log('skip: %s', test.fullTitle());
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.SKIPPED, {
+    client.addTestRun(STATUS.SKIPPED, {
       title: test.title,
+      test_id: testId,
       time: test.duration,
     });
   });
@@ -76,9 +77,9 @@ function MochaReporter(runner, opts) {
     debug(`fail test=${specificTest} content = `, content);
 
     client.addTestRun(
-      testId,
-      TRConstants.FAILED, {
+      STATUS.FAILED, {
         error: err,
+        test_id: testId,
         title: test.title,
         time: test.duration,
       }, 
@@ -87,7 +88,7 @@ function MochaReporter(runner, opts) {
   });
 
   runner.on(EVENT_RUN_END, () => {
-    const status = failures === 0 ? TRConstants.PASSED : TRConstants.FAILED;
+    const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
     console.log(chalk.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
     client.updateRunStatus(status);
 

package/lib/adapter/playwright.js

@@ -3,11 +3,12 @@ const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
-const Status = require('../constants');
+const { APP_PREFIX, STATUS: Status } = require('../constants');
 const TestomatioClient = require('../client');
 const upload = require('../fileUploader');
 const { parseTest } = require('../util');
 
+
 class TestomatioReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
@@ -56,8 +57,9 @@ class TestomatioReporter {
       files.push({ path: fileName, type: attachment.contentType });
     }
 
-    this.client.addTestRun(testId, checkStatus(result.status), {
+    this.client.addTestRun(checkStatus(result.status), {
       error,
+      test_id: testId,
       suite_title,
       title,
       files,
@@ -70,14 +72,15 @@ class TestomatioReporter {
     if (!this.client) return;
 
     if (this.videos.length && upload.isArtifactsEnabled()) {
-      console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
+      console.log(APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       const promises = [];
       for (const video of this.videos) {
         const { testId, title, attachment, suite_title } = video;
         const file = { path: attachment.path, title, type: attachment.contentType };
         promises.push(
-          this.client.addTestRun(testId, undefined, {
+          this.client.addTestRun(undefined, {
+            test_id: testId,
             title,
             suite_title,
             files: [file],

package/lib/adapter/webdriver.js

@@ -43,9 +43,10 @@ class WebdriverReporter extends WDIOReporter {
       .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
       .map(el => Buffer.from(el.result.value, 'base64'));
 
-    await this.client.addTestRun(testId, state, {
+    await this.client.addTestRun(state, {
       error,
       title,
+      test_id: testId,
       time: duration,
       filesBuffers: screenshotsBuffers,
     });

package/lib/bin/reportXml.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 const program = require("commander");
 const chalk = require("chalk");
 const glob = require('glob');

package/lib/bin/startTest.js

@@ -3,7 +3,7 @@ const { spawn } = require('child_process');
 const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const { APP_PREFIX, FINISHED } = require('../constants');
+const { APP_PREFIX, STATUS } = require('../constants');
 const { version } = require('../../package.json');
 
 console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
@@ -42,7 +42,7 @@ program
 
       const client = new TestomatClient({ apiKey });
 
-      client.updateRunStatus(FINISHED, true).then(() => {
+      client.updateRunStatus(STATUS.FINISHED, true).then(() => {
         console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
         process.exit(0);
       });

package/lib/client.js

@@ -3,25 +3,26 @@ const createCallsiteRecord = require('callsite-record');
 const { sep, join } = require('path');
 const fs = require('fs');
 const chalk = require('chalk');
+const { randomUUID } = require('crypto');
 const upload = require('./fileUploader');
-const { PASSED, FAILED, FINISHED, APP_PREFIX } = require('./constants');
+const { APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
 
-const { TESTOMATIO_ENV } = process.env;
+/**
+ * @typedef {import('../types').TestData} TestData
+ * @typedef {import('../types').RunStatus} RunStatus
+ */
 
-class TestomatClient {
+class Client {
   /**
    * Create a Testomat client instance
    *
    * @param {*} params
    */
   constructor(params = {}) {
-    this.title = params.title || process.env.TESTOMATIO_TITLE;
-    this.createNewTests = params.createNewTests ?? !!process.env.TESTOMATIO_CREATE;
-    this.proceed = process.env.TESTOMATIO_PROCEED;
-    this.env = TESTOMATIO_ENV;
     this.parallel = params.parallel;
     const store = {};
+    this.uuid = randomUUID();
     this.pipes = pipesFactory(params, store);
     this.queue = Promise.resolve();
     this.totalUploaded = 0;
@@ -32,11 +33,11 @@ class TestomatClient {
   /**
    * Used to create a new Test run
    *
-   * @returns {Promise} - resolves to Run id which should be used to update / add test
+   * @returns {Promise<void>} - resolves to Run id which should be used to update / add test
    */
   createRun() {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
 
     const runParams = {
       title: this.title,
@@ -48,22 +49,31 @@ class TestomatClient {
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.createRun(runParams))))
-      .catch(err => console.log(APP_PREFIX, err));
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined); // fixes return type
     debug('Run', this.queue);
     return this.queue;
   }
 
   /**
-   * Used to add a new test to Run instance
-   *
-   * @returns {Promise}
+   * Updates test status and its data
+   * 
+   * @param {string|undefined} status
+   * @param {TestData} [testData]
+   * @param {string[]} [storeArtifacts]
+   * @returns {Promise<void>}
    */
-  async addTestRun(testId, status, testData = {}, storeArtifacts = []) {
+  async addTestRun(status, testData, storeArtifacts = []) {
     // all pipes disabled, skipping
     if (!this.pipes.filter(p => p.isEnabled).length) return;
 
+    if (!testData) testData = {
+      title: 'Unknown test',
+      suite_title: 'Unknown suite',
+    }
+
     const {
-      error = '',
+      error = null,
       time = '',
       example = null,
       files = [],
@@ -79,20 +89,18 @@ class TestomatClient {
 
     const uploadedFiles = [];
 
-    if (testId) testData.test_id = testId;
-
     let stack = '';
 
     if (error) {
-      stack = this.formatError(error);
-      message = error.message;
+      stack = this.formatError(error) || '';
+      message = error?.message;
     }
     if (steps) {
       stack = this.formatSteps(stack, steps);
     }
 
     if (Array.isArray(storeArtifacts) && storeArtifacts.length) {
-      debug("CLIENT storeArtefact", storeArtifacts);
+      debug("CLIENT storeArtifact", storeArtifacts);
       files.push(...storeArtifacts);
     }
 
@@ -103,12 +111,12 @@ class TestomatClient {
     }
 
     for (const file of files) {
-      uploadedFiles.push(upload.uploadFileByPath(file, this.runId));
+      uploadedFiles.push(upload.uploadFileByPath(file, this.uuid));
     }
 
     for (const [idx, buffer] of filesBuffers.entries()) {
       const fileName = `${idx + 1}-${title.replace(/\s+/g, '-')}`;
-      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.runId));
+      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.uuid));
     }
 
     const artifacts = await Promise.all(uploadedFiles);
@@ -135,25 +143,23 @@ class TestomatClient {
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.addTest(data))))
-      .catch(err => console.log(APP_PREFIX, err));
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined);
     return this.queue;
   }
 
   /**
-   * Update run status
    *
-   * @returns {Promise}
+   * 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 {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
+   * @returns {Promise<void>} - A Promise that resolves when finishes the run.
    */
-  updateRunStatus(status, isParallel) {
+  updateRunStatus(status, isParallel = false) {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
 
-    let statusEvent;
-    if (status === FINISHED) statusEvent = 'finish';
-    if (status === PASSED) statusEvent = 'pass';
-    if (status === FAILED) statusEvent = 'fail';
-    if (isParallel) statusEvent += '_parallel';
-    const runParams = { status, statusEvent };
+    const runParams = { status, parallel: isParallel };
 
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
@@ -211,4 +217,4 @@ class TestomatClient {
   }
 }
 
-module.exports = TestomatClient;
+module.exports = Client;

package/lib/constants.js

@@ -11,12 +11,16 @@ const CSV_HEADERS = [
   { id: 'stack', title: 'Stack' },
 ];
 
-module.exports = Object.freeze({
+const STATUS = {
   PASSED: 'passed',
   FAILED: 'failed',
   SKIPPED: 'skipped',
   FINISHED: 'finished',
+};
+
+module.exports = {
   APP_PREFIX,
+  TESTOMAT_ARTIFACT_SUFFIX,
   CSV_HEADERS,
-  TESTOMAT_ARTIFACT_SUFFIX
-});
+  STATUS,
+}

package/lib/fileUploader.js

@@ -1,6 +1,6 @@
 const debug = require('debug')('@testomatio/reporter:file-uploader');
 const { S3 } = require('@aws-sdk/client-s3');
-const { Upload } = require("@aws-sdk/lib-storage");
+const { Upload } = require('@aws-sdk/lib-storage');
 const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');

package/lib/junit-adapter/csharp.js

@@ -14,5 +14,4 @@ class CSharpAdapter extends Adapter {
   }
 }
 
-
 module.exports = CSharpAdapter;

package/lib/junit-adapter/index.js

@@ -5,8 +5,7 @@ const PythonAdapter = require('./python');
 const RubyAdapter = require('./ruby');
 const CSharpAdapter = require('./csharp');
 
-
-module.exports = function (lang, opts) {
+function AdapterFactory(lang, opts) {
   if (!lang) return new Adapter(opts);
 
   if (lang === 'java') {
@@ -25,3 +24,5 @@ module.exports = function (lang, opts) {
     return new CSharpAdapter(opts);
   }
 }
+
+module.exports = AdapterFactory;

package/lib/pipe/csv.js

@@ -7,9 +7,16 @@ const merge = require('lodash.merge');
 const { isSameTest, getCurrentDateTime } = require('../util');
 const { CSV_HEADERS } = require('../constants');
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class CsvPipe
+ * @implements {Pipe}
+ */
 class CsvPipe {
-  constructor(params, store = {}) {
-    this.store = store;
+
+  constructor(params, store) {
+    this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.isEnabled = true;
     this.results = [];
@@ -59,7 +66,12 @@ class CsvPipe {
     // First, we check whether the export directory exists: if yes - OK, no - create it.
     this.checkExportDir();
 
-    console.log(chalk.yellow(`The test results will be added to the csv. It will take some time...`));
+    if (!this.outputFile) {
+      console.log(this, chalk.yellow(`CSV file is not set, ignoring`));
+      return;
+    }
+
+    console.log(this, chalk.yellow(`The test results will be added to the csv. It will take some time...`));
     // Create csv writer object
     const writer = csvWriter.createObjectCsvWriter({
       path: this.outputFile,
@@ -68,7 +80,7 @@ class CsvPipe {
     // Save csv file based on the current data
     try {
       await writer.writeRecords(data);
-      console.log(chalk.green(`Recording completed! You can check the result in file = ${this.outputFile}`));
+      console.log(this, chalk.green(`Recording completed! You can check the result in file = ${this.outputFile}`));
     } catch (e) {
       console.log('Unknown error: ', e);
     }
@@ -100,8 +112,8 @@ class CsvPipe {
   }
 
   /**
-   * Save short tests data to the csv file.
-   * @param {Object} runParams - run params.
+   * @param {{ tests?: TestData[] }} runParams
+   * @returns {Promise<void>}
    */
   async finishRun(runParams) {
     if (!this.isEnabled) return;

package/lib/pipe/github.js

@@ -7,6 +7,12 @@ const { Octokit } = require('@octokit/rest');
 const { APP_PREFIX } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../util');
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class GitHubPipe
+ * @implements {Pipe}
+ */
 class GitHubPipe {
   constructor(params, store = {}) {
     this.isEnabled = false;
@@ -23,7 +29,8 @@ class GitHubPipe {
     this.isEnabled = true;
     const matchedIssue = this.ref.match(/refs\/pull\/(\d+)\/merge/);
     if (!matchedIssue) return;
-    this.issue = matchedIssue[1];
+    this.issue = parseInt(matchedIssue[1], 10);
+
     this.start = new Date();
 
     debug('GitHub Pipe: Enabled');
@@ -31,8 +38,6 @@ class GitHubPipe {
 
   async createRun() {}
 
-  updateRun() {}
-
   addTest(test) {
     debug('Adding test:', test);
     if (!this.isEnabled) return;
@@ -49,6 +54,7 @@ class GitHubPipe {
 
   async finishRun(runParams) {
     if (!this.isEnabled) return;
+    if (!this.issue) return;
 
     if (runParams.tests) runParams.tests.forEach(t => this.addTest(t));
 
@@ -56,7 +62,7 @@ class GitHubPipe {
       auth: this.token,
     });
 
-    const [owner, repo] = this.repo.split('/');
+    const [owner, repo] = (this.repo || '').split('/');
     if (!(owner || repo)) return;
 
     // ... create a comment on GitHub
@@ -148,6 +154,7 @@ class GitHubPipe {
         .join('\n');
       body += '\n</details>';
     }
+    
 
     await deletePreviousReport(this.octokit, owner, repo, this.issue, this.hiddenCommentData);
 

package/lib/pipe/gitlab.js

@@ -1,5 +1,5 @@
 const debug = require('debug')('@testomatio/reporter:pipe:gitlab');
-const axios = require('axios');
+const { default: axios } = require('axios');
 const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
@@ -10,6 +10,11 @@ const { ansiRegExp, isSameTest } = require('../util');
 //! GITLAB_PAT environment variable is required for this functionality to work
 //! and your pipeline trigger should be merge_request
 
+/**
+ * @class GitLabPipe
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ */
 class GitLabPipe {
   constructor(params, store = {}) {
     this.isEnabled = false;
@@ -19,7 +24,6 @@ class GitLabPipe {
     // GitLab PAT looks like glpat-nKGdja3jsG4850sGksh7
     this.token = params.GITLAB_PAT || this.ENV.GITLAB_PAT;
     this.hiddenCommentData = `<!--- testomat.io report ${process.env.CI_JOB_NAME || ''} -->`;
-    this.axios = axios.create();
 
     debug(
       chalk.yellow('GitLab Pipe:'),
@@ -142,13 +146,13 @@ class GitLabPipe {
     const commentsRequestURL = `https://gitlab.com/api/v4/projects/${this.ENV.CI_PROJECT_ID}/merge_requests/${this.ENV.CI_MERGE_REQUEST_IID}/notes`;
 
     // delete previous report
-    await deletePreviousReport(this.axios, commentsRequestURL, this.hiddenCommentData, this.token);
+    await deletePreviousReport(axios, commentsRequestURL, this.hiddenCommentData, this.token);
 
     // add current report
     debug(`Adding comment via url: ${commentsRequestURL}`);
 
     try {
-      const addCommentResponse = await this.axios.post(`${commentsRequestURL}?access_token=${this.token}`, { body });
+      const addCommentResponse = await axios.post(`${commentsRequestURL}?access_token=${this.token}`, { body });
 
       const commentID = addCommentResponse.data.id;
       // eslint-disable-next-line max-len

package/lib/pipe/index.js

@@ -7,7 +7,7 @@ const GitHubPipe = require('./github');
 const GitLabPipe = require('./gitlab');
 const CsvPipe = require('./csv');
 
-module.exports = function (params, opts) {
+function PipeFactory(params, opts) {
   const extraPipes = [];
 
   // Add extra pipes into package.json file:
@@ -17,7 +17,7 @@ module.exports = function (params, opts) {
 
   const packageJsonFile = path.join(process.cwd(), 'package.json');
   if (fs.existsSync(packageJsonFile)) {
-    const packageJson = fs.readFileSync(packageJsonFile);
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonFile).toString());
     const pipeDefs = packageJson?.testomatio?.pipes || [];
 
     for (const pipeDef of pipeDefs) {
@@ -58,4 +58,6 @@ module.exports = function (params, opts) {
   );
 
   return pipes;
-};
+}
+
+module.exports = PipeFactory;

package/lib/pipe/testomatio.js

@@ -2,18 +2,22 @@ const debug = require('debug')('@testomatio/reporter:pipe:testomatio');
 const chalk = require('chalk');
 const axios = require('axios');
 const JsonCycle = require('json-cycle');
-
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_RUN } = process.env;
-const { APP_PREFIX } = require('../constants');
+const { APP_PREFIX, STATUS } = require('../constants');
 const { isValidUrl } = require('../util');
 
-
+const { TESTOMATIO_RUN } = process.env;
 if (TESTOMATIO_RUN) {
   process.env.runId = TESTOMATIO_RUN;
 }
 
+/**
+ * @typedef {import('../../types').Pipe} Pipe
+ * @typedef {import('../../types').TestData} TestData
+ * @class TestomatioPipe
+ * @implements {Pipe}
+ */
 class TestomatioPipe {
-  constructor(params, store = {}) {
+  constructor(params, store) {
     this.isEnabled = false;
     this.url = params.testomatioUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
     this.apiKey = params.apiKey || process.env.TESTOMATIO;
@@ -22,10 +26,13 @@ class TestomatioPipe {
       return;
     }
     debug('Testomatio Pipe: Enabled');
-    this.store = store;
+    this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
+    this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
+    this.env = process.env.TESTOMATIO_ENV;
     this.axios = axios.create();
     this.isEnabled = true;
+    // do not finish this run (for parallel testing)
     this.proceed = process.env.TESTOMATIO_PROCEED;
     this.runId = params.runId || process.env.runId;
     this.createNewTests = !!process.env.TESTOMATIO_CREATE;
@@ -36,11 +43,20 @@ class TestomatioPipe {
     }
   }
 
-  async createRun(runParams) {
+  /**
+   * @returns Promise<void>
+   */
+  async createRun() {
     if (!this.isEnabled) return;
 
-    runParams.api_key = this.apiKey.trim();
-    runParams.group_title = TESTOMATIO_RUNGROUP_TITLE;
+    const runParams = Object.fromEntries(
+      Object.entries({
+        api_key: this.apiKey.trim(),
+        group_title: this.groupTitle,
+        env: this.env,
+        title: this.title,
+      }).filter(([, value]) => !!value)
+    );
 
     if (this.runId) {
       return this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
@@ -65,6 +81,11 @@ class TestomatioPipe {
     }
   }
 
+  /**
+   * 
+   * @param testData data 
+   * @returns 
+   */
   addTest(data) {
     if (!this.isEnabled) return;
     if (!this.runId) return;
@@ -98,14 +119,27 @@ class TestomatioPipe {
     });
   }
 
+  /**
+   * @param {import('../../types').RunData} params 
+   * @returns 
+   */
   async finishRun(params) {
     if (!this.isEnabled) return;
+
+    const { status, parallel } = params;
+
+    let status_event;
+
+    if (status === STATUS.FINISHED) status_event = 'finish';
+    if (status === STATUS.PASSED) status_event = 'pass';
+    if (status === STATUS.FAILED) status_event = 'fail';
+    if (parallel) status_event += '_parallel';
+
     try {
       if (this.runId && !this.proceed) {
         await this.axios.put(`${this.url}/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
-          status_event: params.statusEvent,
-          status: params.status,
+          status_event,
           tests: params.tests,
         });
         if (this.runUrl) {