@testomatio/reporter 0.8.0-beta.9 → 0.8.2-beta.1

package/lib/adapter/cucumber/current.js

@@ -2,7 +2,8 @@
 const { Formatter, formatterHelpers } = require("@cucumber/cucumber");
 const chalk = require('chalk');
 const fs = require('fs');
-const { TestomatClient, TRConstants } = require('../../reporter');
+const { STATUS } = require('../../constants');
+const TestomatClient = require('../../client');
 
 const { GherkinDocumentParser, PickleParser } = formatterHelpers
 const {
@@ -19,7 +20,7 @@ class CucumberReporter extends Formatter {
     this.cases = [];
 
     this.client = new TestomatClient();
-    this.status = TRConstants.PASSED;
+    this.status = STATUS.PASSED;
 
   }
 
@@ -33,7 +34,8 @@ class CucumberReporter extends Formatter {
     const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId);
 
     let example;
-    let status = TRConstants.PASSED;
+
+    let status = STATUS.PASSED;
     let color = 'green';
     let message;
 
@@ -41,22 +43,23 @@ class CucumberReporter extends Formatter {
 
     if (testCaseAttempt.worstTestStepResult) {
       if (testCaseAttempt.worstTestStepResult.status === 'SKIPPED') {
-        status = TRConstants.SKIPPED;
+        status = STATUS.SKIPPED;
       }
       if (testCaseAttempt.worstTestStepResult.status === 'UNDEFINED') {
-        status = TRConstants.SKIPPED;
+        status = STATUS.SKIPPED;
         message = 'Undefined steps. Implement missing steps and rerun this scenario';
       }
       if (testCaseAttempt.worstTestStepResult.status === 'FAILED') {
         message = testCaseAttempt?.worstTestStepResult?.message;
-        status = TRConstants.FAILED;
+        status = STATUS.FAILED;
       }
       color = getStatusColor(testCaseAttempt.worstTestStepResult.status);
-      if (status !== TRConstants.PASSED) this.failures.push(testCaseAttempt);
+      if (status !== STATUS.PASSED) this.failures.push(testCaseAttempt);
     }
 
     if (testCaseAttempt.pickle.astNodeIds.length > 1) {
       example = getExample(testCaseAttempt);
+      // @ts-ignore
       testCaseAttempt.example = example;
     }
 
@@ -70,8 +73,8 @@ class CucumberReporter extends Formatter {
     if (message) cliMessage += chalk.gray(message.split('\n')[0]);
     console.log(cliMessage);
 
-    if (status !== TRConstants.PASSED && status !== TRConstants.SKIPPED) {
-      this.status = TRConstants.FAILED;
+    if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
+      this.status = STATUS.FAILED;
     }
 
     const time = Object.values(testCaseAttempt.stepResults)
@@ -80,12 +83,13 @@ class CucumberReporter extends Formatter {
 
     if (!this.client) return;
 
-    this.client.addTestRun(testId, status, {
+    this.client.addTestRun(status, {
       // error: testCaseAttempt.worstTestStepResult.message,
       message,
       steps: getSteps(testCaseAttempt).map(s => s.toString()).join('\n').trim(),
       example: { ...example},
       title: scenario,
+      test_id: testId,
       time,
     });
   }
@@ -121,9 +125,9 @@ class CucumberReporter extends Formatter {
 
     if (!this.client) return;
 
-    this.client.updateRunStatus(testRunFinished.success ? TRConstants.PASSED : TRConstants.FAILED)
+    this.client.updateRunStatus(testRunFinished.success ? STATUS.PASSED : STATUS.FAILED)
   }
-};
+}
 
 function getSteps(tc) {
   const stepIds = Object.keys(tc.stepResults);

package/lib/adapter/cucumber/legacy.js

@@ -1,8 +1,9 @@
-// eslint-disable-next-line import/no-unresolved
+// eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
 const { Formatter } = require('cucumber');
 const chalk = require('chalk');
-const { TestomatClient, TRConstants } = require('../../reporter');
 const { parseTest } = require('../../util');
+const { STATUS } = require('../../constants');
+const TestomatClient = require('../../client');
 
 const createTestomatFormatter = apiKey => {
   if (!apiKey || apiKey === '') {
@@ -92,18 +93,18 @@ const createTestomatFormatter = apiKey => {
       if (!apiKey) return;
 
       this.client = new TestomatClient({ apiKey });
-      this.status = TRConstants.PASSED;
+      this.status = STATUS.PASSED.toString();
 
       options.eventBroadcaster.on('gherkin-document', addDocument);
-      options.eventBroadcaster.on('test-run-started', () => this.client.createRun());
+      options.eventBroadcaster.on('test-run-started', () => this?.client?.createRun());
       options.eventBroadcaster.on('test-case-finished', this.onTestCaseFinished.bind(this));
-      options.eventBroadcaster.on('test-run-finished', () => this.client.updateRunStatus(this.status));
+      options.eventBroadcaster.on('test-run-finished', () => this?.client?.updateRunStatus(this.status));
     }
 
     onTestCaseFinished(event) {
       const scenario = getScenario(event.sourceLocation);
       const testId = getTestId(scenario);
-      const status = event.result.status === 'undefined' ? TRConstants.SKIPPED : event.result.status;
+      const status = event.result.status === 'undefined' ? STATUS.SKIPPED : event.result.status;
 
       let example = getDataTableMap(scenario, event.sourceLocation);
       if (example) example = JSON.parse(example);
@@ -120,14 +121,17 @@ const createTestomatFormatter = apiKey => {
         message = 'Undefined steps. Implement missing steps and rerun this scenario';
       }
       console.log(cliMessage);
-      if (status !== TRConstants.PASSED && status !== TRConstants.SKIPPED) {
-        this.status = TRConstants.FAILED;
+      if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
+        this.status = STATUS.FAILED;
       }
-      this.client.addTestRun(testId, status, {
-        error: event.result.exception,
+
+      this.client?.addTestRun(status, {
+        error: event.result.exception instanceof Error ? event.result.exception : undefined,
         message,
         example,
+        test_id: testId,
         title: getTitle(scenario),
+        suite_title: getTitle(getFeature(event.sourceLocation.uri)),
       });
     }
   };

package/lib/adapter/cypress-plugin/index.js

@@ -1,4 +1,4 @@
-const TRConstants = require('../../constants');
+const { STATUS } = require('../../constants');
 const { parseTest, parseSuite } = require('../../util');
 const TestomatClient = require('../../client');
 
@@ -57,16 +57,16 @@ const testomatioReporter = on => {
 
       let state;
       switch (test.state) {
-        case 'passed': state = TRConstants.PASSED; break;
-        case 'failed': state = TRConstants.FAILED; break;
+        case 'passed': state = STATUS.PASSED; break;
+        case 'failed': state = STATUS.FAILED; break;
         case 'skipped':
         case 'pending': 
         default:
-          state = TRConstants.SKIPPED;
+          state = STATUS.SKIPPED;
       }
 
-      addSpecTestsPromises.push(client.addTestRun(testId, state, {
-        title, time, example, error, files, suite_title: suiteTitle, suite_id: suiteId
+      addSpecTestsPromises.push(client.addTestRun(state, {
+        title, time, example, error, files, suite_title: suiteTitle, test_id: testId, suite_id: suiteId
       }));
     }
 
@@ -74,7 +74,7 @@ const testomatioReporter = on => {
   });
 
   on('after:run', async results => {
-    const status = results.totalFailed ? TRConstants.FAILED : TRConstants.PASSED;
+    const status = results.totalFailed ? STATUS.FAILED : STATUS.PASSED;
     await client.updateRunStatus(status);
   });
 };

package/lib/adapter/jasmine.js

@@ -1,6 +1,6 @@
 const TestomatClient = require('../client');
 const { parseTest, ansiRegExp } = require('../util');
-const { PASSED, FAILED } = require('../constants');
+const { STATUS } = require('../constants');
 
 class JasmineReporter {
   constructor(options) {
@@ -32,13 +32,14 @@ class JasmineReporter {
       errorMessage = `${errorMessage}Failure: ${result.failedExpectations[i].message}\n`;
       errorMessage = `${errorMessage}\n ${result.failedExpectations[i].stack}`;
     }
-    console.log(`${title} : ${PASSED}`);
+    console.log(`${title} : ${STATUS.PASSED}`);
     console.log(errorMessage);
     const testId = parseTest(title);
     errorMessage = errorMessage.replace(ansiRegExp(), '');
-    this.client.addTestRun(testId, status, {
+    this.client.addTestRun(status, {
       error: result.failedExpectations[0],
       message: errorMessage,
+      test_id: testId,
       title,
       time: this.getDuration(result),
     });
@@ -48,7 +49,7 @@ class JasmineReporter {
     if (!this.client) return;
 
     const { overallStatus } = suiteInfo;
-    const status = overallStatus === 'failed' ? FAILED : PASSED;
+    const status = overallStatus === 'failed' ? STATUS.FAILED : STATUS.PASSED;
 
     this.client.updateRunStatus(status).then(() => done);
   }

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,16 +3,17 @@ 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 { isArtifactsEnabled } = require('../fileUploader');
 const { parseTest } = require('../util');
 
+
 class TestomatioReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
 
-    this.videos = [];
+    this.uploads = [];
   }
 
   onBegin(_config, suite) {
@@ -36,31 +37,15 @@ class TestomatioReporter {
       appendStep(step, steps);
     }
 
-    const files = [];
-
-    for (const attachment of result.attachments) {
-      if (!attachment.body && !attachment.path) {
-        continue;
-      }
-      if (attachment.contentType && attachment.contentType.startsWith('video')) {
-        // video is post-processed
-        this.videos.push({ testId, attachment, title, suite_title });
-        continue;
-      }
-
-      let fileName = attachment.path;
-      if (attachment.body) {
-        fileName = tmpFile();
-        fs.writeFileSync(fileName, attachment.body);
-      }
-      files.push({ path: fileName, type: attachment.contentType });
-    }
+    this.uploads.push({
+      testId, title, suite_title, files: result.attachments.filter((a) => a.body || a.path)
+    })
 
-    this.client.addTestRun(testId, checkStatus(result.status), {
+    this.client.addTestRun(checkStatus(result.status), {
       error,
+      test_id: testId,
       suite_title,
       title,
-      files,
       steps: steps.join('\n'),
       time: duration,
     });
@@ -69,18 +54,30 @@ 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.uploads.length && isArtifactsEnabled()) {
+      console.log(APP_PREFIX, `🎞️  Uploading ${this.uploads.length} files...`);
 
       const promises = [];
-      for (const video of this.videos) {
-        const { testId, title, attachment, suite_title } = video;
-        const file = { path: attachment.path, title, type: attachment.contentType };
+
+      for (const upload of this.uploads) {
+
+        const { title, testId, suite_title } = upload;
+
+        const files = upload.files.map((attachment) => {
+          if (attachment.body) {
+            const fileName = tmpFile();
+            fs.writeFileSync(fileName, attachment.body);
+          }
+          return { 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],
+            files,
           }),
         );
       }

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