@testomatio/reporter 2.6.0 → 2.6.1

package/lib/pipe/testomatio.js

@@ -234,6 +234,15 @@ class TestomatioPipe {
             });
             if (resp.data.artifacts)
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
+            if (resp.data.url) {
+                const respUrl = new URL(resp.data.url);
+                this.runUrl = `${this.url}${respUrl.pathname}`;
+                this.runPublicUrl = resp.data.public_url;
+                this.store.runUrl = this.runUrl;
+                this.store.runPublicUrl = this.runPublicUrl;
+                console.log(constants_js_1.APP_PREFIX, '📊 Using existing run. Report ID:', this.runId);
+                console.log(constants_js_1.APP_PREFIX, '📊 Report URL:', picocolors_1.default.magenta(this.runUrl));
+            }
             return;
         }
         debug('Creating run...');
@@ -514,7 +523,9 @@ function printCreateIssue() {
  * @returns {string}
  */
 function hideTestomatioToken(data) {
-    return data.replace(/"api_key": "[^"]+"/g, '"api_key": "<hidden>"').replace(/"(tstmt_[^"]+)"/g, 'tstmt_***');
+    return (typeof data === 'string' ? data : '')
+        .replace(/"api_key"\s*:\s*"[^"]+"/g, '"api_key": "<hidden>"')
+        .replace(/"(tstmt_[^"]+)"/g, '"tstmt_***"');
 }
 /**
  * Stringifies provided data

package/lib/reporter-functions.d.ts

@@ -39,29 +39,54 @@ declare function addStep(message: string, logs?: {
 }): 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
+ * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) OR key (string)
+ * @param {string|undefined} [value=undefined] - optional value when keyValue is a string
  * @returns {void}
+ *
+ * @example
+ * meta('key', 'value');
+ * meta({ key: 'value' });
+ * meta({ key1: 'value1', key2: 'value2' });
  */
 declare function setKeyValue(keyValue: {
     [key: string]: string;
-} | string, value?: string | null): void;
+} | string, value?: string | undefined): void;
 /**
- * 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')
+ * Adds label(s) to the test
+ * @param {string | {
+ * [key: string]: string}
+ * } key - just label OR custom field name OR object with custom field name and value
+ * @param {string | null} [value=null] - optional label value (of custom field value)
+ * (used when key is a string)
  * @returns {void}
+ *
+ * @example
+ * label('high');
+ * label('priority', 'high');
+ * label({priority: 'high'});
  */
-declare function setLabel(key: string, value?: string | null): void;
+declare function setLabel(key: string | {
+    [key: string]: string;
+}, value?: string | null): void;
 /**
  * Add link(s) to the test report
- * @param {...string} testIds - test IDs to link
+ * @param {...string | string[]} testIds - test IDs to link
  * @returns {void}
+ *
+ * @example
+ * linkTest('T11111111', 'T22222222')
+ * or
+ * linkTest(['T11111111', 'T22222222'])
  */
-declare function linkTest(...testIds: string[]): void;
+declare function linkTest(...testIds: (string | string[])[]): void;
 /**
  * Add JIRA issue link(s) to the test report
- * @param {...string} jiraIds - JIRA issue IDs to link
+ * @param {...(string | string[])} jiraIds - JIRA issue IDs to link
  * @returns {void}
+ *
+ * @example
+ * linkJira('TICKET-1', 'TICKET-2')
+ * or
+ * linkJira(['TICKET-1', 'TICKET-2'])
  */
-declare function linkJira(...jiraIds: string[]): void;
+declare function linkJira(...jiraIds: (string | string[])[]): void;

package/lib/reporter-functions.js

@@ -1,7 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const playwright_js_1 = require("./adapter/utils/playwright.js");
 const helpers_js_1 = require("./helpers.js");
 const index_js_1 = require("./services/index.js");
+const picocolors_1 = __importDefault(require("picocolors"));
 /**
  * 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
@@ -9,7 +14,9 @@ const index_js_1 = require("./services/index.js");
  * @returns {void}
  */
 function saveArtifact(data, context = null) {
-    showPlaywrightWarning('artifact', 'Playwright supports artifacts out of the box.');
+    if (helpers_js_1.isPlaywright)
+        console.warn(`[TESTOMATIO] 'artifact' function is not supported for Playwright
+   Playwright supports artifacts out of the box.`);
     if (!data)
         return;
     index_js_1.services.artifacts.put(data, context);
@@ -42,62 +49,97 @@ function addStep(message, logs) {
 }
 /**
  * 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
+ * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) OR key (string)
+ * @param {string|undefined} [value=undefined] - optional value when keyValue is a string
  * @returns {void}
+ *
+ * @example
+ * meta('key', 'value');
+ * meta({ key: 'value' });
+ * meta({ key1: 'value1', key2: 'value2' });
  */
-function setKeyValue(keyValue, value = null) {
-    showPlaywrightWarning('meta', 'Use test annotations instead.');
+function setKeyValue(keyValue, value = undefined) {
+    // in this case keyValue acts as key (value passed as second argument)
     if (typeof keyValue === 'string') {
-        keyValue = { [keyValue]: value };
+        const key = keyValue;
+        keyValue = { [key]: value };
+    }
+    if (helpers_js_1.isPlaywright) {
+        console.log(`${playwright_js_1.playwrightLogsMarkers.meta} ${JSON.stringify(keyValue)}`);
+        return;
     }
+    // in this case keyValue is expected to be an object
     index_js_1.services.keyValues.put(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')
+ * Adds label(s) to the test
+ * @param {string | {
+ * [key: string]: string}
+ * } key - just label OR custom field name OR object with custom field name and value
+ * @param {string | null} [value=null] - optional label value (of custom field value)
+ * (used when key is a string)
  * @returns {void}
+ *
+ * @example
+ * label('high');
+ * label('priority', 'high');
+ * label({priority: 'high'});
  */
 function setLabel(key, value = null) {
-    showPlaywrightWarning('label', 'Use test tag instead.');
-    if (Array.isArray(value)) {
-        return value.forEach(label => setLabel(key, label));
+    let labelsArr = [];
+    // process label('priority', 'high') and label('high'
+    if (typeof key === 'string') {
+        labelsArr = [value ? `${key}:${value}` : key];
+        // process label({priority: 'high'}), label({priority: 'high', scope: 'smoke'})
+    }
+    else if (key !== null && typeof key === 'object') {
+        labelsArr = Object.entries(key).map(([key, value]) => `${key}:${value}`);
     }
-    const labelObject = value !== null && value !== undefined && value !== '' ? { label: `${key}:${value}` } : { label: key };
-    index_js_1.services.links.put([labelObject]);
+    const labels = labelsArr.map(l => ({ label: l }));
+    if (helpers_js_1.isPlaywright) {
+        console.log(`${playwright_js_1.playwrightLogsMarkers.label} ${JSON.stringify(labels)}`);
+        return;
+    }
+    index_js_1.services.links.put(labels);
 }
 /**
  * Add link(s) to the test report
- * @param {...string} testIds - test IDs to link
+ * @param {...string | string[]} testIds - test IDs to link
  * @returns {void}
+ *
+ * @example
+ * linkTest('T11111111', 'T22222222')
+ * or
+ * linkTest(['T11111111', 'T22222222'])
  */
 function linkTest(...testIds) {
+    const testIdsArr = testIds.flat();
+    const links = testIdsArr.map(testId => ({ test: testId }));
     if (helpers_js_1.isPlaywright) {
-        console.log(`[TESTOMATIO-LINK-TESTS] ${JSON.stringify(testIds)}`);
+        console.log(`${playwright_js_1.playwrightLogsMarkers.linkTest} ${JSON.stringify(links)}`);
         return;
     }
-    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
+ * @param {...(string | string[])} jiraIds - JIRA issue IDs to link
  * @returns {void}
+ *
+ * @example
+ * linkJira('TICKET-1', 'TICKET-2')
+ * or
+ * linkJira(['TICKET-1', 'TICKET-2'])
  */
 function linkJira(...jiraIds) {
+    const jiraIdsArr = jiraIds.flat();
+    const links = jiraIdsArr.map(jiraId => ({ jira: jiraId }));
     if (helpers_js_1.isPlaywright) {
-        console.log(`[TESTOMATIO-LINK-JIRA] ${JSON.stringify(jiraIds)}`);
+        console.log(`${playwright_js_1.playwrightLogsMarkers.linkJira} ${JSON.stringify(links)}`);
         return;
     }
-    const links = jiraIds.map(jiraId => ({ jira: jiraId }));
     index_js_1.services.links.put(links);
 }
-function showPlaywrightWarning(functionName, recommendation) {
-    if (helpers_js_1.isPlaywright) {
-        console.warn(`[TESTOMATIO] '${functionName}' function is not supported for Playwright. ${recommendation}`);
-    }
-}
 module.exports = {
     artifact: saveArtifact,
     log: logMessage,

package/lib/reporter.d.ts

@@ -82,13 +82,15 @@ export const logger: {
 };
 export const meta: (keyValue: {
     [key: string]: string;
-} | string, value?: string | null) => void;
+} | string, value?: string | undefined) => void;
 export const step: (message: string, logs?: {
     [key: string]: any;
 }) => void;
-export const label: (key: string, value?: string | null) => void;
-export const linkTest: (...testIds: string[]) => void;
-export const linkJira: (...jiraIds: string[]) => void;
+export const label: (key: string | {
+    [key: string]: string;
+}, value?: string | null) => void;
+export const linkTest: (...testIds: (string | string[])[]) => void;
+export const linkJira: (...jiraIds: (string | string[])[]) => void;
 declare namespace _default {
     export let testomatioLogger: {
         "__#14@#originalUserLogger": {
@@ -236,13 +238,15 @@ declare namespace _default {
     };
     export let meta: (keyValue: {
         [key: string]: string;
-    } | string, value?: string | null) => void;
+    } | string, value?: string | undefined) => void;
     export let step: (message: string, logs?: {
         [key: string]: any;
     }) => void;
-    export let label: (key: string, value?: string | null) => void;
-    export let linkTest: (...testIds: string[]) => void;
-    export let linkJira: (...jiraIds: string[]) => void;
+    export let label: (key: string | {
+        [key: string]: string;
+    }, value?: string | null) => void;
+    export let linkTest: (...testIds: (string | string[])[]) => void;
+    export let linkJira: (...jiraIds: (string | string[])[]) => void;
     export { Client as TestomatioClient };
     export { STATUS };
 }