@testomatio/reporter 1.6.13 → 2.0.1-beta-esm

package/lib/reporter-functions.d.ts

@@ -0,0 +1,34 @@
+declare namespace _default {
+    export { saveArtifact as artifact };
+    export { logMessage as log };
+    export { addStep as step };
+    export { setKeyValue as keyValue };
+}
+export default _default;
+/**
+ * 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
+ */
+declare function saveArtifact(data: string | {
+    path: string;
+    type: string;
+    name: string;
+}, context?: any): void;
+/**
+ * Attach log message(s) to the test report
+ * @param  string
+ */
+declare function logMessage(...args: any[]): void;
+/**
+ * Similar to "log" function but marks message in report as a step
+ * @param {string} message
+ */
+declare function addStep(message: string): 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?} value
+ */
+declare function setKeyValue(keyValue: {
+    [key: string]: string;
+} | string, value?: string | null): void;

package/lib/reporter-functions.js

@@ -1,50 +1,52 @@
-const { services } = require('./services');
-const { initPlaywrightForStorage } = require('./adapter/playwright');
-
-if (process.env.PLAYWRIGHT_TEST_BASE_URL) {
-  initPlaywrightForStorage();
-}
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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
  */
 function saveArtifact(data, context = null) {
-  if (!data) return;
-  services.artifacts.put(data, context);
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error(`This function is not available in Playwright framework.
+    /Playwright supports artifacts out of the box`);
+    if (!data)
+        return;
+    index_js_1.services.artifacts.put(data, context);
 }
-
 /**
  * Attach log message(s) to the test report
- * @param  {...any} args
+ * @param  string
  */
 function logMessage(...args) {
-  services.logger._templateLiteralLog(...args);
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework');
+    index_js_1.services.logger._templateLiteralLog(...args);
 }
-
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {*} message
+ * @param {string} message
  */
 function addStep(message) {
-  services.logger.step(message);
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework. Use playwright steps');
+    index_js_1.services.logger.step(message);
 }
-
 /**
  * Add key-value pair(s) to the test report
- * @param {*} keyValue or key
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
  * @param {string?} value
  */
 function setKeyValue(keyValue, value = null) {
-  if (value && typeof keyValue === 'string') {
-    keyValue = { [keyValue]: value };
-  }
-  services.keyValues.put(keyValue);
+    if (process.env.IS_PLAYWRIGHT)
+        throw new Error('This function is not available in Playwright framework. Use test tag instead.');
+    if (typeof keyValue === 'string') {
+        keyValue = { [keyValue]: value };
+    }
+    index_js_1.services.keyValues.put(keyValue);
 }
-
 module.exports = {
-  artifact: saveArtifact,
-  log: logMessage,
-  step: addStep,
-  keyValue: setKeyValue,
+    artifact: saveArtifact,
+    log: logMessage,
+    step: addStep,
+    keyValue: setKeyValue,
 };

package/lib/reporter.d.ts

@@ -0,0 +1,232 @@
+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: {
+    "__#12@#originalUserLogger": {
+        assert(condition?: boolean, ...data: any[]): void;
+        assert(value: any, message?: string, ...optionalParams: any[]): void;
+        clear(): void;
+        clear(): void;
+        count(label?: string): void;
+        count(label?: string): void;
+        countReset(label?: string): void;
+        countReset(label?: string): void;
+        debug(...data: any[]): void;
+        debug(message?: any, ...optionalParams: any[]): void;
+        dir(item?: any, options?: any): void;
+        dir(obj: any, options?: import("util").InspectOptions): void;
+        dirxml(...data: any[]): void;
+        dirxml(...data: any[]): void;
+        error(...data: any[]): void;
+        error(message?: any, ...optionalParams: any[]): void;
+        group(...data: any[]): void;
+        group(...label: any[]): void;
+        groupCollapsed(...data: any[]): void;
+        groupCollapsed(...label: any[]): void;
+        groupEnd(): void;
+        groupEnd(): void;
+        info(...data: any[]): void;
+        info(message?: any, ...optionalParams: any[]): void;
+        log(...data: any[]): void;
+        log(message?: any, ...optionalParams: any[]): void;
+        table(tabularData?: any, properties?: string[]): void;
+        table(tabularData: any, properties?: readonly string[]): void;
+        time(label?: string): void;
+        time(label?: string): void;
+        timeEnd(label?: string): void;
+        timeEnd(label?: string): void;
+        timeLog(label?: string, ...data: any[]): void;
+        timeLog(label?: string, ...data: any[]): void;
+        timeStamp(label?: string): void;
+        timeStamp(label?: string): void;
+        trace(...data: any[]): void;
+        trace(message?: any, ...optionalParams: any[]): void;
+        warn(...data: any[]): void;
+        warn(message?: any, ...optionalParams: any[]): void;
+        Console: console.ConsoleConstructor;
+        profile(label?: string): void;
+        profileEnd(label?: string): void;
+    };
+    "__#12@#userLoggerWithOverridenMethods": any;
+    logLevel: string;
+    step(strings: any, ...values: any[]): void;
+    getLogs(context: string): string[];
+    "__#12@#stringifyLogs"(...args: any[]): string;
+    _templateLiteralLog(strings: any, ...args: any[]): void;
+    "__#12@#logWrapper"(argsArray: any, level: 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;
+    intercept(userLogger: any): void;
+    stopInterception(): void;
+    configure(config?: {
+        logLevel?: string;
+        prettyObjects?: boolean;
+    }): 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;
+declare namespace _default {
+    let testomatioLogger: {
+        "__#12@#originalUserLogger": {
+            assert(condition?: boolean, ...data: any[]): void;
+            assert(value: any, message?: string, ...optionalParams: any[]): void;
+            clear(): void;
+            clear(): void;
+            count(label?: string): void;
+            count(label?: string): void;
+            countReset(label?: string): void;
+            countReset(label?: string): void;
+            debug(...data: any[]): void;
+            debug(message?: any, ...optionalParams: any[]): void;
+            dir(item?: any, options?: any): void;
+            dir(obj: any, options?: import("util").InspectOptions): void;
+            dirxml(...data: any[]): void;
+            dirxml(...data: any[]): void;
+            error(...data: any[]): void;
+            error(message?: any, ...optionalParams: any[]): void;
+            group(...data: any[]): void;
+            group(...label: any[]): void;
+            groupCollapsed(...data: any[]): void;
+            groupCollapsed(...label: any[]): void;
+            groupEnd(): void;
+            groupEnd(): void;
+            info(...data: any[]): void;
+            info(message?: any, ...optionalParams: any[]): void;
+            log(...data: any[]): void;
+            log(message?: any, ...optionalParams: any[]): void;
+            table(tabularData?: any, properties?: string[]): void;
+            table(tabularData: any, properties?: readonly string[]): void;
+            time(label?: string): void;
+            time(label?: string): void;
+            timeEnd(label?: string): void;
+            timeEnd(label?: string): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeStamp(label?: string): void;
+            timeStamp(label?: string): void;
+            trace(...data: any[]): void;
+            trace(message?: any, ...optionalParams: any[]): void;
+            warn(...data: any[]): void;
+            warn(message?: any, ...optionalParams: any[]): void;
+            Console: console.ConsoleConstructor;
+            profile(label?: string): void;
+            profileEnd(label?: string): void;
+        };
+        "__#12@#userLoggerWithOverridenMethods": any;
+        logLevel: string;
+        step(strings: any, ...values: any[]): void;
+        getLogs(context: string): string[];
+        "__#12@#stringifyLogs"(...args: any[]): string;
+        _templateLiteralLog(strings: any, ...args: any[]): void;
+        "__#12@#logWrapper"(argsArray: any, level: 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;
+        intercept(userLogger: any): void;
+        stopInterception(): void;
+        configure(config?: {
+            logLevel?: string;
+            prettyObjects?: boolean;
+        }): void;
+        prettyObjects: boolean;
+    };
+    let artifact: (data: string | {
+        path: string;
+        type: string;
+        name: string;
+    }, context?: any) => void;
+    let log: (...args: any[]) => void;
+    let logger: {
+        "__#12@#originalUserLogger": {
+            assert(condition?: boolean, ...data: any[]): void;
+            assert(value: any, message?: string, ...optionalParams: any[]): void;
+            clear(): void;
+            clear(): void;
+            count(label?: string): void;
+            count(label?: string): void;
+            countReset(label?: string): void;
+            countReset(label?: string): void;
+            debug(...data: any[]): void;
+            debug(message?: any, ...optionalParams: any[]): void;
+            dir(item?: any, options?: any): void;
+            dir(obj: any, options?: import("util").InspectOptions): void;
+            dirxml(...data: any[]): void;
+            dirxml(...data: any[]): void;
+            error(...data: any[]): void;
+            error(message?: any, ...optionalParams: any[]): void;
+            group(...data: any[]): void;
+            group(...label: any[]): void;
+            groupCollapsed(...data: any[]): void;
+            groupCollapsed(...label: any[]): void;
+            groupEnd(): void;
+            groupEnd(): void;
+            info(...data: any[]): void;
+            info(message?: any, ...optionalParams: any[]): void;
+            log(...data: any[]): void;
+            log(message?: any, ...optionalParams: any[]): void;
+            table(tabularData?: any, properties?: string[]): void;
+            table(tabularData: any, properties?: readonly string[]): void;
+            time(label?: string): void;
+            time(label?: string): void;
+            timeEnd(label?: string): void;
+            timeEnd(label?: string): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeLog(label?: string, ...data: any[]): void;
+            timeStamp(label?: string): void;
+            timeStamp(label?: string): void;
+            trace(...data: any[]): void;
+            trace(message?: any, ...optionalParams: any[]): void;
+            warn(...data: any[]): void;
+            warn(message?: any, ...optionalParams: any[]): void;
+            Console: console.ConsoleConstructor;
+            profile(label?: string): void;
+            profileEnd(label?: string): void;
+        };
+        "__#12@#userLoggerWithOverridenMethods": any;
+        logLevel: string;
+        step(strings: any, ...values: any[]): void;
+        getLogs(context: string): string[];
+        "__#12@#stringifyLogs"(...args: any[]): string;
+        _templateLiteralLog(strings: any, ...args: any[]): void;
+        "__#12@#logWrapper"(argsArray: any, level: 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;
+        intercept(userLogger: any): void;
+        stopInterception(): void;
+        configure(config?: {
+            logLevel?: string;
+            prettyObjects?: boolean;
+        }): void;
+        prettyObjects: boolean;
+    };
+    let meta: (keyValue: {
+        [key: string]: string;
+    } | string, value?: string | null) => void;
+    let step: (message: string) => void;
+}
+export default _default;

package/lib/reporter.js

@@ -1,30 +1,35 @@
-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.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;
+/**
+ * @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
+ */
+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,
+    // 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 "__#13@#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,9 @@
+export namespace services {
+    export { logger };
+    export { artifactStorage as artifacts };
+    export { keyValueStorage as keyValues };
+    export function setContext(context: any): void;
+}
+import { logger } from './logger.js';
+import { artifactStorage } from './artifacts.js';
+import { keyValueStorage } from './key-values.js';

package/lib/services/index.js

@@ -1,13 +1,15 @@
-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 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,
+    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 "__#14@#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 {};