@testomatio/reporter 1.3.5-beta → 1.4.1-beta-1

package/lib/xmlReader.js

@@ -4,12 +4,17 @@ const chalk = require('chalk');
 const fs = require("fs");
 const { XMLParser } = require("fast-xml-parser");
 const { APP_PREFIX, STATUS } = require('./constants');
-const { fetchFilesFromStackTrace, fetchSourceCode, fetchSourceCodeFromStackTrace } = require('./util');
+const { fetchFilesFromStackTrace, 
+        fetchIdFromOutput, 
+        fetchSourceCode, 
+        fetchSourceCodeFromStackTrace, 
+        fetchIdFromCode,
+        humanize
+      } = require('./utils/utils');
 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;
@@ -25,7 +30,7 @@ const options = {
 const reduceOptions = {};
 
 class XmlReader {
-  
+
   constructor(opts = {}) {
     this.requestParams = {
       apiKey: opts.apiKey || TESTOMATIO,
@@ -35,12 +40,12 @@ class XmlReader {
       group_title: TESTOMATIO_RUNGROUP_TITLE,
     };
     this.runId = opts.runId || TESTOMATIO_RUN;
-    this.adapter = adapterFactory(null, opts)
+    this.adapter = adapterFactory(opts.lang?.toLowerCase(), opts)
     if (!this.adapter) throw new Error('XML adapter for this format not found');
 
     this.opts = opts || {};
-    const store = {}
-    this.pipes = pipesFactory(opts, store);
+    this.store = {}
+    this.pipes = pipesFactory(opts, this.store);
 
     this.parser = new XMLParser(options);
     this.tests = []
@@ -49,27 +54,33 @@ class XmlReader {
     this.filesToUpload = {}
 
     this.version = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json')).toString()).version;
-    console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);    
+    console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
   }
 
   connectAdapter() {
-    if (this.opts.javaTests) return adapterFactory('java', this.opts);
-    return adapterFactory(this.stats.language, this.opts);
+    if (this.opts.javaTests) {
+      this.adapter = adapterFactory('java', this.opts);
+      return this.adapter;
+    }
+    this.adapter = adapterFactory(this.stats.language, this.opts);
+    return this.adapter;
   }
 
-  parse(fileName) {       
+  parse(fileName) {
     const xmlData = fs.readFileSync(path.resolve(fileName));
     const jsonResult = this.parser.parse(xmlData);
     let jsonSuite;
-    
+
     if (jsonResult.testsuites) {
       jsonSuite = jsonResult.testsuites;
     } else if (jsonResult.testsuite) {
       jsonSuite = jsonResult;
     } else if (jsonResult.TestRun) {
-      return this.processTRX(jsonResult);      
+      return this.processTRX(jsonResult);
     } else if (jsonResult['test-run']) {
       return this.processNUnit(jsonResult['test-run']);
+    } else if (jsonResult.assemblies) {
+      return this.processXUnit(jsonResult.assemblies);
     } else {
       console.log(jsonResult)
       throw new Error("Format can't be parsed")
@@ -83,9 +94,9 @@ class XmlReader {
 
     reduceOptions.preferClassname = this.stats.language === 'python';
     const resultTests = processTestSuite(testsuite);
-    
+
     const hasFailures = resultTests.filter(t => t.status === 'failed').length > 0;
-    const status = ( failures > 0 || errors > 0 || hasFailures) ? 'failed' : 'passed';
+    const status = (failures > 0 || errors > 0 || hasFailures) ? 'failed' : 'passed';
 
     this.tests = this.tests.concat(resultTests);
 
@@ -118,7 +129,7 @@ class XmlReader {
       skipped_count: parseInt(inconclusive + skipped, 10),
       tests: resultTests,
     };
-  }  
+  }
 
   processTRX(jsonSuite) {
     let defs = jsonSuite?.TestRun?.TestDefinitions?.UnitTest;
@@ -127,10 +138,10 @@ class XmlReader {
     const tests = defs.map(td => {
       const title = td.name.replace(/\(.*?\)/, '').trim();
       let example = td.name.match(/\((.*?)\)/);
-      if (example) example = { ...example[1].split(',')};
+      if (example) example = { ...example[1].split(',') };
       const suite = td.TestMethod.className.split(', ')[0].split('.');
       const suite_title = suite.pop();
-      return { 
+      return {
         title,
         example,
         file: suite.join('/'),
@@ -143,18 +154,18 @@ class XmlReader {
     let result = jsonSuite?.TestRun?.Results?.UnitTestResult;
     if (!Array.isArray(result)) result = [result].filter(d => !!d);
 
-    const results = result.map(td => ({ 
+    const results = result.map(td => ({
       id: td.executionId,
       // seconds are used in junit reports, but ms are used by testomatio
       run_time: parseFloat(td.duration) * 1000,
-      status: td.outcome, 
+      status: td.outcome,
       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;
@@ -169,7 +180,7 @@ class XmlReader {
     });
 
     debug(results);
-    
+
     const counters = jsonSuite?.TestRun?.ResultSummary?.Counters || {};
 
     const failed_count = parseInt(counters.failed, 10) + parseInt(counters.error, 10);
@@ -187,7 +198,80 @@ class XmlReader {
       skipped_count: parseInt(counters.notExecuted, 10),
       failed_count,
       tests: results,
-    };    
+    };
+  }
+
+  processXUnit(assemblies) {
+    const tests = [];
+
+    assemblies = Array.isArray(assemblies.assembly) ? assemblies.assembly : [assemblies.assembly];
+
+    assemblies.forEach(assembly => {
+      const { collection } = assembly;
+
+      const suites = Array.isArray(collection) ? collection : [collection];
+
+      suites.forEach(suite => {
+        const { test } = suite;
+        if (!test) return;
+        const cases = Array.isArray(test) ? test : [test];
+        cases.forEach(testCase => {
+          const { type, time, result } = testCase;
+
+          let message = '';
+          let stack = '';
+
+          if (testCase.failure) {
+            message = testCase.failure.message;
+            stack = testCase.failure['stack-trace']
+          }
+          if (testCase.reason) {
+            message = testCase.reason.message;
+          }
+
+          let status = STATUS.PASSED;
+          if (result === 'Pass') status = STATUS.PASSED;
+          if (result === 'Fail') status = STATUS.FAILED;
+          if (result === 'Skip') status = STATUS.SKIPPED;
+
+          const pathParts = type.split('.');
+          const suite_title = pathParts[pathParts.length - 1];
+          const file = pathParts.slice(0, -1).join('/');
+          const title = testCase.method || testCase.name.split('.').pop();
+          const run_time = parseFloat(time) * 1000;
+
+          tests.push({
+            create: true,
+            stack,
+            message,
+            file,
+            status,
+            title,
+            suite_title,
+            run_time,
+          });
+
+        });
+      });
+    });
+
+    const hasFailures = tests.filter(t => t.status === STATUS.FAILED).length > 0;
+    const status = hasFailures ? STATUS.FAILED : STATUS.PASSED;
+
+    this.tests = tests;
+
+    debug(tests);
+
+    return {
+      status,
+      create_tests: true,
+      name: 'xUnit',
+      tests_count: tests.length,
+      passed_count: tests.filter(t => t.status === STATUS.PASSED).length,
+      failed_count: tests.filter(t => t.status === STATUS.FAILED).length,
+      skipped_count: tests.filter(t => t.status === STATUS.SKIPPED).length,
+      tests,
+    };
   }
 
   calculateStats() {
@@ -221,12 +305,19 @@ class XmlReader {
           if (file.endsWith('.py')) this.stats.language = 'python';
           if (file.endsWith('.java')) this.stats.language = 'java';
           if (file.endsWith('.rb')) this.stats.language = 'ruby';
-          if (file.endsWith('.js')) this.stats.language  = 'js';
+          if (file.endsWith('.js')) this.stats.language = 'js';
           if (file.endsWith('.ts')) this.stats.language = 'ts';
         }
 
+        if (!fs.existsSync(file)) {
+          debug('Failed to open file with the source code', file)
+          return;
+        }
         const contents = fs.readFileSync(file).toString();
         t.code = fetchSourceCode(contents, { ...t, lang: this.stats.language })
+        if (t.code) debug('Fetched code for test %s', t.title);
+        t.test_id = fetchIdFromCode(t.code, { lang: this.stats.language })
+        if (t.test_id) debug('Fetched test id %s for test %s', t.test_id, t.title);
       } catch (err) {
         debug(err)
       }
@@ -241,18 +332,7 @@ class XmlReader {
 
       this.adapter.formatTest(t)
 
-      t.title = t.title
-      // insert a space before all caps
-        .replace(/([A-Z])/g, ' $1')
-      // _ chars to spaces
-        .replace(/_/g, ' ')
-      // uppercase the first character
-        .replace(/^(.)|\s(.)/g, $1 => $1.toLowerCase())
-
-        // remove standard prefixes
-        .replace(/^test\s/, '')
-        .replace(/^should\s/, '')
-        .trim();
+      t.title = humanize(t.title);
     });
   }
 
@@ -281,8 +361,12 @@ class XmlReader {
       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)));
+
+      if (!files.length) continue;
+
+      const runId = this.runId || this.store.runId || Date.now().toString();
+      test.artifacts = await Promise.all(files.map(f => upload.uploadFileByPath(f, runId)));
+      console.log(APP_PREFIX, `🗄️ Uploaded ${chalk.bold(`${files.length} artifacts`)} for test ${test.title}`);
     }
   }
 
@@ -292,7 +376,7 @@ class XmlReader {
       title: this.requestParams.title,
       env: this.requestParams.env,
       group_title: this.requestParams.group_title,
-    };    
+    };
 
     debug("Run", runParams);
 
@@ -310,9 +394,9 @@ class XmlReader {
     debug(
       'Uploading data',
       {
-      ...this.stats,
-      tests: this.tests,
-    })
+        ...this.stats,
+        tests: this.tests,
+      })
 
     const dataString = {
       ...this.stats,
@@ -334,6 +418,8 @@ function reduceTestCases(prev, item) {
   if (!Array.isArray(testCases)) {
     testCases = [testCases]
   }
+  const suiteOutput = item['system-out'] || item.output || item.log || '';
+  const suiteErr = item['system-err'] || item.output || item.log || '';
   testCases.filter(t => !!t).forEach(testCaseItem => {
     const file = testCaseItem.file || item.filepath || '';
 
@@ -349,8 +435,9 @@ function reduceTestCases(prev, item) {
     if (testCaseItem.error && testCaseItem.error['#text']) stack = testCaseItem.error['#text'];
     if (!message) message = stack.trim().split('\n')[0];
 
-    // prepend system output
-    stack = `${testCaseItem['system-out'] || testCaseItem.output || testCaseItem.log || ''}\n\n${stack}`.trim()
+    // eslint-disable-next-line
+    stack = `${testCaseItem['system-out'] || testCaseItem.output || testCaseItem.log || ''}\n\n${stack}\n\n${suiteOutput}\n\n${suiteErr}`.trim()
+    const testId = fetchIdFromOutput(stack);
 
     let status = STATUS.PASSED.toString();
     if ('failure' in testCaseItem || 'error' in testCaseItem) status = STATUS.FAILED;
@@ -360,6 +447,7 @@ function reduceTestCases(prev, item) {
       create: true,
       file,
       stack,
+      test_id: testId,
       message,
       line: testCaseItem.lineno,
       // seconds are used in junit reports, but ms are used by testomatio

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.3.5-beta",
+  "version": "1.4.1-beta-1",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -20,15 +20,16 @@
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
     "fast-xml-parser": "^4.0.8",
-    "glob": "^8.0.3",
+    "glob": "^10.3",
     "has-flag": "^5.0.1",
     "humanize-duration": "^3.27.3",
     "is-valid-path": "^0.1.1",
     "json-cycle": "^1.3.0",
-    "lodash": "^4.17.21",
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
-    "uuid": "^9.0.0"
+    "minimatch": "^9.0.3",
+    "uuid": "^9.0.0",
+    "promise-retry": "^2.0.1"
   },
   "files": [
     "bin",
@@ -42,21 +43,21 @@
     "lint:fix": "eslint lib --fix",
     "test": "mocha tests/**",
     "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"
+    "test:adapter:cucumber:example": "cd ./tests/adapter/examples/cucumber && npx cucumber-js",
+    "test:storage": "npx mocha ./tests-storage/**"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.3.0",
     "@redocly/cli": "^1.0.0-beta.125",
     "@wdio/reporter": "^7.16.13",
     "chai": "^4.3.6",
-    "codeceptjs": "^3.2.3",
+    "codeceptjs": "latest",
     "cucumber": "^6.0.7",
     "eslint": "^8.7.0",
     "eslint-config-airbnb-base": "^15.0.0",
@@ -66,6 +67,7 @@
     "jest": "^27.4.7",
     "mocha": "^9.2.0",
     "mock-http-server": "^1.4.5",
+    "pino": "^8.15.0",
     "prettier": "2.5.1",
     "puppeteer": "^13.1.2"
   },

package/lib/_ArtifactStorageOld.js

@@ -1,142 +0,0 @@
-const debug = require('debug')('@testomatio/reporter:storage');
-const { join, resolve } = require('path');
-const fs = require('fs');
-const os = require('os');
-const uuid = require('uuid');
-const { TESTOMAT_ARTIFACT_SUFFIX } = require('./constants');
-const { specificTestInfo } = require('./util');
-
-class ArtifactStorage {
-  
-  constructor(params) {
-    this.isFile = false;
-    this.isMemory = true;
-    this.storage = params?.toFile;
-
-    if (this.storage) {
-      // this is fine to use when you start saving artifacts;
-      // but when you need to retrieve them, you will not know if there is "isFile" param,
-      // because you need to create a new instance of ArtifactStorage inside client
-      // so the solution is make it opposite to isMemory (which will be retrieved from global)
-      this.isFile = true;
-      this.isMemory = false;
-      this.tmpDirFullpath = this.createTestomatTmpDir(ArtifactStorage._tmpPrefix);
-      debug('SAVE to tmp folder mode enabled!');
-    }
-  }
-
-  static async storeToFile(tmpDirName, artifact, testSuffix = "test") {
-    // this assumes to use multiple files for each test. do we really want this?
-    const suffix = TESTOMAT_ARTIFACT_SUFFIX + uuid.v4() + testSuffix;
-    const dirpath = join(os.tmpdir(), tmpDirName);
-    // why json?
-    const filepath = resolve(dirpath, `${suffix}.json`);
-
-    return fs.promises.appendFile(filepath, JSON.stringify(artifact));
-  }
-
-  static async artifact(artifact, context) {
-    // TODO: mode for different pre-hooks. As variant - "all-tests" || "only_fail"
-    // const mode = process.env.TESTOMAT_ARTIFACTS || "only_fail";
-
-    // you save the artifact without specifying its source - test id
-    if (Array.isArray(global.testomatioArtifacts)) {
-      debug("Saving artifacts to global storage");
-
-      global.testomatioArtifacts.push(artifact);
-    }
-
-    if (global?.testomatioArtifacts === undefined) {
-      const tmpDirNames = ArtifactStorage.tmpTestomatDirNames();
-
-      const testSuffix = specificTestInfo(context.test);
-
-      if (Array.isArray(tmpDirNames) && tmpDirNames.length) {
-        debug("Saving artifacts to memory tmp folder");
-
-        return ArtifactStorage.storeToFile(tmpDirNames[tmpDirNames.length - 1], artifact, testSuffix);
-      }
-    }
-  }
-
-  async artifactByTestName(test) {
-    const list = [];
-
-    if (this.isFile && this.tmpDirFullpath) {
-      const files = fs.readdirSync(this.tmpDirFullpath);
-
-      for (const file of files) {
-        if (file.includes(test)) {
-          const buff = await fs.promises.readFile(`${this.tmpDirFullpath  }/${  file}`);
-
-          list.push(JSON.parse(buff.toString()));
-        }
-      }
-    }
-
-    return list;
-  }
-
-  // returns all the content from all files; do we really need it?
-  async tmpContents() {
-    const contents = [];
-
-    if (this.isFile && this.tmpDirFullpath) {
-      const files = fs.readdirSync(this.tmpDirFullpath);
-
-      for (const file of files) {
-        const buff = await fs.promises.readFile(`${this.tmpDirFullpath  }/${  file}`);
-        const content = buff.toString();
-
-        contents.push(content);
-      }
-    }
-
-    return contents;
-  }
-
-  createTestomatTmpDir(clientPrefix) {
-    return fs.mkdtempSync(join(os.tmpdir(), clientPrefix));
-  }
-
-  clearTmpDirByName(name) {
-    const tmpDirPath = join(os.tmpdir(), name);
-
-    if (fs.existsSync(tmpDirPath)) {
-      fs.rmSync(tmpDirPath, { recursive: true });
-      debug(` Testomat tmpDir = ${tmpDirPath} was deleted successfully!`);
-
-      
-    }
-  }
-
-  // no need to use multiple dirs; we can implement it later if required
-  static tmpTestomatDirNames() {
-    const subname = ArtifactStorage._tmpPrefix || "tsmt_reporter";
-
-    return fs.readdirSync(os.tmpdir(), { withFileTypes: true })
-      .filter((item) => item.isDirectory())
-      .map((item) => item.name)
-      .filter((name) => name.includes(subname));
-  }
-
-  cleanup() {
-    // when you do a cleanup, I know nothing about isFile param
-    if (this.isFile && this.tmpDirFullpath) {
-      const tmpDirNames = ArtifactStorage.tmpTestomatDirNames();
-
-      if (Array.isArray(tmpDirNames) && tmpDirNames.length) {
-        for (const name of tmpDirNames) {
-          this.clearTmpDirByName(name);
-        }
-      }
-    }
-    else {
-      debug("The tmp folder has not been created! Nothing to delete");
-    }
-  }
-}
-
-ArtifactStorage._tmpPrefix = "tsmt_reporter";
-
-module.exports = ArtifactStorage;

package/lib/artifactStorage.js

@@ -1,25 +0,0 @@
-// const debug = require('debug')('@testomatio/reporter:logger');
-const { DataStorage } = require('./dataStorage');
-
-class ArtifactStorage {
-  constructor(params = {}) {
-    this.dataStorage = new DataStorage('artifact', params);
-
-    // singleton
-    if (!ArtifactStorage.instance) {
-      ArtifactStorage.instance = this;
-    }
-  }
-
-  save(data, context = null) {
-    this.dataStorage.putData(data, context);
-  }
-
-  get(context) {
-    this.dataStorage.getData(context);
-  }
-}
-
-ArtifactStorage.instance = null;
-
-module.exports = new ArtifactStorage();