@testomatio/reporter 1.2.0-beta-4 → 1.2.0

package/lib/xmlReader.js

@@ -1,57 +1,57 @@
 const debug = require('debug')('@testomatio/reporter:xml');
-const path = require("path");
+const path = require('path');
 const chalk = require('chalk');
-const fs = require("fs");
-const { XMLParser } = require("fast-xml-parser");
+const fs = require('fs');
+const { XMLParser } = require('fast-xml-parser');
 const { APP_PREFIX, STATUS } = require('./constants');
-const { fetchFilesFromStackTrace, 
-        fetchIdFromOutput, 
-        fetchSourceCode, 
-        fetchSourceCodeFromStackTrace, 
-        fetchIdFromCode,
-        humanize
-      } = require('./utils/utils');
+const {
+  fetchFilesFromStackTrace,
+  fetchIdFromOutput,
+  fetchSourceCode,
+  fetchSourceCodeFromStackTrace,
+  fetchIdFromCode,
+  humanize,
+} = require('./utils/utils');
 const upload = require('./fileUploader');
 const pipesFactory = require('./pipe');
 const adapterFactory = require('./junit-adapter');
+const config = require('./config');
 
-const TESTOMATIO_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
-const TESTOMATIO = process.env.TESTOMATIO; // key?
+const TESTOMATIO_URL = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
 const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
 
 const options = {
   ignoreDeclaration: true,
   ignoreAttributes: false,
   alwaysCreateTextNode: false,
-  attributeNamePrefix: "",
+  attributeNamePrefix: '',
   parseTagValue: true,
 };
 
 const reduceOptions = {};
 
 class XmlReader {
-
   constructor(opts = {}) {
     this.requestParams = {
-      apiKey: opts.apiKey || TESTOMATIO,
+      apiKey: opts.apiKey || config.TESTOMATIO,
       url: opts.url || TESTOMATIO_URL,
       title: TESTOMATIO_TITLE,
       env: TESTOMATIO_ENV,
       group_title: TESTOMATIO_RUNGROUP_TITLE,
     };
     this.runId = opts.runId || TESTOMATIO_RUN;
-    this.adapter = adapterFactory(opts.lang?.toLowerCase(), opts)
+    this.adapter = adapterFactory(opts.lang?.toLowerCase(), opts);
     if (!this.adapter) throw new Error('XML adapter for this format not found');
 
     this.opts = opts || {};
-    this.store = {}
+    this.store = {};
     this.pipes = pipesFactory(opts, this.store);
 
     this.parser = new XMLParser(options);
-    this.tests = []
-    this.stats = {}
+    this.tests = [];
+    this.stats = {};
     this.stats.language = opts.lang?.toLowerCase();
-    this.filesToUpload = {}
+    this.filesToUpload = {};
 
     this.version = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json')).toString()).version;
     console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
@@ -82,8 +82,8 @@ class XmlReader {
     } else if (jsonResult.assemblies) {
       return this.processXUnit(jsonResult.assemblies);
     } else {
-      console.log(jsonResult)
-      throw new Error("Format can't be parsed")
+      console.log(jsonResult);
+      throw new Error("Format can't be parsed");
     }
 
     return this.processJUnit(jsonSuite);
@@ -96,7 +96,7 @@ class XmlReader {
     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);
 
@@ -135,21 +135,22 @@ class XmlReader {
     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(', ')[0].split('.');
-      const suite_title = suite.pop();
-      return {
-        title,
-        example,
-        file: suite.join('/'),
-        description: td.Description,
-        suite_title,
-        id: td.Execution.id,
-      }
-    }) || [];
+    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(', ')[0].split('.');
+        const suite_title = suite.pop();
+        return {
+          title,
+          example,
+          file: suite.join('/'),
+          description: td.Description,
+          suite_title,
+          id: td.Execution.id,
+        };
+      }) || [];
 
     let result = jsonSuite?.TestRun?.Results?.UnitTestResult;
     if (!Array.isArray(result)) result = [result].filter(d => !!d);
@@ -160,10 +161,9 @@ class XmlReader {
       run_time: parseFloat(td.duration) * 1000,
       status: td.outcome,
       stack: td.Output.StdOut,
-      files: td?.ResultFiles?.ResultFile?.map(rf => rf.path)
+      files: td?.ResultFiles?.ResultFile?.map(rf => rf.path),
     }));
 
-
     results.forEach(r => {
       const test = tests.find(t => t.id === r.id) || {};
       r.suite_title = test.suite_title;
@@ -223,7 +223,7 @@ class XmlReader {
 
           if (testCase.failure) {
             message = testCase.failure.message;
-            stack = testCase.failure['stack-trace']
+            stack = testCase.failure['stack-trace'];
           }
           if (testCase.reason) {
             message = testCase.reason.message;
@@ -250,7 +250,6 @@ class XmlReader {
             suite_title,
             run_time,
           });
-
         });
       });
     });
@@ -283,12 +282,12 @@ class XmlReader {
       passed_count: 0,
       failed_count: 0,
       skipped_count: 0,
-    }
+    };
     this.tests.forEach(t => {
       this.stats.tests_count++;
       if (t.status === 'passed') this.stats.passed_count++;
       if (t.status === 'failed') this.stats.failed_count++;
-    })
+    });
     if (this.stats.failed_count) this.stats.status = 'failed';
 
     return this.stats;
@@ -297,7 +296,7 @@ class XmlReader {
   fetchSourceCode() {
     this.tests.forEach(t => {
       try {
-        const file = this.adapter.getFilePath(t)
+        const file = this.adapter.getFilePath(t);
         if (!file) return;
 
         if (!this.stats.language) {
@@ -310,16 +309,16 @@ class XmlReader {
         }
 
         if (!fs.existsSync(file)) {
-          debug('Failed to open file with the source code', 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 })
+        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 })
+        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)
+        debug(err);
       }
     });
   }
@@ -327,21 +326,22 @@ class XmlReader {
   formatTests() {
     this.tests.forEach(t => {
       if (t.file) {
-        t.file = t.file.replace(process.cwd() + path.sep, '')
+        t.file = t.file.replace(process.cwd() + path.sep, '');
       }
 
-      this.adapter.formatTest(t)
+      this.adapter.formatTest(t);
 
       t.title = humanize(t.title);
     });
   }
 
   formatErrors() {
-    this.tests.filter(t => !!t.stack).forEach(t => {
-      t.stack = this.formatStack(t)
-      t.message = this.adapter.formatMessage(t);
-    });
-
+    this.tests
+      .filter(t => !!t.stack)
+      .forEach(t => {
+        t.stack = this.formatStack(t);
+        t.message = this.adapter.formatMessage(t);
+      });
   }
 
   formatStack(t) {
@@ -359,7 +359,7 @@ class XmlReader {
   async uploadArtifacts() {
     for (const test of this.tests.filter(t => !!t.stack)) {
       let files = [];
-      if (test.files?.length) files = test.files.map(f => path.join(process.cwd(), f))
+      if (test.files?.length) files = test.files.map(f => path.join(process.cwd(), f));
       files = [...files, ...fetchFilesFromStackTrace(test.stack)];
 
       if (!files.length) continue;
@@ -378,7 +378,7 @@ class XmlReader {
       group_title: this.requestParams.group_title,
     };
 
-    debug("Run", runParams);
+    debug('Run', runParams);
 
     return Promise.all(this.pipes.map(p => p.createRun(runParams)));
   }
@@ -391,12 +391,10 @@ class XmlReader {
     this.formatErrors();
     this.formatTests();
 
-    debug(
-      'Uploading data',
-      {
-        ...this.stats,
-        tests: this.tests,
-      })
+    debug('Uploading data', {
+      ...this.stats,
+      tests: this.tests,
+    });
 
     const dataString = {
       ...this.stats,
@@ -411,59 +409,62 @@ class XmlReader {
 
 module.exports = XmlReader;
 
-
 function reduceTestCases(prev, item) {
   let testCases = item.testcase;
   if (!testCases) testCases = item['test-case'];
   if (!Array.isArray(testCases)) {
-    testCases = [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 || '';
-
-    let stack = '';
-    let message = '';
-    if (testCaseItem.error) stack = testCaseItem.error;
-    if (testCaseItem.failure) stack = testCaseItem.failure;
-    if (testCaseItem?.failure?.['stack-trace']) stack = testCaseItem.failure['stack-trace'];
-    if (testCaseItem?.failure?.message) message = testCaseItem.failure.message;
-    if (testCaseItem?.error?.message) message = testCaseItem.error.message;
-
-    if (testCaseItem.failure && testCaseItem.failure['#text']) stack = testCaseItem.failure['#text'];
-    if (testCaseItem.error && testCaseItem.error['#text']) stack = testCaseItem.error['#text'];
-    if (!message) message = stack.trim().split('\n')[0];
-
-    // 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;
-    if ('skipped' in testCaseItem) status = STATUS.SKIPPED;
-
-    prev.push({
-      create: true,
-      file,
-      stack,
-      test_id: testId,
-      message,
-      line: testCaseItem.lineno,
-      // seconds are used in junit reports, but ms are used by testomatio
-      run_time: parseFloat(testCaseItem.time || testCaseItem.duration) * 1000,
-      status,
-      title: testCaseItem.name,
-      suite_title: reduceOptions.preferClassname ? testCaseItem.classname : (item.name || testCaseItem.classname),
-    })
-  });
+  testCases
+    .filter(t => !!t)
+    .forEach(testCaseItem => {
+      const file = testCaseItem.file || item.filepath || '';
+
+      let stack = '';
+      let message = '';
+      if (testCaseItem.error) stack = testCaseItem.error;
+      if (testCaseItem.failure) stack = testCaseItem.failure;
+      if (testCaseItem?.failure?.['stack-trace']) stack = testCaseItem.failure['stack-trace'];
+      if (testCaseItem?.failure?.message) message = testCaseItem.failure.message;
+      if (testCaseItem?.error?.message) message = testCaseItem.error.message;
+
+      if (testCaseItem.failure && testCaseItem.failure['#text']) stack = testCaseItem.failure['#text'];
+      if (testCaseItem.error && testCaseItem.error['#text']) stack = testCaseItem.error['#text'];
+      if (!message) message = stack.trim().split('\n')[0];
+
+      // 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;
+      if ('skipped' in testCaseItem) status = STATUS.SKIPPED;
+
+      prev.push({
+        create: true,
+        file,
+        stack,
+        test_id: testId,
+        message,
+        line: testCaseItem.lineno,
+        // seconds are used in junit reports, but ms are used by testomatio
+        run_time: parseFloat(testCaseItem.time || testCaseItem.duration) * 1000,
+        status,
+        title: testCaseItem.name,
+        suite_title: reduceOptions.preferClassname ? testCaseItem.classname : item.name || testCaseItem.classname,
+      });
+    });
   return prev;
 }
 
 function processTestSuite(testsuite) {
   if (!testsuite) return [];
-  if (testsuite.testsuite) return processTestSuite(testsuite.testsuite)
-  if (testsuite['test-suite']) return processTestSuite(testsuite['test-suite'])
+  if (testsuite.testsuite) return processTestSuite(testsuite.testsuite);
+  if (testsuite['test-suite']) return processTestSuite(testsuite['test-suite']);
 
   let suites = testsuite;
   if (!Array.isArray(testsuite)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.2.0-beta-4",
+  "version": "1.2.0",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -12,7 +12,8 @@
     "@aws-sdk/lib-storage": "^3.279.0",
     "@octokit/rest": "^19.0.5",
     "aws-sdk": "^2.1072.0",
-    "axios": "^0.25.0",
+    "axios": "^1.6.2",
+    "axios-retry": "^3.9.1",
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
@@ -30,6 +31,7 @@
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
     "minimatch": "^9.0.3",
+    "promise-retry": "^2.0.1",
     "uuid": "^9.0.0"
   },
   "files": [
@@ -51,7 +53,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:storage": "npx mocha ./tests-storage/**"
+    "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": {
     "@cucumber/cucumber": "^9.3.0",

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('./utils/utils');
-
-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() {
-    this.dataStorage = new DataStorage('artifact');
-
-    // 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();