@testomatio/reporter 1.1.0-beta → 1.1.0-beta-3

package/lib/storages/data-storage.js

@@ -0,0 +1,307 @@
+const debug = require('debug')('@testomatio/reporter:storage');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const { join } = require('path');
+const { TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
+const { fileSystem, jestHelpers, parseTest } = require('../utils/utils');
+
+const getTestIdFromTestTitle = parseTest;
+
+class DataStorage {
+  /**
+   * Creates data storage instance for specific data type.
+   * Stores data to global variable or to file depending on what is applicable for current test runner
+   * (running environment).
+   * Recommend to use composition while using this class (instead of inheritance).
+   * ! Also the class which will use data storage should be singleton (to avoid data loss).
+   * @param {*} dataType storage type (like 'log', 'artifact'); could be any string, used only to define file path
+   */
+  constructor(dataType) {
+    this.dataType = dataType || 'data';
+    this.isFileStorage = true;
+    this.#refreshStorageType();
+
+    this.dataDirPath = path.join(TESTOMAT_TMP_STORAGE_DIR, this.dataType);
+
+    // set test title for mocha (could not be moved to adapter)
+    // it does not override existing hook, just add new one
+    try {
+      // @ts-ignore
+      if (!beforeEach) return;
+      // @ts-ignore-next-line
+      beforeEach(function () {
+        if (this.currentTest?.__mocha_id__) {
+          global.testTitle = this.currentTest.fullTitle();
+        }
+      });
+    } catch (e) {
+      // ignore
+    }
+
+    // set test title for playwright
+    try {
+      // eslint-disable-next-line import/no-extraneous-dependencies, import/no-unresolved
+      const { test } = require('@playwright/test');
+      // eslint-disable-next-line no-empty-pattern
+      test.beforeEach(async ({}, testInfo) => {
+        global.testTitle = testInfo.title;
+        global.testomatioRunningEnvironment = 'playwright';
+      });
+    } catch (e) {
+      // ignore
+    }
+  }
+
+  /**
+   * 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';
+
+    if (global.codeceptjs) return 'codeceptjs';
+
+    // 'cucumber:current', 'cucumber:legacy'
+    if (global.testomatioRunningEnvironment) return global.testomatioRunningEnvironment;
+
+    if (process.env.PLAYWRIGHT_TEST_BASE_URL || process.env.TEST_WORKER_INDEX) return 'playwright';
+
+    // mocha - can't detect
+    return null;
+  }
+
+  /**
+   * Puts any data to storage (file or global variable).
+   * If file: stores data as text, if global variable – stores as array of data.
+   * @param {*} data anything you want to store (string, object, array, etc)
+   * @param {*} context could be testId or any context (test, suite, etc) which is used to define testId
+   * @returns
+   */
+  putData(data, context = null) {
+    fileSystem.createDir(this.dataDirPath);
+
+    this.#refreshStorageType();
+    context = context ?? global.testTitle ?? null;
+    let testId = this.#tryToRetrieveTestId(context) || context || null;
+
+    if (this.runningEnvironment === 'codeceptjs') {
+      this.isFileStorage = false;
+      testId = testId ?? global.testomatioDataStore?.currentlyRunningTestId;
+    }
+
+    if (this.runningEnvironment === 'jest') {
+      testId = testId ?? jestHelpers.getIdOfCurrentlyRunningTest();
+    }
+
+    // logs in playwright are gathered by pw framework 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 && global?.currentlyRunningTestTitle)
+      testId = this.#tryToRetrieveTestId(global.currentlyRunningTestTitle);
+
+    if (!testId) {
+      debug(`No test id provided for "${this.dataType}" data:`, data);
+      return;
+    }
+
+    if (this.isFileStorage) {
+      this.#putDataToFile(data, testId);
+    } else {
+      this.#putDataToGlobalVar(data, testId);
+    }
+  }
+
+  /**
+   * Returns data, stored for specific testId (or data which was stored without test id specified).
+   * This method will get data from global variable and/or from from file (previosly saved with put method).
+   *
+   * @param {*} context could be testId or any context (test title, suite, etc) which is used to define testId
+   * @returns array of data (any type), null (if no data found for test) or string (if data type is log)
+   */
+  getData(context) {
+    this.#refreshStorageType();
+
+    let testId = null;
+    if (typeof context === 'string') {
+      testId = this.#tryToRetrieveTestId(context) || context;
+    }
+
+    if (!testId) {
+      debug(`Cannot get test id from passed context:`, context);
+      return null;
+    }
+
+    let testDataFromFile = [];
+    let testDataFromGlobalVar = [];
+
+    if (global?.testomatioDataStore) {
+      testDataFromGlobalVar = this.#getDataFromGlobalVar(testId);
+      // these frameworks use global variable storage
+      // if (testDataFromGlobalVar && ['cucumber', 'codeceptjs'].includes(this.runningEnvironment)) {
+      if (testDataFromGlobalVar) {
+        // return as string if its log data
+        if (this.dataType === 'log' && testDataFromGlobalVar.length) return testDataFromGlobalVar.join('\n');
+        // return as array for other data types
+        if (testDataFromGlobalVar.length) return testDataFromGlobalVar;
+      }
+      // don't return nothing if no data in global variable
+    }
+
+    /* condition is removed for mocha
+    mocha has created a global storage, but just in some cases, generally it is not available
+    */
+    // if (this.isFileStorage || !testData) {
+    //   testData = this.#getDataFromFile(testId);
+    //   if (testData) return testData;
+    // }
+
+    testDataFromFile = this.#getDataFromFile(testId);
+
+    if (testDataFromFile.length) {
+      if (this.dataType === 'log') return testDataFromFile.join('\n');
+      return testDataFromFile;
+    }
+    debug(`No "${this.dataType}" data for test id ${testId} in both file and global variable`);
+
+    // in case no data found for test
+    return null;
+  }
+
+  /**
+   * 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.runningEnvironment = this.getRunningEnviroment();
+
+    // some test frameworks do not persist global variables, thus file storage is used for them (by default)
+    if (this.runningEnvironment === 'codeceptjs') this.isFileStorage = false;
+    // playwrigth stores logs by itself; but file storage is used for other data types for playwright
+    if (this.runningEnvironment === 'playwright' && this.dataType === 'log') this.isFileStorage = false;
+  }
+
+  /**
+   * @param {*} testId
+   * @returns aray of data (any type)
+   */
+  #getDataFromGlobalVar(testId) {
+    try {
+      if (global?.testomatioDataStore[this.dataType]) {
+        const testData = global.testomatioDataStore[this.dataType][testId];
+        if (testData) debug(`"${this.dataType}" data for test id ${testId}:`, testData.join(', '));
+        return testData || [];
+      }
+      // debug(`No ${this.dataType} data for test id ${testId} in <global> storage`);
+      return [];
+    } catch (e) {
+      // there could be no data, ignore
+    }
+  }
+
+  /**
+   *
+   * @param {*} testId
+   * @returns array of data (any type)
+   */
+  #getDataFromFile(testId) {
+    try {
+      const filepath = join(this.dataDirPath, `${this.dataType}_${testId}`);
+      if (fs.existsSync(filepath)) {
+        const testDataAsText = fs.readFileSync(filepath, 'utf-8');
+        if (testDataAsText) debug(`"${this.dataType}" data for test id ${testId}:`, testDataAsText);
+        const testDataArr = testDataAsText?.split(os.EOL) || [];
+        return testDataArr;
+      }
+      // debug(`No ${this.dataType} data for test id ${testId} in <file> storage`);
+      return [];
+    } catch (e) {
+      // there could be no data, ignore
+    }
+    return [];
+  }
+
+  /**
+   * Puts data to global variable. Unlike the file storage, stores data in array (file storage just append as string).
+   * @param {*} data
+   * @param {*} testId
+   */
+  #putDataToGlobalVar(data, testId) {
+    debug(`Saving data to global variable for test ${testId}:`, data);
+    if (!global.testomatioDataStore) global.testomatioDataStore = {};
+    if (!global.testomatioDataStore?.[this.dataType]) global.testomatioDataStore[this.dataType] = {};
+
+    if (!global.testomatioDataStore?.[this.dataType][testId]) global.testomatioDataStore[this.dataType][testId] = [];
+    global.testomatioDataStore[this.dataType][testId].push(data);
+  }
+
+  #putDataToFile(data, testId) {
+    if (typeof data !== 'string') data = JSON.stringify(data);
+    const filename = `${this.dataType}_${testId}`;
+    const filepath = join(this.dataDirPath, filename);
+    if (!fs.existsSync(this.dataDirPath)) fileSystem.createDir(this.dataDirPath);
+    debug('Saving data to file for test', testId, 'to', filepath, ':\n', data, '\n');
+
+    // append new line if file already exists (in this case its definitely includes some data)
+    if (fs.existsSync(filepath)) {
+      fs.appendFileSync(filepath, os.EOL + data, 'utf-8');
+    } else {
+      fs.writeFileSync(filepath, data, 'utf-8');
+    }
+  }
+}
+
+module.exports = DataStorage;
+
+// TODO: consider using fs promises instead of writeSync/appendFileSync to
+// prevent blocking and improve performance (probably queue usage will be required)
+
+// TODO: rewrite client - everything regarding storing artifacts
+// TODO: try to define adapter inside client
+// TODO: ability to intercept multiple loggers (upd: no need)
+
+/* does not work for Playwright
+    try {
+      const { test } = require('@playwright/test');
+      test.beforeEach(async ({}, testInfo) => {
+        global.testTitle = testInfo.title;
+        global.testomatioRunningEnvironment = 'playwright';
+      });
+    } catch (e) {
+      // ignore
+    }
+// Playwright storage works fine only when running tests from a single file;
+// otherwise it is not possible to define test id/title, it is overwritten
+ TODO: the only way implementation for Pw for now is to pass testInfo inside test
+//  (and process this testInfo inside "put" function)
+*/

package/lib/storages/key-value-storage.js

@@ -0,0 +1,58 @@
+const debug = require('debug')('@testomatio/reporter:key-value-storage');
+const DataStorage = require('./data-storage');
+
+class KeyValueStorage {
+  constructor() {
+    this.dataStorage = new DataStorage('keyvalue');
+
+    // singleton
+    if (!KeyValueStorage.instance) {
+      KeyValueStorage.instance = this;
+    }
+  }
+
+  /**
+   * Stores key-value pair and passes it to reporter
+   * @param {{key: string}} keyValue - key-value pair(s) as object
+   * @param {*} context testId or test title
+   */
+  put(keyValue, context = null) {
+    if (!keyValue) return;
+    this.dataStorage.putData(keyValue, context);
+  }
+
+  #isKeyValueObject(smth) {
+    return smth && typeof smth === 'object' && !Array.isArray(smth) && smth !== null;
+  }
+
+  /**
+   * Returns key-values pairs for the test as object
+   * @param {*} context testId or test context from test runner
+   * @returns {Object} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
+   */
+  get(context) {
+    if (!context) return null;
+
+    const keyValuesList = this.dataStorage.getData(context);
+    if (!keyValuesList || !keyValuesList?.length) return null;
+
+    const keyValues = {};
+    for (const keyValue of keyValuesList) {
+      if (this.#isKeyValueObject(keyValue)) {
+        Object.assign(keyValues, keyValue);
+      } else if (typeof keyValue === 'string') {
+        try {
+          Object.assign(keyValues, JSON.parse(keyValue));
+        } catch (e) {
+          debug(`Error parsing key-values for test ${context}`, keyValue);
+        }
+      }
+    }
+
+    return Object.keys(keyValues).length ? keyValues : null;
+  }
+}
+
+KeyValueStorage.instance = null;
+
+module.exports = new KeyValueStorage();

package/lib/storages/logger.js

@@ -0,0 +1,290 @@
+const chalk = require('chalk');
+const debug = require('debug')('@testomatio/reporter:logger');
+const DataStorage = require('./data-storage');
+
+const LOG_METHODS = ['assert', 'debug', 'error', 'info', 'log', 'trace', 'warn'];
+const LEVELS = {
+  ALL: { severity: 1, color: '' },
+  VERBOSE: { severity: 3, color: 'grey' },
+  TRACE: { severity: 5, color: 'grey' },
+  DEBUG: { severity: 7, color: 'cyan' },
+  INFO: { severity: 9, color: 'black' },
+  LOG: { severity: 11, color: 'black' },
+  WARN: { severity: 13, color: 'yellow' },
+  ERROR: { severity: 15, color: 'red' },
+};
+
+// ! DON'T use console.log, console.warn, etc in this file, because it will lead to infinite loop
+// use debug() instead
+
+/**
+ * Logger allows to intercept logs from any logger (console.log, tracer, pino, etc)
+ * and save in the testomatio reporter.
+ * Supports different syntaxes to satisfy any user preferences.
+ */
+class Logger {
+  // set default logger to be used in log, warn, error, etc methods
+  #originalUserLogger = { ...console };
+
+  #dataStorage = new DataStorage('log');
+
+  logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
+
+  constructor() {
+    // intercept console by default
+    this.intercept(console);
+
+    // singleton
+    if (!Logger.instance) {
+      Logger.instance = this;
+    }
+  }
+
+  /**
+   * 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
+   */
+  step(strings, ...values) {
+    let logs = '';
+    for (let i = 0; i < strings.length; i++) {
+      logs += strings[i];
+      if (i < values.length) {
+        logs += values[i];
+      }
+    }
+    logs = chalk.blue(`> ${logs}`);
+    this.#dataStorage.putData(logs);
+  }
+
+  /**
+   *
+   * @param {*} context testId or test context from test runner
+   * @returns
+   */
+  getLogs(context) {
+    const logs = this.#dataStorage.getData(context);
+    return logs || '';
+  }
+
+  #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
+          this.prettyObjects ? logs.push(JSON.stringify(arg, null, 2)) : logs.push(JSON.stringify(arg));
+        } catch (e) {
+          debug('Error while stringify object', e);
+          logs.push(arg);
+        }
+      }
+    }
+    return logs.join(' ');
+  }
+
+  /**
+   * Tagget template literal. Allows to use different syntaxes:
+   * 1. Tagget template: log`text ${someVar}`
+   * 2. Standard: log(`text ${someVar}`)
+   * 3. Standard with multiple arguments: log('text', someVar)
+   */
+  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 !== '');
+
+    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
+            : ''),
+        // 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);
+  }
+
+  /**
+   * This function is a wrapper for each logging methods (log, warn, error etc) (not to repeat the same code)
+   * @param {*} argsArray
+   * @param {*} level
+   * @returns
+   */
+  #logWrapper(argsArray, level) {
+    if (!argsArray.length) return;
+
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
+    const logs = this.#stringifyLogs(...argsArray);
+    const colorizedLogs = chalk[LEVELS[level].color](logs);
+    this.#dataStorage.putData(colorizedLogs);
+    try {
+      // level.toLowerCase() represents method name (log, warn, error, etc)
+      this.#originalUserLogger[level.toLowerCase()](colorizedLogs);
+    } catch (e) {
+      // method could be unexisting, ignore error
+    }
+  }
+
+  assert(...args) {
+    this.#logWrapper(args, 'ERROR');
+  }
+
+  debug(...args) {
+    this.#logWrapper(args, 'DEBUG');
+  }
+
+  error(...args) {
+    this.#logWrapper(args, 'ERROR');
+  }
+
+  info(...args) {
+    this.#logWrapper(args, 'INFO');
+  }
+
+  log(...args) {
+    this.#logWrapper(args, 'LOG');
+  }
+
+  trace(...args) {
+    this.#logWrapper(args, 'TRACE');
+  }
+
+  warn(...args) {
+    this.#logWrapper(args, 'WARN');
+  }
+
+  /**
+   * Intercepts user logger messages.
+   * When call this method, Logger start to control the user logger
+   * @param {*} userLogger
+   */
+  intercept(userLogger) {
+    /* 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 && process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED) {
+      debug(`Try to intercept console, but it is already intercepted`);
+      return;
+    }
+
+    process.env.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED = 'true';
+    debug(isUserLoggerConsole ? 'console intercepted' : 'User logger intercepted');
+
+    // override user logger (any, e.g. console) methods to intercept log messages
+    for (const method of LOG_METHODS) {
+      /*
+      its better to create method even if it does not exist in user logger;
+      on method invocation, we will store the data anyway and catch block will prevent potential errors
+      while trying to output the message to terminal
+      */
+      // if (!this._loggerToIntercept[method]) continue;
+      userLogger[method] = (...args) => this[method](...args);
+    }
+
+    /* Playwright
+    Playwright intercepts console messages by default. Thus when we intercept any logger and provide output by console,
+    messages are intercepted by Playwright.
+    */
+
+    /*
+    Initial idea was to intercept any logger (tracer, pino, etc),
+    intercept message and provide output by the same logger.
+    But reality brings some problems: the same messages are intercepted multiple times
+    (because of multiple loggers are created at the same terminal process).
+    Also its difficult to understand (actually did not find the way to do it) if logger was already intercepted or not.
+    Thus, decided to intercept only console by default and provide output by default console.
+    It means, if user uses his own logger, its messages will be intercepted,
+    but the output will be provided by console.
+    TODO: try to implement the providing output to terminal by user logger
+    */
+  }
+
+  /**
+   * Allows to configure logger. Make sure you do it before the logger usage in your code.
+   *
+   * @param {Object} [config={}] - The configuration object.
+   * @param {string} [config.logLevel] - The desired log level. Valid values are 'DEBUG', 'INFO', 'WARN', and 'ERROR'.
+   * @param {boolean} [config.prettyObjects] - Specifies whether to enable pretty printing of objects.
+   * @returns {void}
+   */
+  configure(config = {}) {
+    if (!config) return;
+    if (config.prettyObjects === false || config.prettyObjects === true) this.prettyObjects = config.prettyObjects;
+    if (config.logLevel) this.logLevel = config.logLevel.toUpperCase();
+  }
+}
+
+Logger.instance = null;
+
+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
+
+/* Cypress
+There is no listener like "after:test" in cypress, only "after:spec" is available.
+Thus, cannot separate logs even when I gather them (because I don't know when the test is done, just know about suite).
+Also there is no easy way to access the message from cy.log() function.
+(Using testomatio logger – logger.log() is not convenient because Cypress chains its commands,
+thus such command will interrupt the chain.)
+
+(Could not implement intercepting of cy.log('message'));
+I found the only ability to get any logs using .task('log', 'message') (this is custom, not default cypress command)
+and then intercept it with:
+  on('task', {
+    log (message) {
+      console.log(message)
+      return null
+    }
+  })
+
+but:
+1) it does not solve problem with getting current running testId;
+2) leads to warning "Warning: Multiple attempts to register the following task(s):".)
+
+My way to get test id:
+add cypress command to save test title to file)):
+  Cypress.Commands.add('writeTestTitleToFile', () => {
+    const testTitle = cy.state('runnable').title;
+    cy.writeFile('testomatio_test_title', testTitle);
+  });
+
+Finally, in the test it will look like:
+    cy
+      .writeTestTitleToFile() // <<<
+      .task('log', 'This is a log message from the test') // <<<
+
+      .get('element)
+      .type('text')
+      .click()
+
+
+Parallelization in Cypress is only available if using Cypress Dashboard??
+*/