@testomatio/reporter 2.1.0-beta-nightwatch → 2.1.0-beta.1-codeceptjs

package/lib/reporter.d.ts

@@ -8,7 +8,7 @@ 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: {
-    "__#12@#originalUserLogger": {
+    "__#13@#originalUserLogger": {
         assert(condition?: boolean, ...data: any[]): void;
         assert(value: any, message?: string, ...optionalParams: any[]): void;
         clear(): void;
@@ -53,13 +53,13 @@ export const logger: {
         profile(label?: string): void;
         profileEnd(label?: string): void;
     };
-    "__#12@#userLoggerWithOverridenMethods": any;
+    "__#13@#userLoggerWithOverridenMethods": any;
     logLevel: string;
     step(strings: any, ...values: any[]): void;
     getLogs(context: string): string[];
-    "__#12@#stringifyLogs"(...args: any[]): string;
+    "__#13@#stringifyLogs"(...args: any[]): string;
     _templateLiteralLog(strings: any, ...args: any[]): void;
-    "__#12@#logWrapper"(argsArray: any, level: any): void;
+    "__#13@#logWrapper"(argsArray: any, level: any): void;
     assert(...args: any[]): void;
     debug(...args: any[]): void;
     error(...args: any[]): void;
@@ -81,9 +81,11 @@ export const meta: (keyValue: {
 } | 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;
 declare namespace _default {
     let testomatioLogger: {
-        "__#12@#originalUserLogger": {
+        "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
             clear(): void;
@@ -128,13 +130,13 @@ declare namespace _default {
             profile(label?: string): void;
             profileEnd(label?: string): void;
         };
-        "__#12@#userLoggerWithOverridenMethods": any;
+        "__#13@#userLoggerWithOverridenMethods": any;
         logLevel: string;
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
-        "__#12@#stringifyLogs"(...args: any[]): string;
+        "__#13@#stringifyLogs"(...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
-        "__#12@#logWrapper"(argsArray: any, level: any): void;
+        "__#13@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
         debug(...args: any[]): void;
         error(...args: any[]): void;
@@ -157,7 +159,7 @@ declare namespace _default {
     }, context?: any) => void;
     let log: (...args: any[]) => void;
     let logger: {
-        "__#12@#originalUserLogger": {
+        "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
             clear(): void;
@@ -202,13 +204,13 @@ declare namespace _default {
             profile(label?: string): void;
             profileEnd(label?: string): void;
         };
-        "__#12@#userLoggerWithOverridenMethods": any;
+        "__#13@#userLoggerWithOverridenMethods": any;
         logLevel: string;
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
-        "__#12@#stringifyLogs"(...args: any[]): string;
+        "__#13@#stringifyLogs"(...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
-        "__#12@#logWrapper"(argsArray: any, level: any): void;
+        "__#13@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
         debug(...args: any[]): void;
         error(...args: any[]): void;
@@ -228,5 +230,6 @@ declare namespace _default {
         [key: string]: string;
     } | string, value?: string | null) => void;
     let step: (message: string) => void;
+    let label: (key: string, value?: string) => void;
 }
 export default _default;

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.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
+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");
@@ -13,12 +13,14 @@ exports.log = reporter_functions_js_1.default.log;
 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;
 /**
  * @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
  */
 module.exports = {
     /**
@@ -30,6 +32,7 @@ module.exports = {
     logger: index_js_1.services.logger,
     meta: reporter_functions_js_1.default.keyValue,
     step: reporter_functions_js_1.default.step,
+    label: reporter_functions_js_1.default.label,
     // TestomatClient,
     // TRConstants,
 };

package/lib/services/artifacts.d.ts

@@ -3,7 +3,7 @@ export const artifactStorage: ArtifactStorage;
  * Artifact storage is supposed to store file paths
  */
 declare class ArtifactStorage {
-    static "__#13@#instance": any;
+    static "__#14@#instance": any;
     /**
      * Singleton
      * @returns {ArtifactStorage}

package/lib/services/index.d.ts

@@ -2,8 +2,10 @@ export namespace services {
     export { logger };
     export { artifactStorage as artifacts };
     export { keyValueStorage as keyValues };
+    export { labelStorage as labels };
     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';

package/lib/services/index.js

@@ -4,11 +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 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,
     setContext: context => {
         data_storage_js_1.dataStorage.setContext(context);
     },

package/lib/services/key-values.d.ts

@@ -1,6 +1,6 @@
 export const keyValueStorage: KeyValueStorage;
 declare class KeyValueStorage {
-    static "__#14@#instance": any;
+    static "__#15@#instance": any;
     /**
      *
      * @returns {KeyValueStorage}

package/lib/services/labels.d.ts

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,62 @@
+"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/logger.d.ts

@@ -5,7 +5,7 @@ export const logger: Logger;
  * Supports different syntaxes to satisfy any user preferences.
  */
 declare class Logger {
-    static "__#12@#instance": any;
+    static "__#13@#instance": any;
     /**
      *
      * @returns {Logger}

package/lib/services/logger.js

@@ -90,7 +90,6 @@ class Logger {
             }
             else {
                 try {
-                    // eslint-disable-next-line no-unused-expressions
                     this.prettyObjects ? logs.push(JSON.stringify(arg, null, 2)) : logs.push(JSON.stringify(arg));
                 }
                 catch (e) {
@@ -119,7 +118,7 @@ class Logger {
                 current +
                 // strings are splitted by args when use tagged template, thus we add arg after each string
                 // it looks like: `string1 arg1 string2 arg2 string3`
-                (args[index] !== undefined // eslint-disable-line no-nested-ternary
+                (args[index] !== undefined
                     ? typeof args[index] === 'string'
                         ? args[index] // add arg as it is
                         : this.#stringifyLogs(args[index]) // stringify arg