@testomatio/reporter 1.1.1-beta-codecept-logger → 1.1.1-beta.1.fix-logger

package/lib/{storages → services}/logger.js

@@ -1,6 +1,6 @@
 const chalk = require('chalk');
-const debug = require('debug')('@testomatio/reporter:logger');
-const DataStorage = require('./data-storage');
+const debug = require('debug')('@testomatio/reporter:services-logger');
+const { dataStorage } = require('../data-storage');
 
 const LOG_METHODS = ['assert', 'debug', 'error', 'info', 'log', 'trace', 'warn'];
 const LEVELS = {
@@ -26,9 +26,7 @@ class Logger {
   // set default logger to be used in log, warn, error, etc methods
   #originalUserLogger = { ...console };
 
-  #dataStorage;
-
-  #context = null;
+  #isConsoleIntercepted = false;
 
   static #instance;
 
@@ -46,25 +44,7 @@ class Logger {
   logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
 
   constructor() {
-    this.#dataStorage = new DataStorage('log');
-
-    // intercept console by default
-    this.intercept(console);
-  }
-
-  /**
-   * @param { 'file' | 'global' } storageType
-   */
-  setStorageType(storageType) {
-    this.isFileStorage = storageType === 'file';
-    this.#dataStorage.isFileStorage = this.isFileStorage;
-  }
-
-  /**
-   * @param {string} context - suite title + test title
-   */
-  setContext(context) {
-    this.#context = context;
+    if (!dataStorage.isFileStorage || process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS) this.intercept(console);
   }
 
   /**
@@ -82,7 +62,7 @@ class Logger {
       }
     }
     logs = chalk.blue(`> ${logs}`);
-    this.#dataStorage.putData(logs, this.#context);
+    dataStorage.putData('log', logs);
   }
 
   /**
@@ -91,7 +71,8 @@ class Logger {
    * @returns {string[]}
    */
   getLogs(context) {
-    const logs = this.#dataStorage.getData(context);
+    const logs = dataStorage.getData('log', context);
+    if (!logs) return [];
     return logs;
   }
 
@@ -124,7 +105,7 @@ class Logger {
    * 2. Standard: log(`text ${someVar}`)
    * 3. Standard with multiple arguments: log('text', someVar)
    */
-  templateLiteralLog(strings, ...args) {
+  _templateLiteralLog(strings, ...args) {
     if (Array.isArray(strings)) strings = strings.filter(item => item !== '').map(item => item.trim());
     if (Array.isArray(args)) args = args.filter(item => item !== '');
 
@@ -151,7 +132,7 @@ class Logger {
       logs = this.#stringifyLogs(strings, ...args);
     }
     this.#originalUserLogger.log(logs);
-    this.#dataStorage.putData(logs, this.#context);
+    dataStorage.putData('log', logs);
   }
 
   /**
@@ -168,11 +149,12 @@ class Logger {
 
     const logs = this.#stringifyLogs(...argsArray);
 
-    // skip logs from testomatio reporter itself
-    if (logs.includes('[TESTOMATIO]')) return;
-
     const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.#dataStorage.putData(colorizedLogs, this.#context);
+    // do not attach logs from testomatio reporter itself
+    if (!logs.includes('[TESTOMATIO]')) {
+      dataStorage.putData('log', colorizedLogs);
+    }
+
     try {
       // level.toLowerCase() represents method name (log, warn, error, etc)
       this.#originalUserLogger[level.toLowerCase()](colorizedLogs);
@@ -218,7 +200,7 @@ class Logger {
     /* prevent multiple console interceptions (cause of infinite loop)
     actual only for "console", because its used as default output and is intercepted by default */
     const isUserLoggerConsole = userLogger.toString?.().toLowerCase() === '[object console]';
-    if (isUserLoggerConsole && global.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED) {
+    if (isUserLoggerConsole && this.#isConsoleIntercepted) {
       debug(`Try to intercept console, but it is already intercepted`);
       return;
     }

package/lib/utils/utils.js

@@ -141,7 +141,15 @@ const fetchSourceCode = (contents, opts = {}) => {
   // remove special chars from title
   if (!lineIndex && opts.title) {
     const title = opts.title.replace(/[([@].*/g, '');
-    lineIndex = lines.findIndex(l => l.includes(title));
+    
+    if (opts.lang === 'java') {
+      lineIndex = lines.findIndex(l => l.includes(`test${title}`));
+      if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`@DisplayName("${title}`));
+      if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`public void ${title}`));
+      if (lineIndex === -1) lineIndex = lines.findIndex(l => l.includes(`${title}(`));
+    } else {
+      lineIndex = lines.findIndex(l => l.includes(title));
+    }
   }
 
   if (opts.prepend) {
@@ -290,6 +298,20 @@ function removeColorCodes(input) {
   return input.replace(/\x1b\[[0-9;]*m/g, '');
 }
 
+const jestHelpers = {
+  getIdOfCurrentlyRunningTest: () => {
+    if (!process.env.JEST_WORKER_ID) return null;
+    try {
+      // TODO: expect?.getState()?.testPath + ' ' + expect?.getState()?.currentTestName
+      // @ts-expect-error "expect" could only be defined inside Jest environement (forbidden to import it outside)
+      // eslint-disable-next-line no-undef
+      return expect?.getState()?.currentTestName;
+    } catch (e) {
+      return null;
+    }
+  },
+};
+
 module.exports = {
   isSameTest,
   fetchSourceCode,
@@ -306,5 +328,6 @@ module.exports = {
   parseSuite,
   humanize,
   removeColorCodes,
-  foundedTestLog
+  foundedTestLog,
+  jestHelpers,
 };

package/lib/xmlReader.js

@@ -1,35 +1,36 @@
 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 { TESTOMATIO } = require('./config');
 
-const TESTOMATIO_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN, TESTOMATIO } = process.env;
+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,
@@ -39,18 +40,18 @@ class XmlReader {
       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}`);
@@ -81,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);
@@ -95,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);
 
@@ -134,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);
@@ -159,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;
@@ -222,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;
@@ -249,7 +250,6 @@ class XmlReader {
             suite_title,
             run_time,
           });
-
         });
       });
     });
@@ -282,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;
@@ -296,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) {
@@ -309,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);
       }
     });
   }
@@ -326,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) {
@@ -358,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;
@@ -377,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)));
   }
@@ -390,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,
@@ -410,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.1.1-beta-codecept-logger",
+  "version": "1.1.1-beta.1.fix-logger",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -52,7 +52,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/reporter-functions.test.js"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.3.0",