suman-reporters/modules/tap-reporter/index.js

Suman standard reporters

'use strict';
Object.defineProperty(exports, "__esModule", { value: true });
const process = require('suman-browser-polyfills/modules/process');
const global = require('suman-browser-polyfills/modules/global');
const util = require("util");
const path = require("path");
const su = require("suman-utils");
const chalk = require("chalk");
const suman_events_1 = require("suman-events");
const _suman = global.__suman = (global.__suman || {});
const utils_1 = require("../../lib/utils");
const reporterName = path.basename(__dirname);
const log = utils_1.getLogger(reporterName);
function getCleanTitle(test) {
    return String(test.title || test.desc || test.description || test.name).replace(/#/g, '').trim();
}
function logDebug() {
    let debug;
    if (debug = process.env.SUMAN_DEBUG) {
        const args = Array.from(arguments).filter(i => i);
        args.forEach(function (a) {
            process.stderr.write('\n' + (typeof a === 'string' ? a : util.inspect(a)) + '\n');
        });
    }
    return debug;
}
let onAnyEvent = function () {
    if (!logDebug.apply(null, arguments)) {
        const args = Array.from(arguments).map(function (data) {
            return typeof data === 'string' ? data : util.inspect(data);
        });
        return console.log.apply(console, args);
    }
};
let isTTY = process.stdout.isTTY;
exports.loadreporter = utils_1.wrapReporter(reporterName, (retContainer, results, s, sumanOpts) => {
    if (_suman.inceptionLevel < 1 && !isTTY) {
        log.warning(`"${reporterName}" warning: suman inception level is 0, we may not need to load this reporter.`);
    }
    let isColorable = function () {
        return _suman.inceptionLevel < 1 && !sumanOpts.no_color;
    };
    s.on(String(suman_events_1.events.RUNNER_INITIAL_SET), function (forkedCPs, processes, suites) {
        onAnyEvent('\n\n\t ' + chalk.bgBlue.yellow(' => [Suman runner] =>  initial set => ' +
            forkedCPs.length + ' ' + processes + ' running ' + forkedCPs.length + ' ' + suites + ' ') + '\n');
    });
    s.on(String(suman_events_1.events.RUNNER_OVERALL_SET), function (totalCount, processes, suites, addendum) {
        onAnyEvent('\t ' + chalk.bgBlue.yellow(' => [Suman runner] =>  overall set => '
            + totalCount + ' ' + processes + ' will run ' + totalCount + ' ' + (suites + addendum) + ' ') + '\n\n\n');
    });
    s.on(String(suman_events_1.events.RUNNER_ASCII_LOGO), function (logo) {
        onAnyEvent('\n\n' + logo + '\n\n');
    });
    s.on(String(suman_events_1.events.RUNNER_STARTED), function () {
        _suman.log.info('Suman runner has started.');
    });
    s.on(String(suman_events_1.events.RUNNER_ENDED), function () {
        console.log('# tests ' + (results.passes + results.failures));
        console.log('# pass ' + results.passes);
        console.log('# fail ' + results.failures);
        console.log('# stubbed ' + results.failures);
        console.log('# skipped ' + results.failures);
    });
    s.on(String(suman_events_1.events.TAP_COMPLETE), function (data) {
        if (su.vgt(6)) {
            log.info('All TAP input received.');
        }
    });
    let onTestCaseEnd = function () {
        results.n++;
    };
    let onTestCaseFail = function (test) {
        test = test.testCase || test;
        results.failures++;
        if (false && isColorable()) {
            console.log(chalk.red(`not ok ${results.n} ${getCleanTitle(test)}`));
        }
        else {
            console.log(`not ok ${results.n} ${getCleanTitle(test)}`);
        }
    };
    let onTestCasePass = function (test) {
        test = test.testCase || test;
        results.passes++;
        if (false && isColorable()) {
            console.log(chalk.green(`ok ${results.n} ${getCleanTitle(test)}`));
        }
        else {
            console.log(`ok ${results.n} ${getCleanTitle(test)}`);
        }
    };
    let onTestCaseSkipped = function (test) {
        test = test.testCase || test;
        results.skipped++;
        console.log('ok %d %s # SKIP -', results.n, getCleanTitle(test));
    };
    let onTestCaseStubbed = function (test) {
        test = test.testCase || test;
        results.stubbed++;
        console.log('ok %d %s # STUBBED -', results.n, getCleanTitle(test));
    };
    s.on(String(suman_events_1.events.TEST_CASE_END_TAP_JSON), onTestCaseEnd);
    s.on(String(suman_events_1.events.TEST_CASE_END), onTestCaseEnd);
    s.on(String(suman_events_1.events.TEST_CASE_FAIL_TAP_JSON), onTestCaseFail);
    s.on(String(suman_events_1.events.TEST_CASE_FAIL), onTestCaseFail);
    s.on(String(suman_events_1.events.TEST_CASE_PASS_TAP_JSON), onTestCasePass);
    s.on(String(suman_events_1.events.TEST_CASE_PASS), onTestCasePass);
    s.on(String(suman_events_1.events.TEST_CASE_SKIPPED_TAP_JSON), onTestCaseSkipped);
    s.on(String(suman_events_1.events.TEST_CASE_SKIPPED), onTestCaseSkipped);
    s.on(String(suman_events_1.events.TEST_CASE_STUBBED_TAP_JSON), onTestCaseStubbed);
    s.on(String(suman_events_1.events.TEST_CASE_STUBBED), onTestCaseStubbed);
    s.on(String(suman_events_1.events.RUNNER_EXIT_CODE), function (code) {
        onAnyEvent(['\n  ',
            ' <::::::::::::::::::::::::::::::::: Suman runner exiting with exit code: ' + code +
                ' :::::::::::::::::::::::::::::::::>', '\n'].join('\n'));
    });
    if (!sumanOpts.no_tables) {
        s.on(String(suman_events_1.events.STANDARD_TABLE), function (table) {
            console.log('\n\n');
            let str = table.toString();
            str = '\t' + str;
            console.log(str.replace(/\n/g, '\n\t'));
            console.log('\n');
        });
        s.on(String(suman_events_1.events.RUNNER_RESULTS_TABLE), function (allResultsTableString) {
            onAnyEvent('\n\n' + allResultsTableString.replace(/\n/g, '\n\t') + '\n\n');
        });
        s.on(String(suman_events_1.events.RUNNER_RESULTS_TABLE_SORTED_BY_MILLIS), function (strSorted) {
            onAnyEvent('\n\n' + strSorted.replace(/\n/g, '\n\t') + '\n\n');
        });
        s.on(String(suman_events_1.events.RUNNER_OVERALL_RESULTS_TABLE), function (overallResultsTableString) {
            onAnyEvent(overallResultsTableString.replace(/\n/g, '\n\t') + '\n\n');
        });
    }
    return retContainer.ret = {
        reporterName,
        results
    };
});
exports.default = exports.loadreporter;