@testomatio/reporter 1.3.0-beta → 1.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('./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();

package/lib/dataStorage.js

@@ -1,244 +0,0 @@
-const debug = require('debug')('@testomatio/reporter:storage');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
-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 {
-  /**
-   * 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.
-   * dataType: 'log' | 'artifact' | ...
-   * @param {*} dataType storage type (like 'log', 'artifact'); could be any string, used only to define file path
-   */
-  constructor(dataType) {
-    // if (!dataType) throw new Error('Data type is required when creating data storage');
-    this.dataType = dataType || 'data';
-    this.dataDirName = this.dataType;
-
-    this._refreshStorageType();
-
-    // 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'}`);
-  }
-
-  /**
-   * 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
-    }
-
-    // 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;
-  }
-
-  /**
-   * Puts any data to storage (file or global variable)
-   * @param {*} data anything you want to store
-   * @param {*} context could be testId or any context (test, suite, etc) which is used to define testId
-   * @returns
-   */
-  putData(data, context = null) {
-    this._refreshStorageType();
-
-    let testId = this._tryToRetrieveTestId(context) || null;
-
-    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) {
-      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. 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).
-   *
-   * 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;
-    } else {
-      // TODO: derive testId from context
-      // testId = context...
-    }
-
-    if (!testId) {
-      debug(`Cannot get test id from passed context:\n}`, context);
-      return null;
-    }
-
-    let testData = null;
-
-    if (global?.testomatioDataStore) {
-      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]) {
-        const testData = global.testomatioDataStore[this.dataDirName][testId];
-        debug(`Data for test id ${testId}:\n${testData}`);
-        return testData;
-      }
-      debug(`No ${this.dataType} data for test id ${testId} in <global> storage`);
-      return null;
-    } catch (e) {
-      // there could be no data, ignore
-    }
-  }
-
-  _getDataFromFile(testId) {
-    try {
-      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} in <file> storage`);
-      return null;
-    } catch (e) {
-      // there could be no data, ignore
-    }
-    return null;
-  }
-
-  _putDataToGlobalVar(data, testId) {
-    debug('Saving data to global variable for test', testId, ':\n', data, '\n');
-    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(this.dataDirPath, filename);
-    debug('Saving data to file for test', testId, 'to', filepath, ':\n', data, '\n');
-
-    // TODO: handle multiple invocations of JSON.stringify.
-    // UPD: not actual because decided not to use it - it created extra wrapping quotes "" and // (escaped slashes)
-    fs.appendFileSync(filepath, data + os.EOL, 'utf-8');
-  }
-}
-
-module.exports.DataStorage = 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: use .env
-// TODO: ability to intercept multiple loggers (upd: no need)
-
-
-/* Cypress
-Parallelization is only available if using Cypress Dashboard??
-*/

package/lib/logger.js

@@ -1,294 +0,0 @@
-const chalk = require('chalk');
-const debug = require('debug')('@testomatio/reporter:logger');
-const { DataStorage } = require('./dataStorage');
-
-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' },
-};
-
-/**
- * Logger allows to:
- * 1. Intercept logs from user logger (console.log, etc) and store them.
- * 2. Output logs to console (actually, logger functionality).
- * 3. Varied syntax.
- */
-class Logger {
-  // _originalUserLogger used to output logs to console by the user logger
-  // _loggerToIntercept intercepted and reassigned immediately when added
-
-  constructor() {
-    // set default logger to be used in log, warn, error, etc methods
-    this._originalUserLogger = { ...console };
-
-    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;
-
-    // intercept console by default
-    this.intercept(console);
-
-    // singleton
-    if (!Logger.instance) {
-      Logger.instance = this;
-    }
-
-    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
-   */
-  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: $`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();
-    }
-
-    // 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);
-  }
-
-  /**
-   * 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;
-
-    const logs = this._stringifyLogs(...argsArray);
-    const colorizedLogs = chalk[LEVELS[level].color](logs);
-    this.dataStorage.putData(colorizedLogs, context);
-    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) {
-    // 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._stringifyLogs(...args);
-    this.dataStorage.putData(logs);
-    try {
-      this._originalUserLogger.log(`Assertion result: `, ...args);
-    } catch (e) {
-      // method could be unexisting, ignore 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,
-   * 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;
-
-    /* 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;
-    }
-
-    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)
-      this._originalUserLogger = { ...userLogger };
-    }
-    this._loggerToIntercept = userLogger;
-
-    /* 
-    override user logger (any, e.g. console) methods to intercept log messages
-    this._loggerToIntercept = this; could be used, but decided to override only output methods
-    */
-    for (const method of LOG_METHODS) {
-      /*
-      decided to comment next code line because 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
-      */
-      // if (!this._loggerToIntercept[method]) continue;
-      this._loggerToIntercept[method] = (...args) => this[method](...args);
-    }
-  }
-
-  /**
-   * 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) this.prettyObjects = config.prettyObjects;
-    if (config.logLevel) this.logLevel = config.logLevel.toUpperCase();
-  }
-}
-
-Logger.instance = null;
-
-// module.exports.Logger = 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