@testomatio/reporter/lib/reporter-functions.js

Testomatio Reporter Client

"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
 * @param {any} [context=null] - optional context parameter
 * @returns {void}
 */
function saveArtifact(data, context = null) {
    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 - log messages to attach
 * @returns {void}
 */
function logMessage(...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 {string} message - step message
 * @returns {void}
 */
function addStep(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 {{[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
 * @returns {void}
 */
function setKeyValue(keyValue, value = null) {
    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);
}
/**
 * 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')
 * @returns {void}
 */
function setLabel(key, value = null) {
    if (Array.isArray(value)) {
        return value.forEach(label => setLabel(key, label));
    }
    const labelObject = value !== null && value !== undefined && value !== ''
        ? { label: `${key}:${value}` }
        : { label: key };
    index_js_1.services.links.put([labelObject]);
}
/**
 * Add link(s) to the test report
 * @param {...string} testIds - test IDs to link
 * @returns {void}
 */
function linkTest(...testIds) {
    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
 * @returns {void}
 */
function linkJira(...jiraIds) {
    const links = jiraIds.map(jiraId => ({ jira: jiraId }));
    index_js_1.services.links.put(links);
}
module.exports = {
    artifact: saveArtifact,
    log: logMessage,
    step: addStep,
    keyValue: setKeyValue,
    label: setLabel,
    linkTest,
    linkJira,
};