@testomatio/reporter 2.6.0-beta.1.allure → 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,13 +63,12 @@ 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)             |
-| [Allure](./docs/allure.md)                      |                                               |                                                           |
 
 or **any [other via JUnit](./docs/junit.md)** report....
 
@@ -104,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)
 
@@ -130,10 +129,9 @@ Bring this reporter on CI and never lose test results again!
   - [CSV](./docs/pipes/csv.md)
   - [HTML report](./docs/pipes/html.md)
   - [Bitbucket](./docs/pipes/bitbucket.md)
-- 📓 [JUnit Reports](./docs/junit.md)
-- 🗄️ [Artifacts](./docs/artifacts.md)
-- 🔬 [Allure Reports](./docs/allure.md)
 - 🔗 [Linking Tests](./docs/linking-tests.md)
+- 📓 [JUnit](./docs/junit.md)
+- 🗄️ [Artifacts](./docs/artifacts.md)
 - 🔂 [Workflows](./docs/workflows.md)
 - 🖊️ [Logger](./docs/logger.md)
 - 🪲 [Debug File Format](./docs/debug-file-format.md)

package/lib/adapter/playwright.d.ts

@@ -18,4 +18,6 @@ declare class PlaywrightReporter {
  * @returns {string[]} - array of normalized tags with @ prefix
  */
 export function extractTags(test: any): string[];
+import { fetchLinksFromLogs } from './utils/playwright.js';
 import TestomatioClient from '../client.js';
+export { fetchLinksFromLogs };

package/lib/adapter/playwright.js

@@ -3,8 +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;
-const picocolors_1 = __importDefault(require("picocolors"));
 const crypto_1 = __importDefault(require("crypto"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
@@ -16,6 +16,9 @@ const utils_js_1 = require("../utils/utils.js");
 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 = [];
 class PlaywrightReporter {
     constructor(config = {}) {
@@ -41,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) {
@@ -53,12 +64,23 @@ class PlaywrightReporter {
         const tags = extractTags(test);
         const fullTestTitle = getTestContextName(test);
         let logs = '';
-        if (result.stderr.length || result.stdout.length) {
-            logs = `\n\n${picocolors_1.default.bold('Logs:')}\n${picocolors_1.default.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
+        // get links along with filtered logs (liks related logs removed)
+        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('')}`;
         }
+        /*
+          All services fucntions work different for Playwright.
+          We don't have access to test title (as result, to test id) when calling this functions inside a test.
+          Thus, when user calls services functions inside a test, we just log this data to console.
+          Playwright intercepts the console.log on it's end and we just get this data from it.
+          Thus, we have a tiny drawback: all data from services functions inside a test will be logged to console.
+          And this requires a condition to be added for each service function – if its Playwright, then log to console.
+    
+          "get" method of services will not return data for Playwright, we should parse stdout.
+        */
         const manuallyAttachedArtifacts = index_js_1.services.artifacts.get(fullTestTitle);
         const testMeta = index_js_1.services.keyValues.get(fullTestTitle);
-        const links = index_js_1.services.links.get(fullTestTitle);
         const rid = test.id || test.testId || (0, uuid_1.v4)();
         /**
          * @type {{
@@ -98,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;
@@ -115,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

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

@@ -10,7 +10,6 @@ const glob_1 = require("glob");
 const debug_1 = __importDefault(require("debug"));
 const client_js_1 = __importDefault(require("../client.js"));
 const xmlReader_js_1 = __importDefault(require("../xmlReader.js"));
-const allureReader_js_1 = __importDefault(require("../allureReader.js"));
 const constants_js_1 = require("../constants.js");
 const utils_js_1 = require("../utils/utils.js");
 const config_js_1 = require("../config.js");
@@ -19,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();
@@ -74,25 +73,25 @@ program
     .command('run')
     .alias('test')
     .description('Run tests with the specified command')
-    .argument('<command>', 'Test runner command')
+    .argument('[command]', 'Test runner command')
     .option('--filter <filter>', 'Additional execution filter')
     .option('--filter-list <filter>', 'Get a list of all tests by filter before running')
     .option('--kind <type>', 'Specify run type: automated, manual, or mixed')
     .action(async (command, opts) => {
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
     const title = process.env.TESTOMATIO_TITLE;
-    if (!command || !command.split) {
-        console.log(constants_js_1.APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
-        return process.exit(255);
-    }
     const client = new client_js_1.default({ apiKey, title });
     if (opts.filter || opts.filterList) {
+        console.log(constants_js_1.APP_PREFIX, 'Filtering tests...');
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
         // Example of use: npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml"
         // Example of use: npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml"
         const [pipe, ...optsArray] = opts?.filter ? opts?.filter.split(':') : opts?.filterList.split(':');
         const pipeOptions = optsArray.join(':');
         const prepareRunParams = { pipe, pipeOptions };
+        if (opts.filterList) {
+            client.pipeStore.filterList = true;
+        }
         try {
             const tests = await client.prepareRun(prepareRunParams);
             if (!tests || tests.length === 0) {
@@ -104,16 +103,44 @@ program
             debug(`Execution pattern: "${pattern}"`);
             if (opts.filterList) {
                 console.log(constants_js_1.APP_PREFIX, picocolors_1.default.blue(`Matched test/suite IDs: ${tests.join(', ')}`));
-                console.log(constants_js_1.APP_PREFIX, picocolors_1.default.green(`Full Running Command: ${filteredCommand}`));
+                if (command)
+                    console.log(constants_js_1.APP_PREFIX, picocolors_1.default.green(`Full Running Command: ${filteredCommand}`));
                 return;
             }
-            command = filteredCommand;
+            if (command && command.split) {
+                command = filteredCommand;
+            }
         }
         catch (err) {
             console.log(constants_js_1.APP_PREFIX, err.message || err);
             return;
         }
     }
+    // just create a run (wich tests which match filters) without executing tests
+    if (!command || !command.split) {
+        const createRunParams = {};
+        if (title) {
+            createRunParams.title = title;
+        }
+        if (opts.kind) {
+            createRunParams.kind = opts.kind;
+        }
+        if (apiKey) {
+            await client.createRun(createRunParams);
+            const runId = process.env.TESTOMATIO_RUN || process.env.runId;
+            if (client.pipeStore.runUrl)
+                console.log(constants_js_1.APP_PREFIX, `📊 Report URL: ${picocolors_1.default.magenta(client.pipeStore.runUrl)}`);
+            if (opts.kind !== 'manual') {
+                console.log(constants_js_1.APP_PREFIX, `No command passed, so you need to run tests yourself:`);
+                console.log(constants_js_1.APP_PREFIX, `TESTOMATIO_RUN=${runId} <command>`);
+            }
+        }
+        else {
+            console.log(constants_js_1.APP_PREFIX, '⚠️  No API key provided. Cannot create run without TESTOMATIO key.');
+            process.exit(1);
+        }
+        return process.exit(0);
+    }
     console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
     const runTests = async () => {
         const testCmds = command.split(' ');
@@ -209,33 +236,6 @@ program
     if (timeoutTimer)
         clearTimeout(timeoutTimer);
 });
-program
-    .command('allure')
-    .description('Parse Allure result files and upload to Testomat.io')
-    .argument('<pattern>', 'Allure result directory pattern')
-    .option('-d, --dir <dir>', 'Project directory')
-    .option('--timelimit <time>', 'default time limit in seconds to kill a stuck process')
-    .option('--with-package', 'Keep full package path in file names (default: strip package prefix)')
-    .action(async (pattern, opts) => {
-    const runReader = new allureReader_js_1.default({ withPackage: opts.withPackage });
-    let timeoutTimer;
-    if (opts.timelimit) {
-        timeoutTimer = setTimeout(() => {
-            console.log(`⚠️  Reached timeout of ${opts.timelimit}s. Exiting... (Exit code is 0 to not fail the pipeline)`);
-            process.exit(0);
-        }, parseInt(opts.timelimit, 10) * 1000);
-    }
-    try {
-        await runReader.parse(pattern);
-        await runReader.createRun();
-        await runReader.uploadData();
-    }
-    catch (err) {
-        console.log(constants_js_1.APP_PREFIX, 'Error uploading Allure results:', err);
-    }
-    if (timeoutTimer)
-        clearTimeout(timeoutTimer);
-});
 program
     .command('upload-artifacts')
     .description('Upload artifacts to Testomat.io')

package/lib/data-storage.d.ts

@@ -1,6 +1,6 @@
 export const dataStorage: DataStorage;
 declare class DataStorage {
-    static "__#private@#instance": any;
+    static "__#13@#instance": any;
     /**
      *
      * @returns {DataStorage}

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/junit-adapter/index.js

@@ -9,7 +9,6 @@ const java_js_1 = __importDefault(require("./java.js"));
 const python_js_1 = __importDefault(require("./python.js"));
 const ruby_js_1 = __importDefault(require("./ruby.js"));
 const csharp_js_1 = __importDefault(require("./csharp.js"));
-const kotlin_js_1 = __importDefault(require("./kotlin.js"));
 function AdapterFactory(lang, opts) {
     if (lang === 'java') {
         return new java_js_1.default(opts);
@@ -26,9 +25,6 @@ function AdapterFactory(lang, opts) {
     if (lang === 'c#' || lang === 'csharp') {
         return new csharp_js_1.default(opts);
     }
-    if (lang === 'kotlin') {
-        return new kotlin_js_1.default(opts);
-    }
     return new adapter_js_1.default(opts);
 }
 module.exports = AdapterFactory;

package/lib/pipe/coverage.js

@@ -89,7 +89,7 @@ class CoveragePipe {
                 }
             }
         });
-        // In case if we have all needed data 
+        // In case if we have all needed data
         this.isEnabled = true;
         debug('Coverage Pipe initialized', {
             branch: this.branch,
@@ -110,6 +110,9 @@ class CoveragePipe {
         this.suiteIds.clear();
         this.tagLabels.clear();
         this.results = [];
+        if (this.store) {
+            this.store.coverageConfiguration = undefined;
+        }
         if (!this.isEnabled)
             return [];
         // Step 1: Validate coverage file path & Git changes & Coverage parsing
@@ -117,6 +120,9 @@ class CoveragePipe {
             return [];
         // Step 2: Extract all available tests and compare with coverage file
         const lines = await this.extractRelevantTestsFromChanges();
+        if (this.store?.filterList && lines.size > 0) {
+            console.log(constants_js_1.APP_PREFIX, `Matched files: ${[...lines].join(', ')}`);
+        }
         if (lines.size === 0) {
             console.log(constants_js_1.APP_PREFIX, 'ℹ️  No matching entries in coverage file for provided Git changes.');
             return [];
@@ -134,11 +140,22 @@ class CoveragePipe {
                 tests.forEach(testId => this.tests.add(testId));
             }
         }
-        if (this.tests.size === 0) {
+        if (this.tests.size === 0 && this.suiteIds.size === 0) {
             console.log(constants_js_1.APP_PREFIX, 'ℹ️  No tests found for execution based on Git changes.');
             return [];
         }
-        this.results = [...this.tests];
+        this.results = [...this.tests, ...this.suiteIds];
+        if (this.store) {
+            this.store.coverageConfiguration = {
+                tests: [...this.tests],
+                suites: [...this.suiteIds],
+            };
+            this.store.coverageDescription = this.#buildRunDescription({
+                matchedLines: lines,
+                testsCount: this.tests.size,
+                suitesCount: this.suiteIds.size,
+            });
+        }
         return this.results;
     }
     addTest(data) { }
@@ -230,7 +247,7 @@ class CoveragePipe {
     #buildGitCommand() {
         if (!this.branch)
             throw new Error(`❌ Invalid changes option for setted branch!`);
-        return `git diff ${this.branch} --name-only`; // Example: 'git diff <master> --name-only' 
+        return `git diff ${this.branch} --name-only`; // Example: 'git diff <master> --name-only'
     }
     /**
      * Retrieves the list of files changed in the current Git working directory
@@ -356,7 +373,7 @@ class CoveragePipe {
                         }
                         // Example: "@Sd74099c1"
                         else if (id.startsWith('@S')) {
-                            this.tests.add(id.slice(1));
+                            this.suiteIds.add(id.slice(1));
                         }
                         // Example: "tag:@TestSmoke"
                         else if (id.startsWith('tag')) {
@@ -369,5 +386,46 @@ class CoveragePipe {
         debug(`Matched lines: ${this.matchedLines}`);
         return this.matchedLines;
     }
+    #buildRunDescription({ matchedLines, testsCount, suitesCount }) {
+        const sourceBranch = process.env.GITHUB_HEAD_REF ||
+            process.env.GITHUB_REF_NAME ||
+            process.env.CI_COMMIT_REF_NAME ||
+            this.#getCurrentGitBranch() ||
+            'current branch';
+        const targetBranch = this.branch || 'target branch';
+        const coverageFile = this.coverageFilePath ? path_1.default.basename(this.coverageFilePath) : 'coverage.yml';
+        const updatedFiles = matchedLines && matchedLines.size > 0 ? [...matchedLines] : this.changedFiles;
+        let description = `Changes to **${updatedFiles.length}** files in ${sourceBranch} to ${targetBranch}.\n\n`;
+        if (suitesCount > 0 || testsCount > 0) {
+            const affectedItems = [];
+            if (suitesCount > 0)
+                affectedItems.push(`**${suitesCount} suites**`);
+            if (testsCount > 0)
+                affectedItems.push(`**${testsCount} individual tests**`);
+            description += `May affect ${affectedItems.join(' and ')} which are recommended to be tested for regression.\n\n`; // eslint-disable-line
+        }
+        description += 'Updated source files:\n';
+        if (updatedFiles.length) {
+            description += updatedFiles.map(file => `* \`${file}\``).join('\n');
+            description += '\n\n';
+        }
+        else {
+            description += '* No matched files found\n\n';
+        }
+        description += `Mapping source files to tests set via \`${coverageFile}\` file.`;
+        return description;
+    }
+    #getCurrentGitBranch() {
+        try {
+            const branch = (0, child_process_1.execSync)('git rev-parse --abbrev-ref HEAD', {
+                encoding: 'utf-8',
+                stdio: ['pipe', 'pipe', 'ignore'],
+            }).trim();
+            return branch || undefined;
+        }
+        catch (err) {
+            return undefined;
+        }
+    }
 }
 module.exports = CoveragePipe;

package/lib/pipe/debug.js

@@ -10,7 +10,6 @@ const os_1 = __importDefault(require("os"));
 const debug_1 = __importDefault(require("debug"));
 const constants_js_1 = require("../constants.js");
 const pretty_ms_1 = __importDefault(require("pretty-ms"));
-const utils_js_1 = require("../utils/utils.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:pipe:debug');
 class DebugPipe {
     constructor(params, store) {
@@ -19,7 +18,7 @@ class DebugPipe {
         this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
         if (this.isEnabled) {
             this.batch = {
-                isEnabled: this.params.isBatchEnabled ?? !(0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD),
+                isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
                 intervalFunction: null,
                 intervalTime: 5000,
                 tests: [],

package/lib/pipe/github.js

@@ -153,6 +153,21 @@ class GitHubPipe {
             return text;
         });
         let body = summary;
+        const coverageConfiguration = this.store?.coverageConfiguration;
+        const isManualRun = this.store?.runKind === 'manual';
+        if (isManualRun && coverageConfiguration) {
+            const testsCount = coverageConfiguration.tests?.length || 0;
+            const suitesCount = coverageConfiguration.suites?.length || 0;
+            body += '\n\n<details>\n<summary><h3>🧭 Coverage Scope</h3></summary>\n\n';
+            if (!testsCount && !suitesCount) {
+                body += '- No tests were affected, run disabled\n';
+            }
+            else {
+                body += `- Suites: ${suitesCount}\n`;
+                body += `- Tests: ${testsCount}\n`;
+            }
+            body += '\n</details>';
+        }
         if (failures.length) {
             body += `\n<details>\n<summary><h3>🟥 Failures (${failures.length})</h4></summary>\n\n${failures.join('\n')}\n`;
             if (failures.length > 20) {

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.