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

package/lib/reporter-functions.js

@@ -4,6 +4,8 @@ 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)
@@ -15,7 +17,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)
@@ -24,7 +27,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)
@@ -33,8 +37,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)
@@ -47,41 +52,35 @@ 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}`;
-    }
-    // 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);
+        return value.forEach(label => setLabel(key, label));
     }
-    index_js_1.services.labels.put([labelString]);
+    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);
+}
+/**
+ * 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 }));
+    index_js_1.services.links.put(links);
 }
 module.exports = {
     artifact: saveArtifact,
@@ -89,4 +88,6 @@ module.exports = {
     step: addStep,
     keyValue: setKeyValue,
     label: setLabel,
+    linkTest,
+    linkJira,
 };

package/lib/reporter.d.ts

@@ -1,12 +1,9 @@
-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;
@@ -75,14 +72,12 @@ 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 type label = typeof import("./reporter-functions.js");
-export const label: (key: string, value?: string) => void;
+export const label: (key: string, value?: string | null) => void;
+export const linkTest: (...testIds: string[]) => void;
 declare namespace _default {
     let testomatioLogger: {
         "__#13@#originalUserLogger": {
@@ -230,6 +225,13 @@ declare namespace _default {
         [key: string]: string;
     } | string, value?: string | null) => void;
     let step: (message: string) => void;
-    let label: (key: string, value?: string) => void;
+    let label: (key: string, value?: string | null) => void;
+    let linkTest: (...testIds: 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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
+exports.linkTest = exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
 // import TestomatClient from './client.js';
 // import * as TRConstants from './constants.js';
 const index_js_1 = require("./services/index.js");
@@ -14,13 +14,14 @@ exports.logger = index_js_1.services.logger;
 exports.meta = reporter_functions_js_1.default.keyValue;
 exports.step = reporter_functions_js_1.default.step;
 exports.label = reporter_functions_js_1.default.label;
+exports.linkTest = reporter_functions_js_1.default.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
  */
 module.exports = {
     /**
@@ -33,6 +34,7 @@ module.exports = {
     meta: reporter_functions_js_1.default.keyValue,
     step: reporter_functions_js_1.default.step,
     label: reporter_functions_js_1.default.label,
+    linkTest: reporter_functions_js_1.default.linkTest,
     // TestomatClient,
     // TRConstants,
 };

package/lib/services/index.d.ts

@@ -2,10 +2,10 @@ export namespace services {
     export { logger };
     export { artifactStorage as artifacts };
     export { keyValueStorage as keyValues };
-    export { labelStorage as labels };
+    export { linkStorage as links };
     export function setContext(context: any): void;
 }
 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';

package/lib/services/index.js

@@ -4,13 +4,13 @@ exports.services = void 0;
 const logger_js_1 = require("./logger.js");
 const artifacts_js_1 = require("./artifacts.js");
 const key_values_js_1 = require("./key-values.js");
-const labels_js_1 = require("./labels.js");
+const links_js_1 = require("./links.js");
 const data_storage_js_1 = require("../data-storage.js");
 exports.services = {
     logger: logger_js_1.logger,
     artifacts: artifacts_js_1.artifactStorage,
     keyValues: key_values_js_1.keyValueStorage,
-    labels: labels_js_1.labelStorage,
+    links: links_js_1.linkStorage,
     setContext: context => {
         data_storage_js_1.dataStorage.setContext(context);
     },

package/lib/services/labels.d.ts

@@ -1,22 +0,0 @@
-export const labelStorage: LabelStorage;
-declare class LabelStorage {
-    static "__#16@#instance": any;
-    /**
-     *
-     * @returns {LabelStorage}
-     */
-    static getInstance(): LabelStorage;
-    /**
-     * Stores labels array and passes it to reporter
-     * @param {string[]} labels - array of label strings
-     * @param {*} context - full test title
-     */
-    put(labels: string[], context?: any): void;
-    /**
-     * 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?: any): string[];
-}
-export {};

package/lib/services/labels.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.labelStorage = 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-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;
-        data_storage_js_1.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 = data_storage_js_1.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)];
-    }
-}
-exports.labelStorage = LabelStorage.getInstance();

package/lib/services/links.d.ts

@@ -1,6 +1,6 @@
 export const linkStorage: LinkStorage;
 declare class LinkStorage {
-    static "__#13@#instance": any;
+    static "__#16@#instance": any;
     /**
      *
      * @returns {LinkStorage}

package/lib/utils/utils.js

@@ -321,7 +321,7 @@ const fileSystem = {
 exports.fileSystem = 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!`);
 };
 exports.foundedTestLog = foundedTestLog;
 const humanize = text => {
@@ -399,6 +399,8 @@ function storeRunId(runId) {
 function readLatestRunId() {
     try {
         const filePath = path_1.default.join(os_1.default.tmpdir(), `testomatio.latest.run`);
+        if (!fs_1.default.existsSync(filePath))
+            return null;
         const stats = fs_1.default.statSync(filePath);
         const diff = +new Date() - +stats.mtime;
         const diffHours = diff / 1000 / 60 / 60;

package/package.json

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

package/src/adapter/codecept.js

@@ -25,6 +25,9 @@ const HOOK_EXECUTION_ORDER = {
   POST_TEST: ['AfterHook', 'AfterSuiteHook']
 };
 
+// codeceptjs workers are self-contained
+dataStorage.isFileStorage = false;
+
 const DATA_REGEXP = /[|\s]+?(\{".*\}|\[.*\])/;
 
 if (MAJOR_VERSION < 3) {
@@ -54,8 +57,6 @@ function CodeceptReporter(config) {
     say: output.say,
   };
 
-  output.stepShift = 0;
-
   output.debug = function(msg) {
     originalOutput.debug(msg);
     dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.cyan(msg.toString()));
@@ -71,6 +72,7 @@ function CodeceptReporter(config) {
     originalOutput.log(msg);
     dataStorage.putData('log', repeat(this?.stepShift || 0) + pc.gray(msg));
   };
+  output.stepShift = 0;
 
   recorder.startUnlessRunning();
 
@@ -164,7 +166,7 @@ function CodeceptReporter(config) {
     const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
     const keyValues = services.keyValues.get(test.fullTitle());
     const stepHierarchy = buildUnifiedStepHierarchy(test.steps, hookSteps);
-    const labels = services.labels.get(test.fullTitle());
+    const links = services.links.get(test.fullTitle());
 
     services.setContext(null);
 
@@ -179,7 +181,7 @@ function CodeceptReporter(config) {
       files,
       steps: stepHierarchy, // Array of step objects per API schema
       logs,
-      labels,
+      links,
       manuallyAttachedArtifacts,
       meta: { ...keyValues, ...test.meta },
     });

package/src/adapter/cucumber/current.js

@@ -113,6 +113,7 @@ class CucumberReporter extends Formatter {
     const logs = services.logger.getLogs(testTitle).join('\n');
     const artifacts = services.artifacts.get(testTitle);
     const keyValues = services.keyValues.get(testTitle);
+    const links = services.links.get(testTitle);
 
     this.client.addTestRun(status, {
       // error: testCaseAttempt.worstTestStepResult.message,
@@ -123,6 +124,7 @@ class CucumberReporter extends Formatter {
         .trim(),
       example: { ...example },
       logs,
+      links,
       manuallyAttachedArtifacts: artifacts,
       meta: keyValues,
       title: scenario,

package/src/adapter/jest.js

@@ -59,6 +59,7 @@ export class JestReporter {
       const logs = getTestLogs(result);
       const artifacts = services.artifacts.get(result.fullName);
       const keyValues = services.keyValues.get(result.fullName);
+      const links = services.links.get(result.fullName);
 
       const deducedStatus = status === 'pending' ? 'skipped' : status;
       // In jest if test is not matched with test name pattern it is considered as skipped.
@@ -72,6 +73,7 @@ export class JestReporter {
           title,
           time: duration,
           logs,
+          links,
           manuallyAttachedArtifacts: artifacts,
           meta: keyValues,
         });

package/src/adapter/mocha.js

@@ -61,6 +61,7 @@ function MochaReporter(runner, opts) {
     const logs = getTestLogs(test);
     const artifacts = services.artifacts.get(test.fullTitle());
     const keyValues = services.keyValues.get(test.fullTitle());
+    const links = services.links.get(test.fullTitle());
 
     client.addTestRun(STATUS.PASSED, {
       test_id: testId,
@@ -72,6 +73,7 @@ function MochaReporter(runner, opts) {
       logs,
       manuallyAttachedArtifacts: artifacts,
       meta: keyValues,
+      links,
     });
   });
 
@@ -79,6 +81,10 @@ function MochaReporter(runner, opts) {
     skipped += 1;
     console.log('skip: %s', test.fullTitle());
     const testId = getTestomatIdFromTestTitle(test.title);
+    const artifacts = services.artifacts.get(test.fullTitle());
+    const keyValues = services.keyValues.get(test.fullTitle());
+    const links = services.links.get(test.fullTitle());
+    
     client.addTestRun(STATUS.SKIPPED, {
       title: getTestName(test),
       suite_title: getSuiteTitle(test),
@@ -86,6 +92,9 @@ function MochaReporter(runner, opts) {
       file: getFile(test),
       test_id: testId,
       time: test.duration,
+      manuallyAttachedArtifacts: artifacts,
+      meta: keyValues,
+      links,
     });
   });
 
@@ -95,6 +104,9 @@ function MochaReporter(runner, opts) {
     const testId = getTestomatIdFromTestTitle(test.title);
 
     const logs = getTestLogs(test);
+    const artifacts = services.artifacts.get(test.fullTitle());
+    const keyValues = services.keyValues.get(test.fullTitle());
+    const links = services.links.get(test.fullTitle());
 
     client.addTestRun(STATUS.FAILED, {
       error: err,
@@ -105,6 +117,9 @@ function MochaReporter(runner, opts) {
       code: process.env.TESTOMATIO_UPDATE_CODE ? test.body.toString() : '',
       time: test.duration,
       logs,
+      manuallyAttachedArtifacts: artifacts,
+      meta: keyValues,
+      links,
     });
   });
 

package/src/adapter/playwright.js

@@ -58,6 +58,7 @@ class PlaywrightReporter {
     }
     const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
     const testMeta = services.keyValues.get(fullTestTitle);
+    const links = services.links.get(fullTestTitle);
     const rid = test.id || test.testId || uuidv4();
 
     /**
@@ -95,6 +96,7 @@ class PlaywrightReporter {
       steps: steps.length ? steps : undefined,
       time: duration,
       logs,
+      links,
       manuallyAttachedArtifacts,
       meta: {
         browser: project.browser,

package/src/adapter/webdriver.js

@@ -52,12 +52,10 @@ class WebdriverReporter extends WDIOReporter {
   onTestEnd(test) {
     test.suite = test.parent;
     const logs = getTestLogs(test.fullTitle);
-    // TODO: FIX: artifacts for some reason leads to empty report on Testomat.io
-    // const artifacts = services.artifacts.get(test.fullTitle);
-    // const keyValues = services.keyValues.get(test.fullTitle);
+    test.artifacts = services.artifacts.get(test.fullTitle);
+    test.meta = services.keyValues.get(test.fullTitle);
+    test.links = services.links.get(test.fullTitle);
     test.logs = logs;
-    // test.artifacts = artifacts;
-    // test.meta = keyValues;
 
     this._addTestPromises.push(this.addTest(test));
   }
@@ -72,7 +70,7 @@ class WebdriverReporter extends WDIOReporter {
   async addTest(test) {
     if (!this.client) return;
 
-    const { title, _duration: duration, state, error, output } = test;
+    const { title, _duration: duration, state, error, output, links, artifacts, meta, logs } = test;
 
     const testId = getTestomatIdFromTestTitle(title);
 
@@ -83,10 +81,11 @@ class WebdriverReporter extends WDIOReporter {
 
     await this.client.addTestRun(state, {
       rid: test.uid || '',
-      manuallyAttachedArtifacts: test.artifacts,
+      manuallyAttachedArtifacts: artifacts,
       error,
-      logs: test.logs,
-      meta: test.meta,
+      logs,
+      meta,
+      links,
       title,
       test_id: testId,
       time: duration,