@testomatio/reporter 1.0.16 → 1.0.18-beta.1

package/lib/client.js

@@ -8,6 +8,7 @@ const { randomUUID } = require('crypto');
 const upload = require('./fileUploader');
 const { APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
+const artifactStorage = require('./storages/artifact-storage');
 
 /**
  * @typedef {import('../types').TestData} TestData
@@ -96,9 +97,6 @@ class Client {
     // all pipes disabled, skipping
     if (!this.pipes?.filter(p => p.isEnabled).length) return Promise.resolve();
 
-    global.testomatioArtifacts = [];
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.createRun())))
       .catch(err => console.log(APP_PREFIX, err))
@@ -112,11 +110,9 @@ class Client {
    *
    * @param {string|undefined} status
    * @param {TestData} [testData]
-   * @param {string[]} [storeArtifacts]
    * @returns {Promise<PipeResult[]>}
    */
-  async addTestRun(status, testData, storeArtifacts = []) {
-    debug('Adding test run for test', testData?.test_id || 'unknown test');
+  async addTestRun(status, testData) {
     // all pipes disabled, skipping
     if (!this.pipes?.filter(p => p.isEnabled).length) return [];
 
@@ -155,23 +151,21 @@ class Client {
 
     stack += testData.stack || '';
 
+    // ATTACH LOGS from storage
     // in some cases (e.g. using cucumber) logger instance becomes empty object, if import at the top of the file
-    const logger = require('./logger');
+    const logger = require('./storages/logger');
     const testLogs = logger.getLogs(test_id);
     // debug(`Test logs for ${test_id}:\n`, testLogs);
     if (stack) stack += '\n\n';
     stack += testLogs ? `${chalk.bold('Logs:')}\n${testLogs}` : '';
 
-    if (Array.isArray(storeArtifacts) && storeArtifacts.length) {
-      debug('CLIENT storeArtifact', storeArtifacts);
-      files.push(...storeArtifacts);
-    }
+    // GET ARTIFACTS from storage
+    const artifactFiles = artifactStorage.get(test_id);
+    if (artifactFiles) files.push(...artifactFiles);
 
-    if (Array.isArray(global.testomatioArtifacts)) {
-      debug('CLIENT global[testomatioArtifacts]', global.testomatioArtifacts);
-      files.push(...global.testomatioArtifacts);
-      global.testomatioArtifacts = [];
-    }
+    // GET KEY-VALUEs from storage
+    const keyValueStorage = require('./storages/key-value-storage');
+    const keyValues = keyValueStorage.get(test_id);
 
     for (const file of files) {
       uploadedFiles.push(upload.uploadFileByPath(file, this.uuid));
@@ -184,7 +178,7 @@ class Client {
 
     const artifacts = await Promise.all(uploadedFiles);
 
-    global.testomatioArtifacts = [];
+    // global.testomatioArtifacts = [];
 
     this.totalUploaded += uploadedFiles.filter(n => n).length;
 
@@ -202,6 +196,7 @@ class Client {
       message,
       run_time: parseFloat(time),
       artifacts,
+      meta: keyValues,
     };
 
     this.queue = this.queue.then(() =>
@@ -237,14 +232,16 @@ class Client {
     this.queue = this.queue
       .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
       .then(() => {
-        debug('TOTAL uploaded files', this.totalUploaded);
+        debug('TOTAL artifacts', this.totalUploaded);
+        if (this.totalUploaded && !upload.isArtifactsEnabled())
+          debug(`${this.totalUploaded} artifacts are not uploaded, because artifacts uploading is not enabled`);
 
-        if (upload.isArtifactsEnabled() && this.totalUploaded > 0) {
+        if (this.totalUploaded && upload.isArtifactsEnabled()) {
           console.log(
             APP_PREFIX,
-            `🗄️  Total ${this.totalUploaded} artifacts ${
+            `🗄️ ${this.totalUploaded} artifacts ${
               process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
-            } uploaded to S3 bucket  `,
+            } uploaded to S3 bucket`,
           );
         }
       })
@@ -271,7 +268,7 @@ class Client {
       stack += '\n\n';
     }
 
-    const customFilter = process.env.TESTOMATIO_STACK_FILTER;
+    const customFilter = process.env.TESTOMATIO_STACK_IGNORE;
 
     try {
       let hasFrame = false;

package/lib/constants.js

@@ -1,11 +1,10 @@
 const chalk = require('chalk');
+const os = require('os');
+const path = require('path');
 
 const APP_PREFIX = chalk.gray('[TESTOMATIO]');
-const TESTOMAT_ARTIFACT_SUFFIX = "testomatio_artifact_";
 
-const TESTOMAT_TMP_STORAGE = {
-  mainDir: "testomatio_tmp",
-}
+const TESTOMAT_TMP_STORAGE_DIR = path.join(os.tmpdir(), 'testomatio_tmp');
 
 const CSV_HEADERS = [
   { id: 'suite_title', title: 'Suite_title' },
@@ -24,8 +23,7 @@ const STATUS = {
 
 module.exports = {
   APP_PREFIX,
-  TESTOMAT_ARTIFACT_SUFFIX,
-  TESTOMAT_TMP_STORAGE,
+  TESTOMAT_TMP_STORAGE_DIR,
   CSV_HEADERS,
   STATUS,
 }

package/lib/reporter-functions.js

@@ -0,0 +1,43 @@
+const logger = require('./storages/logger');
+const artifactStorage = require('./storages/artifact-storage');
+const keyValueStorage = require('./storages/key-value-storage');
+
+/**
+ * Stores path to file as artifact and uploads it to the S3 storage
+ * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+ */
+function saveArtifact(data, context = null) {
+  if (!data) return;
+  artifactStorage.put(data, context);
+}
+
+/**
+ * Attach log message(s) to the test report
+ * @param  {...any} args
+ */
+function logMessage(...args) {
+  logger.log(...args);
+}
+
+/**
+ * Similar to "log" function but marks message in report as a step
+ * @param {*} message 
+ */
+function addStep(message) {
+  logger.step(message);
+}
+
+/**
+ * Add key-value pair(s) to the test report
+ * @param {*} keyValue 
+ */
+function setKeyValue(keyValue) {
+  keyValueStorage.put(keyValue);
+}
+
+module.exports = {
+  artifact: saveArtifact,
+  log: logMessage,
+  step: addStep,
+  keyValue: setKeyValue,
+};

package/lib/reporter.js

@@ -1,10 +1,10 @@
-const logger = require('./logger');
+const logger = require('./storages/logger');
 const TestomatClient = require('./client');
 const TRConstants = require('./constants');
-const TRArtifacts = require('./_ArtifactStorageOld');
 
 const log = logger.templateLiteralLog.bind(logger);
 const step = logger.step.bind(logger);
+const reporterFunctions = require('./reporter-functions');
 
 module.exports = {
   logger,
@@ -13,6 +13,11 @@ module.exports = {
   step,
   TestomatClient,
   TRConstants,
-  TRArtifacts,
-  addArtifact: TRArtifacts.artifact,
+};
+
+module.exports.testomat = {
+  artifact: reporterFunctions.artifact,
+  log: reporterFunctions.log,
+  step: reporterFunctions.step,
+  meta: reporterFunctions.keyValue,
 };

package/lib/storages/artifact-storage.js

@@ -0,0 +1,70 @@
+const debug = require('debug')('@testomatio/reporter:artifact-storage');
+const DataStorage = require('./data-storage');
+
+/**
+ * Artifact storage is supposed to store file paths
+ */
+class ArtifactStorage {
+
+  // there is autocompletion for the class methods if implemented singleton this way
+  constructor() {
+    this.dataStorage = new DataStorage('artifact');
+    
+    // singleton
+    if (!ArtifactStorage.instance) {
+      ArtifactStorage.instance = this;
+    }
+  }
+
+  // singleton
+  static getInstance() {
+    if (!ArtifactStorage.instance) {
+      ArtifactStorage.instance = new ArtifactStorage();
+    }
+
+    return ArtifactStorage.instance;
+  }
+
+  /**
+   * Stores path to file as artifact and uploads it to the S3 storage
+   * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
+   * @param {*} context testId or test title
+   */
+  put(data, context = null) {
+    if (!data) return;
+    debug('Save artifact:', data);
+    this.dataStorage.putData(data, context);
+  }
+
+  /**
+   * Returns list of artifacts to upload
+   * @param {*} context testId or test context from test runner
+   * @returns {string | {path: string, type: string, name: string}[]}
+   */
+  get(context) {
+    if (!context) return null;
+
+    // array of any data
+    let artifacts = this.dataStorage.getData(context);
+    if (!artifacts || !artifacts.length) return null;
+
+    artifacts = artifacts.map(artifactData => {
+      // artifact could be an object ({type, path, name} props) or string
+      let artifact;
+      try {
+        artifact = JSON.parse(artifactData);
+      } catch (e) {
+        artifact = artifactData;
+      }
+      return artifact;
+    });
+    artifacts = artifacts.filter(artifact => !!artifact);
+    return artifacts.length ? artifacts : null;
+  }
+}
+
+ArtifactStorage.instance = null;
+
+// const artifactStorage = ArtifactStorage.getInstance();
+const artifactStorage = new ArtifactStorage();
+module.exports = artifactStorage;

package/lib/{dataStorage.js → storages/data-storage.js}

@@ -3,16 +3,18 @@ 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;
+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) {
@@ -20,8 +22,35 @@ class DataStorage {
     this.isFileStorage = true;
     this.#refreshStorageType();
 
-    this.dataDirPath = path.join(TESTOMAT_TMP_STORAGE.mainDir, this.dataType);
-    fileSystem.createDir(this.dataDirPath);
+    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
+    }
   }
 
   /**
@@ -44,15 +73,18 @@ class DataStorage {
   }
 
   /**
-   * Puts any data to storage (file or global variable)
-   * @param {*} data anything you want to store
+   * 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) {
-    this.#refreshStorageType();
+    fileSystem.createDir(this.dataDirPath);
 
-    let testId = this.#tryToRetrieveTestId(context) || null;
+    this.#refreshStorageType();
+    context = context ?? global.testTitle ?? null;
+    let testId = this.#tryToRetrieveTestId(context) || context || null;
 
     if (this.runningEnvironment === 'codeceptjs') {
       this.isFileStorage = false;
@@ -60,7 +92,7 @@ class DataStorage {
     }
 
     if (this.runningEnvironment === 'jest') {
-      testId = testId ?? JestReporter.getIdOfCurrentlyRunningTest();
+      testId = testId ?? jestHelpers.getIdOfCurrentlyRunningTest();
     }
 
     // logs in playwright are gathered by pw framework itself
@@ -74,7 +106,7 @@ class DataStorage {
       testId = this.#tryToRetrieveTestId(global.currentlyRunningTestTitle);
 
     if (!testId) {
-      debug(`No test id provided for ${this.dataType} data: ${data}`);
+      debug(`No test id provided for "${this.dataType}" data:`, data);
       return;
     }
 
@@ -87,12 +119,10 @@ class DataStorage {
 
   /**
    * 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).
+   * This method will get data from global variable and/or from from file (previosly saved with put method).
    *
-   * 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
+   * @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();
@@ -100,9 +130,6 @@ class DataStorage {
     let testId = null;
     if (typeof context === 'string') {
       testId = this.#tryToRetrieveTestId(context) || context;
-    } else {
-      // TODO: derive testId from context
-      // testId = context...
     }
 
     if (!testId) {
@@ -110,12 +137,20 @@ class DataStorage {
       return null;
     }
 
-    let testData = '';
+    let testDataFromFile = [];
+    let testDataFromGlobalVar = [];
 
     if (global?.testomatioDataStore) {
-      testData = this.#getDataFromGlobalVar(testId);
+      testDataFromGlobalVar = this.#getDataFromGlobalVar(testId);
       // these frameworks use global variable storage
-      if (testData && ['cucumber', 'codeceptjs'].includes(this.runningEnvironment)) return testData;
+      // 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
@@ -126,11 +161,16 @@ class DataStorage {
     //   if (testData) return testData;
     // }
 
-    const testDataFromFile = this.#getDataFromFile(testId);
-    testData += testDataFromFile || '';
+    testDataFromFile = this.#getDataFromFile(testId);
 
-    debug(`No ${this.dataType} data for test id ${testId} in both file and global variable`);
-    return testData || '';
+    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;
   }
 
   /**
@@ -166,46 +206,63 @@ class DataStorage {
     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;
+    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];
-        debug(`Data for test id ${testId}:\n${testData}`);
-        return testData || '';
+        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 '';
+      // 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 testData = fs.readFileSync(filepath, 'utf-8');
-        debug(`Data for test id ${testId}:\n${testData}`);
-        return testData || '';
+        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 '';
+      // debug(`No ${this.dataType} data for test id ${testId} in <file> storage`);
+      return [];
     } catch (e) {
       // there could be no data, ignore
     }
-    return '';
+    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, ':\n', data, '\n');
+    debug(`Saving data to global variable for test ${testId}:`, data);
     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);
+
+    if (!global.testomatioDataStore?.[this.dataType][testId]) global.testomatioDataStore[this.dataType][testId] = [];
+    global.testomatioDataStore[this.dataType][testId].push(data);
   }
 
   #putDataToFile(data, testId) {
@@ -215,18 +272,36 @@ class DataStorage {
     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');
+    // 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 = DataStorage;
+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: use .env
 // 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();