@testomatio/reporter 0.8.0-beta.9 → 0.8.2-beta.1

package/lib/pipe/testomatio.js

@@ -1,100 +1,114 @@
+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 {
-  isEnabled = false;
-
-  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`),
-      );
-      return;
+      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 data = err.response.data || { message: '' };
+          const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
             chalk.blue(this.title),
-            `Report couldn't be processed: (${err.response.status}) ${data.message}`,
+            `Report couldn't be processed: (${err.response.status}) ${responseData.message}`,
           );
           return;
         }
@@ -102,18 +116,31 @@ 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) {
           console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
@@ -134,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())
 
@@ -79,6 +79,8 @@ const fetchSourceCodeFromStackTrace = (stack = '') => {
   const prepend = 3;
   const source = fetchSourceCode(fs.readFileSync(file).toString(), { line, prepend, limit: 7 })
 
+  if (!source) return '';
+
   return source.split('\n')
     .map((l, i) => {
       if (i === prepend) return `${line} > ${chalk.bold(l)}`;
@@ -137,15 +139,46 @@ const fetchSourceCode = (contents, opts = {}) => {
   }
 }
 
-const isSameTest = (test, t) => t.title == test.title && t.suite_title == test.suite_title && Object.values(t.example) == Object.values(test.example) && t.test_id == test.test_id
+const isSameTest = (test, t) => (typeof t === 'object') 
+    && (typeof test === 'object') 
+    && t.title === test.title 
+    && t.suite_title === test.suite_title 
+    && Object.values(t.example || {}) === Object.values(test.example || {})
+    && t.test_id === test.test_id;
+
+const getCurrentDateTime = () => {
+  const today = new Date();
+  
+  return `${today.getFullYear()  }_${  today.getMonth() + 1  }_${  today.getDate()  }_${ 
+         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,
+  specificTestInfo,
+  isValidUrl,
+  ansiRegExp,
+  parseTest,
+  parseSuite 
+}

package/lib/xmlReader.js

@@ -1,15 +1,15 @@
+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;
@@ -36,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);
 
@@ -92,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,
@@ -119,49 +121,62 @@ class XmlReader {
   }  
 
   processTRX(jsonSuite) {
-    const tests = jsonSuite?.TestRun?.TestDefinitions?.UnitTest?.map(td => {
+    let defs = jsonSuite?.TestRun?.TestDefinitions?.UnitTest;
+    if (!Array.isArray(defs)) defs = [defs].filter(d => !!d);
+
+    const tests = defs.map(td => {
       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,
       }
     }) || [];
 
-    const results = jsonSuite?.TestRun?.Results?.UnitTestResult?.map(td => ({ 
+    let result = jsonSuite?.TestRun?.Results?.UnitTestResult;
+    if (!Array.isArray(result)) result = [result].filter(d => !!d);
+
+    const results = result.map(td => ({ 
       id: td.executionId, 
       run_time: parseFloat(td.duration),
       status: td.outcome, 
-      stack: td.Output.StdOut  
+      stack: td.Output.StdOut,
+      files: td?.ResultFiles?.ResultFile?.map(rf => rf.path)
     }));
 
+    
     results.forEach(r => {
-      const test = tests.find(t => t.id === r.id) || {};
+      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;
     });
+
+    debug(results);
     
     const counters = jsonSuite?.TestRun?.ResultSummary?.Counters || {};
 
     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;
+    this.tests = results.filter(t => !!t.title);
 
     return {
       status,
@@ -212,9 +227,7 @@ class XmlReader {
         const contents = fs.readFileSync(file).toString();
         t.code = fetchSourceCode(contents, { ...t, lang: this.stats.language })
       } catch (err) {
-        if (process.env.DEBUG) {
-            console.log(err)
-        }
+        debug(err)
       }
     });
   }
@@ -264,7 +277,10 @@ class XmlReader {
 
   async uploadArtifacts() {
     for (const test of this.tests.filter(t => !!t.stack)) {
-      const files = fetchFilesFromStackTrace(test.stack);
+      let files = [];
+      if (test.files.length) files = test.files.map(f => path.join(process.cwd(), f))
+      files = [...files, ...fetchFilesFromStackTrace(test.stack)];
+      debug('Uploading files', files)
       test.artifacts = await Promise.all(files.map(f => upload.uploadFileByPath(f, this.runId)));
     }
   }
@@ -277,7 +293,7 @@ class XmlReader {
       group_title: this.requestParams.group_title,
     };    
 
-    if (process.env.DEBUG) console.log("Run", runParams);
+    debug("Run", runParams);
 
     return Promise.all(this.pipes.map(p => p.createRun(runParams)));
   }
@@ -290,17 +306,17 @@ class XmlReader {
     this.formatErrors();
     this.formatTests();
 
-    if (process.env.DEBUG) {
-      console.log({
-        ...this.stats,
-        tests: this.tests,
-      })
-    }
+    debug(
+      'Uploading data',
+      {
+      ...this.stats,
+      tests: this.tests,
+    })
 
     const dataString = {
       ...this.stats,
       api_key: this.requestParams.apiKey,
-      status_event: 'finish',
+      status: 'finished',
       tests: this.tests,
     };
 
@@ -335,9 +351,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,26 +1,33 @@
 {
   "name": "@testomatio/reporter",
-  "version": "0.8.0-beta.9",
+  "version": "0.8.2-beta.1",
   "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": {
+    "@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",
     "has-flag": "^5.0.1",
+    "humanize-duration": "^3.27.3",
     "is-valid-path": "^0.1.1",
     "json-cycle": "^1.3.0",
     "lodash.memoize": "^4.1.2",
-    "lodash.merge": "^4.6.2"
+    "lodash.merge": "^4.6.2",
+    "uuid": "^9.0.0"
   },
   "files": [
     "bin",
@@ -28,6 +35,7 @@
     "testcafe"
   ],
   "scripts": {
+    "clear-exportdir": "rm -rf export/",
     "pretty": "prettier --write .",
     "lint": "eslint lib",
     "lint:fix": "eslint lib --fix",
@@ -35,15 +43,16 @@
     "init": "cd ./tests/adapter/examples/cucumber && npm i",
     "test:unit": "mocha tests",
     "test:adapter": "mocha './tests/adapter/index.test.js'",
+    "test:pipes": "mocha './tests/pipes/*_test.js'",
     "test:adapter:jest:example": "jest './tests/adapter/examples/jest/index.test.js' --config='./tests/adapter/examples/jest/jest.config.js'",
     "test:adapter:mocha:example": "mocha './tests/adapter/examples/mocha/index.test.js' --config='./tests/adapter/examples/mocha/mocha.config.js'",
     "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"
   },
-  "peerDependencies": {},
   "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",

package/testcafe/index.js

@@ -1,61 +0,0 @@
-const TestomatClient = require('@testomatio/reporter/lib/client');
-const TRConstants = require('@testomatio/reporter/lib/constants');
-const util = require('@testomatio/reporter/lib/util');
-
-module.exports = () => {
-  const apiKey = process.env.TESTOMATIO;
-  let failed = false;
-
-  if (apiKey === '' || apiKey === undefined) {
-    throw new Error('Testomat.io API key cannot be empty');
-  }
-  const client = new TestomatClient({ apiKey });
-
-  return {
-    reportTaskStart(startTime, userAgents) {
-      console.log('TestCafe started with: ', userAgents);
-      client.createRun();
-    },
-
-    reportFixtureStart(name) {
-      console.log(`Suite : ${name}`);
-    },
-
-    reportTestDone(name, testRunInfo) {
-      let status = TRConstants.PASSED;
-      let message = '';
-
-      if (testRunInfo.skipped) {
-        status = TRConstants.SKIPPED;
-      }
-      if (testRunInfo.errs.length) {
-        status = TRConstants.FAILED;
-        message = this.renderErrors(testRunInfo.errs);
-        failed = true;
-      }
-      console.log(` - ${name} : ${status}`);
-      client.addTestRun(util.parseTest(name), status, {
-        error: testRunInfo.errs.length ? testRunInfo.errs[0] : null,
-        message,
-        title: name,
-        time: testRunInfo.durationMs,
-      });
-    },
-
-    renderErrors(errors) {
-      let errorMessage = '';
-      errors.forEach((error, id) => {
-        errorMessage = `${errorMessage}${this.formatError(error, `${id + 1} `)}\n`;
-      });
-
-      console.log(errorMessage);
-      return errorMessage.replace(util.ansiRegExp(), '');
-    },
-
-    reportTaskDone() {
-      const status = failed ? TRConstants.FAILED : TRConstants.PASSED;
-      console.log(`Status : ${status}`);
-      client.updateRunStatus(status);
-    },
-  };
-};

package/testcafe/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "testcafe-reporter-testomatio",
-  "version": "0.1.1",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "koushikmohan1996@gmail.com",
-  "license": "ISC",
-  "dependencies": {
-    "@testomatio/reporter": "^0.6.10"
-  }
-}