@testomatio/reporter 2.1.3-beta.2-xml-import → 2.1.3-beta.3-multi-links

package/lib/adapter/codecept.js

@@ -48,6 +48,7 @@ function CodeceptReporter(config) {
         step: output.step,
         say: output.say,
     };
+    output.stepShift = 0;
     output.debug = function (msg) {
         originalOutput.debug(msg);
         data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.cyan(msg.toString()));
@@ -61,7 +62,6 @@ function CodeceptReporter(config) {
         originalOutput.log(msg);
         data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.gray(msg));
     };
-    output.stepShift = 0;
     recorder.startUnlessRunning();
     const hookSteps = new Map();
     let currentHook = null;
@@ -140,7 +140,7 @@ function CodeceptReporter(config) {
         const manuallyAttachedArtifacts = index_js_1.services.artifacts.get(test.fullTitle());
         const keyValues = index_js_1.services.keyValues.get(test.fullTitle());
         const stepHierarchy = buildUnifiedStepHierarchy(test.steps, hookSteps);
-        const links = index_js_1.services.links.get(test.fullTitle());
+        const labels = index_js_1.services.labels.get(test.fullTitle());
         index_js_1.services.setContext(null);
         client.addTestRun(test.state, {
             ...stripExampleFromTitle(title),
@@ -153,7 +153,7 @@ function CodeceptReporter(config) {
             files,
             steps: stepHierarchy, // Array of step objects per API schema
             logs,
-            links,
+            labels,
             manuallyAttachedArtifacts,
             meta: { ...keyValues, ...test.meta },
         });

package/lib/adapter/mocha.js

@@ -43,7 +43,6 @@ function MochaReporter(runner, opts) {
         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),
@@ -54,16 +53,12 @@ function MochaReporter(runner, opts) {
             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),
@@ -71,9 +66,6 @@ function MochaReporter(runner, opts) {
             file: getFile(test),
             test_id: testId,
             time: test.duration,
-            manuallyAttachedArtifacts: artifacts,
-            meta: keyValues,
-            links,
         });
     });
     runner.on(EVENT_TEST_FAIL, async (test, err) => {
@@ -81,9 +73,6 @@ function MochaReporter(runner, opts) {
         console.log(picocolors_1.default.bold(picocolors_1.default.red('✖')), test.fullTitle(), picocolors_1.default.gray(err.message));
         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),
@@ -93,9 +82,6 @@ function MochaReporter(runner, opts) {
             code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
             time: test.duration,
             logs,
-            manuallyAttachedArtifacts: artifacts,
-            meta: keyValues,
-            links,
         });
     });
     runner.on(EVENT_RUN_END, () => {

package/lib/adapter/webdriver.js

@@ -78,13 +78,11 @@ class WebdriverReporter extends reporter_1.default {
         test.suite = test.parent;
         const logs = getTestLogs(test.fullTitle);
         // TODO: FIX: artifacts for some reason leads to empty report on Testomat.io
-        // ^ not reproduced anymore (Jul 2025)
-        // but still be under investigation
-        const artifacts = index_js_1.services.artifacts.get(test.fullTitle);
-        const keyValues = index_js_1.services.keyValues.get(test.fullTitle);
+        // const artifacts = services.artifacts.get(test.fullTitle);
+        // const keyValues = services.keyValues.get(test.fullTitle);
         test.logs = logs;
-        test.artifacts = artifacts;
-        test.meta = keyValues;
+        // test.artifacts = artifacts;
+        // test.meta = keyValues;
         this._addTestPromises.push(this.addTest(test));
     }
     // wdio-cucumber does not trigger onTestEnd hook, thus, using this one

package/lib/bin/startTest.js

@@ -4,50 +4,103 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_child_process_1 = require("node:child_process");
-const node_path_1 = require("node:path");
-const utils_js_1 = require("../utils/utils.js");
+const cross_spawn_1 = require("cross-spawn");
+const commander_1 = require("commander");
 const picocolors_1 = __importDefault(require("picocolors"));
-// Define __dirname - this will be replaced by build script with actual __dirname for CommonJS
-const cliPath = (0, node_path_1.join)(__dirname, 'cli.js');
+const client_js_1 = __importDefault(require("../client.js"));
+const constants_js_1 = require("../constants.js");
+const utils_js_1 = require("../utils/utils.js");
+const config_js_1 = require("../config.js");
+const dotenv_1 = __importDefault(require("dotenv"));
 const version = (0, utils_js_1.getPackageVersion)();
 console.log(picocolors_1.default.cyan(picocolors_1.default.bold(` 🤩 Testomat.io Reporter v${version}`)));
-// Parse command line arguments to map start-test-run options to @testomatio/reporter run format
-const args = process.argv.slice(2);
-const newArgs = ['run'];
-let i = 0;
-while (i < args.length) {
-    const arg = args[i];
-    if (arg === '-c' || arg === '--command') {
-        // Map -c/--command to positional argument for run command
-        i++;
-        if (i < args.length) {
-            newArgs.push(args[i]);
-        }
+const program = new commander_1.Command();
+program
+    .option('-c, --command <cmd>', 'Test runner command')
+    .option('--launch', 'Start a new run and return its ID')
+    .option('--finish', 'Finish Run by its ID')
+    .option('--env-file <envfile>', 'Load environment variables from env file')
+    .option('--filter <filter>', 'Additional execution filter')
+    .action(async (opts) => {
+    const { launch, finish, filter } = opts;
+    let { command } = opts;
+    if (opts.envFile)
+        dotenv_1.default.config({ path: opts.envFile });
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config_js_1.config.TESTOMATIO;
+    const title = process.env.TESTOMATIO_TITLE;
+    if (launch) {
+        console.log('Starting a new Run on Testomat.io...');
+        const client = new client_js_1.default({ apiKey });
+        client.createRun().then(() => {
+            console.log(process.env.runId);
+            process.exit(0);
+        });
+        return;
     }
-    else if (arg.startsWith('--command=')) {
-        // Handle --command=value format
-        const command = arg.split('=', 2)[1];
-        newArgs.push(command);
+    if (finish) {
+        // TODO: add error in case of TESTOMATIO environment variable is not set
+        // because command is fine in console, but actually (on testomat.io) run is not finished
+        if (!process.env.TESTOMATIO_RUN) {
+            console.log('TESTOMATIO_RUN environment variable must be set.');
+            return process.exit(1);
+        }
+        console.log('Finishing Run on Testomat.io...');
+        const client = new client_js_1.default({ apiKey });
+        // @ts-ignore
+        client.updateRunStatus(constants_js_1.STATUS.FINISHED).then(() => {
+            console.log(picocolors_1.default.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+            process.exit(0);
+        });
+        return;
     }
-    else if (arg === '--launch') {
-        // Map --launch to start command
-        newArgs[0] = 'start';
+    let exitCode = 0;
+    if (!command.split) {
+        process.exitCode = 255;
+        console.log(constants_js_1.APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+        return;
     }
-    else if (arg === '--finish') {
-        // Map --finish to finish command  
-        newArgs[0] = 'finish';
+    const client = new client_js_1.default({ apiKey, title, parallel: true });
+    if (filter) {
+        const [pipe, ...optsArray] = filter.split(':');
+        const pipeOptions = optsArray.join(':');
+        try {
+            const tests = await client.prepareRun({ pipe, pipeOptions });
+            if (!tests || tests.length === 0) {
+                return;
+            }
+            const grep = ` --grep (${tests.join('|')})`;
+            command += grep;
+        }
+        catch (err) {
+            console.log(constants_js_1.APP_PREFIX, err);
+        }
     }
-    else {
-        // Pass through other arguments
-        newArgs.push(arg);
+    const testCmds = command.split(' ');
+    console.log(constants_js_1.APP_PREFIX, `🚀 Running`, picocolors_1.default.green(command));
+    if (!apiKey) {
+        const cmd = (0, cross_spawn_1.spawn)(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+        cmd.on('close', code => {
+            console.log(constants_js_1.APP_PREFIX, '⚠️ ', `Runner exited with ${picocolors_1.default.bold(code)}, report is ignored`);
+            if (code > exitCode)
+                exitCode = code;
+            process.exitCode = exitCode;
+        });
+        return;
     }
-    i++;
-}
-// Execute the main CLI with mapped arguments
-const child = (0, node_child_process_1.spawn)(process.execPath, [cliPath, ...newArgs], {
-    stdio: 'inherit'
-});
-child.on('exit', (code) => {
-    process.exit(code);
+    client.createRun().then(() => {
+        const cmd = (0, cross_spawn_1.spawn)(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+        cmd.on('close', code => {
+            const emoji = code === 0 ? '🟢' : '🔴';
+            console.log(constants_js_1.APP_PREFIX, emoji, `Runner exited with ${picocolors_1.default.bold(code)}`);
+            const status = code === 0 ? 'passed' : 'failed';
+            client.updateRunStatus(status, true);
+            if (code > exitCode)
+                exitCode = code;
+            process.exitCode = exitCode;
+        });
+    });
 });
+if (process.argv.length <= 2) {
+    program.outputHelp();
+}
+program.parse(process.argv);

package/lib/client.js

@@ -50,7 +50,6 @@ const path_1 = __importStar(require("path"));
 const node_url_1 = require("node:url");
 const uploader_js_1 = require("./uploader.js");
 const utils_js_1 = require("./utils/utils.js");
-const links_js_1 = require("./services/links.js");
 const filesize_1 = require("filesize");
 const debug = (0, debug_1.default)('@testomatio/reporter:client');
 // removed __dirname usage, because:
@@ -182,7 +181,7 @@ class Client {
         /**
          * @type {TestData}
          */
-        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, manuallyAttachedArtifacts, overwrite, } = testData;
+        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, manuallyAttachedArtifacts, labels, overwrite, } = testData;
         let { message = '', meta = {} } = testData;
         // stringify meta values and limit keys and values length to 255
         meta = Object.entries(meta)
@@ -221,9 +220,7 @@ class Client {
                 acc[key] = value;
             return acc;
         }, {});
-        // Get links from storage using the test context
-        const testContext = suite_title ? `${suite_title} ${title}` : title;
-        const links = links_js_1.linkStorage.get(testContext) || [];
+        // Labels are simple array of strings, no processing needed
         let errorFormatted = '';
         if (error) {
             errorFormatted += this.formatError(error) || '';
@@ -271,7 +268,7 @@ class Client {
             timestamp,
             artifacts,
             meta,
-            links,
+            labels,
             overwrite,
             ...(rootSuiteId && { root_suite_id: rootSuiteId }),
         };

package/lib/data-storage.d.ts

@@ -12,22 +12,22 @@ declare class DataStorage {
     /**
      * Puts any data to storage (file or global variable).
      * If file: stores data as text, if global variable – stores as array of data.
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {*} data anything you want to store (string, object, array, etc)
      * @param {*} context could be testId or any context (test name, suite name, including their IDs etc)
      * suite name + test name is used by default
      * @returns
      */
-    putData(dataType: "log" | "artifact" | "keyvalue" | "links", data: any, context?: any): void;
+    putData(dataType: "log" | "artifact" | "keyvalue" | "labels", data: any, context?: any): void;
     /**
      * Returns data, stored for specific test/context (or data which was stored without test id specified).
      * This method will get data from global variable and/or from from file (previosly saved with put method).
      *
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {string} context
      * @returns {any []} array of data (any type), null (if no data found for context) or string (if data type is log)
      */
-    getData(dataType: "log" | "artifact" | "keyvalue" | "links", context: string): any[];
+    getData(dataType: "log" | "artifact" | "keyvalue" | "labels", context: string): any[];
     #private;
 }
 export function stringToMD5Hash(str: any): string;

package/lib/data-storage.js

@@ -45,6 +45,7 @@ const os_1 = __importDefault(require("os"));
 const constants_js_1 = require("./constants.js");
 const utils_js_1 = require("./utils/utils.js");
 const crypto_1 = __importDefault(require("crypto"));
+const startTime = Date.now();
 const debug = (0, debug_1.default)('@testomatio/reporter:storage');
 class DataStorage {
     static #instance;
@@ -75,7 +76,7 @@ class DataStorage {
     /**
      * Puts any data to storage (file or global variable).
      * If file: stores data as text, if global variable – stores as array of data.
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {*} data anything you want to store (string, object, array, etc)
      * @param {*} context could be testId or any context (test name, suite name, including their IDs etc)
      * suite name + test name is used by default
@@ -103,7 +104,7 @@ class DataStorage {
      * Returns data, stored for specific test/context (or data which was stored without test id specified).
      * This method will get data from global variable and/or from from file (previosly saved with put method).
      *
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {string} context
      * @returns {any []} array of data (any type), null (if no data found for context) or string (if data type is log)
      */
@@ -134,7 +135,7 @@ class DataStorage {
         return null;
     }
     /**
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {string} context
      * @returns aray of data (any type)
      */
@@ -154,7 +155,7 @@ class DataStorage {
         }
     }
     /**
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {*} context
      * @returns array of data (any type)
      */
@@ -179,7 +180,7 @@ class DataStorage {
     }
     /**
      * Puts data to global variable. Unlike the file storage, stores data in array (file storage just append as string).
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {*} data
      * @param {*} context
      */
@@ -195,7 +196,7 @@ class DataStorage {
     }
     /**
      * Puts data to file. Unlike the global variable storage, stores data as string
-     * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
+     * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
      * @param {*} data
      * @param {string} context
      * @returns
@@ -222,7 +223,7 @@ function stringToMD5Hash(str) {
     const md5 = crypto_1.default.createHash('md5');
     md5.update(str);
     const hash = md5.digest('hex');
-    return hash;
+    return `${startTime}_${hash}`;
 }
 exports.dataStorage = DataStorage.getInstance();
 // TODO: consider using fs promises instead of writeSync/appendFileSync to

package/lib/pipe/testomatio.js

@@ -113,7 +113,8 @@ class TestomatioPipe {
             const resp = await this.client.request({
                 method: 'GET',
                 url: '/api/test_grep',
-                ...q,
+                params: q.params,
+                responseType: q.responseType
             });
             if (Array.isArray(resp.data?.tests) && resp.data?.tests?.length > 0) {
                 (0, utils_js_1.foundedTestLog)(constants_js_1.APP_PREFIX, resp.data.tests);

package/lib/reporter-functions.d.ts

@@ -4,14 +4,11 @@ declare namespace _default {
     export { addStep as step };
     export { setKeyValue as keyValue };
     export { setLabel as label };
-    export { linkTest };
 }
 export default _default;
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
- * @param {any} [context=null] - optional context parameter
- * @returns {void}
  */
 declare function saveArtifact(data: string | {
     path: string;
@@ -20,35 +17,25 @@ declare function saveArtifact(data: string | {
 }, context?: any): void;
 /**
  * Attach log message(s) to the test report
- * @param {...any} args - log messages to attach
- * @returns {void}
+ * @param  string
  */
 declare function logMessage(...args: any[]): void;
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message - step message
- * @returns {void}
+ * @param {string} message
  */
 declare function addStep(message: string): void;
 /**
  * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)
- * @param {string|null} [value=null] - optional value when keyValue is a string
- * @returns {void}
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
+ * @param {string?} value
  */
 declare function setKeyValue(keyValue: {
     [key: string]: string;
 } | string, value?: string | null): void;
 /**
- * Add label(s) to the test report
+ * Add a single label to the test report
  * @param {string} key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
- * @param {string|string[]|null} [value=null] - optional label value(s) (e.g. 'high', 'login') or array of values
- * @returns {void}
+ * @param {string} [value] - optional label value (e.g. 'high', 'login')
  */
-declare function setLabel(key: string, value?: string | string[] | null): void;
-/**
- * Add link(s) to the test report
- * @param {...string} testIds - test IDs to link
- * @returns {void}
- */
-declare function linkTest(...testIds: string[]): void;
+declare function setLabel(key: string, value?: string): void;

package/lib/reporter-functions.js

@@ -4,8 +4,6 @@ const index_js_1 = require("./services/index.js");
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
- * @param {any} [context=null] - optional context parameter
- * @returns {void}
  */
 function saveArtifact(data, context = null) {
     if (process.env.IS_PLAYWRIGHT)
@@ -17,8 +15,7 @@ function saveArtifact(data, context = null) {
 }
 /**
  * Attach log message(s) to the test report
- * @param {...any} args - log messages to attach
- * @returns {void}
+ * @param  string
  */
 function logMessage(...args) {
     if (process.env.IS_PLAYWRIGHT)
@@ -27,8 +24,7 @@ function logMessage(...args) {
 }
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message - step message
- * @returns {void}
+ * @param {string} message
  */
 function addStep(message) {
     if (process.env.IS_PLAYWRIGHT)
@@ -37,9 +33,8 @@ function addStep(message) {
 }
 /**
  * Add key-value pair(s) to the test report
- * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)
- * @param {string|null} [value=null] - optional value when keyValue is a string
- * @returns {void}
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
+ * @param {string?} value
  */
 function setKeyValue(keyValue, value = null) {
     if (process.env.IS_PLAYWRIGHT)
@@ -50,29 +45,43 @@ function setKeyValue(keyValue, value = null) {
     index_js_1.services.keyValues.put(keyValue);
 }
 /**
- * Add label(s) to the test report
+ * Add a single label to the test report
  * @param {string} key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
- * @param {string|string[]|null} [value=null] - optional label value(s) (e.g. 'high', 'login') or array of values
- * @returns {void}
+ * @param {string} [value] - optional label value (e.g. 'high', 'login')
  */
 function setLabel(key, value = null) {
     if (Array.isArray(value)) {
-        value.forEach(val => setLabel(key, val));
+        value.forEach(v => setLabel(key, v));
         return;
     }
-    const labelObject = value !== null && value !== undefined && value !== ''
-        ? { label: `${key}:${value}` }
-        : { label: key };
-    index_js_1.services.links.put([labelObject]);
-}
-/**
- * Add link(s) to the test report
- * @param {...string} testIds - test IDs to link
- * @returns {void}
- */
-function linkTest(...testIds) {
-    const links = testIds.map(testId => ({ test: testId }));
-    index_js_1.services.links.put(links);
+    if (!key || typeof key !== 'string') {
+        console.warn('Label key must be a non-empty string');
+        return;
+    }
+    // Limit key length to 255 characters
+    if (key.length > 255) {
+        console.warn('Label key is too long, trimmed to 255 characters:', key);
+        key = key.substring(0, 255);
+    }
+    let labelString = key;
+    if (value !== null && value !== undefined && value !== '') {
+        if (typeof value !== 'string') {
+            console.warn('Label value must be a string, converting:', value);
+            value = String(value);
+        }
+        // Limit value length to 255 characters
+        if (value.length > 255) {
+            console.warn('Label value is too long, trimmed to 255 characters:', value);
+            value = value.substring(0, 255);
+        }
+        labelString = `${key}:${value}`;
+    }
+    // Limit total label length to 255 characters
+    if (labelString.length > 255) {
+        console.warn('Label is too long, trimmed to 255 characters:', labelString);
+        labelString = labelString.substring(0, 255);
+    }
+    index_js_1.services.labels.put([labelString]);
 }
 module.exports = {
     artifact: saveArtifact,
@@ -80,5 +89,4 @@ module.exports = {
     step: addStep,
     keyValue: setKeyValue,
     label: setLabel,
-    linkTest,
 };