@testomatio/reporter 2.1.2-beta.1-alias → 2.1.3-beta.1-multi-links

package/lib/adapter/codecept.js

@@ -50,18 +50,17 @@ function CodeceptReporter(config) {
     };
     output.debug = function (msg) {
         originalOutput.debug(msg);
-        data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.cyan(msg.toString()));
+        data_storage_js_1.dataStorage.putData('log', repeat(this.stepShift) + picocolors_1.default.cyan(msg.toString()));
     };
     output.say = function (message, color = 'cyan') {
         originalOutput.say(message, color);
-        const sayMsg = repeat(this?.stepShift || 0) + `  ${picocolors_1.default.bold(picocolors_1.default[color](message))}`;
+        const sayMsg = repeat(this.stepShift) + `  ${picocolors_1.default.bold(picocolors_1.default[color](message))}`;
         data_storage_js_1.dataStorage.putData('log', sayMsg);
     };
     output.log = function (msg) {
         originalOutput.log(msg);
-        data_storage_js_1.dataStorage.putData('log', repeat(this?.stepShift || 0) + picocolors_1.default.gray(msg));
+        data_storage_js_1.dataStorage.putData('log', repeat(this.stepShift) + picocolors_1.default.gray(msg));
     };
-    output.stepShift = 0;
     recorder.startUnlessRunning();
     const hookSteps = new Map();
     let currentHook = null;

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/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

@@ -9,8 +9,6 @@ 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;
@@ -19,21 +17,18 @@ 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;
@@ -41,7 +36,6 @@ declare function setKeyValue(keyValue: {
 /**
  * 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|null} [value=null] - optional label value (e.g. 'high', 'login')
- * @returns {void}
+ * @param {string} [value] - optional label value (e.g. 'high', 'login')
  */
-declare function setLabel(key: string, value?: string | null): 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)
@@ -52,10 +47,13 @@ function setKeyValue(keyValue, value = null) {
 /**
  * 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|null} [value=null] - optional label value (e.g. 'high', 'login')
- * @returns {void}
+ * @param {string} [value] - optional label value (e.g. 'high', 'login')
  */
 function setLabel(key, value = null) {
+    if (Array.isArray(value)) {
+        value.forEach(v => setLabel(key, v));
+        return;
+    }
     if (!key || typeof key !== 'string') {
         console.warn('Label key must be a non-empty string');
         return;

package/lib/reporter.d.ts

@@ -1,9 +1,12 @@
+export type artifact = typeof import("./reporter-functions.js");
 export const artifact: (data: string | {
     path: string;
     type: string;
     name: string;
 }, context?: any) => void;
+export type log = typeof import("./reporter-functions.js");
 export const log: (...args: any[]) => void;
+export type logger = typeof import("./services/index.js");
 export const logger: {
     "__#13@#originalUserLogger": {
         assert(condition?: boolean, ...data: any[]): void;
@@ -72,11 +75,14 @@ export const logger: {
     }): void;
     prettyObjects: boolean;
 };
+export type meta = typeof import("./reporter-functions.js");
 export const meta: (keyValue: {
     [key: string]: string;
 } | string, value?: string | null) => void;
+export type step = typeof import("./reporter-functions.js");
 export const step: (message: string) => void;
-export const label: (key: string, value?: string | null) => void;
+export type label = typeof import("./reporter-functions.js");
+export const label: (key: string, value?: string) => void;
 declare namespace _default {
     let testomatioLogger: {
         "__#13@#originalUserLogger": {
@@ -224,12 +230,6 @@ declare namespace _default {
         [key: string]: string;
     } | string, value?: string | null) => void;
     let step: (message: string) => void;
-    let label: (key: string, value?: string | null) => void;
+    let label: (key: string, value?: string) => void;
 }
 export default _default;
-export type ArtifactFunction = typeof import("./reporter-functions.js").default.artifact;
-export type LogFunction = typeof import("./reporter-functions.js").default.log;
-export type LoggerService = typeof import("./services/index.js").services.logger;
-export type MetaFunction = typeof import("./reporter-functions.js").default.keyValue;
-export type StepFunction = typeof import("./reporter-functions.js").default.step;
-export type LabelFunction = typeof import("./reporter-functions.js").default.label;

package/lib/reporter.js

@@ -15,12 +15,12 @@ exports.meta = reporter_functions_js_1.default.keyValue;
 exports.step = reporter_functions_js_1.default.step;
 exports.label = reporter_functions_js_1.default.label;
 /**
- * @typedef {typeof import('./reporter-functions.js').default.artifact} ArtifactFunction
- * @typedef {typeof import('./reporter-functions.js').default.log} LogFunction
- * @typedef {typeof import('./services/index.js').services.logger} LoggerService
- * @typedef {typeof import('./reporter-functions.js').default.keyValue} MetaFunction
- * @typedef {typeof import('./reporter-functions.js').default.step} StepFunction
- * @typedef {typeof import('./reporter-functions.js').default.label} LabelFunction
+ * @typedef {import('./reporter-functions.js')} artifact
+ * @typedef {import('./reporter-functions.js')} log
+ * @typedef {import('./services/index.js')} logger
+ * @typedef {import('./reporter-functions.js')} meta
+ * @typedef {import('./reporter-functions.js')} step
+ * @typedef {import('./reporter-functions.js')} label
  */
 module.exports = {
     /**

package/lib/services/links.d.ts

@@ -0,0 +1,22 @@
+export const linkStorage: LinkStorage;
+declare class LinkStorage {
+    static "__#13@#instance": any;
+    /**
+     *
+     * @returns {LinkStorage}
+     */
+    static getInstance(): LinkStorage;
+    /**
+     * Stores links array and passes it to reporter
+     * @param {object[]} links - array of link objects
+     * @param {*} context - full test title
+     */
+    put(links: object[], context?: any): void;
+    /**
+     * Returns links array for the test
+     * @param {*} context testId or test context from test runner
+     * @returns {object[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
+     */
+    get(context?: any): object[];
+}
+export {};

package/lib/services/links.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkStorage = void 0;
+const debug_1 = __importDefault(require("debug"));
+const data_storage_js_1 = require("../data-storage.js");
+const debug = (0, debug_1.default)('@testomatio/reporter:services-links');
+class LinkStorage {
+    static #instance;
+    /**
+     *
+     * @returns {LinkStorage}
+     */
+    static getInstance() {
+        if (!this.#instance) {
+            this.#instance = new LinkStorage();
+        }
+        return this.#instance;
+    }
+    /**
+     * Stores links array and passes it to reporter
+     * @param {object[]} links - array of link objects
+     * @param {*} context - full test title
+     */
+    put(links, context = null) {
+        if (!links || !Array.isArray(links))
+            return;
+        data_storage_js_1.dataStorage.putData('links', links, context);
+    }
+    /**
+     * Returns links array for the test
+     * @param {*} context testId or test context from test runner
+     * @returns {object[]} links array, e.g. [{test: 'TEST-123'}, {jira: 'JIRA-456'}]
+     */
+    get(context = null) {
+        const linksList = data_storage_js_1.dataStorage.getData('links', context);
+        if (!linksList || !linksList?.length)
+            return [];
+        const allLinks = [];
+        for (const links of linksList) {
+            if (Array.isArray(links)) {
+                allLinks.push(...links);
+            }
+            else if (typeof links === 'string') {
+                try {
+                    const parsedLinks = JSON.parse(links);
+                    if (Array.isArray(parsedLinks)) {
+                        allLinks.push(...parsedLinks);
+                    }
+                }
+                catch (e) {
+                    debug(`Error parsing links for test ${context}`, links);
+                }
+            }
+        }
+        // Remove duplicates based on JSON string comparison
+        const uniqueLinks = [];
+        const seen = new Set();
+        for (const link of allLinks) {
+            const key = JSON.stringify(link);
+            if (!seen.has(key)) {
+                seen.add(key);
+                uniqueLinks.push(link);
+            }
+        }
+        return uniqueLinks;
+    }
+}
+exports.linkStorage = LinkStorage.getInstance();

package/lib/utils/cli_utils.d.ts

@@ -0,0 +1 @@
+export function checkForEnvPassedAsArguments(): void;