cypress-junit-reporter-shp/src/logMessages.js

Cypress Reporter | Enhances your Cypress test suite with the cypress-xray-junit-reporter a specialized custom reporter designed to seamlessly generating comprehensive XRay-compatible JUnit-style XML reports, complete with embedded screenshots on test fail

const converter = require('number-to-words');
const chalk = require('chalk');

const separator = chalk.grey('====================================================================================================\n')
const whitespace = "  "
let tabNum = 2

const logMessages = {
    startingPlugin: (xrayMode) => {
        console.log(separator);
        console.log(chalk.white('  Cypress Xray Junit Reporter | Creating XML report'));
        console.log(chalk.white('  -------------------------------------------------\n'));
        if (xrayMode) { console.log(chalk.white('    ⏳ XrayMode Enabled -> Retrieving suites information from Root Suite... ')); } else {
            console.log(chalk.white('    ⏳ XrayMode Disabled -> Retrieving suites information from Root Suite without searching for JiraKeys... '));
        }
    },
    endPlugin: () => {
        console.log(`\n${whitespace.repeat(tabNum)}------------------------------------`);
        console.log(`${whitespace.repeat(tabNum)}${chalk.green('All suites have been parsed correctly!\n')}`);
        console.log(`${separator}`);
    },
    warning: (shortenLogMode, suitesNum, message) => {
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.black('⚠️  ' + message)}`);
        } else {
            console.log(`${whitespace.repeat(tabNum)}${chalk.black('⚠️  ' + message)}`);
        }
    },
    missingError: (shortenLogMode, suitesNum,) => {
        const message = '‼ Missing jira key in at least one testcase'
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.red(message)}`);
        } else {
            console.log(`${whitespace.repeat(tabNum)}${chalk.red(message)}`);
        }
    },
    skippedError: (shortenLogMode, testArray) => {
        let wsNum
        if (shortenLogMode) {
            wsNum = tabNum
            const message = `‼ Skipping testcases:\n${whitespace.repeat(wsNum)}` + chalk.cyan('- ' + testArray.join(`,\n${whitespace.repeat(wsNum)}- `))
            console.log(`${whitespace.repeat(wsNum)}${chalk.red(message)}`);
        }
    },
    skippedTestcase: (shortenLogMode, suitesNum, title) => {
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.black('〰 Skipping testcase: ')} ${chalk.white(title)}`);
        }
    },
    analyzedTestcase: (shortenLogMode, suitesNum, title) => {
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.black('〰 Properly analyzed testcase:')} ${chalk.white(title)}`);
        }
    },
    foundingSuite: (shortenLogMode, suitesNum, suitesQuantity) => {
        if (!shortenLogMode) {
            console.log(`\n${whitespace.repeat(suitesNum + tabNum)}${chalk.black('〰 Founded ' + chalk.yellow(converter.toWords(suitesQuantity)) + ' testsuite(s), keep scraping..')}`);
        }
    },
    analyzingSuite: (shortenLogMode, suitesNum, title) => {
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.cyanBright('〰 Analyzing testsuite: ') + chalk.white(title)}`);
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.white('🔍 Looking for testsuite or testcase...')}`);
        }
    },
    endSuite: (shortenLogMode, suitesNum, title) => {
        if (!shortenLogMode) {
            console.log(`${whitespace.repeat(suitesNum + tabNum)}${chalk.green('✔ Successfully analyzed suite:')} ${chalk.white(title)}\n`)
        }
    },
};

module.exports = logMessages;