@testomatio/reporter 0.8.0-beta.9 → 0.8.1

package/lib/adapter/jest.js

@@ -1,5 +1,5 @@
 const TestomatClient = require('../client');
-const TRConstants = require('../constants');
+const { STATUS } = require('../constants');
 const { parseTest, ansiRegExp } = require('../util');
 
 class JestReporter {
@@ -16,26 +16,22 @@ class JestReporter {
 
     const { testResults } = testResult;
     for (const result of testResults) {
-      let error = null;
-      let steps = null;
+      let error;
+      let steps;
       const { status, title, duration, failureMessages } = result;
       if (failureMessages[0]) {
         let errorMessage = failureMessages[0].replace(ansiRegExp(), '');
         errorMessage = errorMessage.split('\n')[0];
-        error = {
-          message: errorMessage,
-        };
+        error = new Error(errorMessage);
         steps = failureMessages[0];
       }
       const testId = parseTest(title);
       const deducedStatus = status === 'pending' ? 'skipped' : status;
-
-      const suite_title = result.ancestorTitles && result.ancestorTitles[result.ancestorTitles.length - 1];
       // In jest if test is not matched with test name pattern it is considered as skipped.
       // So adding a check if it is skipped for real or because of test pattern
       if (!this._globalConfig.testNamePattern || deducedStatus !== 'skipped') {
-        this.client.addTestRun(testId, deducedStatus, {
-          suite_title,
+        this.client.addTestRun(deducedStatus, {
+          test_id: testId,
           error,
           steps,
           title,
@@ -49,7 +45,7 @@ class JestReporter {
     if (!this.client) return;
 
     const { numFailedTests } = results;
-    const status = numFailedTests === 0 ? TRConstants.PASSED : TRConstants.FAILED;
+    const status = numFailedTests === 0 ? STATUS.PASSED : STATUS.FAILED;
     this.client.updateRunStatus(status);
   }
 }

package/lib/adapter/mocha.js

@@ -1,47 +1,98 @@
 // 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 TRConstants = require('../constants');
-const { parseTest } = require('../util');
+const { STATUS } = require('../constants');
+const { parseTest, specificTestInfo } = require('../util');
+const ArtifactStorage = require('../ArtifactStorage');
 
-const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS } = Mocha.Runner.constants;
+const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING } = Mocha.Runner.constants;
 
 function MochaReporter(runner, opts) {
   Mocha.reporters.Base.call(this, runner);
-  let passes = 0;
-  let failures = 0;
+  let passes = 0; let failures = 0; let skipped = 0;
+  let artifactStore;
 
-  const client = new TestomatClient({ apiKey: opts?.reporterOptions?.apiKey });
+  const apiKey = opts?.reporterOptions?.apiKey || process.env.TESTOMATIO;
+
+  if (!apiKey) {
+    debug('TESTOMATIO key is empty, ignoring reports');
+    return;
+  }
+  const client = new TestomatClient({ apiKey });
 
   runner.on(EVENT_RUN_BEGIN, () => {
     client.createRun();
+
+    const params = { 
+      toFile: true
+    };
+    
+    artifactStore = runner._workerReporter !== undefined
+      ? new ArtifactStorage(params)
+      : new ArtifactStorage();
   });
 
-  runner.on(EVENT_TEST_PASS, test => {
+  runner.on(EVENT_TEST_PASS, async(test) => {
     passes += 1;
-    console.log('pass: %s', test.fullTitle());
+    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
+    );
+  });
+
+  runner.on(EVENT_TEST_PENDING, test => {
+    skipped += 1;
+    console.log('skip: %s', test.fullTitle());
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.PASSED, {
+    client.addTestRun(STATUS.SKIPPED, {
       title: test.title,
+      test_id: testId,
       time: test.duration,
     });
   });
 
-  runner.on(EVENT_TEST_FAIL, (test, err) => {
+  runner.on(EVENT_TEST_FAIL, async(test, err) => {
     failures += 1;
-    console.log('fail: %s -- error: %s', test.fullTitle(), err.message);
+    console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
     const testId = parseTest(test.title);
-    client.addTestRun(testId, TRConstants.FAILED, {
-      error: err,
-      title: test.title,
-      time: test.duration,
-    });
+
+    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
+    );
   });
 
   runner.on(EVENT_RUN_END, () => {
-    console.log('end: %d/%d', passes, passes + failures);
-    const status = failures === 0 ? TRConstants.PASSED : TRConstants.FAILED;
+    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,11 +3,12 @@ const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
-const Status = require('../constants');
+const { APP_PREFIX, STATUS: Status } = require('../constants');
 const TestomatioClient = require('../client');
 const upload = require('../fileUploader');
 const { parseTest } = require('../util');
 
+
 class TestomatioReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
@@ -56,8 +57,9 @@ class TestomatioReporter {
       files.push({ path: fileName, type: attachment.contentType });
     }
 
-    this.client.addTestRun(testId, checkStatus(result.status), {
+    this.client.addTestRun(checkStatus(result.status), {
       error,
+      test_id: testId,
       suite_title,
       title,
       files,
@@ -69,15 +71,16 @@ class TestomatioReporter {
   async onEnd(result) {
     if (!this.client) return;
 
-    if (this.videos.length && upload.isArtifactsEnabled) {
-      console.log(Status.APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
+    if (this.videos.length && upload.isArtifactsEnabled()) {
+      console.log(APP_PREFIX, `🎞️  Uploading ${this.videos.length} videos...`);
 
       const promises = [];
       for (const video of this.videos) {
         const { testId, title, attachment, suite_title } = video;
         const file = { path: attachment.path, title, type: attachment.contentType };
         promises.push(
-          this.client.addTestRun(testId, undefined, {
+          this.client.addTestRun(undefined, {
+            test_id: testId,
             title,
             suite_title,
             files: [file],

package/lib/adapter/webdriver.js

@@ -43,9 +43,10 @@ class WebdriverReporter extends WDIOReporter {
       .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
       .map(el => Buffer.from(el.result.value, 'base64'));
 
-    await this.client.addTestRun(testId, state, {
+    await this.client.addTestRun(state, {
       error,
       title,
+      test_id: testId,
       time: duration,
       filesBuffers: screenshotsBuffers,
     });

package/lib/bin/reportXml.js

@@ -2,7 +2,7 @@
 const program = require("commander");
 const chalk = require("chalk");
 const glob = require('glob');
-
+const debug = require('debug')('@testomatio/reporter:xml-cli');
 const { APP_PREFIX } = require('../constants');
 const XmlReader = require("../xmlReader");
 
@@ -22,7 +22,10 @@ program
       pattern += '.xml';
     }
     let { javaTests, lang } = opts;
-    if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
+    if (opts.envFile) {
+      debug('Loading env file: %s', opts.envFile) 
+      require('dotenv').config({ path: opts.envFile }); // eslint-disable-line
+    }
     if (javaTests === true) javaTests = 'src/test/java';
     lang = lang?.toLowerCase();
     const runReader = new XmlReader({ javaTests, lang });

package/lib/bin/startTest.js

@@ -3,7 +3,7 @@ const { spawn } = require('child_process');
 const program = require('commander');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
-const { APP_PREFIX, FINISHED } = require('../constants');
+const { APP_PREFIX, STATUS } = require('../constants');
 const { version } = require('../../package.json');
 
 console.log(chalk.cyan.bold(` 🤩 Testomat.io Reporter v${version}`));
@@ -42,7 +42,7 @@ program
 
       const client = new TestomatClient({ apiKey });
 
-      client.updateRunStatus(FINISHED, true).then(() => {
+      client.updateRunStatus(STATUS.FINISHED, true).then(() => {
         console.log(chalk.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
         process.exit(0);
       });

package/lib/client.js

@@ -1,29 +1,30 @@
-const axios = require('axios');
+const debug = require('debug')('@testomatio/reporter:client');
 const createCallsiteRecord = require('callsite-record');
 const { sep, join } = require('path');
 const fs = require('fs');
 const chalk = require('chalk');
+const { randomUUID } = require('crypto');
 const upload = require('./fileUploader');
-const { PASSED, FAILED, FINISHED, APP_PREFIX } = require('./constants');
+const { APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
 
-const { TESTOMATIO_ENV } = process.env;
+/**
+ * @typedef {import('../types').TestData} TestData
+ * @typedef {import('../types').RunStatus} RunStatus
+ */
 
-
-class TestomatClient {
+class Client {
   /**
    * Create a Testomat client instance
    *
    * @param {*} params
    */
   constructor(params = {}) {
-    this.title = params.title || process.env.TESTOMATIO_TITLE;
-    this.env  = TESTOMATIO_ENV;
     this.parallel = params.parallel;
-    const store = {}
+    const store = {};
+    this.uuid = randomUUID();
     this.pipes = pipesFactory(params, store);
     this.queue = Promise.resolve();
-    this.axios = axios.create();
     this.totalUploaded = 0;
     this.version = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString()).version;
     console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
@@ -32,11 +33,11 @@ class TestomatClient {
   /**
    * Used to create a new Test run
    *
-   * @returns {Promise} - resolves to Run id which should be used to update / add test
+   * @returns {Promise<void>} - resolves to Run id which should be used to update / add test
    */
   createRun() {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
 
     const runParams = {
       title: this.title,
@@ -46,27 +47,39 @@ class TestomatClient {
 
     global.testomatioArtifacts = [];
 
-    this.queue = this.queue.then(() => Promise.all(this.pipes.map(p => p.createRun(runParams))));
-
+    this.queue = this.queue
+      .then(() => Promise.all(this.pipes.map(p => p.createRun(runParams))))
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined); // fixes return type
+    debug('Run', this.queue);
     return this.queue;
   }
 
   /**
-   * Used to add a new test to Run instance
-   *
-   * @returns {Promise}
+   * Updates test status and its data
+   * 
+   * @param {string|undefined} status
+   * @param {TestData} [testData]
+   * @param {string[]} [storeArtifacts]
+   * @returns {Promise<void>}
    */
-  async addTestRun(testId, status, testData = {}) {
+  async addTestRun(status, testData, storeArtifacts = []) {
     // all pipes disabled, skipping
     if (!this.pipes.filter(p => p.isEnabled).length) return;
 
+    if (!testData) testData = {
+      title: 'Unknown test',
+      suite_title: 'Unknown suite',
+    }
+
     const {
-      error = '',
+      error = null,
       time = '',
       example = null,
       files = [],
       filesBuffers = [],
       steps,
+      code = null,
       title,
       suite_title,
       suite_id,
@@ -76,33 +89,37 @@ class TestomatClient {
 
     const uploadedFiles = [];
 
-    if (testId) testData.test_id = testId;
-
     let stack = '';
 
     if (error) {
-      stack = this.formatError(error);
-      message = error.message;
+      stack = this.formatError(error) || '';
+      message = error?.message;
     }
     if (steps) {
       stack = this.formatSteps(stack, steps);
     }
 
+    if (Array.isArray(storeArtifacts) && storeArtifacts.length) {
+      debug("CLIENT storeArtifact", storeArtifacts);
+      files.push(...storeArtifacts);
+    }
+
     if (Array.isArray(global.testomatioArtifacts)) {
+      debug("CLIENT global[testomatioArtifacts]", global.testomatioArtifacts);
       files.push(...global.testomatioArtifacts);
       global.testomatioArtifacts = [];
     }
 
     for (const file of files) {
-      uploadedFiles.push(upload.uploadFileByPath(file, this.runId));
+      uploadedFiles.push(upload.uploadFileByPath(file, this.uuid));
     }
 
     for (const [idx, buffer] of filesBuffers.entries()) {
       const fileName = `${idx + 1}-${title.replace(/\s+/g, '-')}`;
-      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.runId));
+      uploadedFiles.push(upload.uploadFileAsBuffer(buffer, fileName, this.uuid));
     }
 
-    const artifacts = await Promise.all(uploadedFiles)
+    const artifacts = await Promise.all(uploadedFiles);
 
     global.testomatioArtifacts = [];
 
@@ -114,7 +131,8 @@ class TestomatClient {
       status,
       stack,
       example,
-      title,      
+      code,
+      title,
       suite_title,
       suite_id,
       test_id,
@@ -123,36 +141,42 @@ class TestomatClient {
       artifacts,
     };
 
-    this.queue = this.queue.then(() => Promise.all(this.pipes.map(p => p.addTest(data))));
+    this.queue = this.queue
+      .then(() => Promise.all(this.pipes.map(p => p.addTest(data))))
+      .catch(err => console.log(APP_PREFIX, err))
+      .then(() => undefined);
     return this.queue;
   }
 
   /**
-   * Update run status
    *
-   * @returns {Promise}
+   * Updates the status of the current test run and finishes the run.
+   * @param {RunStatus} status - The status of the current test run. Must be one of "passed", "failed", or "finished"
+   * @param {boolean} [isParallel] - Whether the current test run was executed in parallel with other tests.
+   * @returns {Promise<void>} - A Promise that resolves when finishes the run.
    */
-  updateRunStatus(status, isParallel) {
+  updateRunStatus(status, isParallel = false) {
     // all pipes disabled, skipping
-    if (!this.pipes.filter(p => p.isEnabled).length) return;
+    if (!this.pipes.filter(p => p.isEnabled).length) return Promise.resolve();
+
+    const runParams = { status, parallel: isParallel };
+
+    this.queue = this.queue
+      .then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))))
+      .then(() => {
+        debug("TOTAL uploaded files", this.totalUploaded);
+        
+        if (upload.isArtifactsEnabled() && this.totalUploaded > 0) {
+          console.log(
+            APP_PREFIX,
+            `🗄️  Total ${this.totalUploaded} artifacts ${
+              process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
+            } uploaded to S3 bucket  `,
+          );
+        }
+      })
+      .catch(err => console.log(APP_PREFIX, err));
 
-    let statusEvent;
-    if (status === FINISHED) statusEvent = 'finish';
-    if (status === PASSED) statusEvent = 'pass';
-    if (status === FAILED) statusEvent = 'fail';
-    if (isParallel) statusEvent += '_parallel';
-    const runParams = { status, statusEvent }
-
-    this.queue = this.queue.then(() => Promise.all(this.pipes.map(p => p.finishRun(runParams))));
-
-    if (upload.isArtifactsEnabled && this.totalUploaded > 0) {
-      console.log(
-        APP_PREFIX,
-        `🗄️  Total ${this.totalUploaded} artifacts ${
-          process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
-        } uploaded to S3 bucket  `,
-      );
-    }
     return this.queue;
   }
 
@@ -193,4 +217,4 @@ class TestomatClient {
   }
 }
 
-module.exports = TestomatClient;
+module.exports = Client;

package/lib/constants.js

@@ -1,11 +1,26 @@
 const chalk = require('chalk');
 
 const APP_PREFIX = chalk.gray('[TESTOMATIO]');
+const TESTOMAT_ARTIFACT_SUFFIX = "testomatio_artifact_";
 
-module.exports = Object.freeze({
+const CSV_HEADERS = [
+  { id: 'suite_title', title: 'Suite_title' },
+  { id: 'title', title: 'Title' },
+  { id: 'status', title: 'Status' },
+  { id: 'message', title: 'Message' },
+  { id: 'stack', title: 'Stack' },
+];
+
+const STATUS = {
   PASSED: 'passed',
   FAILED: 'failed',
   SKIPPED: 'skipped',
   FINISHED: 'finished',
+};
+
+module.exports = {
   APP_PREFIX,
-});
+  TESTOMAT_ARTIFACT_SUFFIX,
+  CSV_HEADERS,
+  STATUS,
+}