@testomatio/reporter 1.6.0-beta-2-artifacts → 2.0.0-beta-esm

package/lib/reporter-functions.js

@@ -1,46 +1,42 @@
-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");
+const playwright_js_1 = require("./adapter/playwright.js");
+if (process.env.PLAYWRIGHT_TEST_BASE_URL)
+    (0, playwright_js_1.initPlaywrightForStorage)();
 /**
  * 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 (!data)
+        return;
+    index_js_1.services.artifacts.put(data, context);
 }
-
 /**
  * Attach log message(s) to the test report
  * @param  {...any} args
  */
 function logMessage(...args) {
-  services.logger._templateLiteralLog(...args);
+    index_js_1.services.logger._templateLiteralLog(...args);
 }
-
 /**
  * Similar to "log" function but marks message in report as a step
  * @param {*} message
  */
 function addStep(message) {
-  services.logger.step(message);
+    index_js_1.services.logger.step(message);
 }
-
 /**
  * Add key-value pair(s) to the test report
  * @param {*} keyValue
  */
 function setKeyValue(keyValue) {
-  services.keyValues.put(keyValue);
+    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.js

@@ -1,19 +1,49 @@
-const TestomatClient = require('./client');
-const TRConstants = require('./constants');
-const { services } = require('./services');
-
-const reporterFunctions = require('./reporter-functions');
-
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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;
+const client_js_1 = __importDefault(require("./client.js"));
+const TRConstants = __importStar(require("./constants.js"));
+const index_js_1 = require("./services/index.js");
+const reporter_functions_js_1 = __importDefault(require("./reporter-functions.js"));
 module.exports = {
-  // 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,
+    // TODO: deprecate in future; 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: client_js_1.default,
+    TRConstants,
 };
+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;

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.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.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}} 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();