@testomatio/reporter 1.0.17 → 1.1.0-beta-2

package/lib/adapter/codecept.js

@@ -1,7 +1,7 @@
 const debug = require('debug')('@testomatio/reporter:adapter:codeceptjs');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE } = require('../constants');
+const { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
 const upload = require('../fileUploader');
 const { parseTest: getIdFromTestTitle, fileSystem } = require('../utils/utils');
 
@@ -56,7 +56,7 @@ function CodeceptReporter(config) {
   // Listening to events
   event.dispatcher.on(event.all.before, () => {
     // clear tmp dir
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
 
     recorder.add('Creating new run', () => client.createRun());
     videos = [];

package/lib/adapter/cucumber/current.js

@@ -2,9 +2,9 @@
 const { Formatter, formatterHelpers } = require('@cucumber/cucumber');
 const chalk = require('chalk');
 const fs = require('fs');
-const { STATUS, TESTOMAT_TMP_STORAGE } = require('../../constants');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../../constants');
 const TestomatClient = require('../../client');
-const logger = require('../../logger');
+const logger = require('../../storages/logger');
 const { parseTest, fileSystem } = require('../../utils/utils');
 
 const { GherkinDocumentParser, PickleParser } = formatterHelpers;
@@ -37,7 +37,7 @@ class CucumberReporter extends Formatter {
 
   parseEnvelope(envelope) {
     if (envelope.testRunStarted) {
-      fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+      fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
     }
     if (envelope.testCaseStarted && this.client) {
       this.client.createRun();

package/lib/adapter/cucumber/legacy.js

@@ -2,7 +2,7 @@
 const { Formatter } = require('cucumber');
 const chalk = require('chalk');
 const { parseTest, fileSystem } = require('../../utils/utils');
-const { STATUS, TESTOMAT_TMP_STORAGE } = require('../../constants');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../../constants');
 const TestomatClient = require('../../client');
 
 const createTestomatFormatter = apiKey => {
@@ -97,7 +97,7 @@ const createTestomatFormatter = apiKey => {
 
       options.eventBroadcaster.on('gherkin-document', addDocument);
       options.eventBroadcaster.on('test-run-started', () => {
-        fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+        fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
         this?.client?.createRun();
       });
       options.eventBroadcaster.on('test-case-finished', this.onTestCaseFinished.bind(this));

package/lib/adapter/jest.js

@@ -1,5 +1,5 @@
 const TestomatClient = require('../client');
-const { STATUS, TESTOMAT_TMP_STORAGE } = require('../constants');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
 const { parseTest, ansiRegExp, fileSystem } = require('../utils/utils');
 
 class JestReporter {
@@ -11,20 +11,9 @@ class JestReporter {
     this.client.createRun();
   }
 
-  static getIdOfCurrentlyRunningTest() {
-    if (!process.env.JEST_WORKER_ID) return null;
-    try {
-      // @ts-expect-error "expect" could only be defined inside Jest environement (forbidden to import it outside)
-      // eslint-disable-next-line no-undef
-      if (expect && expect?.getState()?.currentTestName) return parseTest(expect?.getState()?.currentTestName); 
-    } catch (e) {
-      return null; 
-    }
-  }
-
   onRunStart() {
     // clear tmp dir
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
   }
 
   onTestResult(test, testResult) {
@@ -72,9 +61,6 @@ class JestReporter {
     const { numFailedTests } = results;
     const status = numFailedTests === 0 ? STATUS.PASSED : STATUS.FAILED;
     this.client.updateRunStatus(status);
-
-    // clear tmp dir
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
   }
 }
 

package/lib/adapter/mocha.js

@@ -1,11 +1,9 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
 const Mocha = require('mocha');
-const debug = require('debug')('@testomatio/reporter:adapter:mocha');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const { STATUS, TESTOMAT_TMP_STORAGE } = require('../constants');
-const { parseTest, specificTestInfo, fileSystem } = require('../utils/utils');
-const ArtifactStorage = require('../_ArtifactStorageOld');
+const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
+const { parseTest, fileSystem } = require('../utils/utils');
 
 const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING } =
   Mocha.Runner.constants;
@@ -15,7 +13,7 @@ function MochaReporter(runner, opts) {
   let passes = 0;
   let failures = 0;
   let skipped = 0;
-  let artifactStore;
+  // let artifactStore;
 
   const apiKey = opts?.reporterOptions?.apiKey || process.env.TESTOMATIO;
 
@@ -24,13 +22,7 @@ function MochaReporter(runner, opts) {
   runner.on(EVENT_RUN_BEGIN, () => {
     client.createRun();
 
-    const params = {
-      toFile: true,
-    };
-
-    artifactStore = runner._workerReporter !== undefined ? new ArtifactStorage(params) : new ArtifactStorage();
-
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
   });
 
   runner.on(EVENT_TEST_PASS, async test => {
@@ -38,20 +30,11 @@ function MochaReporter(runner, opts) {
     console.log(chalk.bold.green('✔'), test.fullTitle());
     const testId = parseTest(test.title);
 
-    const specificTest = specificTestInfo(test);
-    const content = await artifactStore.artifactByTestName(specificTest);
-
-    debug(`test=${specificTest} content = `, content);
-
-    client.addTestRun(
-      STATUS.PASSED,
-      {
-        test_id: testId,
-        title: test.title,
-        time: test.duration,
-      },
-      content,
-    );
+    client.addTestRun(STATUS.PASSED, {
+      test_id: testId,
+      title: test.title,
+      time: test.duration,
+    });
   });
 
   runner.on(EVENT_TEST_PENDING, test => {
@@ -70,29 +53,18 @@ function MochaReporter(runner, opts) {
     console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
     const testId = parseTest(test.title);
 
-    const specificTest = specificTestInfo(test);
-    const content = await artifactStore.artifactByTestName(specificTest);
-
-    debug(`fail test=${specificTest} content = `, content);
-
-    client.addTestRun(
-      STATUS.FAILED,
-      {
-        error: err,
-        test_id: testId,
-        title: test.title,
-        time: test.duration,
-      },
-      content,
-    );
+    client.addTestRun(STATUS.FAILED, {
+      error: err,
+      test_id: testId,
+      title: test.title,
+      time: test.duration,
+    });
   });
 
   runner.on(EVENT_RUN_END, () => {
     const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
     console.log(chalk.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
     client.updateRunStatus(status);
-
-    artifactStore.cleanup();
   });
 }
 

package/lib/adapter/playwright.js

@@ -3,7 +3,7 @@ const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
-const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE } = require('../constants');
+const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
 const TestomatioClient = require('../client');
 const { isArtifactsEnabled } = require('../fileUploader');
 const { parseTest, fileSystem } = require('../utils/utils');
@@ -19,15 +19,17 @@ class PlaywrightReporter {
 
   onBegin(_config, suite) {
     // clean data storage
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE.mainDir);
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
     if (!this.client) return;
     this.suite = suite;
     this.client.createRun();
   }
 
-  // onTestBegin(test) {
-  //   const testId = parseTest(test.title);
-  // }
+  /*
+  onTestBegin(test) {
+    // does not work; value is not to the storage context
+    global.testTitle = test.title;
+  } */
 
   onTestEnd(test, result) {
     if (!this.client) return;
@@ -44,23 +46,33 @@ class PlaywrightReporter {
       appendStep(step, steps);
     }
 
-    const logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
-
-    const reportTestPromise = this.client.addTestRun(checkStatus(result.status), {
-      error,
-      test_id: testId,
-      suite_title,
-      title,
-      steps: steps.join('\n'),
-      time: duration,
-      stack: logs,
-    }).then(pipes => {
-      testId = pipes?.filter(p => p.pipe.includes('Testomatio'))[0]?.result?.data?.test_id;
-
-      this.uploads.push({
-        testId, title, suite_title, files: result.attachments.filter((a) => a.body || a.path)
+    let logs = '';
+    if (result.stderr.length || result.stdout.length) {
+      logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+    }
+
+    const reportTestPromise = this.client
+      .addTestRun(checkStatus(result.status), {
+        error,
+        test_id: testId,
+        suite_title,
+        title,
+        steps: steps.join('\n'),
+        time: duration,
+        stack: logs,
+      })
+      .then(pipes => {
+        testId = pipes?.filter(p => p.pipe.includes('Testomatio'))[0]?.result?.data?.test_id;
+
+        this.uploads.push({
+          testId,
+          title,
+          suite_title,
+          files: result.attachments.filter(a => a.body || a.path),
+        });
+        // remove empty uploads
+        this.uploads = this.uploads.filter(upload => upload.files.length);
       });
-    });
 
     reportTestPromises.push(reportTestPromise);
   }

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`,
           );
         }
       })

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;