@testomatio/reporter 2.6.0 → 2.6.1

package/README.md

@@ -13,7 +13,7 @@ Testomat.io Reporter (this npm package) supports:
 - 🔎 [Stack traces](./docs/stacktrace.md) and error messages
 - 🐙 [GitHub](./docs/pipes/github.md), [GitLab](./docs/pipes/gitlab.md) & [Bitbucket](./docs/pipes/bitbucket.md) integration
 - 🚅 Realtime reports
-- 🗃️ Other test frameworks supported via [JUnit XML](./docs/junit.md) with [XML import configuration](./docs/xml-imports.md)
+- 🗃️ Other test frameworks supported via [JUnit XML](./docs/junit.md)
 - 🚶‍♀️ Steps _(work in progress)_
 - 📄 [Logger](./docs/logger.md) _(work in progress, supports Jest for now)_
 - ☁️ Custom properties and metadata _(work in progress)_
@@ -63,11 +63,11 @@ yarn add @testomatio/reporter --dev
 ### 1️⃣ Attach Reporter to the Test Runner
 
 |                                                 |                                               |                                                           |
-| ----------------------------------------------- | --------------------------------------------- | --------------------------------------------------------- |
-| [Playwright](./docs/frameworks.md#playwright)   | [CodeceptJS](./docs/frameworks.md#CodeceptJS) | [Cypress](./docs/frameworks.md#Cypress)                   |
-| [Jest](./docs/frameworks.md#Jest)               | [Mocha](./docs/frameworks.md#Mocha)           | [WebDriverIO](./docs/frameworks.md#WebDriverIO)           |
-| [TestCafe](./docs/frameworks.md#TestCafe)       | [Detox](./docs/frameworks.md#Detox)           | [Codeception](https://github.com/testomatio/php-reporter) |
-| [Newman (Postman)](./docs/frameworks.md#Newman) | [JUnit](./docs/junit.md#junit)                | [NUnit](./docs/junit.md#nunit)                            |
+|-------------------------------------------------|-----------------------------------------------|-----------------------------------------------------------|
+| [Playwright](./docs/frameworks.md#playwright)   | [CodeceptJS](./docs/frameworks.md#codeceptjs) | [Cypress](./docs/frameworks.md#cypress)                   |
+| [Jest](./docs/frameworks.md#jest)               | [Mocha](./docs/frameworks.md#mocha)           | [WebDriverIO](./docs/frameworks.md#webdriverIO)           |
+| [TestCafe](./docs/frameworks.md#testcafe)       | [Detox](./docs/frameworks.md#detox)           | [Codeception](https://github.com/testomatio/php-reporter) |
+| [Newman (Postman)](./docs/frameworks.md#newman) | [JUnit](./docs/junit.md#junit)                | [NUnit](./docs/junit.md#nunit)                            |
 | [PyTest](./docs/junit.md#pytest)                | [PHPUnit](./docs/junit.md#phpunit)            | [Protractor](./docs/frameworks.md#protractor)             |
 
 or **any [other via JUnit](./docs/junit.md)** report....
@@ -103,7 +103,7 @@ With our reporter, you can:
 * Visualize data on successful and failed tests, including statistics and error details.
 * Quickly share reports with your team members or stakeholders.
 
-![HTML report](./docs/images/html_reporter_example.gif)
+![HTML report](./docs/images/html-reporter-example.gif)
 
 Learn more about generating HTML reports [here](./docs/pipes/html.md)
 

package/lib/adapter/playwright.d.ts

@@ -18,16 +18,6 @@ declare class PlaywrightReporter {
  * @returns {string[]} - array of normalized tags with @ prefix
  */
 export function extractTags(test: any): string[];
-/**
- * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
- *
- * @param {(string | Buffer)[]} stdout
- * @returns {{ links: { [key: 'test' | 'jira']: string }[], stdout: (string | Buffer)[] }}
- */
-export function fetchLinksFromLogs(stdout: (string | Buffer)[]): {
-    links: {
-        [key: "test" | "jira"]: string;
-    }[];
-    stdout: (string | Buffer)[];
-};
+import { fetchLinksFromLogs } from './utils/playwright.js';
 import TestomatioClient from '../client.js';
+export { fetchLinksFromLogs };

package/lib/adapter/playwright.js

@@ -3,9 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchLinksFromLogs = void 0;
 exports.extractTags = extractTags;
-exports.fetchLinksFromLogs = fetchLinksFromLogs;
-const debug_1 = __importDefault(require("debug"));
 const crypto_1 = __importDefault(require("crypto"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
@@ -18,8 +17,9 @@ const index_js_1 = require("../services/index.js");
 const data_storage_js_1 = require("../data-storage.js");
 const constants_js_2 = require("../utils/constants.js");
 const picocolors_1 = __importDefault(require("picocolors"));
+const playwright_js_1 = require("./utils/playwright.js");
+Object.defineProperty(exports, "fetchLinksFromLogs", { enumerable: true, get: function () { return playwright_js_1.fetchLinksFromLogs; } });
 const reportTestPromises = [];
-const debug = (0, debug_1.default)('@testomatio/reporter:adapter-playwright');
 class PlaywrightReporter {
     constructor(config = {}) {
         this.client = new client_js_1.default({ apiKey: config?.apiKey });
@@ -44,6 +44,14 @@ class PlaywrightReporter {
             return;
         const { title } = test;
         const { error, duration } = result;
+        const pwAttachments = (result.attachments || []).filter(a => a.body || a.path);
+        const files = pwAttachments
+            .map(att => ({
+            path: this.#getArtifactPath(att),
+            title: att.name || title,
+            type: att.contentType,
+        }))
+            .filter(f => f.path);
         const suite_title = test.parent ? test.parent?.title : path_1.default.basename(test?.location?.file);
         const steps = [];
         for (const step of result.steps) {
@@ -57,7 +65,7 @@ class PlaywrightReporter {
         const fullTestTitle = getTestContextName(test);
         let logs = '';
         // get links along with filtered logs (liks related logs removed)
-        const { stdout: filteredStdout, links } = fetchLinksFromLogs(result.stdout);
+        const { stdout: filteredStdout, links, meta } = (0, playwright_js_1.fetchLinksFromLogs)(result.stdout);
         if (filteredStdout?.length || result.stderr?.length) {
             logs = `\n\n${picocolors_1.default.bold('Logs:')}\n${picocolors_1.default.red(result.stderr.join(''))}\n${filteredStdout.join('')}`;
         }
@@ -112,12 +120,14 @@ class PlaywrightReporter {
             logs,
             links,
             manuallyAttachedArtifacts,
+            files: files.length ? files : undefined,
             meta: {
                 browser: project.browser,
                 isMobile: project.isMobile,
                 project: project.name,
                 projectDependencies: project.dependencies?.length ? project.dependencies : null,
                 ...testMeta,
+                ...meta,
                 ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
                 ...test.annotations?.reduce((acc, annotation) => {
                     acc[annotation.type] = annotation.description;
@@ -129,7 +139,7 @@ class PlaywrightReporter {
         this.uploads.push({
             rid: `${rid}-${project.name}`,
             title: test.title,
-            files: result.attachments.filter(a => a.body || a.path),
+            files: pwAttachments,
             file: test.location?.file,
         });
         // remove empty uploads
@@ -273,73 +283,6 @@ function extractTags(test) {
 function getTestContextName(test) {
     return `${test._requireFile || ''}_${test.title}`;
 }
-/**
- * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
- *
- * @param {(string | Buffer)[]} stdout
- * @returns {{ links: { [key: 'test' | 'jira']: string }[], stdout: (string | Buffer)[] }}
- */
-function fetchLinksFromLogs(stdout) {
-    const links = [];
-    const markers = [
-        { key: '[TESTOMATIO-LINK-TESTS]', type: 'test' },
-        { key: '[TESTOMATIO-LINK-JIRA]', type: 'jira' },
-    ];
-    const filteredStdout = [];
-    stdout.forEach(entry => {
-        if (typeof entry !== 'string') {
-            filteredStdout.push(entry);
-            return;
-        }
-        // check if entry contains any of markers
-        if (!markers.some(m => entry.includes(m.key))) {
-            filteredStdout.push(entry);
-            return;
-        }
-        const newEntryLines = [];
-        entry.split('\n').forEach(line => {
-            line = line.trim();
-            let hasMarker = false;
-            for (const marker of markers) {
-                if (line.includes(marker.key)) {
-                    hasMarker = true;
-                    try {
-                        const rawJson = line.split(marker.key)[1]?.trim();
-                        if (!rawJson)
-                            continue;
-                        // smart JSON extraction: take until the last ']', otherwise take the whole string
-                        const lastBracketIndex = rawJson.lastIndexOf(']');
-                        const jsonStr = lastBracketIndex !== -1 ? rawJson.substring(0, lastBracketIndex + 1) : rawJson;
-                        // test ids or jira ids
-                        const ids = JSON.parse(jsonStr);
-                        links.push(...ids
-                            // filter non-truthy ids
-                            .filter(id => !!id)
-                            .map(id => ({
-                            // marker type is either 'test' or 'jira'
-                            [marker.type]: id,
-                        })));
-                    }
-                    catch (e) {
-                        debug('Error parsing links from string:', line, '\n', e);
-                    }
-                }
-            }
-            if (!hasMarker && line) {
-                newEntryLines.push(line);
-            }
-        });
-        if (newEntryLines.length) {
-            filteredStdout.push(newEntryLines.join('\n'));
-        }
-    });
-    return {
-        stdout: filteredStdout,
-        links,
-    };
-}
 module.exports = PlaywrightReporter;
 
 module.exports.extractTags = extractTags;
-
-module.exports.fetchLinksFromLogs = fetchLinksFromLogs;

package/lib/adapter/utils/playwright.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{
+ *   links: { [key: 'test' | 'jira' | 'label']: string }[],
+ *   meta: { [key: string]: any },
+ *   stdout: (string | Buffer)[]
+ * }}
+ */
+export function fetchLinksFromLogs(stdout: (string | Buffer)[]): {
+    links: {
+        [key: "test" | "jira" | "label"]: string;
+    }[];
+    meta: {
+        [key: string]: any;
+    };
+    stdout: (string | Buffer)[];
+};
+export namespace playwrightLogsMarkers {
+    let label: string;
+    let meta: string;
+    let linkTest: string;
+    let linkJira: string;
+}

package/lib/adapter/utils/playwright.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playwrightLogsMarkers = void 0;
+exports.fetchLinksFromLogs = fetchLinksFromLogs;
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('@testomatio/reporter:adapter-playwright-utils');
+exports.playwrightLogsMarkers = {
+    label: '[TESTOMATIO-LABEL]',
+    meta: '[TESTOMATIO-META]',
+    linkTest: '[TESTOMATIO-LINK-TEST]',
+    linkJira: '[TESTOMATIO-LINK-JIRA]',
+};
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{
+ *   links: { [key: 'test' | 'jira' | 'label']: string }[],
+ *   meta: { [key: string]: any },
+ *   stdout: (string | Buffer)[]
+ * }}
+ */
+function fetchLinksFromLogs(stdout) {
+    const links = [];
+    const meta = {};
+    const markers = [
+        { key: exports.playwrightLogsMarkers.linkTest, type: 'test' },
+        { key: exports.playwrightLogsMarkers.linkJira, type: 'jira' },
+        { key: exports.playwrightLogsMarkers.label, type: 'label' },
+        { key: exports.playwrightLogsMarkers.meta, type: 'meta' },
+    ];
+    const filteredStdout = [];
+    stdout.forEach(entry => {
+        if (typeof entry !== 'string') {
+            filteredStdout.push(entry);
+            return;
+        }
+        // check if entry contains any of markers
+        if (!markers.some(m => entry.includes(m.key))) {
+            filteredStdout.push(entry);
+            return;
+        }
+        const newEntryLines = [];
+        entry.split('\n').forEach(line => {
+            line = line.trim();
+            let hasMarker = false;
+            for (const marker of markers) {
+                // links (test/jira/label) stored as array of objects
+                if (line.includes(marker.key)) {
+                    hasMarker = true;
+                    try {
+                        const rawData = line.split(marker.key)[1]?.trim();
+                        if (!rawData)
+                            continue;
+                        let data;
+                        try {
+                            data = JSON.parse(rawData);
+                        }
+                        catch (e) {
+                            // Try to extract JSON from the beginning of the string (to handle trailing text)
+                            const jsonMatch = rawData.match(/^\s*(\[.*?\]|\{.*?\})/);
+                            if (jsonMatch) {
+                                try {
+                                    data = JSON.parse(jsonMatch[1]);
+                                }
+                                catch (jsonError) {
+                                    // If JSON extraction fails, skip this entry
+                                    debug('Error parsing links from string:', line, '\n', jsonError);
+                                    continue;
+                                }
+                            }
+                            else {
+                                // No JSON found, skip this entry
+                                debug('No valid JSON found in:', line);
+                                continue;
+                            }
+                        }
+                        if (marker.type === 'meta') {
+                            // meta stored as an object, thus make it similar to links
+                            Object.assign(meta, data);
+                        }
+                        else {
+                            const ids = Array.isArray(data) ? data : [data];
+                            links.push(...ids
+                                // filter non-truthy ids
+                                .filter(id => !!id)
+                                .map(id => {
+                                // If id is already an object with the marker type key, return it as is
+                                if (typeof id === 'object' && id !== null && marker.type in id) {
+                                    return id;
+                                }
+                                // Otherwise, wrap it with the marker type key
+                                return {
+                                    // marker type is either 'test' or 'jira' or 'label'
+                                    [marker.type]: id,
+                                };
+                            }));
+                        }
+                    }
+                    catch (e) {
+                        debug('Error parsing links from string:', line, '\n', e);
+                    }
+                }
+            }
+            if (!hasMarker && line) {
+                newEntryLines.push(line);
+            }
+        });
+        if (newEntryLines.length) {
+            filteredStdout.push(newEntryLines.join('\n'));
+        }
+    });
+    return {
+        stdout: filteredStdout,
+        links,
+        meta,
+    };
+}
+
+module.exports.fetchLinksFromLogs = fetchLinksFromLogs;

package/lib/adapter/vitest.js

@@ -100,7 +100,7 @@ class VitestReporter {
      *
      * @param {VitestTest} test
      *
-     * @returns {TestData & {status: string}}
+     * @returns {TestData & {status: 'passed' | 'failed' | 'skipped'}}
      */
     #getDataFromTest(test) {
         return {
@@ -108,6 +108,7 @@ class VitestReporter {
             file: test.file.name,
             logs: test.logs ? transformLogsToString(test.logs) : '',
             meta: test.meta,
+            // @ts-ignore - STATUS values are string literals but type system sees them as string
             status: getTestStatus(test),
             suite_title: test.suite.name || test.file?.name,
             test_id: (0, utils_js_1.getTestomatIdFromTestTitle)(test.name),

package/lib/bin/cli.js

@@ -18,7 +18,7 @@ const picocolors_1 = __importDefault(require("picocolors"));
 const filesize_1 = require("filesize");
 const dotenv_1 = __importDefault(require("dotenv"));
 const replay_js_1 = __importDefault(require("../replay.js"));
-const debug = (0, debug_1.default)('@testomatio/reporter:xml-cli');
+const debug = (0, debug_1.default)('@testomatio/reporter:cli');
 const version = (0, utils_js_1.getPackageVersion)();
 console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${version}`)));
 const program = new commander_1.Command();

package/lib/data-storage.js

@@ -167,6 +167,7 @@ class DataStorage {
                 if (testDataAsText)
                     debug('<=', dataType, 'file', context, testDataAsText);
                 const testDataArr = testDataAsText?.split(os_1.default.EOL) || [];
+                debug('<=', dataType, 'file', context, testDataArr);
                 return testDataArr;
             }
             // debug(`No ${this.dataType} data for ${context} in <file> storage`);

package/lib/pipe/html.d.ts

@@ -7,7 +7,6 @@ declare class HtmlPipe {
     isHtml: string;
     isEnabled: boolean;
     htmlOutputPath: string;
-    fullHtmlOutputPath: string;
     filenameMsg: string;
     tests: any[];
     htmlReportDir: string;
@@ -19,9 +18,9 @@ declare class HtmlPipe {
     updateRun(): void;
     /**
      * Add test data to the result array for saving. As a result of this function, we get a result object to save.
-     * @param {import('../../types/types.js').RunData} test - object which includes each test entry.
+     * @param {import('../../types/types.js').HtmlTestData} test - object which includes each test entry.
      */
-    addTest(test: import("../../types/types.js").RunData): void;
+    addTest(test: import("../../types/types.js").HtmlTestData): void;
     finishRun(runParams: any): Promise<void>;
     /**
      * Generates an HTML report based on provided test data and a template.