@testomatio/reporter 0.4.5 → 0.5.0-beta.3

package/example/jest/index.test.js

@@ -1,9 +1,9 @@
-describe("Suite 1", () => {
-  test("Test addition", () => {
+describe('Suite 1', () => {
+  test('Test addition', () => {
     expect(1 + 2).toBe(4);
   });
 
-  test("Test some more addition", () => {
+  test('Test some more addition', () => {
     expect(1 + 2).toBe(3);
   });
 });

package/example/jest/jest.config.js

@@ -132,7 +132,7 @@ module.exports = {
   // snapshotSerializers: [],
 
   // The test environment that will be used for testing
-  testEnvironment: "node",
+  testEnvironment: 'node',
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},

package/example/jest/sample.test.js

@@ -1,13 +1,13 @@
-describe("Suite 2", () => {
-  test("This is a sample test 3", () => {
+describe('Suite 2', () => {
+  test('This is a sample test 3', () => {
     expect(1 + 2).toBe(3);
   });
 
-  test("This is a sample test 4", () => {
+  test('This is a sample test 4', () => {
     expect(1 + 2).toBe(3);
   });
 
-  test("Test for suite 2", () => {
+  test('Test for suite 2', () => {
     expect(1 + 2).toBe(3);
   });
 });

package/example/mocha/test/index.test.js

@@ -1,13 +1,13 @@
-const assert = require("assert");
+const assert = require('assert');
 
-describe("Sample mocha suite", () => {
-  it("Sample mocha test", () => {
+describe('Sample mocha suite', () => {
+  it('Sample mocha test', () => {
     assert.equal([1, 2, 3].indexOf(4), 0);
   });
 });
 
-describe("Sample mocha suite 2", () => {
-  it("Sample mocha test 2", () => {
+describe('Sample mocha suite 2', () => {
+  it('Sample mocha test 2', () => {
     assert.equal(1, 1);
   });
 });

package/lib/adapter/codecept.js

@@ -1,62 +1,46 @@
-/* eslint-disable no-param-reassign */
 if (!global.codeceptjs) {
-  global.codeceptjs = require("codeceptjs");
+  // eslint-disable-next-line global-require
+  global.codeceptjs = require('codeceptjs');
 }
+
 const { event, recorder, codecept } = global.codeceptjs;
-const chalk = require("chalk");
-const TestomatClient = require("../client");
-const { FAILED } = require("../constants");
-const TRConstants = require("../constants");
-const upload = require("../fileUploader");
-const Output = require("../output");
+const chalk = require('chalk');
+const TestomatClient = require('../client');
+const { FAILED } = require('../constants');
+const TRConstants = require('../constants');
+const upload = require('../fileUploader');
+const Output = require('../output');
 
 let currentMetaStep = [];
+let error;
 let stepShift = 0;
+
 const output = new Output({
-  filterFn: (stack) => !stack.includes("codeceptjs/lib/output"), // output from codeceptjs
+  filterFn: stack => !stack.includes('codeceptjs/lib/output'), // output from codeceptjs
 });
+
 let stepStart = new Date();
 
 const MAJOR_VERSION = parseInt(codecept.version().match(/\d/)[0], 10);
 
+const DATA_REGEXP = /[|\s]+?(\{".*\}|\[.*\])/;
+
 if (MAJOR_VERSION < 3) {
-  console.log(
-    "🔴 This reporter works with CodeceptJS 3+, please update your tests"
-  );
+  console.log('🔴 This reporter works with CodeceptJS 3+, please update your tests');
 }
 
-const parseTest = (tags) => {
-  if (tags) {
-    for (const tag of tags) {
-      if (tag.startsWith("@T")) {
-        return tag.substring(2, tag.length);
-      }
-    }
-  }
-
-  return null;
-};
-
-const getTestAndMessage = (title) => {
-  const testObj = { message: "" };
-  const testArr = title.split(/\s(\|\s\{.*?\})/);
-  testObj.title = testArr[0];
-
-  return testObj;
-};
-
-module.exports = (config) => {
+function CodeceptReporter(config) {
   let failedTests = [];
   let videos = [];
   const testTimeMap = {};
   const { apiKey } = config;
 
   if (!apiKey) {
-    console.log("TESTOMATIO key is empty, ignoring reports");
+    console.log('TESTOMATIO key is empty, ignoring reports');
     return;
   }
 
-  const getDuration = (test) => {
+  const getDuration = test => {
     if (testTimeMap[test.id]) {
       return Date.now() - testTimeMap[test.id];
     }
@@ -70,7 +54,7 @@ module.exports = (config) => {
 
   // Listening to events
   event.dispatcher.on(event.all.before, () => {
-    recorder.add("Creating new run", () => client.createRun());
+    recorder.add('Creating new run', () => client.createRun());
     videos = [];
   });
 
@@ -83,7 +67,7 @@ module.exports = (config) => {
     });
   });
 
-  event.dispatcher.on(event.test.started, (test) => {
+  event.dispatcher.on(event.test.started, test => {
     testTimeMap[test.id] = Date.now();
   });
 
@@ -91,14 +75,16 @@ module.exports = (config) => {
     if (videos.length && upload.isEnabled()) {
       console.log(TRConstants.APP_PREFIX, `🎞️  Uploading ${videos.length} videos...`);
 
-      let promises = [];
+      const promises = [];
       for (const video of videos) {
         const { testId, title, path, type } = video;
         const file = { path, type, title };
-        promises.push(client.addTestRun(testId, undefined, {
-          ...stripExampleFromTitle(title),
-          files: [file],
-        }));
+        promises.push(
+          client.addTestRun(testId, undefined, {
+            ...stripExampleFromTitle(title),
+            files: [file],
+          }),
+        );
       }
       await Promise.all(promises);
     }
@@ -107,10 +93,10 @@ module.exports = (config) => {
     client.updateRunStatus(status);
   });
 
-  event.dispatcher.on(event.test.passed, (test) => {
+  event.dispatcher.on(event.test.passed, test => {
     const { id, tags, title } = test;
     if (id && failedTests.includes(id)) {
-      failedTests = failedTests.filter((failed) => id !== failed);
+      failedTests = failedTests.filter(failed => id !== failed);
     }
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
@@ -123,14 +109,19 @@ module.exports = (config) => {
     output.stop();
   });
 
-  event.dispatcher.on(event.test.after, (test) => {
+  event.dispatcher.on(event.test.failed, (test, err) => {
+    error = err;
+  });
+
+  event.dispatcher.on(event.test.after, test => {
     if (test.state && test.state !== FAILED) return;
-    const { id, tags, title, err, artifacts } = test;
+    if (test.err) error = test.err;
+    const { id, tags, title, artifacts } = test;
     failedTests.push(id || title);
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
-    if (err && err.stack && test.steps && test.steps.length) {
-      err.stack = test.steps[test.steps.length - 1].line();
+    if (error && error.stack && test.steps && test.steps.length) {
+      error.stack = test.steps[test.steps.length - 1].line();
     }
 
     const files = [];
@@ -140,7 +131,7 @@ module.exports = (config) => {
 
     client.addTestRun(testId, TRConstants.FAILED, {
       ...stripExampleFromTitle(title),
-      error: err,
+      error,
       message: testObj.message,
       time: getDuration(test),
       files,
@@ -149,7 +140,7 @@ module.exports = (config) => {
     output.stop();
   });
 
-  event.dispatcher.on(event.test.skipped, (test) => {
+  event.dispatcher.on(event.test.skipped, test => {
     const { tags, title } = test;
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
@@ -161,13 +152,13 @@ module.exports = (config) => {
     output.stop();
   });
 
-  event.dispatcher.on(event.step.started, (step) => {
+  event.dispatcher.on(event.step.started, step => {
     stepShift = 0;
     step.started = true;
     stepStart = new Date();
   });
 
-  event.dispatcher.on(event.step.finished, (step) => {
+  event.dispatcher.on(event.step.finished, step => {
     if (!step.started) return;
     let processingStep = step;
     const metaSteps = [];
@@ -177,24 +168,15 @@ module.exports = (config) => {
     }
     const shift = metaSteps.length;
 
-    for (
-      let i = 0;
-      i < Math.max(currentMetaStep.length, metaSteps.length);
-      i++
-    ) {
+    for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
       if (currentMetaStep[i] !== metaSteps[i]) {
         stepShift = 2 * i;
+        // eslint-disable-next-line no-continue
         if (!metaSteps[i]) continue;
         if (metaSteps[i].isBDD()) {
-          output.push(
-            repeat(stepShift) +
-              chalk.bold(metaSteps[i].toString()) +
-              metaSteps[i].comment
-          );
+          output.push(repeat(stepShift) + chalk.bold(metaSteps[i].toString()) + metaSteps[i].comment);
         } else {
-          output.push(
-            repeat(stepShift) + chalk.green.bold(metaSteps[i].toString())
-          );
+          output.push(repeat(stepShift) + chalk.green.bold(metaSteps[i].toString()));
         }
       }
     }
@@ -213,23 +195,43 @@ module.exports = (config) => {
     }
   });
 
-  event.dispatcher.on(event.step.comment, (step) => {
+  event.dispatcher.on(event.step.comment, step => {
     output.push(chalk.cyan.bold(step.toString()));
   });
-};
+}
 
-const DATA_REGEXP = /[|\s]+?(\{".*\}|\[.*\])/;
+function parseTest(tags) {
+  if (tags) {
+    for (const tag of tags) {
+      if (tag.startsWith('@T')) {
+        return tag.substring(2, tag.length);
+      }
+    }
+  }
+
+  return null;
+}
+
+function getTestAndMessage(title) {
+  const testObj = { message: '' };
+  const testArr = title.split(/\s(\|\s\{.*?\})/);
+  testObj.title = testArr[0];
+
+  return testObj;
+}
 
 function stripExampleFromTitle(title) {
   const res = title.match(DATA_REGEXP);
   if (!res) return { title, example: null };
 
   const example = JSON.parse(res[1]);
-  title = title.replace(DATA_REGEXP, "").trim();
+  title = title.replace(DATA_REGEXP, '').trim();
 
   return { title, example };
 }
 
 function repeat(num) {
-  return "".padStart(num, " ");
+  return ''.padStart(num, ' ');
 }
+
+module.exports = CodeceptReporter;

package/lib/adapter/cucumber.js

@@ -1,24 +1,25 @@
-const { Formatter } = require("cucumber");
-const chalk = require("chalk");
-const { TestomatClient, TRConstants } = require("../reporter");
-const { parseTest } = require("../util");
-
-const createTestomatFormatter = (apiKey) => {
-  if (!apiKey || apiKey === "") {
-    console.log(chalk.red("TESTOMATIO key is empty, ignoring reports"));
+// eslint-disable-next-line import/no-unresolved
+const { Formatter } = require('cucumber');
+const chalk = require('chalk');
+const { TestomatClient, TRConstants } = require('../reporter');
+const { parseTest } = require('../util');
+
+const createTestomatFormatter = apiKey => {
+  if (!apiKey || apiKey === '') {
+    console.log(chalk.red('TESTOMATIO key is empty, ignoring reports'));
   }
 
   const documents = {};
   const dataTableMap = {};
 
-  const addDocument = (gherkinDocument) => {
+  const addDocument = gherkinDocument => {
     documents[gherkinDocument.uri] = gherkinDocument.document;
   };
 
-  const getTitle = (scenario) => {
+  const getTitle = scenario => {
     let { name } = scenario;
     if (scenario.tags.length) {
-      let tags = "";
+      let tags = '';
       for (const tag of scenario.tags) {
         tags = `${tags} ${tag.name}`;
       }
@@ -27,18 +28,15 @@ const createTestomatFormatter = (apiKey) => {
     return name;
   };
 
-  const getFeature = (uri) => documents[uri].feature;
+  const getFeature = uri => documents[uri].feature;
 
-  const getScenario = (location) => {
+  const getScenario = location => {
     const { children } = getFeature(location.uri);
     for (const scenario of children) {
-      if (
-        scenario.type === "Scenario" &&
-        scenario.location.line === location.line
-      ) {
+      if (scenario.type === 'Scenario' && scenario.location.line === location.line) {
         return scenario;
       }
-      if (scenario.type === "ScenarioOutline") {
+      if (scenario.type === 'ScenarioOutline') {
         for (const example of scenario.examples) {
           for (const tableBody of example.tableBody) {
             if (tableBody.location.line === location.line) {
@@ -53,19 +51,15 @@ const createTestomatFormatter = (apiKey) => {
   };
 
   const loadDataTable = (scenario, uri) => {
-    if (scenario.type === "ScenarioOutline") {
+    if (scenario.type === 'ScenarioOutline') {
       for (const example of scenario.examples) {
         for (const tableBody of example.tableBody) {
-          const dataMap = example.tableHeader.cells.reduce(
-            (acc, cell, index) => {
-              acc[cell.value] = tableBody.cells[index].value;
-              return acc;
-            },
-            {}
-          );
-
-          dataTableMap[`${uri}:${tableBody.location.line}`] =
-            JSON.stringify(dataMap);
+          const dataMap = example.tableHeader.cells.reduce((acc, cell, index) => {
+            acc[cell.value] = tableBody.cells[index].value;
+            return acc;
+          }, {});
+
+          dataTableMap[`${uri}:${tableBody.location.line}`] = JSON.stringify(dataMap);
         }
       }
     }
@@ -77,10 +71,10 @@ const createTestomatFormatter = (apiKey) => {
       loadDataTable(scenario, sourceLocation.uri);
     }
 
-    return dataTableMap[key] || "";
+    return dataTableMap[key] || '';
   };
 
-  const getTestId = (scenario) => {
+  const getTestId = scenario => {
     if (scenario) {
       for (const tag of scenario.tags) {
         const testId = parseTest(tag.name);
@@ -100,41 +94,30 @@ const createTestomatFormatter = (apiKey) => {
       this.client = new TestomatClient({ apiKey });
       this.status = TRConstants.PASSED;
 
-      options.eventBroadcaster.on("gherkin-document", addDocument);
-      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('gherkin-document', addDocument);
+      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));
     }
 
     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' ? TRConstants.SKIPPED : event.result.status;
 
       let example = getDataTableMap(scenario, event.sourceLocation);
       if (example) example = JSON.parse(example);
 
       if (!scenario.name) return;
 
-      let message = "";
-      let cliMessage = `- ${scenario.name}: ${chalk.bold(
-        status.toUpperCase()
-      )}`;
+      let message = '';
+      let cliMessage = `- ${scenario.name}: ${chalk.bold(status.toUpperCase())}`;
 
-      if (event.result.status === "undefined") {
+      if (event.result.status === 'undefined') {
         cliMessage += chalk.yellow(
-          " (undefined steps. Run Cucumber without this formatter and implement missing steps)"
+          ' (undefined steps. Run Cucumber without this formatter and implement missing steps)',
         );
-        message =
-          "Undefined steps. Implement missing steps and rerun this scenario";
+        message = 'Undefined steps. Implement missing steps and rerun this scenario';
       }
       console.log(cliMessage);
       if (status !== TRConstants.PASSED && status !== TRConstants.SKIPPED) {

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

@@ -0,0 +1,44 @@
+const TRConstants = require('../../constants');
+const { parseTest } = require('../../util');
+const TestomatClient = require('../../client');
+
+const testomatioReporter = on => {
+  const client = new TestomatClient({ apiKey: process.env.TESTOMATIO });
+
+  on('before:run', async () => {
+    await client.createRun();
+  });
+
+  on('after:spec', async (_spec, results) => {
+    const addSpecTestsPromises = [];
+
+    const videos = [results.video];
+
+    for (const test of results.tests) {
+      const latestAttempt = test.attempts[test.attempts.length - 1];
+      const time = latestAttempt.duration;
+      const error = latestAttempt.error;
+
+      const title = test.title[1]; // [0] - spec title, [1] - test title
+      const testId = parseTest(title);
+
+      const screenshots = results.screenshots
+        .filter(screenshot => screenshot.path.includes(title))
+        .map(screenshot => screenshot.path);
+      const files = [...videos, ...screenshots];
+
+      const state = test.state === 'passed' ? TRConstants.PASSED : TRConstants.FAILED;
+
+      addSpecTestsPromises.push(client.addTestRun(testId, state, { title, time, error, files }));
+    }
+
+    await Promise.all(addSpecTestsPromises);
+  });
+
+  on('after:run', async results => {
+    const status = results.totalFailed ? TRConstants.FAILED : TRConstants.PASSED;
+    await client.updateRunStatus(status);
+  });
+};
+
+module.exports = testomatioReporter;

package/lib/adapter/jasmine.js

@@ -1,6 +1,6 @@
-const TestomatClient = require("../client");
-const { parseTest, ansiRegExp } = require("../util");
-const { PASSED } = require("../constants");
+const TestomatClient = require('../client');
+const { parseTest, ansiRegExp } = require('../util');
+const { PASSED, FAILED } = require('../constants');
 
 class JasmineReporter {
   constructor(options) {
@@ -8,7 +8,7 @@ class JasmineReporter {
     const { apiKey } = options;
 
     if (!apiKey) {
-      console.log("TESTOMATIO key is empty, ignoring reports");
+      console.log('TESTOMATIO key is empty, ignoring reports');
       return;
     }
 
@@ -33,7 +33,7 @@ class JasmineReporter {
 
     const title = result.description;
     const { status } = result;
-    let errorMessage = "";
+    let errorMessage = '';
 
     for (let i = 0; i < result.failedExpectations.length; i += 1) {
       errorMessage = `${errorMessage}Failure: ${result.failedExpectations[i].message}\n`;
@@ -42,7 +42,7 @@ class JasmineReporter {
     console.log(`${title} : ${PASSED}`);
     console.log(errorMessage);
     const testId = parseTest(title);
-    errorMessage = errorMessage.replace(ansiRegExp(), "");
+    errorMessage = errorMessage.replace(ansiRegExp(), '');
     this.client.addTestRun(testId, status, {
       error: result.failedExpectations[0],
       message: errorMessage,
@@ -50,6 +50,15 @@ class JasmineReporter {
       time: this.getDuration(result),
     });
   }
+
+  jasmineDone(suiteInfo, done) {
+    if (!this.client) return;
+
+    const { overallStatus } = suiteInfo;
+    const status = overallStatus === 'failed' ? FAILED : PASSED;
+
+    this.client.updateRunStatus(status).then(() => done);
+  }
 }
 
 module.exports = JasmineReporter;

package/lib/adapter/jest.js

@@ -1,6 +1,6 @@
-const TestomatClient = require("../client");
-const TRConstants = require("../constants");
-const { parseTest, ansiRegExp } = require("../util");
+const TestomatClient = require('../client');
+const TRConstants = require('../constants');
+const { parseTest, ansiRegExp } = require('../util');
 
 class JestReporter {
   constructor(globalConfig, options) {
@@ -9,7 +9,7 @@ class JestReporter {
     const { apiKey } = options;
 
     if (!apiKey) {
-      console.log("TESTOMATIO key is empty, ignoring reports");
+      console.log('TESTOMATIO key is empty, ignoring reports');
       return;
     }
 
@@ -26,19 +26,19 @@ class JestReporter {
       let steps = null;
       const { status, title, duration, failureMessages } = result;
       if (failureMessages[0]) {
-        let errorMessage = failureMessages[0].replace(ansiRegExp(), "");
-        errorMessage = errorMessage.split("\n")[0];
+        let errorMessage = failureMessages[0].replace(ansiRegExp(), '');
+        errorMessage = errorMessage.split('\n')[0];
         error = {
           message: errorMessage,
         };
         steps = failureMessages[0];
       }
       const testId = parseTest(title);
-      const deducedStatus = status === "pending" ? "skipped" : status;
+      const deducedStatus = status === 'pending' ? 'skipped' : status;
 
       // 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") {
+      if (!this._globalConfig.testNamePattern || deducedStatus !== 'skipped') {
         this.client.addTestRun(testId, deducedStatus, {
           error,
           steps,
@@ -53,8 +53,7 @@ class JestReporter {
     if (!this.client) return;
 
     const { numFailedTests } = results;
-    const status =
-      numFailedTests === 0 ? TRConstants.PASSED : TRConstants.FAILED;
+    const status = numFailedTests === 0 ? TRConstants.PASSED : TRConstants.FAILED;
     this.client.updateRunStatus(status);
   }
 }