@testomatio/reporter 2.1.3-beta.3-multi-links → 2.3.0-beta.1-links

package/src/bin/startTest.js

@@ -1,124 +1,53 @@
 #!/usr/bin/env node
-import { spawn } from 'cross-spawn';
-import { Command } from 'commander';
-import pc from 'picocolors';
-import TestomatClient from '../client.js';
-import { APP_PREFIX, STATUS } from '../constants.js';
+import { spawn } from 'node:child_process';
+import { join, dirname } from 'node:path';
 import { getPackageVersion } from '../utils/utils.js';
-import { config } from '../config.js';
-import dotenv from 'dotenv';
+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');
 
 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;
-
-    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;
+// 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]);
     }
+  } 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++;
+}
 
-    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;
-    }
-
-    const client = new TestomatClient({ 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(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;
-      });
-    });
-  });
+// Execute the main CLI with mapped arguments
 
-if (process.argv.length <= 2) {
-  program.outputHelp();
-}
+const child = spawn(process.execPath, [cliPath, ...newArgs], {
+  stdio: 'inherit'
+});
 
-program.parse(process.argv);
+child.on('exit', (code) => {
+  process.exit(code);
+});

package/src/client.js

@@ -181,8 +181,8 @@ class Client {
       suite_id,
       test_id,
       timestamp,
+      links,
       manuallyAttachedArtifacts,
-      labels,
       overwrite,
     } = testData;
     let { message = '', meta = {} } = testData;
@@ -190,41 +190,13 @@ class Client {
     // stringify meta values and limit keys and values length to 255
     meta = Object.entries(meta)
       .filter(([, value]) => value !== null && value !== undefined)
-      .map(([key, value]) => {
-        try {
-          if (typeof value === 'object') {
-            value = JSON.stringify(value);
-          } else if (typeof value !== 'string') {
-            try {
-              value = value.toString();
-            } catch (err) {
-              console.warn(APP_PREFIX, `Can't convert meta value to string`, err);
-            }
-          }
-
-          if (value?.length > 255) {
-            value = value.substring(0, 255);
-            debug(APP_PREFIX, `Meta info value "${value}" is too long, trimmed to 255 characters`);
-          }
-
-          if (key?.length > 255) {
-            const newKey = key.substring(0, 255);
-            debug(APP_PREFIX, `Meta info key "${key}" is too long, trimmed to 255 characters`);
-            return [newKey, value];
-          }
-
-          return [key, value];
-        } catch (err) {
-          debug(APP_PREFIX, `Error while processing meta info key ${key}`, err);
-          return [null, null];
-        }
-      })
       .reduce((acc, [key, value]) => {
         if (key) acc[key] = value;
         return acc;
       }, {});
 
-    // Labels are simple array of strings, no processing needed
+    // Get links from storage using the test context
+    const testContext = suite_title ? `${suite_title} ${title}` : title;
 
     let errorFormatted = '';
     if (error) {
@@ -280,7 +252,7 @@ class Client {
       timestamp,
       artifacts,
       meta,
-      labels,
+      links,
       overwrite,
       ...(rootSuiteId && { root_suite_id: rootSuiteId }),
     };

package/src/data-storage.js

@@ -6,8 +6,6 @@ import { TESTOMAT_TMP_STORAGE_DIR } from './constants.js';
 import { fileSystem, testRunnerHelper } from './utils/utils.js';
 import crypto from 'crypto';
 
-const startTime = Date.now();
-
 const debug = createDebugMessages('@testomatio/reporter:storage');
 class DataStorage {
   static #instance;
@@ -43,7 +41,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' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} 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
@@ -72,7 +70,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' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} 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)
    */
@@ -110,7 +108,7 @@ class DataStorage {
   }
 
   /**
-   * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
    * @param {string} context
    * @returns aray of data (any type)
    */
@@ -118,7 +116,7 @@ class DataStorage {
     try {
       if (global?.testomatioDataStore[dataType]) {
         const testData = global.testomatioDataStore[dataType][context];
-        if (testData) debug(`"${dataType}" data for constext "${context}":`, testData.join(', '));
+        if (testData) debug('<=', dataType, 'global', context, testData);
         return testData || [];
       }
       // debug(`No ${this.dataType} data for context ${context} in <global> storage`);
@@ -129,7 +127,7 @@ class DataStorage {
   }
 
   /**
-   * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
    * @param {*} context
    * @returns array of data (any type)
    */
@@ -139,7 +137,7 @@ class DataStorage {
       const filepath = join(dataDirPath, `${dataType}_${context}`);
       if (fs.existsSync(filepath)) {
         const testDataAsText = fs.readFileSync(filepath, 'utf-8');
-        if (testDataAsText) debug(`"${dataType}" data for context "${context}":`, testDataAsText);
+        if (testDataAsText) debug('<=', dataType, 'file', context, testDataAsText);
         const testDataArr = testDataAsText?.split(os.EOL) || [];
         return testDataArr;
       }
@@ -153,12 +151,12 @@ 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' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
    * @param {*} data
    * @param {*} context
    */
   #putDataToGlobalVar(dataType, data, context) {
-    debug('Saving data to global variable for ', context, ':', data);
+    debug('=>', dataType, 'global', context, data);
     if (!global.testomatioDataStore) global.testomatioDataStore = {};
     if (!global.testomatioDataStore?.[dataType]) global.testomatioDataStore[dataType] = {};
 
@@ -168,7 +166,7 @@ class DataStorage {
 
   /**
    * Puts data to file. Unlike the global variable storage, stores data as string
-   * @param {'log' | 'artifact' | 'keyvalue' | 'labels'} dataType
+   * @param {'log' | 'artifact' | 'keyvalue' | 'links'} dataType
    * @param {*} data
    * @param {string} context
    * @returns
@@ -179,7 +177,7 @@ class DataStorage {
     const filename = `${dataType}_${context}`;
     const filepath = join(dataDirPath, filename);
     if (!fs.existsSync(dataDirPath)) fileSystem.createDir(dataDirPath);
-    debug(`Saving data to file for context "${context}" to ${filepath}. Data: ${JSON.stringify(data)}`);
+    debug('=>', dataType, 'file', context, data);
 
     // append new line if file already exists (in this case its definitely includes some data)
     if (fs.existsSync(filepath)) {
@@ -194,8 +192,7 @@ function stringToMD5Hash(str) {
   const md5 = crypto.createHash('md5');
   md5.update(str);
   const hash = md5.digest('hex');
-
-  return `${startTime}_${hash}`;
+  return `${process.env.runId || 'run'}_${hash}`;
 }
 
 export const dataStorage = DataStorage.getInstance();

package/src/pipe/testomatio.js

@@ -119,8 +119,7 @@ class TestomatioPipe {
       const resp = await this.client.request({
         method: 'GET',
         url: '/api/test_grep',
-        params: q.params,
-        responseType: q.responseType
+        ...q,
       });
 
       if (Array.isArray(resp.data?.tests) && resp.data?.tests?.length > 0) {
@@ -188,7 +187,8 @@ class TestomatioPipe {
       const resp = await this.client.request({
         method: 'PUT',
         url: `/api/reporter/${this.runId}`,
-        data: runParams
+        data: runParams,
+        responseType: 'json'
       });
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;

package/src/reporter-functions.js

@@ -3,6 +3,8 @@ 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)
@@ -14,7 +16,8 @@ function saveArtifact(data, context = null) {
 
 /**
  * Attach log message(s) to the test report
- * @param  string
+ * @param {...any} args - log messages to attach
+ * @returns {void}
  */
 function logMessage(...args) {
   if (process.env.IS_PLAYWRIGHT) throw new Error('This function is not available in Playwright framework');
@@ -23,7 +26,8 @@ function logMessage(...args) {
 
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {string} message
+ * @param {string} message - step message
+ * @returns {void}
  */
 function addStep(message) {
   if (process.env.IS_PLAYWRIGHT)
@@ -34,8 +38,9 @@ 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?} value
+ * @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}
  */
 function setKeyValue(keyValue, value = null) {
   if (process.env.IS_PLAYWRIGHT)
@@ -50,46 +55,37 @@ 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} [value] - optional label value (e.g. 'high', 'login')
+ * @param {string|null} [value=null] - optional label value (e.g. 'high', 'login')
+ * @returns {void}
  */
 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;
-  }
-
-  // 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}`;
+    return value.forEach(label => setLabel(key, label));
   }
+  const labelObject = value !== null && value !== undefined && value !== ''
+    ? { label: `${key}:${value}` }
+    : { label: key };
+  services.links.put([labelObject]);
+}
 
-  // 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);
-  }
+/**
+ * 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 }));
+  services.links.put(links);
+}
 
-  services.labels.put([labelString]);
+/**
+ * Add JIRA issue link(s) to the test report
+ * @param {...string} jiraIds - JIRA issue IDs to link
+ * @returns {void}
+ */
+function linkJira(...jiraIds) {
+  const links = jiraIds.map(jiraId => ({ jira: jiraId }));
+  services.links.put(links);
 }
 
 export default {
@@ -98,4 +94,6 @@ export default {
   step: addStep,
   keyValue: setKeyValue,
   label: setLabel,
+  linkTest,
+  linkJira,
 };

package/src/reporter.js

@@ -9,14 +9,15 @@ export const logger = services.logger;
 export const meta = reporterFunctions.keyValue;
 export const step = reporterFunctions.step;
 export const label = reporterFunctions.label;
+export const linkTest = reporterFunctions.linkTest;
 
 /**
- * @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
+ * @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
  */
 export default {
   /**
@@ -30,6 +31,7 @@ export default {
   meta: reporterFunctions.keyValue,
   step: reporterFunctions.step,
   label: reporterFunctions.label,
+  linkTest: reporterFunctions.linkTest,
 
   // TestomatClient,
   // TRConstants,

package/src/services/index.js

@@ -1,14 +1,14 @@
 import { logger } from './logger.js';
 import { artifactStorage } from './artifacts.js';
 import { keyValueStorage } from './key-values.js';
-import { labelStorage } from './labels.js';
+import { linkStorage } from './links.js';
 import { dataStorage } from '../data-storage.js';
 
 export const services = {
   logger,
   artifacts: artifactStorage,
   keyValues: keyValueStorage,
-  labels: labelStorage,
+  links: linkStorage,
   setContext: context => {
     dataStorage.setContext(context);
   },

package/src/services/labels.js

@@ -1,59 +1 @@
-import createDebugMessages from 'debug';
-import { dataStorage } from '../data-storage.js';
 
-const debug = createDebugMessages('@testomatio/reporter:services-labels');
-class LabelStorage {
-  static #instance;
-
-  /**
-   *
-   * @returns {LabelStorage}
-   */
-  static getInstance() {
-    if (!this.#instance) {
-      this.#instance = new LabelStorage();
-    }
-    return this.#instance;
-  }
-
-  /**
-   * Stores labels array and passes it to reporter
-   * @param {string[]} labels - array of label strings
-   * @param {*} context - full test title
-   */
-  put(labels, context = null) {
-    if (!labels || !Array.isArray(labels)) return;
-    dataStorage.putData('labels', labels, context);
-  }
-
-  /**
-   * Returns labels array for the test
-   * @param {*} context testId or test context from test runner
-   * @returns {string[]} labels array, e.g. ['smoke', 'severity:high', 'feature:user_account']
-   */
-  get(context = null) {
-    const labelsList = dataStorage.getData('labels', context);
-    if (!labelsList || !labelsList?.length) return [];
-
-    const allLabels = [];
-    for (const labels of labelsList) {
-      if (Array.isArray(labels)) {
-        allLabels.push(...labels);
-      } else if (typeof labels === 'string') {
-        try {
-          const parsedLabels = JSON.parse(labels);
-          if (Array.isArray(parsedLabels)) {
-            allLabels.push(...parsedLabels);
-          }
-        } catch (e) {
-          debug(`Error parsing labels for test ${context}`, labels);
-        }
-      }
-    }
-
-    // Remove duplicates
-    return [...new Set(allLabels)];
-  }
-}
-
-export const labelStorage = LabelStorage.getInstance();

package/src/services/links.js

@@ -0,0 +1,69 @@
+import createDebugMessages from 'debug';
+import { dataStorage } from '../data-storage.js';
+
+const debug = createDebugMessages('@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;
+    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 = 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;
+  }
+}
+
+export const linkStorage = LinkStorage.getInstance();

package/src/utils/utils.js

@@ -53,7 +53,7 @@ const parseSuite = suiteTitle => {
  */
 const validateSuiteId = suiteId => {
   if (!suiteId) return null;
-  
+
   const match = suiteId.match(SUITE_ID_REGEX);
   return match ? match[0] : null;
 };
@@ -273,7 +273,7 @@ const fileSystem = {
 const foundedTestLog = (app, tests) => {
   const n = tests.length;
 
-  return n === 1 ? console.log(app, `✅ We found one test!`) : console.log(app, `✅ We found ${n} tests!`);
+  return console.log(app, `✅ We found ${n === 1 ? 'one test' : `${n} tests`} in Testomat.io!`);
 };
 
 const humanize = text => {
@@ -354,12 +354,14 @@ function storeRunId(runId) {
 }
 
 /**
- * 
+ *
  * @returns {String|null} latest run ID
  */
 function readLatestRunId() {
   try {
     const filePath = path.join(os.tmpdir(), `testomatio.latest.run`);
+    if (!fs.existsSync(filePath)) return null;
+    
     const stats = fs.statSync(filePath);
     const diff = +new Date() - +stats.mtime;
     const diffHours = diff / 1000 / 60 / 60;