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

package/lib/pipe/gitlab.js

@@ -1,4 +1,5 @@
-const axios = require('axios');
+const debug = require('debug')('@testomatio/reporter:pipe:gitlab');
+const { default: axios } = require('axios');
 const chalk = require('chalk');
 const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
@@ -9,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;
@@ -18,32 +24,26 @@ 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();
 
-    if (this.ENV.DEBUG) {
-      console.log(
-        APP_PREFIX,
-        chalk.yellow('GitLab Pipe:'),
-        this.token ? 'TOKEN passed' : '*no token*',
-        `Project id: ${this.ENV.CI_PROJECT_ID}, MR id: ${this.ENV.CI_MERGE_REQUEST_IID}`,
-      );
-    }
+    debug(
+      chalk.yellow('GitLab Pipe:'),
+      this.token ? 'TOKEN passed' : '*no token*',
+      `Project id: ${this.ENV.CI_PROJECT_ID}, MR id: ${this.ENV.CI_MERGE_REQUEST_IID}`,
+    );
 
     if (!this.ENV.CI_PROJECT_ID || !this.ENV.CI_MERGE_REQUEST_IID) {
-      // console.warn(`CI pipeline should be run in Merge Request to have ability to add the report comment.`);
+      debug(`CI pipeline should be run in Merge Request to have ability to add the report comment.`);
       return;
     }
 
     if (!this.token) {
-      console.warn(chalk.grey(`Hint: GitLab CI variables are unavailable for unprotected branches by default.`));
+      debug(`Hint: GitLab CI variables are unavailable for unprotected branches by default.`);
       return;
     }
 
     this.isEnabled = true;
 
-    if (this.ENV.DEBUG) {
-      console.log(APP_PREFIX, chalk.yellow('GitLab Pipe: Enabled'));
-    }
+    debug('GitLab Pipe: Enabled');
   }
 
   async createRun() {}
@@ -75,8 +75,7 @@ class GitLabPipe {
     let summary = `${this.hiddenCommentData}
 
   | [![Testomat.io Report](https://avatars.githubusercontent.com/u/59105116?s=36&v=4)](https://testomat.io)  | ${
-    statusEmoji(runParams.status,
-  )} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
+    statusEmoji(runParams.status)} ${runParams.status.toUpperCase()} ${statusEmoji(runParams.status)} |
   | --- | --- |
   | Tests | ✔️  **${this.tests.length}** tests run  |
   | Summary | ${statusEmoji('failed')} **${failedCount}** failed; ${statusEmoji(
@@ -86,8 +85,8 @@ class GitLabPipe {
   `;
 
     if (this.ENV.CI_JOB_NAME && this.ENV.CI_JOB_ID) {
-      summary += `| Job | 👷 [${this.ENV.CI_JOB_ID}](${this.ENV.CI_JOB_URL})<br>Name: **${
-        this.ENV.CI_JOB_NAME}**<br>Stage: **${this.ENV.CI_JOB_STAGE}** | `;
+      // eslint-disable-next-line max-len
+      summary += `| Job | 👷 [${this.ENV.CI_JOB_ID}](${this.ENV.CI_JOB_URL})<br>Name: **${this.ENV.CI_JOB_NAME}**<br>Stage: **${this.ENV.CI_JOB_STAGE}** | `;
     }
 
     const failures = this.tests
@@ -147,12 +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
-    console.info(chalk.grey(`Adding comment via url: ${commentsRequestURL}`));
+    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
@@ -160,7 +160,7 @@ class GitLabPipe {
 
       console.log(APP_PREFIX, chalk.yellow('GitLab'), `Report created: ${chalk.magenta(commentURL)}`);
     } catch (err) {
-      console.log(
+      console.error(
         APP_PREFIX,
         chalk.yellow('GitLab'),
         `Couldn't create GitLab report\n${err}.
@@ -215,7 +215,7 @@ async function deletePreviousReport(axiosInstance, commentsRequestURL, hiddenCom
         const deleteCommentURL = `${commentsRequestURL}/${comment.id}?access_token=${token}`;
         await axiosInstance.delete(deleteCommentURL);
       } catch (e) {
-        console.error(`Can't delete previously added comment with testomat.io report. Ignore.`);
+        console.warn(`Can't delete previously added comment with testomat.io report. Ignore.`);
       }
 
       // pass next env var if need to clear all previous reports;

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

@@ -1,94 +1,107 @@
+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;
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'Testomatio Pipe: ', this.apiKey ? 'API KEY' : '*no api key*');  
-    }    
+    debug('Testomatio Pipe: ', this.apiKey ? 'API KEY' : '*no api key*');
     if (!this.apiKey) {
       return;
     }
-    if (process.env.DEBUG) {
-      console.log(APP_PREFIX, 'Testomatio Pipe: Enabled');  
-    }    
-    this.store = store;
+    debug('Testomatio Pipe: Enabled');
+    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;
 
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
-      console.log(
-        APP_PREFIX,
-        chalk.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`),
-      );
-      
+      console.error(APP_PREFIX, chalk.red(`Error creating report on Testomat.io, report url '${this.url}' is invalid`));
     }
   }
 
-  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)  
+      return this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
     }
-    
+
     try {
       const resp = await this.axios.post(`${this.url.trim()}/api/reporter`, runParams, {
         maxContentLength: Infinity,
         maxBodyLength: Infinity,
-      })
+      });
       this.runId = resp.data.uid;
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.store.runUrl = this.runUrl;
-      this.store.runId = this.runId;      
+      this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
     } catch (err) {
-      console.log(
+      console.error(
         APP_PREFIX,
         'Error creating Testomat.io report, please check if your API key is valid. Skipping report',
       );
     }
   }
 
-  async addTest(data) {
+  /**
+   * 
+   * @param testData data 
+   * @returns 
+   */
+  addTest(data) {
     if (!this.isEnabled) return;
     if (!this.runId) return;
     data.api_key = this.apiKey;
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    try {
-      return await this.axios.post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
-        maxContentLength: Infinity,
-        maxBodyLength: Infinity,
-        headers: {
-          // Overwrite Axios's automatically set Content-Type
-          'Content-Type': 'application/json',
-        },
-      });
-    } catch (err) {
+    return this.axios.post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
+      headers: {
+        // Overwrite Axios's automatically set Content-Type
+        'Content-Type': 'application/json',
+      },
+    })
+    .catch((err) => {
       if (err.response) {
         if (err.response.status >= 400) {
           const responseData = err.response.data || { message: '' };
@@ -103,18 +116,30 @@ class TestomatioPipe {
       } else {
         console.log(APP_PREFIX, chalk.blue(this.title), "Report couldn't be processed", err);
       }
-    }
-
+    });
   }
 
+  /**
+   * @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) {
@@ -136,4 +161,4 @@ class TestomatioPipe {
   }
 }
 
-module.exports = TestomatioPipe;
+module.exports = TestomatioPipe;

package/lib/reporter.js

@@ -1,7 +1,9 @@
 const TestomatClient = require('./client');
 const TRConstants = require('./constants');
+const TRArtifacts = require('./ArtifactStorage');
 
 module.exports = {
   TestomatClient,
   TRConstants,
+  TRArtifacts
 };

package/lib/util.js

@@ -1,5 +1,5 @@
 const { URL } = require('url');
-const { sep } = require('path');
+const { sep, basename } = require('path');
 const chalk = require('chalk');
 const fs = require('fs');
 const isValid = require('is-valid-path');
@@ -7,7 +7,7 @@ const isValid = require('is-valid-path');
 /**
  * @param {String} testTitle - Test title
  *
- * @returns {String} testId
+ * @returns {String|null} testId
  */
 const parseTest = testTitle => {
   const captures = testTitle.match(/@T([\w\d]+)/);
@@ -21,7 +21,7 @@ const parseTest = testTitle => {
 /**
  * @param {String} suiteTitle - suite title
  *
- * @returns {String} suiteId
+ * @returns {String|null} suiteId
  */
 const parseSuite = suiteTitle => {
   const captures = suiteTitle.match(/@S([\w\d]+)/);
@@ -63,12 +63,12 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
     // .map(l => l.match(/\[(.*?)\]/)?.[1] || l) // minitest format
     // .map(l => l.split(':')[0])
     .map(l => l.trim())
-    .map(l => l.split(' ').find(p => p.includes(':')))
-    .filter(l => isValid(l.split(':')[0]))
+    .map(l => l.split(' ').find(p => p.includes(':')) || '')
+    .filter(l => isValid(l?.split(':')[0]))
 
     // // filter out 3rd party libs
-    .filter(l => !l.includes(`vendor${  sep}`))
-    .filter(l => !l.includes(`node_modules${  sep}`))
+    .filter(l => !l?.includes(`vendor${  sep}`))
+    .filter(l => !l?.includes(`node_modules${  sep}`))
     .filter(l => fs.existsSync(l.split(':')[0]))
     .filter(l => fs.lstatSync(l.split(':')[0]).isFile())
 
@@ -153,14 +153,32 @@ const getCurrentDateTime = () => {
          today.getHours()  }_${  today.getMinutes()  }_${  today.getSeconds()}`;
 }
 
+/**
+ * @param {Object} test - Test adapter object
+ *
+ * @returns {String|null} testInfo as one string 
+ */
+const specificTestInfo = test => {
+  // TODO: afterEach has another context.... need to add specific handler, maybe...
+  if (test?.title && test?.file) {
+
+    return `${basename(test.file).split(".").join("#")
+              }#${ 
+              test.title.split(" ").join("#")}`;
+  }
+
+  return null;
+};
+
 module.exports = {
-  parseTest,
-  parseSuite,
-  ansiRegExp,
   isSameTest,
-  isValidUrl,
   fetchSourceCode,
   fetchSourceCodeFromStackTrace,
   fetchFilesFromStackTrace,
-  getCurrentDateTime
-};
+  getCurrentDateTime,
+  specificTestInfo,
+  isValidUrl,
+  ansiRegExp,
+  parseTest,
+  parseSuite 
+}

package/lib/xmlReader.js

@@ -2,15 +2,14 @@ const debug = require('debug')('@testomatio/reporter:xml');
 const path = require("path");
 const chalk = require('chalk');
 const fs = require("fs");
-
-// const util = require("util"); // you can see a result
 const { XMLParser } = require("fast-xml-parser");
-const { APP_PREFIX, PASSED, FAILED, SKIPPED } = require('./constants');
+const { APP_PREFIX, STATUS } = require('./constants');
 const { fetchFilesFromStackTrace, fetchSourceCode, fetchSourceCodeFromStackTrace } = require('./util');
 const upload = require('./fileUploader');
 const pipesFactory = require('./pipe');
 const adapterFactory = require('./junit-adapter');
 
+
 const TESTOMATIO_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
 const TESTOMATIO = process.env.TESTOMATIO; // key?
 const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
@@ -37,7 +36,9 @@ class XmlReader {
     };
     this.runId = opts.runId || TESTOMATIO_RUN;
     this.adapter = adapterFactory(null, opts)
-    this.opts = opts;
+    if (!this.adapter) throw new Error('XML adapter for this format not found');
+
+    this.opts = opts || {};
     const store = {}
     this.pipes = pipesFactory(opts, store);
 
@@ -93,7 +94,7 @@ class XmlReader {
       create_tests: true,
       name,
       tests_count: parseInt(tests, 10),
-      passed_count: parseInt(tests - failures, 10),
+      passed_count: parseInt(tests, 10) - parseInt(failures, 10),
       failed_count: parseInt(failures, 10),
       skipped_count: 0,
       tests: resultTests,
@@ -127,12 +128,13 @@ class XmlReader {
       const title = td.name.replace(/\(.*?\)/, '').trim();
       let example = td.name.match(/\((.*?)\)/);
       if (example) example = { ...example[1].split(',')};
-      const suite = td.TestMethod.className.split('.');
+      const suite = td.TestMethod.className.split(', ')[0].split('.');
       const suite_title = suite.pop();
       return { 
         title,
         example,
         file: suite.join('/'),
+        description: td.Description,
         suite_title,
         id: td.Execution.id,
       }
@@ -154,12 +156,14 @@ class XmlReader {
       const test = tests.find(t => t.id === r.id) || { };
       r.suite_title = test.suite_title;
       r.title = test.title?.trim();
+      if (test.code) r.code = test.code;
+      if (test.description) r.description = test.description;
       if (test.example) r.example = test.example;
       if (test.file) r.file = test.file;
       r.create = true;
-      if (r.status === 'Passed') r.status = PASSED;
-      if (r.status === 'Failed') r.status = FAILED;
-      if (r.status === 'Skipped') r.status = SKIPPED;
+      if (r.status === 'Passed') r.status = STATUS.PASSED;
+      if (r.status === 'Failed') r.status = STATUS.FAILED;
+      if (r.status === 'Skipped') r.status = STATUS.SKIPPED;
       delete r.id;
     });
 
@@ -169,8 +173,8 @@ class XmlReader {
 
     const failed_count = parseInt(counters.failed, 10) + parseInt(counters.error, 10);
 
-    let status = PASSED;
-    if (failed_count > 0) status = FAILED;
+    let status = STATUS.PASSED.toString();
+    if (failed_count > 0) status = STATUS.FAILED;
 
     this.tests = results.filter(t => !!t.title);
 
@@ -310,7 +314,7 @@ class XmlReader {
     const dataString = {
       ...this.stats,
       api_key: this.requestParams.apiKey,
-      status_event: 'finish',
+      status: 'finished',
       tests: this.tests,
     };
 
@@ -345,9 +349,9 @@ function reduceTestCases(prev, item) {
     // prepend system output
     stack = `${testCaseItem['system-out'] || testCaseItem.output || testCaseItem.log || ''}\n\n${stack}`.trim()
 
-    let status = PASSED;
-    if ('failure' in testCaseItem || 'error' in testCaseItem) status = FAILED;
-    if ('skipped' in testCaseItem) status = SKIPPED;
+    let status = STATUS.PASSED.toString();
+    if ('failure' in testCaseItem || 'error' in testCaseItem) status = STATUS.FAILED;
+    if ('skipped' in testCaseItem) status = STATUS.SKIPPED;
 
     prev.push({
       create: true,

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.8.0-beta.30",
+  "version": "0.8.0-beta.32",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
+  "typings": "typings/index.d.ts",
   "repository": "git@github.com:testomatio/reporter.git",
   "author": "Michael Bodnarchuk <davert@testomat.io>,Koushik Mohan <koushikmohan1996@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@octokit/rest": "^19.0.5",
-    "aws-sdk": "^2.1072.0",
     "@aws-sdk/client-s3": "^3.279.0",
     "@aws-sdk/lib-storage": "^3.279.0",
+    "@octokit/rest": "^19.0.5",
+    "aws-sdk": "^2.1072.0",
     "axios": "^0.25.0",
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
+    "csv-writer": "^1.6.0",
+    "debug": "^4.3.4",
     "dotenv": "^16.0.1",
     "fast-xml-parser": "^4.0.8",
     "glob": "^8.0.3",
@@ -24,7 +27,7 @@
     "json-cycle": "^1.3.0",
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
-    "csv-writer": "^1.6.0"
+    "uuid": "^9.0.0"
   },
   "files": [
     "bin",
@@ -49,6 +52,7 @@
   },
   "devDependencies": {
     "@cucumber/cucumber": "^8.6.0",
+    "@redocly/cli": "^1.0.0-beta.125",
     "@wdio/reporter": "^7.16.13",
     "chai": "^4.3.6",
     "codeceptjs": "^3.2.3",