@testomatio/reporter 2.19.0 → 2.21.0

package/lib/adapter/mocha.js

@@ -10,133 +10,137 @@ const utils_js_1 = require("../utils/utils.js");
 const config_js_1 = require("../config.js");
 const index_js_1 = require("../services/index.js");
 const picocolors_1 = __importDefault(require("picocolors"));
+global.TESTOMATIO_ADAPTER = 'mocha';
 const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_SUITE_BEGIN, EVENT_SUITE_END, EVENT_TEST_BEGIN, EVENT_TEST_END, } = mocha_1.default.Runner.constants;
-function MochaReporter(runner, opts) {
-    mocha_1.default.reporters.Base.call(this, runner);
-    let passes = 0;
-    let failures = 0;
-    let skipped = 0;
-    // let artifactStore;
-    const apiKey = opts?.reporterOptions?.apiKey || config_js_1.config.TESTOMATIO;
-    const client = new client_js_1.default({ apiKey });
-    // Track hook failures
-    const hookFailures = new Map();
-    runner.on(EVENT_RUN_BEGIN, () => {
-        client.createRun();
-        // clear dir with artifacts/logs
-        utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
-    });
-    runner.on(EVENT_SUITE_BEGIN, async (suite) => {
-        index_js_1.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 = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-                    const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
-                    const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
-                    const links = index_js_1.services.links.get(test.fullTitle());
-                    client.addTestRun(constants_js_1.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_1.default.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_js_1.config.TESTOMATIO;
+        const client = new client_js_1.default({ apiKey });
+        // Track hook failures
+        const hookFailures = new Map();
+        runner.on(EVENT_RUN_BEGIN, () => {
+            client.createRun();
+            // clear dir with artifacts/logs
+            utils_js_1.fileSystem.clearDir(constants_js_1.TESTOMAT_TMP_STORAGE_DIR);
+        });
+        runner.on(EVENT_SUITE_BEGIN, async (suite) => {
+            index_js_1.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 = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+                        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
+                        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
+                        const links = index_js_1.services.links.get(test.fullTitle());
+                        client.addTestRun(constants_js_1.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,
+                        });
+                    }
                 }
             }
-        }
-        index_js_1.services.setContext(null);
-    });
-    runner.on(EVENT_TEST_BEGIN, async (test) => {
-        index_js_1.services.setContext(test.fullTitle());
-    });
-    runner.on(EVENT_TEST_END, async () => {
-        index_js_1.services.setContext(null);
-    });
-    runner.on(EVENT_TEST_PASS, async (test) => {
-        passes += 1;
-        console.log(picocolors_1.default.bold(picocolors_1.default.green('✔')), test.fullTitle());
-        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        const logs = getTestLogs(test);
-        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
-        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
-        const links = index_js_1.services.links.get(test.fullTitle());
-        client.addTestRun(constants_js_1.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,
+            index_js_1.services.setContext(null);
+        });
+        runner.on(EVENT_TEST_BEGIN, async (test) => {
+            index_js_1.services.setContext(test.fullTitle());
+        });
+        runner.on(EVENT_TEST_END, async () => {
+            index_js_1.services.setContext(null);
+        });
+        runner.on(EVENT_TEST_PASS, async (test) => {
+            passes += 1;
+            console.log(picocolors_1.default.bold(picocolors_1.default.green('✔')), test.fullTitle());
+            const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+            const logs = getTestLogs(test);
+            const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
+            const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
+            const links = index_js_1.services.links.get(test.fullTitle());
+            client.addTestRun(constants_js_1.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_PENDING, test => {
-        skipped += 1;
-        console.log('skip: %s', test.fullTitle());
-        const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
-        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
-        const links = index_js_1.services.links.get(test.fullTitle());
-        client.addTestRun(constants_js_1.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_PENDING, test => {
+            skipped += 1;
+            console.log('skip: %s', test.fullTitle());
+            const testId = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+            const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
+            const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
+            const links = index_js_1.services.links.get(test.fullTitle());
+            client.addTestRun(constants_js_1.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(picocolors_1.default.bold(picocolors_1.default.red('✖')), test.fullTitle(), picocolors_1.default.gray(err.message));
-        const isHookFailure = test.title.includes('before each') || test.title.includes('after each');
-        if (isHookFailure && test.parent) {
-            hookFailures.set(test.parent.fullTitle(), {
+        runner.on(EVENT_TEST_FAIL, async (test, err) => {
+            failures += 1;
+            console.log(picocolors_1.default.bold(picocolors_1.default.red('✖')), test.fullTitle(), picocolors_1.default.gray(err.message));
+            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 = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
+            const logs = getTestLogs(test);
+            const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
+            const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
+            const links = index_js_1.services.links.get(test.fullTitle());
+            client.addTestRun(constants_js_1.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 = (0, utils_js_1.getTestomatIdFromTestTitle)(test.title);
-        const logs = getTestLogs(test);
-        const artifacts = index_js_1.services.artifacts.get(test.fullTitle());
-        const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
-        const links = index_js_1.services.links.get(test.fullTitle());
-        client.addTestRun(constants_js_1.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 ? constants_js_1.STATUS.PASSED : constants_js_1.STATUS.FAILED;
-        console.log(picocolors_1.default.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
-        // @ts-ignore
-        client.updateRunStatus(status);
-    });
+        runner.on(EVENT_RUN_END, () => {
+            const status = failures === 0 ? constants_js_1.STATUS.PASSED : constants_js_1.STATUS.FAILED;
+            console.log(picocolors_1.default.bold(status), `${passes} passed, ${failures} failed, ${skipped} skipped`);
+            // @ts-ignore
+            client.updateRunStatus(status);
+        });
+    }
 }
 function getTestLogs(test) {
     const suiteLogsArr = index_js_1.services.logger.getLogs(test.parent.fullTitle());
@@ -166,7 +170,4 @@ function getTestName(test) {
         return test.fullTitle();
     return test.title;
 }
-// To have this reporter "extend" a built-in reporter uncomment the following line:
-// @ts-ignore
-mocha_1.default.utils.inherits(MochaReporter, mocha_1.default.reporters.Spec);
 module.exports = MochaReporter;

package/lib/adapter/nightwatch.js

@@ -7,6 +7,7 @@ const client_js_1 = __importDefault(require("../client.js"));
 const config_js_1 = require("../config.js");
 const constants_js_1 = require("../constants.js");
 const utils_js_1 = require("../utils/utils.js");
+global.TESTOMATIO_ADAPTER = 'nightwatch';
 const apiKey = config_js_1.config.TESTOMATIO;
 const client = new client_js_1.default({ apiKey });
 module.exports = {

package/lib/adapter/playwright.js

@@ -21,6 +21,7 @@ const playwright_js_1 = require("./utils/playwright.js");
 Object.defineProperty(exports, "fetchLinksFromLogs", { enumerable: true, get: function () { return playwright_js_1.fetchLinksFromLogs; } });
 const step_formatter_js_1 = require("./utils/step-formatter.js");
 const log_js_1 = require("../utils/log.js");
+global.TESTOMATIO_ADAPTER = 'playwright';
 class PlaywrightReporter {
     constructor(config = {}) {
         this.client = new client_js_1.default({ apiKey: config?.apiKey });
@@ -103,7 +104,11 @@ class PlaywrightReporter {
             if (result.status === 'passed')
                 status = 'failed';
         }
-        const reportTestPromise = this.client.addTestRun(checkStatus(status), {
+        const testStatus = checkStatus(status);
+        let failedUrl;
+        if (testStatus === constants_js_1.STATUS.FAILED)
+            failedUrl = lastNavigatedUrl(result.steps, test.parent.project().use.baseURL);
+        const reportTestPromise = this.client.addTestRun(testStatus, {
             rid: `${rid}-${project.name}`,
             error,
             test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(`${title} ${tags.join(' ')}`),
@@ -121,6 +126,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
@@ -221,6 +227,32 @@ function processArtifactsForUpload(attachments) {
 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)

package/lib/adapter/vitest.js

@@ -10,6 +10,7 @@ const constants_js_1 = require("../constants.js");
 const utils_js_1 = require("../utils/utils.js");
 const debug_1 = __importDefault(require("debug"));
 const debug = (0, debug_1.default)('@testomatio/reporter:adapter-jest');
+global.TESTOMATIO_ADAPTER = 'vitest';
 /**
  * @typedef {import('../../types/types.js').VitestTest} VitestTest
  * @typedef {import('../../types/types.js').VitestTestFile} VitestTestFile
@@ -393,7 +394,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 || {}),
+            },
         };
     }
     return {

package/lib/adapter/webdriver.js

@@ -42,6 +42,9 @@ const utils_js_1 = require("../utils/utils.js");
 const index_js_1 = require("../services/index.js");
 const constants_js_1 = require("../constants.js");
 const data_storage_js_1 = require("../data-storage.js");
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('@testomatio/reporter:adapter:webdriver');
+global.TESTOMATIO_ADAPTER = 'webdriverio';
 class WebdriverReporter extends reporter_1.default {
     constructor(options) {
         super(options);
@@ -129,13 +132,19 @@ class WebdriverReporter extends reporter_1.default {
     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 = (0, utils_js_1.getTestomatIdFromTestTitle)(title);
         const screenshotEndpoint = '/session/:sessionId/screenshot';
         const screenshotsBuffers = output
             .filter(el => el.endpoint === screenshotEndpoint && el.result && el.result.value)
             .map(el => Buffer.from(el.result.value, 'base64'));
         const rid = (0, data_storage_js_1.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,
@@ -152,7 +161,7 @@ class WebdriverReporter extends reporter_1.default {
     /**
      * @param {import('../../types/types.js').WebdriverIOScenario} scenario
      */
-    addBddScenario(scenario) {
+    async addBddScenario(scenario) {
         if (!this.client)
             return;
         const { title, _duration: duration } = scenario;
@@ -167,6 +176,12 @@ class WebdriverReporter extends reporter_1.default {
             .filter(Boolean);
         const error = errors.join('\n');
         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,10 +189,38 @@ class WebdriverReporter extends reporter_1.default {
             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/lib/allureReader.d.ts

@@ -35,7 +35,10 @@ declare class AllureReader {
         steps: any;
         message: any;
         stack: any;
-        meta: {};
+        meta: {
+            reporterVersion: any;
+            adapter: string;
+        };
         links: {
             label: string;
         }[];

package/lib/allureReader.js

@@ -163,7 +163,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,