@testomatio/reporter 1.2.0-beta-3 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.2.0-beta-3",
+  "version": "1.2.0",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -12,7 +12,8 @@
     "@aws-sdk/lib-storage": "^3.279.0",
     "@octokit/rest": "^19.0.5",
     "aws-sdk": "^2.1072.0",
-    "axios": "^0.25.0",
+    "axios": "^1.6.2",
+    "axios-retry": "^3.9.1",
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
@@ -30,6 +31,7 @@
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
     "minimatch": "^9.0.3",
+    "promise-retry": "^2.0.1",
     "uuid": "^9.0.0"
   },
   "files": [
@@ -51,7 +53,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/logger-2.test.js && npx mocha tests-storage/reporter-functions.test.js"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.3.0",
@@ -66,6 +68,7 @@
     "eslint-plugin-import": "^2.25.4",
     "jasmine": "^3.10.0",
     "jest": "^27.4.7",
+    "jsdom": "^22.1.0",
     "mocha": "^9.2.0",
     "mock-http-server": "^1.4.5",
     "pino": "^8.15.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('./utils/utils');
-
-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() {
-    this.dataStorage = new DataStorage('artifact');
-
-    // 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,232 +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('./utils/utils');
-const getTestIdFromTestTitle = require('./utils/utils').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).
-   * @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.mainDir, this.dataType);
-    fileSystem.createDir(this.dataDirPath);
-  }
-
-  /**
-   * 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)
-   * @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') {
-      this.isFileStorage = false;
-      testId = testId ?? global.testomatioDataStore?.currentlyRunningTestId;
-    }
-
-    if (this.runningEnvironment === 'jest') {
-      testId = testId ?? JestReporter.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. 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 = this.#tryToRetrieveTestId(context) || context;
-    } else {
-      // TODO: derive testId from context
-      // testId = context...
-    }
-
-    if (!testId) {
-      debug(`Cannot get test id from passed context:`, context);
-      return null;
-    }
-
-    let testData = '';
-
-    if (global?.testomatioDataStore) {
-      testData = this.#getDataFromGlobalVar(testId);
-      // these frameworks use global variable storage
-      if (testData && ['cucumber', 'codeceptjs'].includes(this.runningEnvironment)) return testData;
-    }
-
-    /* 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;
-    // }
-
-    const testDataFromFile = this.#getDataFromFile(testId);
-    testData += testDataFromFile || '';
-
-    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.runningEnvironment = this.getRunningEnviroment();
-
-    // some test frameworks do not persist global variables, thus file storage is used for them (by default)
-    if (['playwright', 'codeceptjs'].includes(this.runningEnvironment)) this.isFileStorage = false;
-  }
-
-  #getDataFromGlobalVar(testId) {
-    try {
-      if (global?.testomatioDataStore[this.dataType]) {
-        const testData = global.testomatioDataStore[this.dataType][testId];
-        debug(`Data for test id ${testId}:\n${testData}`);
-        return testData || '';
-      }
-      debug(`No ${this.dataType} data for test id ${testId} in <global> storage`);
-      return '';
-    } 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 '';
-    } catch (e) {
-      // there could be no data, ignore
-    }
-    return '';
-  }
-
-  #putDataToGlobalVar(data, testId) {
-    debug('Saving data to global variable for test', testId, ':\n', data, '\n');
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-    if (!global.testomatioDataStore?.[this.dataType]) global.testomatioDataStore[this.dataType] = {};
-    global.testomatioDataStore?.[this.dataType][testId] // eslint-disable-line no-unused-expressions
-      ? (global.testomatioDataStore[this.dataType][testId] += `\n${data}`)
-      : (global.testomatioDataStore[this.dataType][testId] = 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');
-
-    // 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)

package/lib/template/real-data-example.js

@@ -1,47 +0,0 @@
-// TODO: use as example for the unit-tests
-
-const result = {
-    "runId": "51eb2798",
-    "status": "failed",
-    "runUrl": "https://beta.testomat.io/projects/codecept-new-mode-exmple/runs/51eb2798/report",
-    "executionTime": "0 seconds",
-    "executionDate": "(30/07/2023 11:11:11)",
-    "tests": [{
-        "files": [],
-        "steps": "\u001b[32m\u001b[1mOn TodosPage: goto \u001b[22m\u001b[39m\n",
-        "status": "passed",
-        "stack": "I execute script () => sessionStorage.clear()",
-        "example": null,
-        "code": null,
-        "title": "Create a new todo item @T50e82737",
-        "suite_title": "Create Tasks @step:06 @smoke @story:12 @S2f5c1942",
-        "test_id": "50e82737",
-        "message": "",
-        "run_time": 121,
-        "artifacts": [],
-        "api_key": "tstmt_gRqrhBUaVxTpezGpZjRmlahOeqcRBBbDMA1692050199",
-        "create": false
-    }, {
-        "files": [{
-            "path": "/home/codeceptjs-testomat-example/codeceptJS/output/Create_2_@T5b8d1186.failed.png",
-            "type": "image/png"
-        }],
-        "steps": "I am on page \"http://todomvc.com/examples/angularjs/#/\"",
-        "status": "failed",
-        "stack": "I am on page \"http://todomvc.com/examples/angularjs/#/\"",
-        "example": null,
-        "code": null,
-        "title": "Create a new todo item part 2 @T5b8d1186",
-        "suite_title": "@second Create Tasks @step:07 @smoke @story:13 @S2f5c1942",
-        "test_id": "5b8d1186",
-        "message": "expected expected number of visible is 2, but found 1 \"1\" to equal \"2\"",
-        "run_time": 176,
-        "artifacts": [null],
-        "api_key": "tstmt_gRqrhBUaVxTpezGpZjRmlahOeqcRBBbDMA1692050199",
-        "create": false
-    }]
-}
-
-module.exports = {
-    result
-}