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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.1.2-beta.1-alias",
+  "version": "2.1.3-beta.1-multi-links",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/adapter/codecept.js

@@ -56,20 +56,19 @@ function CodeceptReporter(config) {
 
   output.debug = function(msg) {
     originalOutput.debug(msg);
-    dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.cyan(msg.toString()));
+    dataStorage.putData('log', repeat(this.stepShift) + pc.cyan(msg.toString()));
   };
 
   output.say = function(message, color = 'cyan') {
     originalOutput.say(message, color);
-    const sayMsg = repeat(this?.stepShift || 0) + `  ${pc.bold(pc[color](message))}`;
+    const sayMsg = repeat(this.stepShift) + `  ${pc.bold(pc[color](message))}`;
     dataStorage.putData('log', sayMsg);
   };
 
   output.log = function(msg) {
     originalOutput.log(msg);
-    dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.gray(msg));
+    dataStorage.putData('log', repeat(this.stepShift) + pc.gray(msg));
   };
-  output.stepShift = 0;
 
   recorder.startUnlessRunning();
 

package/src/bin/startTest.js

@@ -1,53 +1,124 @@
 #!/usr/bin/env node
-import { spawn } from 'node:child_process';
-import { join, dirname } from 'node:path';
-import { getPackageVersion } from '../utils/utils.js';
+import { spawn } from 'cross-spawn';
+import { Command } from 'commander';
 import pc from 'picocolors';
-
-// Define __dirname - this will be replaced by build script with actual __dirname for CommonJS
-const __dirname = typeof globalThis.__dirname !== 'undefined' ? globalThis.__dirname : '.';
-const cliPath = join(__dirname, 'cli.js');
+import TestomatClient from '../client.js';
+import { APP_PREFIX, STATUS } from '../constants.js';
+import { getPackageVersion } from '../utils/utils.js';
+import { config } from '../config.js';
+import dotenv from 'dotenv';
 
 const version = getPackageVersion();
 console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
+const program = new 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;
 
-// 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]);
+    if (opts.envFile) dotenv.config({ path: opts.envFile });
+
+    const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || config.TESTOMATIO;
+    const title = process.env.TESTOMATIO_TITLE;
+
+    if (launch) {
+      console.log('Starting a new Run on Testomat.io...');
+      const client = new TestomatClient({ apiKey });
+
+      client.createRun().then(() => {
+        console.log(process.env.runId);
+        process.exit(0);
+      });
+      return;
+    }
+
+    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 TestomatClient({ apiKey });
+
+      // @ts-ignore
+      client.updateRunStatus(STATUS.FINISHED).then(() => {
+        console.log(pc.yellow(`Run ${process.env.TESTOMATIO_RUN} was finished`));
+        process.exit(0);
+      });
+      return;
+    }
+
+    let exitCode = 0;
+
+    if (!command.split) {
+      process.exitCode = 255;
+      console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
+      return;
     }
-  } else if (arg.startsWith('--command=')) {
-    // Handle --command=value format
-    const command = arg.split('=', 2)[1];
-    newArgs.push(command);
-  } else if (arg === '--launch') {
-    // Map --launch to start command
-    newArgs[0] = 'start';
-  } else if (arg === '--finish') {
-    // Map --finish to finish command  
-    newArgs[0] = 'finish';
-  } else {
-    // Pass through other arguments
-    newArgs.push(arg);
-  }
-  i++;
-}
 
-// Execute the main CLI with mapped arguments
+    const client = new TestomatClient({ apiKey, title, parallel: true });
 
-const child = spawn(process.execPath, [cliPath, ...newArgs], {
-  stdio: 'inherit'
-});
+    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(APP_PREFIX, err);
+      }
+    }
+
+    const testCmds = command.split(' ');
+    console.log(APP_PREFIX, `🚀 Running`, pc.green(command));
+
+    if (!apiKey) {
+      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+
+      cmd.on('close', code => {
+        console.log(APP_PREFIX, '⚠️ ', `Runner exited with ${pc.bold(code)}, report is ignored`);
+
+        if (code > exitCode) exitCode = code;
+        process.exitCode = exitCode;
+      });
+
+      return;
+    }
+
+    client.createRun().then(() => {
+      const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
+
+      cmd.on('close', code => {
+        const emoji = code === 0 ? '🟢' : '🔴';
+        console.log(APP_PREFIX, emoji, `Runner exited with ${pc.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();
+}
 
-child.on('exit', (code) => {
-  process.exit(code);
-});
+program.parse(process.argv);

package/src/pipe/testomatio.js

@@ -119,7 +119,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) {

package/src/reporter-functions.js

@@ -3,8 +3,6 @@ import { services } from './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)
@@ -16,8 +14,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) throw new Error('This function is not available in Playwright framework');
@@ -26,8 +23,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)
@@ -38,9 +34,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)
@@ -55,10 +50,14 @@ 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/src/reporter.js

@@ -11,12 +11,12 @@ export const step = reporterFunctions.step;
 export const label = reporterFunctions.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
  */
 export default {
   /**