@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/package.json

@@ -1,21 +1,24 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.6.13",
+  "version": "2.0.1-beta-esm",
   "description": "Testomatio Reporter Client",
-  "main": "./lib/reporter.js",
+  "engines": {
+    "node": ">=18"
+  },
   "typings": "typings/index.d.ts",
   "repository": "git@github.com:testomatio/reporter.git",
   "author": "Michael Bodnarchuk <davert@testomat.io>,Koushik Mohan <koushikmohan1996@gmail.com>",
   "license": "MIT",
+  "type": "module",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.279.0",
     "@aws-sdk/lib-storage": "^3.279.0",
+    "@cucumber/cucumber": "^10.9.0",
     "@octokit/rest": "^19.0.5",
     "aws-sdk": "^2.1072.0",
     "axios": "^1.6.2",
     "axios-retry": "^3.9.1",
     "callsite-record": "^4.1.4",
-    "chalk": "^4.1.0",
     "commander": "^12",
     "cross-spawn": "^7.0.3",
     "csv-writer": "^1.6.0",
@@ -33,6 +36,7 @@
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
     "minimatch": "^9.0.3",
+    "picocolors": "^1.0.1",
     "pretty-ms": "^7.0.1",
     "promise-retry": "^2.0.1",
     "strip-ansi": "^7.1.0",
@@ -41,51 +45,89 @@
   "files": [
     "bin",
     "lib",
+    "src",
     "testcafe"
   ],
   "scripts": {
+    "@cucumber/cucumber": "^10.9.0",
     "clear-exportdir": "rm -rf export/",
     "pretty": "npx prettier --check .",
     "pretty:fix": "prettier --write .",
-    "lint": "eslint lib",
-    "lint:fix": "eslint lib --fix",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
     "format": "npm run lint:fix && npm run pretty:fix",
     "test": "mocha tests/**",
     "init": "cd ./tests/adapter/examples/cucumber && npm i",
-    "test:adapter": "mocha './tests/adapter/index.test.js'",
+    "test:adapter": "node node_modules/mocha/bin/mocha './tests/adapter/index.test.js'",
     "test:pipes": "mocha './tests/pipes/*_test.js'",
     "test:adapter:jest:example": "jest './tests/adapter/examples/jest/index.test.js' --config='./tests/adapter/examples/jest/jest.config.js'",
-    "test:adapter:mocha:example": "mocha './tests/adapter/examples/mocha/index.test.js' --config='./tests/adapter/examples/mocha/mocha.config.js'",
-    "test:adapter:jasmine:example": "./tests/adapter/examples/jasmine/passReporterOpts.sh && jasmine './tests/adapter/examples/jasmine/index.test.js' --reporter=./../../../lib/adapter/jasmine.js",
+    "test:adapter:mocha:example": "mocha './tests/adapter/examples/mocha/index.test.js' --config='./tests/adapter/examples/mocha/mocha.config.cjs'",
+    "test:adapter:jasmine:example": "jasmine './tests/adapter/examples/jasmine/index.test.js' --reporter=./lib/adapter/jasmine.js",
     "test:adapter:codecept:example": "codeceptjs run --config='./tests/adapter/examples/codecept/codecept.conf.js'",
     "test:adapter:cucumber:example": "cd ./tests/adapter/examples/cucumber && npx cucumber-js",
-    "test:adapter:vitest:example": "vitest --config='./tests/adapter/examples/vitest/vitest.config.js'",
-    "test:storage": "npx mocha tests-storage/artifact-storage.test.js && npx mocha tests-storage/data-storage.test.js && TESTOMATIO_INTERCEPT_CONSOLE_LOGS=true npx mocha tests-storage/logger.test.js && npx mocha tests-storage/logger-2.test.js && npx mocha tests-storage/reporter-functions.test.js"
+    "test:adapter:playwright:example": "npx playwright test --config='./tests/adapter/examples/playwright/playwright.config.ts'",
+    "test:adapter:vitest:example": "npx vitest --config='./tests/adapter/examples/vitest/vitest.config.ts'",
+    "test:storage": "npx mocha tests-storage/artifact-storage.test.js && npx mocha tests-storage/data-storage.test.js && TESTOMATIO_INTERCEPT_CONSOLE_LOGS=true npx mocha tests-storage/logger.test.js && npx mocha tests-storage/logger-2.test.js && npx mocha tests-storage/reporter-functions.test.js",
+    "//": "builds code from /src (esm) into /lib (commonjs)",
+    "build": "rm -rf ./cjs && tsc --module commonjs && npx tsx build/scripts/edit-js-files.js && npx tsx build/scripts/edit-package-json.js && chmod +x ./build/scripts/copy-tesmplate.sh && ./build/scripts/copy-tesmplate.sh"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "^9.3.0",
+    "@playwright/test": "^1.49.1",
     "@redocly/cli": "^1.0.0-beta.125",
+    "@types/cross-spawn": "^6.0.6",
+    "@types/cucumber": "^7.0.0",
+    "@types/mocha": "^10.0.7",
     "@wdio/reporter": "^7.16.13",
     "chai": "^4.3.6",
-    "codeceptjs": "^3.5.11",
+    "codeceptjs": "^3.6.5",
     "cucumber": "^6.0.7",
-    "eslint": "^8.7.0",
+    "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.4",
-    "jasmine": "^3.10.0",
+    "jasmine": "^5.2.0",
     "jest": "^27.4.7",
     "jsdom": "^22.1.0",
     "mocha": "^9.2.0",
     "mock-http-server": "^1.4.5",
     "pino": "^8.15.0",
     "prettier": "^3.2.5",
-    "puppeteer": "^22.15.0"
+    "puppeteer": "^22.15.0",
+    "typescript": "^5.5.4",
+    "vitest": "^1.6.0"
   },
   "bin": {
     "@testomatio/reporter": "./lib/bin/cli.js",
     "report-xml": "./lib/bin/reportXml.js",
     "start-test-run": "./lib/bin/startTest.js",
     "upload-artifacts": "./lib/bin/uploadArtifacts.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./src/reporter.js",
+      "require": "./lib/reporter.js",
+      "types": "./types/types.d.ts"
+    },
+    "./lib/adapter/codecept/codecept.js": "./lib/adapter/codecept.js",
+    "./lib/adapter/codecept": "./lib/adapter/codecept.js",
+    "./codecept": "./lib/adapter/codecept.js",
+    "./lib/adapter/cucumber/cucumber.js": "./lib/adapter/cucumber/current.js",
+    "./cucumber": "./lib/adapter/cucumber/current.js",
+    "./lib/adapter/cypress-plugin": "./lib/adapter/cypress-plugin/index.js",
+    "./cypress-plugin": "./lib/adapter/cypress-plugin/index.js",
+    "./cypress": "./lib/adapter/cypress-plugin/index.js",
+    "./lib/adapter/jasmine.js": "./lib/adapter/jasmine.js",
+    "./jasmine": "./lib/adapter/jasmine.js",
+    "./lib/adapter/jest.js": "./lib/adapter/jest.js",
+    "./jest": "./lib/adapter/jest.js",
+    "./lib/adapter/mocha/mocha.js": "./lib/adapter/mocha.js",
+    "./mocha": "./lib/adapter/mocha.js",
+    "./lib/adapter/playwright.js": "./lib/adapter/playwright.js",
+    "./playwright": "./lib/adapter/playwright.js",
+    "./vitest": "./lib/adapter/vitest.js",
+    "./lib/adapter/webdriver.js": "./lib/adapter/webdriver.js",
+    "./lib/adapter/webdriver": "./lib/adapter/webdriver.js",
+    "./webdriver": "./lib/adapter/webdriver.js",
+    "./wdio": "./lib/adapter/webdriver.js"
   }
 }

package/src/adapter/codecept.js

@@ -0,0 +1,375 @@
+import createDebugMessages from 'debug';
+import pc from 'picocolors';
+import TestomatClient from '../client.js';
+import { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
+import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
+import { services } from '../services/index.js';
+// eslint-disable-next-line
+import codeceptjs from 'codeceptjs';
+
+const debug = createDebugMessages('@testomatio/reporter:adapter:codeceptjs');
+// @ts-ignore
+if (!global.codeceptjs) {
+  // @ts-ignore
+  global.codeceptjs = codeceptjs;
+}
+
+// @ts-ignore
+const { event, recorder, codecept } = global.codeceptjs;
+
+let currentMetaStep = [];
+let error;
+let stepShift = 0;
+
+// const output = new Output({
+//   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');
+}
+
+function CodeceptReporter(config) {
+  let failedTests = [];
+  let videos = [];
+  let traces = [];
+  const reportTestPromises = [];
+
+  const testTimeMap = {};
+  const { apiKey } = config;
+
+  const getDuration = test => {
+    if (!test.uid) return 0;
+    if (testTimeMap[test.uid]) {
+      return Date.now() - testTimeMap[test.uid];
+    }
+
+    return 0;
+  };
+
+  const client = new TestomatClient({ apiKey });
+
+  recorder.startUnlessRunning();
+
+  // Listening to events
+  event.dispatcher.on(event.all.before, () => {
+    // clear tmp dir
+    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
+
+    // recorder.add('Creating new run', () => );
+    client.createRun();
+    videos = [];
+    traces = [];
+
+    if (!global.testomatioDataStore) global.testomatioDataStore = {};
+  });
+
+  let hookSteps = [];
+  let suiteHookRunning = false;
+
+  event.dispatcher.on(event.suite.before, suite => {
+    suiteHookRunning = true;
+    hookSteps = [];
+    global.testomatioDataStore.steps = [];
+
+    services.setContext(suite.fullTitle());
+  });
+
+  event.dispatcher.on(event.suite.after, () => {
+    services.setContext(null);
+  });
+
+  event.dispatcher.on(event.hook.started, () => {
+    // global.testomatioDataStore.steps = [];
+  });
+
+  event.dispatcher.on(event.hook.passed, () => {
+    if (suiteHookRunning) {
+      hookSteps.push(...global.testomatioDataStore.steps);
+      services.setContext(null);
+    }
+  });
+
+  event.dispatcher.on(event.hook.failed, () => {
+    if (suiteHookRunning) {
+      hookSteps.push(...global.testomatioDataStore.steps);
+      services.setContext(null);
+    }
+  });
+
+  event.dispatcher.on(event.test.before, test => {
+    suiteHookRunning = false;
+    global.testomatioDataStore.steps = [];
+
+    recorder.add(() => {
+      currentMetaStep = [];
+      // output.reset();
+      // output.start();
+      stepShift = 0;
+    });
+
+    if (!global.testomatioDataStore) global.testomatioDataStore = {};
+    // reset steps
+    global.testomatioDataStore.steps = [];
+
+    services.setContext(test.fullTitle());
+  });
+
+  event.dispatcher.on(event.test.started, test => {
+    services.setContext(test.fullTitle());
+
+    testTimeMap[test.id] = Date.now();
+    if (!test.uid) return;
+    testTimeMap[test.uid] = Date.now();
+  });
+
+  event.dispatcher.on(event.all.result, async () => {
+    debug('waiting for all tests to be reported');
+    // all tests were reported and we can upload videos
+    await Promise.all(reportTestPromises);
+
+    await uploadAttachments(client, videos, '🎞️ Uploading', 'video');
+    await uploadAttachments(client, traces, '📁 Uploading', 'trace');
+
+    const status = failedTests.length === 0 ? STATUS.PASSED : STATUS.FAILED;
+    // @ts-ignore
+    client.updateRunStatus(status);
+  });
+
+  event.dispatcher.on(event.test.passed, test => {
+    const { uid, tags, title } = test;
+    if (uid && failedTests.includes(uid)) {
+      failedTests = failedTests.filter(failed => uid !== failed);
+    }
+    const testObj = getTestAndMessage(title);
+
+    const logs = getTestLogs(test);
+    const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
+    const keyValues = services.keyValues.get(test.fullTitle());
+    services.setContext(null);
+
+    client.addTestRun(STATUS.PASSED, {
+      ...stripExampleFromTitle(title),
+      rid: uid,
+      suite_title: test.parent && test.parent.title,
+      message: testObj.message,
+      time: getDuration(test),
+      steps: global.testomatioDataStore.steps.join('\n') || null,
+      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
+      logs,
+      manuallyAttachedArtifacts,
+      meta: keyValues,
+    });
+    // output.stop();
+  });
+
+  event.dispatcher.on(event.test.failed, (test, err) => {
+    error = err;
+  });
+
+  event.dispatcher.on(event.hook.failed, (suite, err) => {
+    error = err;
+
+    if (!suite) return;
+    if (!suite.tests) return;
+    for (const test of suite.tests) {
+      const { uid, tags, title } = test;
+      failedTests.push(uid || title);
+      const testId = getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`);
+
+      client.addTestRun(STATUS.FAILED, {
+        rid: uid,
+        ...stripExampleFromTitle(title),
+        suite_title: suite.title,
+        test_id: testId,
+        error,
+        time: 0,
+      });
+    }
+    // output.stop();
+  });
+
+  event.dispatcher.on(event.test.after, test => {
+    if (test.state && test.state !== STATUS.FAILED) return;
+    if (test.err) error = test.err;
+    const { uid, tags, title, artifacts } = test;
+    failedTests.push(uid || title);
+    const testObj = getTestAndMessage(title);
+
+    const files = [];
+    if (artifacts.screenshot) files.push({ path: artifacts.screenshot, type: 'image/png' });
+    // todo: video must be uploaded later....
+
+    const logs = getTestLogs(test);
+    const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
+    const keyValues = services.keyValues.get(test.fullTitle());
+    services.setContext(null);
+
+    client.addTestRun(STATUS.FAILED, {
+      ...stripExampleFromTitle(title),
+      rid: uid,
+      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
+      suite_title: test.parent && test.parent.title,
+      error,
+      message: testObj.message,
+      time: getDuration(test),
+      files,
+      steps: global.testomatioDataStore?.steps?.join('\n') || null,
+      logs,
+      manuallyAttachedArtifacts,
+      meta: keyValues,
+    });
+
+    debug('artifacts', artifacts);
+
+    for (const aid in artifacts) {
+      if (aid.startsWith('video')) videos.push({ rid: uid, title, path: artifacts[aid], type: 'video/webm' });
+      if (aid.startsWith('trace')) traces.push({ rid: uid, title, path: artifacts[aid], type: 'application/zip' });
+    }
+
+    // output.stop();
+  });
+
+  event.dispatcher.on(event.test.skipped, test => {
+    const { uid, tags, title } = test;
+    if (failedTests.includes(uid || title)) return;
+
+    const testObj = getTestAndMessage(title);
+    client.addTestRun(STATUS.SKIPPED, {
+      rid: uid,
+      ...stripExampleFromTitle(title),
+      test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
+      suite_title: test.parent && test.parent.title,
+      message: testObj.message,
+      time: getDuration(test),
+    });
+    // output.stop();
+  });
+
+  event.dispatcher.on(event.step.started, step => {
+    stepShift = 0;
+    step.started = true;
+    stepStart = new Date();
+  });
+
+  event.dispatcher.on(event.step.finished, step => {
+    if (!step.started) return;
+    let processingStep = step;
+    const metaSteps = [];
+    while (processingStep.metaStep) {
+      metaSteps.unshift(processingStep.metaStep);
+      processingStep = processingStep.metaStep;
+    }
+    const shift = metaSteps.length;
+
+    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) + pc.bold(metaSteps[i].toString()) + metaSteps[i].comment);
+          global.testomatioDataStore?.steps?.push(
+            repeat(stepShift) + pc.bold(metaSteps[i].toString()) + metaSteps[i].comment,
+          );
+        } else {
+          // output.push(repeat(stepShift) + pc.green.bold(metaSteps[i].toString()));
+          global.testomatioDataStore?.steps?.push(repeat(stepShift) + pc.green(pc.bold(metaSteps[i].toString())));
+        }
+      }
+    }
+    currentMetaStep = metaSteps;
+    stepShift = 2 * shift;
+
+    const durationMs = +new Date() - +stepStart;
+    let duration = '';
+    if (durationMs) {
+      duration = repeat(1) + pc.gray(`(${durationMs}ms)`);
+    }
+
+    if (step.status === STATUS.FAILED) {
+      // output.push(repeat(stepShift) + pc.red(step.toString()) + duration);
+      global.testomatioDataStore?.steps?.push(repeat(stepShift) + pc.red(step.toString()) + duration);
+    } else {
+      // output.push(repeat(stepShift) + step.toString() + duration);
+      global.testomatioDataStore?.steps?.push(repeat(stepShift) + step.toString() + duration);
+    }
+  });
+
+  event.dispatcher.on(event.step.comment, step => {
+    // output.push(pc.cyan.bold(step.toString()));
+    global.testomatioDataStore?.steps?.push(pc.cyan(pc.bold(step.toString())));
+  });
+}
+
+async function uploadAttachments(client, attachments, messagePrefix, attachmentType) {
+  if (!attachments?.length) return;
+
+  if (client.uploader.isEnabled) {
+    console.log(APP_PREFIX, `Attachments: ${messagePrefix} ${attachments.length} ${attachmentType} ...`);
+  }
+
+  const promises = attachments.map(async attachment => {
+    const { rid, title, path, type } = attachment;
+    const file = { path, type, title };
+
+    // we are storing file if upload is disabled
+    if (!client.uploader.isEnabled) return client.uploader.storeUploadedFile(path, client.runId, rid, false);
+
+    return client.addTestRun(undefined, {
+      ...stripExampleFromTitle(title),
+      rid,
+      files: [file],
+    });
+  });
+
+  await Promise.all(promises);
+}
+
+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();
+
+  return { title, example };
+}
+
+function repeat(num) {
+  return ''.padStart(num, ' ');
+}
+
+// TODO: think about moving to some common utils
+function getTestLogs(test) {
+  const suiteLogsArr = services.logger.getLogs(test.parent.fullTitle());
+  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
+  const testLogsArr = services.logger.getLogs(test.fullTitle());
+  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
+
+  let logs = '';
+  if (suiteLogs) {
+    logs += `${pc.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
+  }
+  if (testLogs) {
+    logs += `\n${pc.bold('\t--- Test ---')}\n${testLogs}`;
+  }
+  return logs;
+}
+
+export { CodeceptReporter };
+export default CodeceptReporter;