@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/lib/adapter/cucumber/legacy.js

@@ -1,155 +1,130 @@
-// eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
-const { Formatter } = require('cucumber');
-const chalk = require('chalk');
-const { getTestomatIdFromTestTitle, fileSystem } = require('../../utils/utils');
-const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../../constants');
-const TestomatClient = require('../../client');
-const config = require('../../config');
-
-const createTestomatFormatter = apiKey => {
-  if (!apiKey || apiKey === '') {
-    console.log(chalk.red('TESTOMATIO key is empty, ignoring reports'));
-  }
-
-  const documents = {};
-  const dataTableMap = {};
-
-  const addDocument = gherkinDocument => {
-    documents[gherkinDocument.uri] = gherkinDocument.document;
-  };
-
-  const getTitle = scenario => {
-    let { name } = scenario;
-    if (scenario.tags.length) {
-      let tags = '';
-      for (const tag of scenario.tags) {
-        tags = `${tags} ${tag.name}`;
-      }
-      name = `${name}${tags}`;
-    }
-    return name;
-  };
-
-  const getFeature = uri => documents[uri].feature;
-
-  const getScenario = location => {
-    const { children } = getFeature(location.uri);
-    for (const scenario of children) {
-      if (scenario.type === 'Scenario' && scenario.location.line === location.line) {
-        return scenario;
-      }
-      if (scenario.type === 'ScenarioOutline') {
-        for (const example of scenario.examples) {
-          for (const tableBody of example.tableBody) {
-            if (tableBody.location.line === location.line) {
-              return scenario;
-            }
-          }
-        }
-      }
-    }
-
-    return null;
-  };
-
-  const loadDataTable = (scenario, uri) => {
-    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 getDataTableMap = (scenario, sourceLocation) => {
-    const key = `${sourceLocation.uri}:${sourceLocation.line}`;
-    if (!dataTableMap[key]) {
-      loadDataTable(scenario, sourceLocation.uri);
-    }
-
-    return dataTableMap[key] || '';
-  };
-
-  const getTestId = scenario => {
-    if (scenario) {
-      for (const tag of scenario.tags) {
-        const testId = getTestomatIdFromTestTitle(tag.name);
-        if (testId) return testId;
-      }
-    }
-
-    return null;
-  };
-
-  return class TestomatFormatter extends Formatter {
-    constructor(options) {
-      super(options);
-
-      if (!apiKey) return;
-
-      this.client = new TestomatClient({ apiKey });
-      this.status = STATUS.PASSED.toString();
-
-      options.eventBroadcaster.on('gherkin-document', addDocument);
-      options.eventBroadcaster.on('test-run-started', () => {
-        fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-        this?.client?.createRun();
-      });
-      options.eventBroadcaster.on('test-case-finished', this.onTestCaseFinished.bind(this));
-      options.eventBroadcaster.on('test-case-started', this.onTestCaseStarted.bind(this));
-      options.eventBroadcaster.on('test-run-finished', () => this?.client?.updateRunStatus(this.status));
-
-      global.testomatioRunningEnvironment = 'cucumber:legacy';
-    }
-
-    onTestCaseStarted(event) {
-      const scenario = getScenario(event.sourceLocation);
-      const testId = getTestId(scenario);
-
-      if (!global.testomatioDataStore) global.testomatioDataStore = {};
-      global.testomatioDataStore.currentlyRunningTestId = testId;
-    }
-
-    onTestCaseFinished(event) {
-      const scenario = getScenario(event.sourceLocation);
-      const testId = getTestId(scenario);
-      const status = event.result.status === 'undefined' ? STATUS.SKIPPED : event.result.status;
-
-      let example = getDataTableMap(scenario, event.sourceLocation);
-      if (example) example = JSON.parse(example);
-
-      if (!scenario.name) return;
-
-      const message = '';
-      const cliMessage = `- ${scenario.name}: ${chalk.bold(status.toUpperCase())}`;
-
-      // if (event.result.status === 'undefined') {
-      //   cliMessage += chalk.yellow(
-      //     ' (undefined steps. Run Cucumber without this formatter and implement missing steps)',
-      //   );
-      //   message = 'Undefined steps. Implement missing steps and rerun this scenario';
-      // }
-      console.log(cliMessage);
-      if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
-        this.status = STATUS.FAILED;
-      }
-
-      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)),
-      });
-    }
-  };
-};
-
-module.exports = createTestomatFormatter(config.TESTOMATIO);
+// import { Formatter } from 'cucumber';
+// import pc from 'picocolors';
+// import { getTestomatIdFromTestTitle, fileSystem } from '../../utils/utils.js';
+// import { STATUS, TESTOMAT_TMP_STORAGE_DIR } from '../../constants.js';
+// import TestomatClient from '../../client.js';
+// import {config} from '../../config.js';
+// const createTestomatFormatter = apiKey => {
+//   if (!apiKey || apiKey === '') {
+//     console.log(pc.red('TESTOMATIO key is empty, ignoring reports'));
+//   }
+//   const documents = {};
+//   const dataTableMap = {};
+//   const addDocument = gherkinDocument => {
+//     documents[gherkinDocument.uri] = gherkinDocument.document;
+//   };
+//   const getTitle = scenario => {
+//     let { name } = scenario;
+//     if (scenario.tags.length) {
+//       let tags = '';
+//       for (const tag of scenario.tags) {
+//         tags = `${tags} ${tag.name}`;
+//       }
+//       name = `${name}${tags}`;
+//     }
+//     return name;
+//   };
+//   const getFeature = uri => documents[uri].feature;
+//   const getScenario = location => {
+//     const { children } = getFeature(location.uri);
+//     for (const scenario of children) {
+//       if (scenario.type === 'Scenario' && scenario.location.line === location.line) {
+//         return scenario;
+//       }
+//       if (scenario.type === 'ScenarioOutline') {
+//         for (const example of scenario.examples) {
+//           for (const tableBody of example.tableBody) {
+//             if (tableBody.location.line === location.line) {
+//               return scenario;
+//             }
+//           }
+//         }
+//       }
+//     }
+//     return null;
+//   };
+//   const loadDataTable = (scenario, uri) => {
+//     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 getDataTableMap = (scenario, sourceLocation) => {
+//     const key = `${sourceLocation.uri}:${sourceLocation.line}`;
+//     if (!dataTableMap[key]) {
+//       loadDataTable(scenario, sourceLocation.uri);
+//     }
+//     return dataTableMap[key] || '';
+//   };
+//   const getTestId = scenario => {
+//     if (scenario) {
+//       for (const tag of scenario.tags) {
+//         const testId = getTestomatIdFromTestTitle(tag.name);
+//         if (testId) return testId;
+//       }
+//     }
+//     return null;
+//   };
+//   return class TestomatFormatter extends Formatter {
+//     constructor(options) {
+//       super(options);
+//       if (!apiKey) return;
+//       this.client = new TestomatClient({ apiKey });
+//       this.status = STATUS.PASSED.toString();
+//       options.eventBroadcaster.on('gherkin-document', addDocument);
+//       options.eventBroadcaster.on('test-run-started', () => {
+//         fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
+//         this?.client?.createRun();
+//       });
+//       options.eventBroadcaster.on('test-case-finished', this.onTestCaseFinished.bind(this));
+//       options.eventBroadcaster.on('test-case-started', this.onTestCaseStarted.bind(this));
+//       // @ts-ignore
+//       options.eventBroadcaster.on('test-run-finished', () => this?.client?.updateRunStatus(this.status));
+//       global.testomatioRunningEnvironment = 'cucumber:legacy';
+//     }
+//     onTestCaseStarted(event) {
+//       const scenario = getScenario(event.sourceLocation);
+//       const testId = getTestId(scenario);
+//       if (!global.testomatioDataStore) global.testomatioDataStore = {};
+//       global.testomatioDataStore.currentlyRunningTestId = testId;
+//     }
+//     onTestCaseFinished(event) {
+//       const scenario = getScenario(event.sourceLocation);
+//       const testId = getTestId(scenario);
+//       const status = event.result.status === 'undefined' ? STATUS.SKIPPED : event.result.status;
+//       let example = getDataTableMap(scenario, event.sourceLocation);
+//       if (example) example = JSON.parse(example);
+//       if (!scenario.name) return;
+//       const message = '';
+//       const cliMessage = `- ${scenario.name}: ${pc.bold(status.toUpperCase())}`;
+//       // if (event.result.status === 'undefined') {
+//       //   cliMessage += pc.yellow(
+//       //     ' (undefined steps. Run Cucumber without this formatter and implement missing steps)',
+//       //   );
+//       //   message = 'Undefined steps. Implement missing steps and rerun this scenario';
+//       // }
+//       console.log(cliMessage);
+//       if (status !== STATUS.PASSED && status !== STATUS.SKIPPED) {
+//         this.status = STATUS.FAILED;
+//       }
+//       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)),
+//       });
+//     }
+//   };
+// };
+// const CucumberLegacyReporter = createTestomatFormatter(config.TESTOMATIO);
+// export { CucumberLegacyReporter };
+// export default CucumberLegacyReporter;

package/lib/adapter/cucumber.d.ts

@@ -0,0 +1,2 @@
+export default CucumberReporter;
+import { CucumberReporter } from './cucumber/current.js';

package/lib/adapter/cucumber.js

@@ -1,16 +1,5 @@
-try {
-  // eslint-disable-next-line import/no-unresolved
-  require.resolve('@cucumber/cucumber');
-  // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-  module.exports = require('./cucumber/current');
-} catch (_e) {
-  try {
-    // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-    require.resolve('cucumber');
-    // eslint-disable-next-line global-require, import/no-extraneous-dependencies
-    module.exports = require('./cucumber/legacy');
-  } catch (_err) {
-    console.error('Cucumber packages: "@cucumber/cucumber" or "cucumber" were not detected. Report won\'t be sent');
-    module.exports = {};
-  }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const current_js_1 = require("./cucumber/current.js");
+// import { CucumberLegacyReporter } from './cucumber/legacy.js';
+module.exports = current_js_1.CucumberReporter;

package/lib/adapter/cypress-plugin/index.d.ts

@@ -0,0 +1,2 @@
+export default testomatioReporter;
+declare function testomatioReporter(on: any): void;

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

@@ -1,109 +1,97 @@
-const { STATUS } = require('../../constants');
-const { getTestomatIdFromTestTitle, parseSuite } = require('../../utils/utils');
-const TestomatClient = require('../../client');
-const config = require('../../config');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_js_1 = require("../../constants.js");
+const utils_js_1 = require("../../utils/utils.js");
+const client_js_1 = __importDefault(require("../../client.js"));
+const config_js_1 = require("../../config.js");
 const testomatioReporter = on => {
-  if (!config.TESTOMATIO) {
-    console.log('TESTOMATIO key is empty, ignoring reports');
-    return;
-  }
-  const client = new TestomatClient({ apiKey: config.TESTOMATIO });
-
-  on('before:run', async run => {
-    // TODO: looks like client.env does not exist
-    if (!client.env) {
-      client.env = `${run.browser.displayName},${run.system.osName}`;
-    }
-    await client.createRun();
-  });
-
-  on('after:spec', async (_spec, results) => {
-    const addSpecTestsPromises = [];
-
-    const videos = [results.video];
-
-    for (const test of results.tests) {
-      const lastAttemptIndex = test.attempts.length - 1;
-      const latestAttempt = test.attempts[lastAttemptIndex];
-
-      // latestAttempt.duration && latestAttempt.error were available in adapters version up to 13 JFYI
-      const time = latestAttempt.duration || latestAttempt.wallClockDuration || test.duration;
-      let error = latestAttempt.error;
-
-      let title = test.title.pop();
-      const examples = title.match(/\(example (#\d+)\)/);
-      let example = null;
-      if (examples && examples[1]) example = { example: examples[1] };
-      title = title.replace(/\(example #\d+\)/, '').trim();
-
-      const suiteTitle = test.title.pop();
-
-      const testId = getTestomatIdFromTestTitle(title);
-      const suiteId = parseSuite(suiteTitle);
-
-      if (!error && test.displayError) {
-        error = { message: test.displayError };
-        error.inspect = function () {
-          // eslint-disable-line func-names
-          return this.message;
-        };
-      }
-
-      const formattedError = error
-        ? {
-            message: error.message,
-            inspect:
-              error.inspect ||
-              function () {
-                return this.message;
-              },
-          }
-        : '';
-
-      const screenshots = Array.isArray(results.screenshots)
-        ? results.screenshots
-            .filter(screenshot => screenshot?.path && screenshot?.path.includes(title) && screenshot?.takenAt)
-            .map(screenshot => screenshot.path)
-        : [];
-
-      const files = [...videos, ...screenshots];
-
-      let state;
-      switch (test.state) {
-        case 'passed':
-          state = STATUS.PASSED;
-          break;
-        case 'failed':
-          state = STATUS.FAILED;
-          break;
-        case 'skipped':
-        case 'pending':
-        default:
-          state = STATUS.SKIPPED;
-      }
-
-      addSpecTestsPromises.push(
-        client.addTestRun(state, {
-          title,
-          time,
-          example,
-          error: formattedError,
-          files,
-          suite_title: suiteTitle,
-          test_id: testId,
-          suite_id: suiteId,
-        }),
-      );
+    if (!config_js_1.config.TESTOMATIO) {
+        console.log('TESTOMATIO key is empty, ignoring reports');
+        return;
     }
-
-    await Promise.all(addSpecTestsPromises);
-  });
-
-  on('after:run', async results => {
-    const status = results.totalFailed ? STATUS.FAILED : STATUS.PASSED;
-    await client.updateRunStatus(status);
-  });
+    const client = new client_js_1.default({ apiKey: config_js_1.config.TESTOMATIO });
+    on('before:run', async () => {
+        // TODO: looks like client.env does not exist
+        // if (!client.env) {
+        //   client.env = `${run.browser.displayName},${run.system.osName}`;
+        // }
+        await client.createRun();
+    });
+    on('after:spec', async (_spec, results) => {
+        const addSpecTestsPromises = [];
+        const videos = [results.video];
+        for (const test of results.tests) {
+            const lastAttemptIndex = test.attempts.length - 1;
+            const latestAttempt = test.attempts[lastAttemptIndex];
+            // latestAttempt.duration && latestAttempt.error were available in adapters version up to 13 JFYI
+            const time = latestAttempt.duration || latestAttempt.wallClockDuration || test.duration;
+            let error = latestAttempt.error;
+            let title = test.title.pop();
+            const examples = title.match(/\(example (#\d+)\)/);
+            let example = null;
+            if (examples && examples[1])
+                example = { example: examples[1] };
+            title = title.replace(/\(example #\d+\)/, '').trim();
+            const suiteTitle = test.title.pop();
+            const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(title);
+            const suiteId = (0, utils_js_1.parseSuite)(suiteTitle);
+            if (!error && test.displayError) {
+                error = { message: test.displayError };
+                // eslint-disable-next-line
+                error.inspect = function () {
+                    return this.message;
+                };
+            }
+            const formattedError = error
+                ? {
+                    message: error.message,
+                    name: error.name,
+                    inspect: error.inspect ||
+                        // eslint-disable-next-line
+                        function () {
+                            return this.message;
+                        },
+                }
+                : undefined;
+            const screenshots = Array.isArray(results.screenshots)
+                ? results.screenshots
+                    .filter(screenshot => screenshot?.path && screenshot?.path.includes(title) && screenshot?.takenAt)
+                    .map(screenshot => screenshot.path)
+                : [];
+            const files = [...videos, ...screenshots];
+            let state;
+            switch (test.state) {
+                case 'passed':
+                    state = constants_js_1.STATUS.PASSED;
+                    break;
+                case 'failed':
+                    state = constants_js_1.STATUS.FAILED;
+                    break;
+                case 'skipped':
+                case 'pending':
+                default:
+                    state = constants_js_1.STATUS.SKIPPED;
+            }
+            addSpecTestsPromises.push(client.addTestRun(state, {
+                title,
+                time,
+                example,
+                error: formattedError,
+                files,
+                suite_title: suiteTitle,
+                test_id: testId,
+                suite_id: suiteId,
+            }));
+        }
+        await Promise.all(addSpecTestsPromises);
+    });
+    on('after:run', async (results) => {
+        const status = results.totalFailed ? constants_js_1.STATUS.FAILED : constants_js_1.STATUS.PASSED;
+        // @ts-ignore
+        await client.updateRunStatus(status);
+    });
 };
-
 module.exports = testomatioReporter;

package/lib/adapter/jasmine.d.ts

@@ -0,0 +1,11 @@
+export default JasmineReporter;
+export class JasmineReporter {
+    constructor(options: any);
+    testTimeMap: {};
+    client: TestomatClient;
+    getDuration(test: any): number;
+    specStarted(result: any): void;
+    specDone(result: any): void;
+    jasmineDone(suiteInfo: any, done: any): void;
+}
+import TestomatClient from '../client.js';

package/lib/adapter/jasmine.js

@@ -1,58 +1,59 @@
-const TestomatClient = require('../client');
-const { getTestomatIdFromTestTitle, ansiRegExp } = require('../utils/utils');
-const { STATUS } = require('../constants');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JasmineReporter = void 0;
+const client_js_1 = __importDefault(require("../client.js"));
+const utils_js_1 = require("../utils/utils.js");
+const constants_js_1 = require("../constants.js");
 class JasmineReporter {
-  constructor(options) {
-    this.testTimeMap = {};
-    this.client = new TestomatClient({ apiKey: options?.apiKey });
-    this.client.createRun();
-  }
-
-  getDuration(test) {
-    if (this.testTimeMap[test.id]) {
-      return Date.now() - this.testTimeMap[test.id];
+    constructor(options) {
+        this.testTimeMap = {};
+        this.client = new client_js_1.default({ apiKey: options?.apiKey });
+        this.client.createRun();
     }
-
-    return 0;
-  }
-
-  specStarted(result) {
-    this.testTimeMap[result.id] = Date.now();
-  }
-
-  specDone(result) {
-    if (!this.client) return;
-
-    const title = result.description;
-    const { status } = result;
-    let errorMessage = '';
-
-    for (let i = 0; i < result.failedExpectations.length; i += 1) {
-      errorMessage = `${errorMessage}Failure: ${result.failedExpectations[i].message}\n`;
-      errorMessage = `${errorMessage}\n ${result.failedExpectations[i].stack}`;
+    getDuration(test) {
+        if (this.testTimeMap[test.id]) {
+            return Date.now() - this.testTimeMap[test.id];
+        }
+        return 0;
+    }
+    specStarted(result) {
+        this.testTimeMap[result.id] = Date.now();
+    }
+    specDone(result) {
+        if (!this.client)
+            return;
+        const title = result.description;
+        const { status } = result;
+        let errorMessage = '';
+        for (let i = 0; i < result.failedExpectations.length; i += 1) {
+            errorMessage = `${errorMessage}Failure: ${result.failedExpectations[i].message}\n`;
+            errorMessage = `${errorMessage}\n ${result.failedExpectations[i].stack}`;
+        }
+        console.log(`${title} : ${constants_js_1.STATUS.PASSED}`);
+        console.log(errorMessage);
+        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(title);
+        errorMessage = errorMessage.replace((0, utils_js_1.ansiRegExp)(), '');
+        this.client.addTestRun(status, {
+            error: result.failedExpectations[0],
+            message: errorMessage,
+            test_id: testId,
+            title,
+            time: this.getDuration(result),
+        });
+    }
+    jasmineDone(suiteInfo, done) {
+        if (!this.client)
+            return;
+        const { overallStatus } = suiteInfo;
+        const status = overallStatus === 'failed' ? constants_js_1.STATUS.FAILED : constants_js_1.STATUS.PASSED;
+        // @ts-ignore
+        this.client.updateRunStatus(status).then(() => done);
     }
-    console.log(`${title} : ${STATUS.PASSED}`);
-    console.log(errorMessage);
-    const testId = getTestomatIdFromTestTitle(title);
-    errorMessage = errorMessage.replace(ansiRegExp(), '');
-    this.client.addTestRun(status, {
-      error: result.failedExpectations[0],
-      message: errorMessage,
-      test_id: testId,
-      title,
-      time: this.getDuration(result),
-    });
-  }
-
-  jasmineDone(suiteInfo, done) {
-    if (!this.client) return;
-
-    const { overallStatus } = suiteInfo;
-    const status = overallStatus === 'failed' ? STATUS.FAILED : STATUS.PASSED;
-
-    this.client.updateRunStatus(status).then(() => done);
-  }
 }
-
+exports.JasmineReporter = JasmineReporter;
 module.exports = JasmineReporter;
+
+module.exports.JasmineReporter = JasmineReporter;