@testomatio/reporter 1.2.4-beta → 1.3.0-ignore-stack-for-passed.1

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,241 +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 { getCurrentlyRunningTestId } = require('./helpers');
-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'}`);
-  }
-
-  // TODO: implement
-  // eslint-disable-next-line no-unused-vars
-  getTestIdFromContext(context) {
-    // return testId;
-  }
-
-  /**
-   * 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
-   */
-  _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 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();
-
-    // jest does not persist global variables, thus file storage is used
-    if (this.runningEnvironment === 'jest') this.isFileStorage = true;
-    if (this.runningEnvironment === 'playwright') this.isFileStorage = true;
-  }
-
-  /**
-   * 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 = null;
-    if (typeof context === 'string') {
-      testId = context;
-    } else {
-      // TODO: derive testId from context
-      // testId = context...
-    }
-
-    // try to get testId for Jest
-    if (this.runningEnvironment === 'jest') testId = testId ?? JestReporter.getIdOfCurrentlyRunningTest();
-    if (this.runningEnvironment === 'codeceptjs') testId = testId ?? global.testomatioDataStore?.currentlyRunningTestId;
-    // if (this.runningEnvironment === 'playwright') testId = testId ?? getCurrentlyRunningTestId();
-    // 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;
-  }
-
-  _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)
-
-/* Playwright
-There is no global scope sharing between tests and reporter listeners.
-Thus need to use file storage. But when tests are run in parallel, the new problem occurs.
-Tried to solve it by using the TEST_WORKER_INDEX env variable, but it is available inside the listener
-(available only inside the test). Thus when cannot match currently running test id from the reporter listener
-with the currently running test.
-The only solution I see for now is to pass the test id to the logger from the test itself.
-By passing the testInfo param to the test function:
-async ({ page }, testInfo)
-and then retrieving the .title from it.
-*/
-
-/* Cypress
-Parallelization is only available if using Cypress Dashboard??
-*/

package/lib/helpers.js

@@ -1,34 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const { TESTOMAT_TMP_STORAGE } = require('./constants');
-
-// NEXT HELPERS ARE CREATED FOR PLAYWRIGHT. IGNORE FOR NOW. PROBABLY WILL BE REMOVED SHORTLY
-
-// TEST_WORKER_INDEX is not available inside the test listener :/
-/**
- * Sets id of currently running test to storage (global variable or file)
- * Used for Playwright
- * @param {*} testId
- */
-function setCurrentlyRunningTestIdForPlaywright(testId) {
-  const workerId = +process.env.TEST_WORKER_INDEX || 0;
-  const filePath = path.join(TESTOMAT_TMP_STORAGE.mainDir,  'current_test_id_' + workerId);
-  fs.writeFileSync(filePath, testId);
-}
-
-/**
- * Gets id of currently running test from storage (global variable or file)
- * Used for Playwright
- * @returns string test id of currently running test
- */
-function getCurrentlyRunningTestIdForPlaywright() {
-  const workerId = +process.env.TEST_WORKER_INDEX || 0;
-  const filePath = path.join(TESTOMAT_TMP_STORAGE.mainDir, 'current_test_id_' + workerId);
-  if (fs.existsSync(filePath)) {
-    return fs.readFileSync(filePath, 'utf8') || null;
-  }
-  return null;
-};
-
-module.exports.setCurrentlyRunningTestId = setCurrentlyRunningTestIdForPlaywright;
-module.exports.getCurrentlyRunningTestId = getCurrentlyRunningTestIdForPlaywright;