@testomatio/reporter 1.0.2 → 1.0.3

package/lib/dataStorage.js

@@ -6,6 +6,7 @@ const { join } = require('path');
 const JestReporter = require('./adapter/jest');
 const { TESTOMAT_TMP_STORAGE } = require('./constants');
 const { fileSystem } = require('./util');
+const getTestIdFromTestTitle = require('./util').parseTest;
 
 class DataStorage {
   /**
@@ -13,52 +14,48 @@ class DataStorage {
    * Stores data to global variable or to file depending on what is applicable for current test runner.
    * dataType: 'log' | 'artifact' | ...
    * @param {*} dataType storage type (like 'log', 'artifact'); could be any string, used only to define file path
-   * @param {*} params
    */
-  constructor(dataType, params = {}) {
-    if (!dataType) throw new Error('Data type is required when creating data storage');
+  constructor(dataType) {
+    // if (!dataType) throw new Error('Data type is required when creating data storage');
     this.dataType = dataType || 'data';
-    this.dataDirName = `${dataType}s`;
-    this.isFileStorage = params?.isFileStorage ?? !global.testomatioDataStore;
+    this.dataDirName = this.dataType;
 
-    /*
-      FYI:
-      If this storage instance is used within test runner, it works fine.
-      But if, for example, we create storage instance inside the testomatio client (to get stored data),
-      the environment could be different (not already a test runner env).
-      Thus, checking environment is only reasonable when you put data to starage 
-      and potentially useless when get data from storage
-    */
-    this.runningEnvironment = this.getRunningEnviroment();
-    if (this.runningEnvironment === 'jest') this.isFileStorage = true;
+    this._refreshStorageType();
 
-    if (this.isFileStorage) {
-      this.dataDirPath = path.join(TESTOMAT_TMP_STORAGE.mainDir, this.dataDirName);
-      fileSystem.createDir(this.dataDirPath);
-    }
+    // dir is created in any case (not to recheck its existence every time)
+    this.dataDirPath = path.join(TESTOMAT_TMP_STORAGE.mainDir, this.dataDirName);
+    fileSystem.createDir(this.dataDirPath);
 
     debug(`Data storage mode: ${this.isFileStorage ? 'file' : 'memory'}`);
   }
 
-  // TODO: implement
-  getTestIdFromContext(context) { // eslint-disable-line
-    // eslint-disable-line
-    // return testId;
-  }
-
   /**
    * Try to define the running environment. Not 100% reliable and used as additional check
    * @returns jest | mocha | ...
    */
   getRunningEnviroment() {
+    // jest
     if (process.env.JEST_WORKER_ID) return 'jest';
+
+    // mocha
     try {
       // @ts-expect-error mocha is defined only in mocha environment
       if (typeof mocha !== 'undefined') return 'mocha';
     } catch (e) {
       // ignore
     }
-    return undefined;
+
+    // codeceptjs
+    // @ts-expect-error codeceptjs is defined only in codeceptjs environment
+    if (global.codeceptjs) return 'codeceptjs';
+
+    // others
+    // 'cucumber:current', 'cucumber:legacy'
+    if (global.testomatioRunningEnvironment) return global.testomatioRunningEnvironment;
+
+    if (process.env.PLAYWRIGHT_TEST_BASE_URL) return 'playwright';
+
+    return null;
   }
 
   /**
@@ -68,21 +65,24 @@ class DataStorage {
    * @returns
    */
   putData(data, context = null) {
-    // this.isFileStorage = !global.testomatioDataStore;
+    this._refreshStorageType();
 
-    let testId = null;
-    if (typeof context === 'string') {
-      testId = context;
-    } else {
-      // TODO: derive testId from context
-      // testId = context...
-    }
+    let testId = this._tryToRetrieveTestId(context) || null;
 
-    // try to get testId for Jest
+    if (this.runningEnvironment === 'codeceptjs') testId = testId ?? global.testomatioDataStore?.currentlyRunningTestId;
     if (this.runningEnvironment === 'jest') testId = testId ?? JestReporter.getIdOfCurrentlyRunningTest();
+    // logs in playwright are gathered by pw framwork itself
+    if (this.runningEnvironment === 'playwright' && this.dataType === 'log') return;
+
+    // get id from global store
+    if (global.testomatioDataStore && global.testomatioDataStore.currentlyRunningTestId)
+      testId = testId ?? global.testomatioDataStore?.currentlyRunningTestId;
 
     // if testId is not provided, data is be saved to `{dataType}_other` file;
-    if (!testId) testId = 'other';
+    if (!testId) {
+      debug(`No test id provided for ${this.dataType} data: ${data}`);
+      return;
+    }
 
     if (this.isFileStorage) {
       this._putDataToFile(data, testId);
@@ -92,13 +92,17 @@ class DataStorage {
   }
 
   /**
-   * Returns data, stored for specific testId (or data which was stored without test id specified)
+   * Returns data, stored for specific testId (or data which was stored without test id specified).
+   * This method will get data from global variable. But if it is not available, it will try to get data from file.
+   * Thus, good approach is to remove file storage folder before each test run (and after, for sure).
    *
-   * (Don't try to guess the execution environment (e.g. test runner) inside this method, it could be any)
+   * Defining the execution environment is not guaranteed! Is used only as additional check.
    * @param {*} context could be testId or any context (test, suite, etc) which is used to define testId
    * @returns
    */
   getData(context) {
+    this._refreshStorageType();
+
     let testId = null;
     if (typeof context === 'string') {
       testId = context;
@@ -109,18 +113,71 @@ class DataStorage {
 
     if (!testId) {
       debug(`Cannot get test id from passed context:\n}`, context);
+      return null;
     }
 
-    if (this.isFileStorage) {
-      return this._getDataFromFile(testId);
-    }
+    let testData = null;
+
     if (global?.testomatioDataStore) {
-      return this._getDataFromGlobalVar(testId);
+      testData = this._getDataFromGlobalVar(testId);
+      if (testData) return testData;
     }
+
+    if (this.isFileStorage || !testData) {
+      testData = this._getDataFromFile(testId);
+      if (testData) return testData;
+    }
+
     debug(`No ${this.dataType} data for test id ${testId} in both file and global variable`);
+    return testData;
+  }
+
+  /**
+   * This method is named as "try" because it does not guarantee that test id could be retrieved.
+   * Context could be anything (test, suite, string, etc) which is used to define testId.
+   * Or it could represent any other entity (which does not contain test id).
+   * @param {*} context
+   */
+  _tryToRetrieveTestId(context) {
+    if (!context) return null;
+    this._refreshStorageType();
+
+    if (this.runningEnvironment === 'playwright' || context?.title) {
+      // context is testInfo
+      const testId = getTestIdFromTestTitle(context.title);
+      if (testId) return testId;
+    }
+
+    if (typeof context === 'string') {
+      const testId = getTestIdFromTestTitle(context);
+      if (testId) return testId;
+    }
+
     return null;
   }
 
+  /**
+   * Refreshes storage type (file or global variable) depending on current environment
+   * This method should be run on each attempt to put or get data from/to storage
+   * Because storage instance is created before the test runner is started. And storage type could be changed
+   */
+  _refreshStorageType() {
+    this.isFileStorage = !global.testomatioDataStore;
+    /*
+        FYI:
+        If this storage instance is used within test runner, it works fine.
+        But if, for example, we create storage instance inside the testomatio client (to get stored data),
+        the environment could differs (not already a test runner environment).
+        Thus, checking environment is only reasonable when you put data to starage
+        (to define where to put data - to global variable or to file)
+        and potentially useless when getting data from storage
+      */
+    this.runningEnvironment = this.getRunningEnviroment();
+
+    // some test frameworks do not persist global variables, thus file storage is used for them
+    if (this.runningEnvironment === 'jest') this.isFileStorage = true;
+  }
+
   _getDataFromGlobalVar(testId) {
     try {
       if (global?.testomatioDataStore[this.dataDirName]) {
@@ -128,7 +185,7 @@ class DataStorage {
         debug(`Data for test id ${testId}:\n${testData}`);
         return testData;
       }
-      debug(`No ${this.dataType} data for test id ${testId}`);
+      debug(`No ${this.dataType} data for test id ${testId} in <global> storage`);
       return null;
     } catch (e) {
       // there could be no data, ignore
@@ -137,13 +194,13 @@ class DataStorage {
 
   _getDataFromFile(testId) {
     try {
-      const filepath = join(TESTOMAT_TMP_STORAGE.mainDir, `${this.dataType}_${testId}`);
+      const filepath = join(this.dataDirPath, `${this.dataType}_${testId}`);
       if (fs.existsSync(filepath)) {
         const testData = fs.readFileSync(filepath, 'utf-8');
         debug(`Data for test id ${testId}:\n${testData}`);
         return testData;
       }
-      debug(`No ${this.dataType} data for test id ${testId}`);
+      debug(`No ${this.dataType} data for test id ${testId} in <file> storage`);
       return null;
     } catch (e) {
       // there could be no data, ignore
@@ -153,14 +210,16 @@ class DataStorage {
 
   _putDataToGlobalVar(data, testId) {
     debug('Saving data to global variable for test', testId, ':\n', data, '\n');
-    global.testomatioDataStore[this.dataDirName] = {};
-    global.testomatioDataStore[this.dataDirName][testId] = data;
+    if (!global.testomatioDataStore[this.dataDirName]) global.testomatioDataStore[this.dataDirName] = {};
+    global.testomatioDataStore[this.dataDirName][testId] // eslint-disable-line no-unused-expressions
+      ? (global.testomatioDataStore[this.dataDirName][testId] += `\n${data}`)
+      : (global.testomatioDataStore[this.dataDirName][testId] = data);
   }
 
   _putDataToFile(data, testId) {
     if (typeof data !== 'string') data = JSON.stringify(data);
     const filename = `${this.dataType}_${testId}`;
-    const filepath = join(TESTOMAT_TMP_STORAGE.mainDir, filename);
+    const filepath = join(this.dataDirPath, filename);
     debug('Saving data to file for test', testId, 'to', filepath, ':\n', data, '\n');
 
     // TODO: handle multiple invocations of JSON.stringify.
@@ -177,4 +236,9 @@ module.exports.DataStorage = DataStorage;
 // TODO: rewrite client - everything regarding storing artifacts
 // TODO: try to define adapter inside client
 // TODO: use .env
-// TODO: ability to intercept multiple loggers
+// TODO: ability to intercept multiple loggers (upd: no need)
+
+
+/* Cypress
+Parallelization is only available if using Cypress Dashboard??
+*/

package/lib/logger.js

@@ -1,5 +1,6 @@
 const chalk = require('chalk');
 const debug = require('debug')('@testomatio/reporter:logger');
+const _ = require('lodash');
 const { DataStorage } = require('./dataStorage');
 
 const LOG_METHODS = ['assert', 'debug', 'error', 'info', 'log', 'trace', 'warn'];
@@ -24,61 +25,41 @@ class Logger {
   // _originalUserLogger used to output logs to console by the user logger
   // _loggerToIntercept intercepted and reassigned immediately when added
 
-  constructor(params = {}) {
+  constructor() {
     // set default logger to be used in log, warn, error, etc methods
     this._originalUserLogger = { ...console };
 
-    this.dataStorage = new DataStorage('log', params);
+    this.dataStorage = new DataStorage('log');
     this.logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
 
     // commented because prefer to use "intercept" method
     // if (params?.logger) this._loggerToIntercept = params.logger;
 
-    this.intercept(this._loggerToIntercept);
+    // intercept console by default
+    this.intercept(console);
 
     // singleton
     if (!Logger.instance) {
       Logger.instance = this;
     }
-  }
 
-  /**
-   * Tagget template literal. Allows to use different syntaxes:
-   * 1. Tagget template: $`text ${someVar}`
-   * 2. Standard: $(`text ${someVar}`)
-   * 3. Standard with multiple arguments: $('text', someVar)
-   */
-  _log(strings, ...args) {
-    let logs;
-    // this block means tagged template is used (syntax like $`text ${someVar}`)
-    if (Array.isArray(strings) && strings.length === args.length + 1) {
-      logs = strings.reduce(
-        (result, current, index) =>
-          result +
-          current +
-          // strings are splitted by args when use tagged template, thus we add arg after each string
-          // it looks like: `string1 arg1 string2 arg2 string3`
-          (args[index] !== undefined // eslint-disable-line no-nested-ternary
-            ? typeof args[index] === 'string'
-              ? args[index] // add arg as it is
-              : this._strinfifyLogs(args[index]) // stringify arg
-            : ' '), // add space if no arg after string
-        // initial accumulator value
-        '',
-      );
-    } else {
-      // this block means arguments syntax is used (syntax like $('text', someVar))
-      // in this case strings represents just a first argument
-      logs = this._strinfifyLogs(strings, ...args);
-    }
-    this.dataStorage.putData(logs);
+    this._helpers = {
+      parseLastArgToGetTestId: (...args) => {
+        try {
+          return this.dataStorage._tryToRetrieveTestId(args.at(-1));
+        } catch (e) {
+          // node 14 support
+          return this.dataStorage._tryToRetrieveTestId(args[args.length - 1]);
+        }
+      },
+    };
   }
 
   /**
    * Allows you to define a step inside a test. Step name is attached to the report and
    * helps to understand the test flow.
-   * @param {*} strings 
-   * @param  {...any} values 
+   * @param {*} strings
+   * @param  {...any} values
    */
   step(strings, ...values) {
     let logs = '';
@@ -98,15 +79,20 @@ class Logger {
    * @returns
    */
   getLogs(context) {
-    return this.dataStorage.getData(context);
+    const logs = this.dataStorage.getData(context);
+    return logs || '';
   }
 
-  _strinfifyLogs(...args) {
+  _stringifyLogs(...args) {
     const logs = [];
     // stringify everything except strings
     for (const arg of args) {
+      // ignore empty strings
+      if (arg === '') continue;
       if (typeof arg === 'string') {
         logs.push(arg);
+      } else if (Array.isArray(arg)) {
+        logs.push(arg.join(' '));
       } else {
         try {
           // eslint-disable-next-line no-unused-expressions
@@ -120,123 +106,159 @@ class Logger {
     return logs.join(' ');
   }
 
-  assert(...args) {
-    const level = 'ERROR';
-    const severity = LEVELS[level].severity;
-    if (severity < LEVELS[this.logLevel]?.severity) return;
+  /**
+   * Tagget template literal. Allows to use different syntaxes:
+   * 1. Tagget template: $`text ${someVar}`
+   * 2. Standard: $(`text ${someVar}`)
+   * 3. Standard with multiple arguments: $('text', someVar)
+   */
+  _log(strings, ...args) {
+    // entity which is used to define testId
+    let context = null;
+    // last argument could contain testId
+    const testId = this._helpers.parseLastArgToGetTestId(...args);
+    if (testId) {
+      // last arg is test id, do not log it
+      context = args.pop();
+    }
 
-    const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
-    try {
-      this._originalUserLogger.log(`Assertion result: `, ...args);
-    } catch (e) {
-      // method could be unexisting, ignore error
+    // filter empty strings
+    strings = strings.filter(item => item !== '');
+
+    let logs;
+    // this block means tagged template is used (syntax like $`text ${someVar}`)
+    if (Array.isArray(strings) && strings.length === args.length + 1) {
+      logs = strings.reduce(
+        (result, current, index) =>
+          result +
+          current +
+          // strings are splitted by args when use tagged template, thus we add arg after each string
+          // it looks like: `string1 arg1 string2 arg2 string3`
+          (args[index] !== undefined // eslint-disable-line no-nested-ternary
+            ? typeof args[index] === 'string'
+              ? args[index] // add arg as it is
+              : this._stringifyLogs(args[index]) // stringify arg
+            : ' '), // add space if no arg after string
+        // initial accumulator value
+        '',
+      );
+    } else {
+      // this block means arguments syntax is used (syntax like $('text', someVar))
+      // in this case strings represents just a first argument
+      logs = this._stringifyLogs(strings, ...args);
     }
+    this._originalUserLogger.log(logs);
+    this.dataStorage.putData(logs, context);
   }
 
-  debug(...args) {
-    const level = 'DEBUG';
+  /**
+   * This function is a wrapper for all logging methods (not to repeat the same code)
+   * @param {*} argsArray
+   * @param {*} level
+   * @returns
+   */
+  _logWrapper(argsArray, level) {
+    if (!argsArray.length) return;
+
+    // entity which is used to define testId
+    let context = null;
+    // last argument could contain testId
+    const testId = this._helpers.parseLastArgToGetTestId(...argsArray);
+    if (testId) {
+      // last arg is test id, do not log it
+      context = argsArray.pop();
+    }
+
     const severity = LEVELS[level].severity;
     if (severity < LEVELS[this.logLevel]?.severity) return;
 
-    if (this.logLevel === 'error' || this.logLevel === 'warn') return;
-    const logs = this._strinfifyLogs(...args);
+    const logs = this._stringifyLogs(...argsArray);
     const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.dataStorage.putData(colorizedLogs);
+    this.dataStorage.putData(colorizedLogs, context);
     try {
-      this._originalUserLogger.debug(...args);
+      // level.toLowerCase() represents method name (log, warn, error, etc)
+      this._originalUserLogger[level.toLowerCase()](colorizedLogs);
     } catch (e) {
       // method could be unexisting, ignore error
     }
   }
 
-  error(...args) {
+  assert(...args) {
+    // sometimes user invokes logger without any arguments passed
+    if (!args.length) return;
+
     const level = 'ERROR';
     const severity = LEVELS[level].severity;
     if (severity < LEVELS[this.logLevel]?.severity) return;
 
-    const logs = this._strinfifyLogs(...args);
-    const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.dataStorage.putData(colorizedLogs);
+    const logs = this._stringifyLogs(...args);
+    this.dataStorage.putData(logs);
     try {
-      this._originalUserLogger.error(...args);
+      this._originalUserLogger.log(`Assertion result: `, ...args);
     } catch (e) {
       // method could be unexisting, ignore error
     }
   }
 
-  info(...args) {
-    const level = 'INFO';
-    const severity = LEVELS[level].severity;
-    if (severity < LEVELS[this.logLevel]?.severity) return;
+  debug(...args) {
+    this._logWrapper(args, 'DEBUG');
+  }
 
-    const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
-    try {
-      this._originalUserLogger.info(...args);
-    } catch (e) {
-      // method could be unexisting, ignore error
-    }
+  error(...args) {
+    this._logWrapper(args, 'ERROR');
   }
 
-  log(...args) {
-    const level = 'INFO';
-    const severity = LEVELS[level].severity;
-    if (severity < LEVELS[this.logLevel]?.severity) return;
+  info(...args) {
+    this._logWrapper(args, 'INFO');
+  }
 
-    const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
-    try {
-      this._originalUserLogger.log(...args);
-    } catch (e) {
-      // method could be unexisting, ignore error
-    }
+  log(...args) {
+    this._logWrapper(args, 'LOG');
   }
 
   trace(...args) {
-    const level = 'TRACE';
-    const severity = LEVELS[level].severity;
-    if (severity < LEVELS[this.logLevel]?.severity) return;
-
-    const logs = this._strinfifyLogs(...args);
-    const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.dataStorage.putData(colorizedLogs);
-    try {
-      this._originalUserLogger.trace(...args);
-    } catch (e) {
-      // method could be unexisting, ignore error
-    }
+    this._logWrapper(args, 'TRACE');
   }
 
   warn(...args) {
-    const level = 'WARN';
-    const severity = LEVELS[level].severity;
-    if (severity < LEVELS[this.logLevel]?.severity) return;
-
-    const logs = this._strinfifyLogs(...args);
-    const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.dataStorage.putData(colorizedLogs);
-    try {
-      this._originalUserLogger.warn(...args);
-    } catch (e) {
-      // method could be unexisting, ignore error
-    }
+    this._logWrapper(args, 'WARN');
   }
 
   /**
    * Intercepts user logger messages.
    * When call this method, Logger start to control the user logger,
-   * but almost nothing is changed for user ragarding the console output (like log level set by user)
+   * but almost nothing is changed for user regarding the console output (like log level set by user)
    * (until multiple loggers are intercepted,
    * in this case only the last intercepted logger will be used as user console output).
    * @param {*} userLogger
    */
   intercept(userLogger) {
     if (!userLogger) return;
-    debug(`Intercepting user logger`);
 
-    // save original user logger to use it for logging (last intercepted will be used for console output)
-    this._originalUserLogger = { ...userLogger };
+    /* prevent multiple console interceptions (cause 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 && process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED) {
+      debug(`Try to intercept console, but it is already intercepted`);
+      return;
+    }
+    // prevent other loggers multiple interceptions
+    if (_.isEqual(userLogger, this._originalUserLogger)) {
+      debug(`Try to intercept user logger, but it is already intercepted`);
+      return;
+    }
+
+    process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED = 'true';
+    debug(isUserLoggerConsole ? 'console intercepted' : 'User logger intercepted');
+
+    /* logs could be intercepted for playwright only if console provides output, thus adding this exception.
+    it means default _originalUserLogger (console by default) will be used to provide output
+    (for other frameworks user logger will be passed for output) */
+    if (this.dataStorage.runningEnvironment !== 'playwright') {
+      // save original user logger to use it for logging (last intercepted will be used for console output)
+      //! TODO: temporary don't oeverride user logger to prevent recursion; console will be used for output
+      // this._originalUserLogger = { ...userLogger };
+    }
     this._loggerToIntercept = userLogger;
 
     /* 
@@ -271,8 +293,9 @@ class Logger {
 Logger.instance = null;
 
 // module.exports.Logger = Logger;
-module.exports = new Logger();
+const logger = new Logger();
+
+module.exports = logger;
 
 // TODO: parse passed arguments as {level: 'str', message: 'str'} because some loggers use such syntax;
 // upd: did not face such loggers, but still could be useful
-

package/lib/pipe/testomatio.js

@@ -27,6 +27,7 @@ class TestomatioPipe {
       return;
     }
     debug('Testomatio Pipe: Enabled');
+    this.parallel = params.parallel;
     this.store = store || {};
     this.title = params.title || process.env.TESTOMATIO_TITLE;
     this.sharedRun = !!process.env.TESTOMATIO_SHARED_RUN;
@@ -53,6 +54,7 @@ class TestomatioPipe {
 
     const runParams = Object.fromEntries(
       Object.entries({
+        parallel: this.parallel,
         api_key: this.apiKey.trim(),
         group_title: this.groupTitle,
         env: this.env,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -25,6 +25,7 @@
     "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"
@@ -51,11 +52,12 @@
     "test:adapter:cucumber:example": "cd ./tests/adapter/examples/cucumber && npx cucumber-js"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "^8.6.0",
+    "@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",
+    "cucumber": "^6.0.7",
     "eslint": "^8.7.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.3.0",