@testomatio/reporter 2.0.1-beta.5-timestamp → 2.0.1-beta.7

package/lib/reporter.js

@@ -1,30 +1,38 @@
-const TestomatClient = require('./client');
-const TRConstants = require('./constants');
-const { services } = require('./services');
-
-const reporterFunctions = require('./reporter-functions');
-
-const testomat = {
-  // TODO: deprecate in future; use log or testomat.log
-  testomatioLogger: services.logger,
-
-  artifact: reporterFunctions.artifact,
-  log: reporterFunctions.log,
-  logger: services.logger,
-  meta: reporterFunctions.keyValue,
-  step: reporterFunctions.step,
-
-  TestomatClient,
-  TRConstants,
+"use strict";
+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;
+// import TestomatClient from './client.js';
+// import * as TRConstants from './constants.js';
+const index_js_1 = require("./services/index.js");
+const reporter_functions_js_1 = __importDefault(require("./reporter-functions.js"));
+exports.artifact = reporter_functions_js_1.default.artifact;
+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 = {
+    /**
+     * @deprecated Use `log` or `testomat.log`
+     */
+    testomatioLogger: index_js_1.services.logger,
+    artifact: reporter_functions_js_1.default.artifact,
+    log: reporter_functions_js_1.default.log,
+    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,
 };
-
-module.exports = testomat;
-
-module.exports.testomatioLogger = testomat;
-module.exports.artifact = reporterFunctions.artifact;
-module.exports.log = reporterFunctions.log;
-module.exports.logger = services.logger;
-module.exports.meta = reporterFunctions.keyValue;
-module.exports.step = reporterFunctions.step;
-module.exports.TestomatClient = TestomatClient;
-module.exports.TRConstants = TRConstants;

package/lib/services/artifacts.d.ts

@@ -0,0 +1,33 @@
+export const artifactStorage: ArtifactStorage;
+/**
+ * Artifact storage is supposed to store file paths
+ */
+declare class ArtifactStorage {
+    static "__#14@#instance": any;
+    /**
+     * Singleton
+     * @returns {ArtifactStorage}
+     */
+    static getInstance(): ArtifactStorage;
+    /**
+     * 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 {*} context testId or test title
+     */
+    put(data: string | {
+        path: string;
+        type: string;
+        name: string;
+    }, context?: any): void;
+    /**
+     * Returns list of artifacts to upload
+     * @param {*} context testId or test context from test runner
+     * @returns {(string | {path: string, type: string, name: string})[]}
+     */
+    get(context: any): (string | {
+        path: string;
+        type: string;
+        name: string;
+    })[];
+}
+export {};

package/lib/services/artifacts.js

@@ -1,57 +1,61 @@
-const debug = require('debug')('@testomatio/reporter:services-artifacts');
-const { dataStorage } = require('../data-storage');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.artifactStorage = 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-artifacts');
 /**
  * Artifact storage is supposed to store file paths
  */
 class ArtifactStorage {
-  static #instance;
-
-  /**
-   * Singleton
-   * @returns {ArtifactStorage}
-   */
-  static getInstance() {
-    if (!this.#instance) {
-      this.#instance = new ArtifactStorage();
+    static #instance;
+    /**
+     * Singleton
+     * @returns {ArtifactStorage}
+     */
+    static getInstance() {
+        if (!this.#instance) {
+            this.#instance = new ArtifactStorage();
+        }
+        return this.#instance;
+    }
+    /**
+     * 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 {*} context testId or test title
+     */
+    put(data, context = null) {
+        if (!data)
+            return;
+        debug('Save artifact:', data);
+        data_storage_js_1.dataStorage.putData('artifact', data, context);
+    }
+    /**
+     * Returns list of artifacts to upload
+     * @param {*} context testId or test context from test runner
+     * @returns {(string | {path: string, type: string, name: string})[]}
+     */
+    get(context) {
+        let artifacts = data_storage_js_1.dataStorage.getData('artifact', context);
+        if (!artifacts || !artifacts.length)
+            return [];
+        artifacts = artifacts.map(artifactData => {
+            // artifact could be an object ({type, path, name} props) or string (just path)
+            let artifact;
+            try {
+                artifact = JSON.parse(artifactData);
+            }
+            catch (e) {
+                artifact = artifactData;
+            }
+            return artifact;
+        });
+        artifacts = artifacts.filter(artifact => !!artifact);
+        debug(`Artifacts for test ${context}:`, artifacts);
+        return artifacts.length ? artifacts : [];
     }
-    return this.#instance;
-  }
-
-  /**
-   * 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 {*} context testId or test title
-   */
-  put(data, context = null) {
-    if (!data) return;
-    debug('Save artifact:', data);
-    dataStorage.putData('artifact', data, context);
-  }
-
-  /**
-   * Returns list of artifacts to upload
-   * @param {*} context testId or test context from test runner
-   * @returns {(string | {path: string, type: string, name: string})[]}
-   */
-  get(context) {
-    let artifacts = dataStorage.getData('artifact', context);
-    if (!artifacts || !artifacts.length) return [];
-
-    artifacts = artifacts.map(artifactData => {
-      // artifact could be an object ({type, path, name} props) or string (just path)
-      let artifact;
-      try {
-        artifact = JSON.parse(artifactData);
-      } catch (e) {
-        artifact = artifactData;
-      }
-      return artifact;
-    });
-    artifacts = artifacts.filter(artifact => !!artifact);
-    debug(`Artifacts for test ${context}:`, artifacts);
-    return artifacts.length ? artifacts : [];
-  }
 }
-
-module.exports.artifactStorage = ArtifactStorage.getInstance();
+exports.artifactStorage = ArtifactStorage.getInstance();

package/lib/services/index.d.ts

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

@@ -1,13 +1,17 @@
-const { logger } = require('./logger');
-const { artifactStorage } = require('./artifacts');
-const { keyValueStorage } = require('./key-values');
-const { dataStorage } = require('../data-storage');
-
-module.exports.services = {
-  logger,
-  artifacts: artifactStorage,
-  keyValues: keyValueStorage,
-  setContext: context => {
-    dataStorage.setContext(context);
-  },
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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

@@ -0,0 +1,27 @@
+export const keyValueStorage: KeyValueStorage;
+declare class KeyValueStorage {
+    static "__#15@#instance": any;
+    /**
+     *
+     * @returns {KeyValueStorage}
+     */
+    static getInstance(): KeyValueStorage;
+    /**
+     * Stores key-value pair and passes it to reporter
+     * @param {{[key: string]: string}} keyValue - key-value pair(s) as object
+     * @param {*} context - full test title
+     */
+    put(keyValue: {
+        [key: string]: string;
+    }, context?: any): void;
+    /**
+     * Returns key-values pairs for the test as object
+     * @param {*} context testId or test context from test runner
+     * @returns {{[key: string]: string} | {}} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
+     */
+    get(context?: any): {
+        [key: string]: string;
+    } | {};
+    #private;
+}
+export {};

package/lib/services/key-values.js

@@ -1,58 +1,61 @@
-const debug = require('debug')('@testomatio/reporter:services-key-value');
-const { dataStorage } = require('../data-storage');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keyValueStorage = 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-key-value');
 class KeyValueStorage {
-  static #instance;
-
-  /**
-   *
-   * @returns {KeyValueStorage}
-   */
-  static getInstance() {
-    if (!this.#instance) {
-      this.#instance = new KeyValueStorage();
+    static #instance;
+    /**
+     *
+     * @returns {KeyValueStorage}
+     */
+    static getInstance() {
+        if (!this.#instance) {
+            this.#instance = new KeyValueStorage();
+        }
+        return this.#instance;
+    }
+    /**
+     * Stores key-value pair and passes it to reporter
+     * @param {{[key: string]: string}} keyValue - key-value pair(s) as object
+     * @param {*} context - full test title
+     */
+    put(keyValue, context = null) {
+        if (!keyValue)
+            return;
+        data_storage_js_1.dataStorage.putData('keyvalue', keyValue, context);
+    }
+    #isKeyValueObject(smth) {
+        return smth && typeof smth === 'object' && !Array.isArray(smth) && smth !== null;
     }
-    return this.#instance;
-  }
-
-  /**
-   * Stores key-value pair and passes it to reporter
-   * @param {{key: string}} keyValue - key-value pair(s) as object
-   * @param {*} context - full test title
-   */
-  put(keyValue, context = null) {
-    if (!keyValue) return;
-    dataStorage.putData('keyvalue', keyValue, context);
-  }
-
-  #isKeyValueObject(smth) {
-    return smth && typeof smth === 'object' && !Array.isArray(smth) && smth !== null;
-  }
-
-  /**
-   * Returns key-values pairs for the test as object
-   * @param {*} context testId or test context from test runner
-   * @returns {{[key: string]: string} | {}} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
-   */
-  get(context = null) {
-    const keyValuesList = dataStorage.getData('keyvalue', context);
-    if (!keyValuesList || !keyValuesList?.length) return {};
-
-    const keyValues = {};
-    for (const keyValue of keyValuesList) {
-      if (this.#isKeyValueObject(keyValue)) {
-        Object.assign(keyValues, keyValue);
-      } else if (typeof keyValue === 'string') {
-        try {
-          Object.assign(keyValues, JSON.parse(keyValue));
-        } catch (e) {
-          debug(`Error parsing key-values for test ${context}`, keyValue);
+    /**
+     * Returns key-values pairs for the test as object
+     * @param {*} context testId or test context from test runner
+     * @returns {{[key: string]: string} | {}} key-values pairs as object, e.g. {priority: 'high', browser: 'chrome'}
+     */
+    get(context = null) {
+        const keyValuesList = data_storage_js_1.dataStorage.getData('keyvalue', context);
+        if (!keyValuesList || !keyValuesList?.length)
+            return {};
+        const keyValues = {};
+        for (const keyValue of keyValuesList) {
+            if (this.#isKeyValueObject(keyValue)) {
+                Object.assign(keyValues, keyValue);
+            }
+            else if (typeof keyValue === 'string') {
+                try {
+                    Object.assign(keyValues, JSON.parse(keyValue));
+                }
+                catch (e) {
+                    debug(`Error parsing key-values for test ${context}`, keyValue);
+                }
+            }
         }
-      }
+        return keyValues;
     }
-
-    return keyValues;
-  }
 }
-
-module.exports.keyValueStorage = KeyValueStorage.getInstance();
+exports.keyValueStorage = KeyValueStorage.getInstance();

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

@@ -0,0 +1,64 @@
+export const logger: Logger;
+/**
+ * Logger allows to intercept logs from any logger (console.log, tracer, pino, etc)
+ * and save in the testomatio reporter.
+ * Supports different syntaxes to satisfy any user preferences.
+ */
+declare class Logger {
+    static "__#13@#instance": any;
+    /**
+     *
+     * @returns {Logger}
+     */
+    static getInstance(): Logger;
+    logLevel: string;
+    /**
+     * Allows you to define a step inside a test. Step name is attached to the report and
+     * helps to understand the test flow.
+     * @param {*} strings
+     * @param  {...any} values
+     */
+    step(strings: any, ...values: any[]): void;
+    /**
+     *
+     * @param {string} context testId or test context from test runner
+     * @returns {string[]}
+     */
+    getLogs(context: string): string[];
+    /**
+     * Tagget template literal. Allows to use different syntaxes:
+     * 1. Tagget template: log`text ${someVar}`
+     * 2. Standard: log(`text ${someVar}`)
+     * 3. Standard with multiple arguments: log('text', someVar)
+     */
+    _templateLiteralLog(strings: any, ...args: any[]): void;
+    assert(...args: any[]): void;
+    debug(...args: any[]): void;
+    error(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    trace(...args: any[]): void;
+    warn(...args: any[]): void;
+    /**
+     * Intercepts user logger messages.
+     * When call this method, Logger start to control the user logger
+     * @param {*} userLogger
+     */
+    intercept(userLogger: any): void;
+    stopInterception(): void;
+    /**
+     * Allows to configure logger. Make sure you do it before the logger usage in your code.
+     *
+     * @param {Object} [config={}] - The configuration object.
+     * @param {string} [config.logLevel] - The desired log level. Valid values are 'DEBUG', 'INFO', 'WARN', and 'ERROR'.
+     * @param {boolean} [config.prettyObjects] - Specifies whether to enable pretty printing of objects.
+     * @returns {void}
+     */
+    configure(config?: {
+        logLevel?: string;
+        prettyObjects?: boolean;
+    }): void;
+    prettyObjects: boolean;
+    #private;
+}
+export {};