@testomatio/reporter/lib/utils/pipe_utils.js

Testomatio Reporter Client

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.updateFilterType = updateFilterType;
exports.parseFilterParams = parseFilterParams;
exports.generateFilterRequestParams = generateFilterRequestParams;
exports.setS3Credentials = setS3Credentials;
exports.statusEmoji = statusEmoji;
exports.fullName = fullName;
const constants_js_1 = require("../constants.js");
/**
 * Set S3 credentials from the provided artifacts object.
 * @param {Object} artifacts - The artifacts object containing S3 credentials.
 */
function setS3Credentials(artifacts) {
    if (!Object.keys(artifacts).length)
        return;
    console.log(constants_js_1.APP_PREFIX, 'S3 credentials obtained from Testomat.io...');
    if (artifacts.ACCESS_KEY_ID)
        process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID;
    if (artifacts.SECRET_ACCESS_KEY)
        process.env.S3_SECRET_ACCESS_KEY = artifacts.SECRET_ACCESS_KEY;
    if (artifacts.REGION)
        process.env.S3_REGION = artifacts.REGION;
    if (artifacts.BUCKET)
        process.env.S3_BUCKET = artifacts.BUCKET;
    if (artifacts.SESSION_TOKEN)
        process.env.S3_SESSION_TOKEN = artifacts.SESSION_TOKEN;
    if (artifacts.presign)
        process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
    // endpoint is not received from the server; and shuld be empty if IAM used (credentails obtained from the testomat)
    process.env.S3_ENDPOINT = artifacts.ENDPOINT || '';
}
/**
 * Generates mode request parameters based on the input params.
 * @param {{type: string, id?: string, apiKey: string}} params - The input parameters for the request.
 * @returns {Object|null} - An object containing the generated request parameters, or null if the type is invalid.
 */
function generateFilterRequestParams(params) {
    const { type, id, apiKey } = params;
    if (!type) {
        return;
    }
    if (!id) {
        console.error(constants_js_1.APP_PREFIX, `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
        return;
    }
    return {
        params: {
            type,
            id: encodeURIComponent(id),
            api_key: apiKey,
        },
        responseType: 'json',
    };
}
/**
 * Parse filter parameters from a string in the format "type=id".
 * @param {string} opts - The input string containing the filter parameters.
 * @returns {Object} An object containing the parsed filter parameters.
 *                   The object has properties "type" and "id".
 */
function parseFilterParams(opts) {
    const [type, id] = opts.split('=');
    const validType = updateFilterType(type);
    return {
        type: validType,
        id,
    };
}
/**
 * Update and validate the filter type.
 * @param {string} type - The original filter type.
 * @returns {string|undefined} The updated and validated filter type.
 *                            Returns undefined if the type is not valid.
 */
function updateFilterType(type) {
    let typeLowerCase = type.toLowerCase();
    const filterTypes = ['tag-name', 'plan', 'label', 'jira-ticket'];
    if (typeLowerCase === 'plan-id') {
        typeLowerCase = 'plan';
    }
    const filterApi = [
        'tag',
        'plan',
        'label',
        'jira',
        // "ims-issue", //TODO: WIP
    ];
    if (!filterTypes.includes(typeLowerCase)) {
        console.log(constants_js_1.APP_PREFIX, `❗❗❗ Invalid "filter=${type}" start settings! Available option list: ${filterTypes}`);
        return;
    }
    const index = filterTypes.indexOf(typeLowerCase);
    return index !== -1 ? filterApi[index] : undefined;
}
/**
 * Return an emoji based on the provided status.
 * @param {string} status - The status value ('passed', 'failed', or 'skipped').
 * @returns {string} - An emoji corresponding to the provided status.
 */
function statusEmoji(status) {
    if (status === 'passed')
        return '🟢';
    if (status === 'failed')
        return '🔴';
    if (status === 'skipped')
        return '🟡';
    return '';
}
/**
 * Generate a full name string based on the provided test object.
 * @param {object} t - The test object.
 * @returns {string} - A formatted full name string for the test object.
 */
function fullName(t) {
    let line = '';
    if (t.suite_title)
        line = `${t.suite_title}: `;
    line += `**${t.title}**`;
    if (t.example)
        line += ` \`[${Object.values(t.example)}]\``;
    return line;
}

module.exports.updateFilterType = updateFilterType;

module.exports.parseFilterParams = parseFilterParams;

module.exports.generateFilterRequestParams = generateFilterRequestParams;

module.exports.setS3Credentials = setS3Credentials;

module.exports.statusEmoji = statusEmoji;

module.exports.fullName = fullName;