@testomatio/reporter 2.19.0 → 2.21.0

package/src/adapter/mocha.js

@@ -6,6 +6,8 @@ import { config } from '../config.js';
 import { services } from '../services/index.js';
 import pc from 'picocolors';
 
+global.TESTOMATIO_ADAPTER = 'mocha';
+
 const {
   EVENT_RUN_BEGIN,
   EVENT_RUN_END,
@@ -18,157 +20,160 @@ const {
   EVENT_TEST_END,
 } = Mocha.Runner.constants;
 
-function MochaReporter(runner, opts) {
-  Mocha.reporters.Base.call(this, runner);
-  let passes = 0;
-  let failures = 0;
-  let skipped = 0;
-  // let artifactStore;
-
-  const apiKey = opts?.reporterOptions?.apiKey || config.TESTOMATIO;
-
-  const client = new TestomatClient({ apiKey });
-
-  // Track hook failures
-  const hookFailures = new Map();
-
-  runner.on(EVENT_RUN_BEGIN, () => {
-    client.createRun();
-
-    // clear dir with artifacts/logs
-    fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
-  });
-
-  runner.on(EVENT_SUITE_BEGIN, async suite => {
-    services.setContext(suite.fullTitle());
-  });
-
-  runner.on(EVENT_SUITE_END, async suite => {
-    if (hookFailures.has(suite.fullTitle())) {
-      const { error, suiteTitle } = hookFailures.get(suite.fullTitle());
-
-      for (const test of suite.tests) {
-        if (test.state === 'pending' || !test.state) {
-          const testId = getTestomatIdFromTestTitle(test.title);
-          const artifacts = services.artifacts.get(test.fullTitle());
-          const keyValues = services.keyValues.get(test.fullTitle());
-          const links = services.links.get(test.fullTitle());
-
-          client.addTestRun(STATUS.FAILED, {
-            error,
-            suite_title: suiteTitle || suite.title,
-            file: suite.file,
-            test_id: testId,
-            title: test.title,
-            code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
-            time: 0,
-            manuallyAttachedArtifacts: artifacts,
-            meta: keyValues,
-            links,
-          });
+// ES class so it works with mocha 12, where Base is a class and utils.inherits is gone
+class MochaReporter extends Mocha.reporters.Base {
+  constructor(runner, opts) {
+    super(runner, opts);
+    let passes = 0;
+    let failures = 0;
+    let skipped = 0;
+    // let artifactStore;
+
+    const apiKey = opts?.reporterOptions?.apiKey || config.TESTOMATIO;
+
+    const client = new TestomatClient({ apiKey });
+
+    // Track hook failures
+    const hookFailures = new Map();
+
+    runner.on(EVENT_RUN_BEGIN, () => {
+      client.createRun();
+
+      // clear dir with artifacts/logs
+      fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
+    });
+
+    runner.on(EVENT_SUITE_BEGIN, async suite => {
+      services.setContext(suite.fullTitle());
+    });
+
+    runner.on(EVENT_SUITE_END, async suite => {
+      if (hookFailures.has(suite.fullTitle())) {
+        const { error, suiteTitle } = hookFailures.get(suite.fullTitle());
+
+        for (const test of suite.tests) {
+          if (test.state === 'pending' || !test.state) {
+            const testId = getTestomatIdFromTestTitle(test.title);
+            const artifacts = services.artifacts.get(test.fullTitle());
+            const keyValues = services.keyValues.get(test.fullTitle());
+            const links = services.links.get(test.fullTitle());
+
+            client.addTestRun(STATUS.FAILED, {
+              error,
+              suite_title: suiteTitle || suite.title,
+              file: suite.file,
+              test_id: testId,
+              title: test.title,
+              code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
+              time: 0,
+              manuallyAttachedArtifacts: artifacts,
+              meta: keyValues,
+              links,
+            });
+          }
         }
       }
-    }
-
-    services.setContext(null);
-  });
-
-  runner.on(EVENT_TEST_BEGIN, async test => {
-    services.setContext(test.fullTitle());
-  });
-
-  runner.on(EVENT_TEST_END, async () => {
-    services.setContext(null);
-  });
-
-  runner.on(EVENT_TEST_PASS, async test => {
-    passes += 1;
-
-    console.log(pc.bold(pc.green('✔')), test.fullTitle());
-    const testId = getTestomatIdFromTestTitle(test.title);
-
-    const logs = getTestLogs(test);
-    const artifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-    const links = services.links.get(test.fullTitle());
-
-    client.addTestRun(STATUS.PASSED, {
-      test_id: testId,
-      suite_title: getSuiteTitle(test),
-      title: getTestName(test),
-      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
-      file: getFile(test),
-      time: test.duration,
-      logs,
-      manuallyAttachedArtifacts: artifacts,
-      meta: keyValues,
-      links,
+
+      services.setContext(null);
+    });
+
+    runner.on(EVENT_TEST_BEGIN, async test => {
+      services.setContext(test.fullTitle());
+    });
+
+    runner.on(EVENT_TEST_END, async () => {
+      services.setContext(null);
     });
-  });
-
-  runner.on(EVENT_TEST_PENDING, test => {
-    skipped += 1;
-    console.log('skip: %s', test.fullTitle());
-    const testId = getTestomatIdFromTestTitle(test.title);
-    const artifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-    const links = services.links.get(test.fullTitle());
-
-    client.addTestRun(STATUS.SKIPPED, {
-      title: getTestName(test),
-      suite_title: getSuiteTitle(test),
-      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
-      file: getFile(test),
-      test_id: testId,
-      time: test.duration,
-      manuallyAttachedArtifacts: artifacts,
-      meta: keyValues,
-      links,
+
+    runner.on(EVENT_TEST_PASS, async test => {
+      passes += 1;
+
+      console.log(pc.bold(pc.green('✔')), test.fullTitle());
+      const testId = getTestomatIdFromTestTitle(test.title);
+
+      const logs = getTestLogs(test);
+      const artifacts = services.artifacts.get(test.fullTitle());
+      const keyValues = services.keyValues.get(test.fullTitle());
+      const links = services.links.get(test.fullTitle());
+
+      client.addTestRun(STATUS.PASSED, {
+        test_id: testId,
+        suite_title: getSuiteTitle(test),
+        title: getTestName(test),
+        code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
+        file: getFile(test),
+        time: test.duration,
+        logs,
+        manuallyAttachedArtifacts: artifacts,
+        meta: keyValues,
+        links,
+      });
     });
-  });
 
-  runner.on(EVENT_TEST_FAIL, async (test, err) => {
-    failures += 1;
-    console.log(pc.bold(pc.red('✖')), test.fullTitle(), pc.gray(err.message));
+    runner.on(EVENT_TEST_PENDING, test => {
+      skipped += 1;
+      console.log('skip: %s', test.fullTitle());
+      const testId = getTestomatIdFromTestTitle(test.title);
+      const artifacts = services.artifacts.get(test.fullTitle());
+      const keyValues = services.keyValues.get(test.fullTitle());
+      const links = services.links.get(test.fullTitle());
+
+      client.addTestRun(STATUS.SKIPPED, {
+        title: getTestName(test),
+        suite_title: getSuiteTitle(test),
+        code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
+        file: getFile(test),
+        test_id: testId,
+        time: test.duration,
+        manuallyAttachedArtifacts: artifacts,
+        meta: keyValues,
+        links,
+      });
+    });
+
+    runner.on(EVENT_TEST_FAIL, async (test, err) => {
+      failures += 1;
+      console.log(pc.bold(pc.red('✖')), test.fullTitle(), pc.gray(err.message));
+
+      const isHookFailure = test.title.includes('before each') || test.title.includes('after each');
 
-    const isHookFailure = test.title.includes('before each') || test.title.includes('after each');
+      if (isHookFailure && test.parent) {
+        hookFailures.set(test.parent.fullTitle(), {
+          error: err,
+          suiteTitle: getSuiteTitle(test),
+        });
+        return;
+      }
+
+      const testId = getTestomatIdFromTestTitle(test.title);
 
-    if (isHookFailure && test.parent) {
-      hookFailures.set(test.parent.fullTitle(), {
+      const logs = getTestLogs(test);
+      const artifacts = services.artifacts.get(test.fullTitle());
+      const keyValues = services.keyValues.get(test.fullTitle());
+      const links = services.links.get(test.fullTitle());
+
+      client.addTestRun(STATUS.FAILED, {
         error: err,
-        suiteTitle: getSuiteTitle(test),
+        suite_title: getSuiteTitle(test),
+        file: getFile(test),
+        test_id: testId,
+        title: getTestName(test),
+        code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
+        time: test.duration,
+        logs,
+        manuallyAttachedArtifacts: artifacts,
+        meta: keyValues,
+        links,
       });
-      return;
-    }
-
-    const testId = getTestomatIdFromTestTitle(test.title);
-
-    const logs = getTestLogs(test);
-    const artifacts = services.artifacts.get(test.fullTitle());
-    const keyValues = services.keyValues.get(test.fullTitle());
-    const links = services.links.get(test.fullTitle());
-
-    client.addTestRun(STATUS.FAILED, {
-      error: err,
-      suite_title: getSuiteTitle(test),
-      file: getFile(test),
-      test_id: testId,
-      title: getTestName(test),
-      code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
-      time: test.duration,
-      logs,
-      manuallyAttachedArtifacts: artifacts,
-      meta: keyValues,
-      links,
     });
-  });
-
-  runner.on(EVENT_RUN_END, () => {
-    const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
-    console.log(pc.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
-    // @ts-ignore
-    client.updateRunStatus(status);
-  });
+
+    runner.on(EVENT_RUN_END, () => {
+      const status = failures === 0 ? STATUS.PASSED : STATUS.FAILED;
+      console.log(pc.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
+      // @ts-ignore
+      client.updateRunStatus(status);
+    });
+  }
 }
 
 function getTestLogs(test) {
@@ -204,8 +209,4 @@ function getTestName(test) {
   return test.title;
 }
 
-// To have this reporter "extend" a built-in reporter uncomment the following line:
-// @ts-ignore
-Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);
-
 export default MochaReporter;

package/src/adapter/nightwatch.js

@@ -3,6 +3,8 @@ import { config } from '../config.js';
 import { STATUS } from '../constants.js';
 import { getTestomatIdFromTestTitle } from '../utils/utils.js';
 
+global.TESTOMATIO_ADAPTER = 'nightwatch';
+
 const apiKey = config.TESTOMATIO;
 const client = new TestomatClient({ apiKey });
 

package/src/adapter/playwright.js

@@ -14,6 +14,8 @@ import { fetchLinksFromLogs } from './utils/playwright.js';
 import { formatStep, addStatusToStep, addArtifactsToStep } from './utils/step-formatter.js';
 import { log } from '../utils/log.js';
 
+global.TESTOMATIO_ADAPTER = 'playwright';
+
 class PlaywrightReporter {
   constructor(config = {}) {
     this.client = new TestomatioClient({ apiKey: config?.apiKey });
@@ -108,7 +110,11 @@ class PlaywrightReporter {
       if (result.status === 'passed') status = 'failed';
     }
 
-    const reportTestPromise = this.client.addTestRun(checkStatus(status), {
+    const testStatus = checkStatus(status);
+    let failedUrl;
+    if (testStatus === Status.FAILED) failedUrl = lastNavigatedUrl(result.steps, test.parent.project().use.baseURL);
+
+    const reportTestPromise = this.client.addTestRun(testStatus, {
       rid: `${rid}-${project.name}`,
       error,
       test_id: getTestomatIdFromTestTitle(`${title} ${tags.join(' ')}`),
@@ -126,6 +132,7 @@ class PlaywrightReporter {
         isMobile: project.isMobile,
         project: project.name,
         projectDependencies: project.dependencies?.length ? project.dependencies : null,
+        failedUrl,
         ...testMeta,
         ...meta,
         ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
@@ -242,6 +249,31 @@ function isScreenshotArtifact(attachment) {
   return attachment?.contentType === 'image/png' && attachment?.name === 'screenshot';
 }
 
+/**
+ * Last url the test navigated to; the reporter has no access to the page itself.
+ * @returns {string|undefined}
+ */
+function lastNavigatedUrl(steps, baseURL) {
+  const url = findLastNavigation(steps);
+  if (!url) return;
+  try {
+    return new URL(url, baseURL).href;
+  } catch {
+    return url;
+  }
+}
+
+function findLastNavigation(steps = []) {
+  let url;
+  for (const step of steps) {
+    // 'Navigate to "url"' since Playwright 1.53, 'page.goto(url)' before
+    const match = step.title.match(/^Navigate to "(.+)"$/) || step.title.match(/^page\.goto\((.+)\)$/);
+    if (step.category === 'pw:api' && match) url = match[1];
+    url = findLastNavigation(step.steps) || url;
+  }
+  return url;
+}
+
 function appendStep(step, shift = 0) {
   // nesting too deep, ignore those steps
   if (shift >= 10) return;

package/src/adapter/vitest.js

@@ -6,6 +6,8 @@ import createDebugMessages from 'debug';
 
 const debug = createDebugMessages('@testomatio/reporter:adapter-jest');
 
+global.TESTOMATIO_ADAPTER = 'vitest';
+
 /**
  * @typedef {import('../../types/types.js').VitestTest} VitestTest
  * @typedef {import('../../types/types.js').VitestTestFile} VitestTestFile
@@ -396,7 +398,10 @@ function normalizeVitestTest(test) {
       file,
       suiteTitle,
       logs: '',
-      meta: typeof test.meta === 'function' ? test.meta() : {},
+      meta: {
+        ...(test.task?.meta || {}),
+        ...(typeof test.meta === 'function' ? test.meta() : test.meta || {}),
+      },
     };
   }
 

package/src/adapter/webdriver.js

@@ -4,6 +4,11 @@ import { getTestomatIdFromTestTitle, fileSystem } from '../utils/utils.js';
 import { services } from '../services/index.js';
 import { TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
 import { stringToMD5Hash } from '../data-storage.js';
+import createDebugMessages from 'debug';
+
+const debug = createDebugMessages('@testomatio/reporter:adapter:webdriver');
+
+global.TESTOMATIO_ADAPTER = 'webdriverio';
 
 class WebdriverReporter extends WDIOReporter {
   constructor(options) {
@@ -120,7 +125,8 @@ class WebdriverReporter extends WDIOReporter {
   async addTest(test) {
     if (!this.client) return;
 
-    const { title, _duration: duration, state, error, output, links, artifacts, meta, logs } = test;
+    const { title, _duration: duration, state, error, output, links, artifacts, logs } = test;
+    let { meta } = test;
 
     const testId = getTestomatIdFromTestTitle(title);
 
@@ -131,6 +137,11 @@ class WebdriverReporter extends WDIOReporter {
 
     const rid = stringToMD5Hash(test.fullTitle);
 
+    if (state === 'failed') {
+      const failedUrl = (await grabCurrentUrl()) || lastNavigatedUrl(output);
+      if (failedUrl) meta = { ...meta, failedUrl };
+    }
+
     await this.client.addTestRun(state, {
       rid,
       manuallyAttachedArtifacts: test.artifacts,
@@ -148,7 +159,7 @@ class WebdriverReporter extends WDIOReporter {
   /**
    * @param {import('../../types/types.js').WebdriverIOScenario} scenario
    */
-  addBddScenario(scenario) {
+  async addBddScenario(scenario) {
     if (!this.client) return;
 
     const { title, _duration: duration } = scenario;
@@ -167,6 +178,12 @@ class WebdriverReporter extends WDIOReporter {
 
     const tags = scenario.tags.map(tag => tag.name);
 
+    let meta;
+    if (scenarioState === 'failed') {
+      const failedUrl = await grabCurrentUrl();
+      if (failedUrl) meta = { failedUrl };
+    }
+
     return this.client.addTestRun(scenarioState, {
       error: error ? Error(error) : null,
       title,
@@ -174,11 +191,38 @@ class WebdriverReporter extends WDIOReporter {
       time: duration,
       tags,
       file: scenario.file,
+      meta,
       // filesBuffers: screenshotsBuffers,
     });
   }
 }
 
+/**
+ * Current url of the browser in this worker; reporters run in the worker process.
+ * @returns {Promise<string|undefined>}
+ */
+async function grabCurrentUrl() {
+  // @ts-ignore
+  const browser = globalThis.browser;
+  if (typeof browser?.getUrl !== 'function') return;
+  try {
+    const url = await browser.getUrl();
+    // multiremote returns a url per browser
+    if (typeof url === 'string') return url;
+  } catch (err) {
+    debug('Failed to grab url of failed test', err?.message || err);
+  }
+}
+
+/**
+ * Last url opened by the test, taken from its command log.
+ * @returns {string|undefined}
+ */
+function lastNavigatedUrl(output = []) {
+  const navigations = output.filter(el => el.endpoint === '/session/:sessionId/url' && el.body?.url);
+  return navigations.at(-1)?.body.url;
+}
+
 /**
  *
  * @param {*} fullTestTitle

package/src/allureReader.js

@@ -186,7 +186,8 @@ class AllureReader {
       steps: this.convertSteps(result.steps || [], resultsDir),
       message: result.statusDetails?.message || '',
       stack: result.statusDetails?.trace || '',
-      meta: this.extractMeta(result),
+      // meta must always include reporter version and adapter used
+      meta: { ...this.extractMeta(result), reporterVersion: this.version, adapter: 'allure' },
       links: this.extractLinks(result),
       artifacts: [],
       create: true,