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

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)
@@ -48,48 +53,32 @@ function setKeyValue(keyValue, value = null) {
 }
 
 /**
- * Add a single label to the test report
+ * Add label(s) 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|string[]|null} [value=null] - optional label value(s) (e.g. 'high', 'login') or array of values
+ * @returns {void}
  */
 function setLabel(key, value = null) {
   if (Array.isArray(value)) {
-    value.forEach(v => setLabel(key, v));
+    value.forEach(val => setLabel(key, val));
     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}`;
-  }
+  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);
-  }
 
-  services.labels.put([labelString]);
+/**
+ * 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);
 }
 
 export default {
@@ -98,4 +87,5 @@ export default {
   step: addStep,
   keyValue: setKeyValue,
   label: setLabel,
+  linkTest,
 };

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

@@ -23,7 +23,7 @@ class LabelStorage {
    */
   put(labels, context = null) {
     if (!labels || !Array.isArray(labels)) return;
-    dataStorage.putData('labels', labels, context);
+    dataStorage.putData('links', labels, context);
   }
 
   /**
@@ -32,7 +32,7 @@ class LabelStorage {
    * @returns {string[]} labels array, e.g. ['smoke', 'severity:high', 'feature:user_account']
    */
   get(context = null) {
-    const labelsList = dataStorage.getData('labels', context);
+    const labelsList = dataStorage.getData('links', context);
     if (!labelsList || !labelsList?.length) return [];
 
     const allLabels = [];

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;

package/lib/utils/cli_utils.d.ts

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