wdio-workflo-allure-reporter/build/reporter.js

'use strict';

var _get = require('babel-runtime/helpers/get')['default'];

var _inherits = require('babel-runtime/helpers/inherits')['default'];

var _createClass = require('babel-runtime/helpers/create-class')['default'];

var _classCallCheck = require('babel-runtime/helpers/class-call-check')['default'];

var _Object$keys = require('babel-runtime/core-js/object/keys')['default'];

var _getIterator = require('babel-runtime/core-js/get-iterator')['default'];

var _interopRequireDefault = require('babel-runtime/helpers/interop-require-default')['default'];

var _interopRequireWildcard = require('babel-runtime/helpers/interop-require-wildcard')['default'];

Object.defineProperty(exports, '__esModule', {
    value: true
});

var _events = require('events');

var _events2 = _interopRequireDefault(_events);

var _allureJsCommonsWorkflo = require('allure-js-commons-workflo');

var _allureJsCommonsWorkflo2 = _interopRequireDefault(_allureJsCommonsWorkflo);

var _allureJsCommonsWorkfloBeansStep = require('allure-js-commons-workflo/beans/step');

var _allureJsCommonsWorkfloBeansStep2 = _interopRequireDefault(_allureJsCommonsWorkfloBeansStep);

var _fs = require('fs');

var fs = _interopRequireWildcard(_fs);

var _path = require('path');

var path = _interopRequireWildcard(_path);

function isEmpty(object) {
    return !object || _Object$keys(object).length === 0;
}

var LOGGING_HOOKS = ['"before all" hook', '"after all" hook'];

var debug = false;
var debugSeleniumCommand = false;

function logger() {
    if (debug) {
        console.log(arguments);
    }
}
function error() {
    console.error(arguments);
}

/**
 * Initialize a new `Allure` test reporter.
 *
 * @param {Runner} runner
 * @api public
 */

var AllureReporter = (function (_events$EventEmitter) {
    _inherits(AllureReporter, _events$EventEmitter);

    function AllureReporter(baseReporter, config) {
        var _this = this;

        var options = arguments.length <= 2 || arguments[2] === undefined ? {} : arguments[2];

        _classCallCheck(this, AllureReporter);

        _get(Object.getPrototypeOf(AllureReporter.prototype), 'constructor', this).call(this);

        this.baseReporter = baseReporter;
        this.config = config;
        this.options = options;
        if (options) {
            debug = options.debug;
            debugSeleniumCommand = options.debugSeleniumCommand;
        }
        this.allures = {};
        this.currentTestId = '';
        this.startedSpecs = false;
        this.testIds = {};
        this.errorCtr = 0;

        // const { epilogue } = this.baseReporter

        this.on('end', function () {
            // epilogue.call(baseReporter)
            if (_this.startedSpecs) {
                _this.addResults();
            }
        });

        this.on('startSpecs', function (runner) {
            if (!_this.startedSpecs) {
                _this.startedSpecs = true;
            }
        });

        this.on('suite:start', function (suite) {
            var allure = _this.getAllure(suite.cid);
            var currentSuite = allure.getCurrentSuite();
            var prefix = currentSuite ? currentSuite.name + ' ' : '';

            process.workflo.currentCid = suite.cid;

            allure.startSuite(prefix + suite.title);
        });

        this.on('suite:end', function (suite) {
            _this.getAllure(suite.cid).endSuite();
        });

        this.on('test:setCurrentId', function (test) {
            var allure = _this.getAllure(test.cid);
            _this.currentTestId = test.id;

            var currentTest = allure.getCurrentTest();

            if (_this.currentTestId) {
                if (test.testcase) {
                    var traceInfo = _this.config.traceInfo.testcases[_this.currentTestId];

                    currentTest.addParameter('argument', 'Testcase File', traceInfo.testcaseFile);
                    currentTest.addParameter('argument', 'Validates Specs', traceInfo.specs.join(', '));
                } else if (test.spec) {
                    var parts = _this.currentTestId.split('|');
                    var spec = parts[0];
                    var criteria = parts[1];

                    var traceInfo = _this.config.traceInfo.specs[spec];

                    currentTest.addParameter('argument', 'Spec File', traceInfo.specFile);

                    var manualFile = traceInfo.criteriaValidationFiles[criteria].manualFile;
                    var testcases = traceInfo.criteriaValidationFiles[criteria].testcases;

                    if (manualFile) {
                        currentTest.addParameter('argument', 'Validated by Manual Results', manualFile);
                    } else if (testcases.length > 0) {
                        currentTest.addParameter('argument', 'Validated in Testcases', testcases.join(', '));
                    }
                }
            }
        });

        this.on('test:start', function (test) {
            var allure = _this.getAllure(test.cid);
            allure.startCase(test.title);

            _this.lastCid = test.cid;

            var currentTest = allure.getCurrentTest();

            if (test.metadata) {
                for (var key in test.metadata) {
                    var meta = {
                        event: 'test:meta',
                        cid: test.cid
                    };
                    meta[key] = test.metadata[key];

                    _this.handleMetadata(meta);
                }
            }

            // add spec ids
            var printObject = _this.config.printObject;

            var filterFilesStr = printObject['Spec Files'] + ' specFiles, ' + printObject['Testcase Files'] + ' testcaseFiles, ' + printObject['Manual Result Files'] + ' manualResultFiles';
            var filtersStr = printObject['Features'] + ' features, ' + printObject['Specs'] + ' specs, ' + printObject['Suites'] + ' suites, ' + printObject['Testcases'] + ' testcases';
            var coverageStr = printObject['Automated Criteria'].count + ' automated ' + printObject['Automated Criteria'].percentage + ', ' + printObject['Manual Criteria'].count + ' manual ' + printObject['Manual Criteria'].percentage + ', ' + printObject['Uncovered Criteria'].count + ' uncovered ' + printObject['Uncovered Criteria'].percentage;
            var uncoveredCriteriaStr = '';

            for (var spec in printObject['Uncovered Criteria Object']) {
                uncoveredCriteriaStr += spec + ': [' + printObject['Uncovered Criteria Object'][spec].join(', ') + '], ';
            }

            uncoveredCriteriaStr = uncoveredCriteriaStr.substring(0, uncoveredCriteriaStr.length - 2);

            // these will be added on dashboard page
            currentTest.addParameter('environment-variable', 'BROWSER', test.runner[test.cid].browserName);
            currentTest.addParameter('environment-variable', 'BASE URL', _this.config.baseUrl);

            if (_this.config.manualOnly) {
                currentTest.addParameter('environment-variable', 'EXECUTION MODE: ', 'Manual Only');
            } else if (_this.config.automaticOnly) {
                currentTest.addParameter('environment-variable', 'EXECUTION MODE: ', 'Automatic Only');
            } else {
                currentTest.addParameter('environment-variable', 'EXECUTION MODE: ', 'Automatic and Manual');
            }

            // currentTest.addParameter('environment-variable', 'SELENIUM CAPABILITIES', JSON.stringify(test.runner[test.cid]))
            // currentTest.addParameter('environment-variable', 'WEBDRIVER HOST', this.config.host)
            // currentTest.addParameter('environment-variable', 'WEBDRIVER PORT', this.config.port)
            currentTest.addParameter('environment-variable', 'CRITERIA COVERAGE: ', coverageStr);
            currentTest.addParameter('environment-variable', 'FILTER FILES: ', filterFilesStr);
            currentTest.addParameter('environment-variable', 'FILTERS: ', filtersStr);

            if (uncoveredCriteriaStr) {
                currentTest.addParameter('environment-variable', 'UNCOVERED CRITERIA: ', uncoveredCriteriaStr);
            }
        });

        this.on('test:pass', function (test) {
            var allure = _this.getAllure(test.cid);

            _this.addArguments(test);
            _this.addResultsDummy(test);
            allure.endCase('passed');
        });

        this.on('test:fail', function (test) {
            var allure = _this.getAllure(test.cid);

            if (!allure.getCurrentTest()) {
                allure.startCase(test.title);
            } else {
                allure.getCurrentTest().name = test.title;
            }

            while (allure.getCurrentSuite().currentStep instanceof _allureJsCommonsWorkfloBeansStep2['default']) {
                allure.endStep('failed');
            }

            _this.addArguments(test);
            _this.addResultsDummy(test);
            allure.endCase('failed', {
                message: '\n' + test.err.message,
                stack: '\n' + test.err.stack
            });
        });

        this.on('test:broken', function (test) {
            var allure = _this.getAllure(test.cid);

            if (!allure.getCurrentTest()) {
                allure.startCase(test.title);
            } else {
                allure.getCurrentTest().name = test.title;
            }

            while (allure.getCurrentSuite().currentStep instanceof _allureJsCommonsWorkfloBeansStep2['default']) {
                allure.endStep('broken');
            }

            _this.addArguments(test);
            _this.addResultsDummy(test);

            allure.endCase('broken', {
                message: '\n' + test.err.message,
                stack: '\n' + test.err.stack
            });
        });

        this.on('test:pending', function (test) {
            var allure = _this.getAllure(test.cid);

            _this.addArguments(test);
            _this.addResultsDummy(test);
            allure.endCase('pending', { message: 'Test ignored', stack: '' });
        });

        this.on('test:unvalidated', function (test) {
            var allure = _this.getAllure(test.cid);

            if (!allure.getCurrentTest()) {
                allure.startCase(test.title);
            } else {
                allure.getCurrentTest().name = test.title;
            }

            _this.addArguments(test);
            _this.addResultsDummy(test);
            allure.endCase('unknown', {
                message: '\n' + test.err.message
            });
        });

        this.on('runner:command', function (command) {
            var allure = _this.getAllure(command.cid);

            if (!_this.isAnyTestRunning(allure)) {
                return;
            }

            if (debugSeleniumCommand) {
                allure.startStep(command.method + ' ' + command.uri.path);

                if (!isEmpty(command.data)) {
                    _this.dumpJSON(allure, 'Request', command.data);
                }
            }
        });

        this.on('runner:result', function (command) {
            var allure = _this.getAllure(command.cid);
            var status = 'passed';

            if (!_this.isAnyTestRunning(allure)) {
                return;
            }

            if (debugSeleniumCommand) {
                if (command.body.screenshot) {
                    allure.addAttachment('Screenshot', new Buffer(command.body.screenshot, 'base64'));
                    delete command.body.screenshot;
                }
                if (command.body.type && command.body.type === 'RuntimeError') {
                    status = 'broken';
                }

                _this.dumpJSON(allure, 'Response', command.body);

                allure.endStep(status);
            }
        });

        /*
           meta : {
            (mandatory) cid : ...,
            (mandatory) event : 'test:meta'
            (optional) description : string
            (optional) feature : string | array
            (optional) story : string | array
            (optional) issue : string | array // bugs???
            (optional) severity : [ 'blocker','critical','normal','minor','trivial' ]
            (optional) argument : {name: value, name2: value }
            (optional) environment : {name: value, name2: value }
           }
        */
        this.on('test:meta', function (meta) {
            this.handleMetadata(meta);
        });

        this.on('step:start', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:start', step);

            if (!this.isAnyTestRunning(allure)) {
                error('ERROR', 'cannot start step because no test is running', step);
                return;
            }
            allure.startStep(step.title != null ? step.title : 'No name defined');

            if (step.arg) {
                this.dumpJSON(allure, 'Step Arg', step.arg);
            }
        });

        this.on('step:end', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:end', step);

            if (!this.isAnyTestRunning(allure)) {
                error('ERROR', 'cannot end step because no test is running', step);
                return;
            }

            if (step.arg) {
                this.dumpJSON(allure, 'Step Result', step.arg);
            }

            if (step.assertionFailures) {
                this.dumpJSON(allure, 'Validation Failures', step.assertionFailures);
            }

            if (step.screenshots) {
                for (var screenshotMessage in step.screenshots) {
                    for (var i = 0; i < step.screenshots[screenshotMessage].length; ++i) {
                        if (step.screenshots[screenshotMessage] && step.screenshots[screenshotMessage][i]) {
                            allure.addAttachment(screenshotMessage + ' (' + (i + 1) + ')', new Buffer(fs.readFileSync(step.screenshots[screenshotMessage][i], { encoding: 'base64' }), 'base64'));
                        }
                    }
                }
            }

            allure.endStep(step.status);
        });

        this.on('step:pass', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:pass', step);

            allure.endStep('passed');
        });

        this.on('step:fail', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:fail', step);

            this.dumpJSON(allure, 'Validation Failures', step.errs);

            if (step.screenshots) {
                for (var screenshotMessage in step.screenshots) {
                    for (var i = 0; i < step.screenshots[screenshotMessage].length; ++i) {
                        if (step.screenshots[screenshotMessage] && step.screenshots[screenshotMessage][i]) {
                            allure.addAttachment(screenshotMessage + ' (' + (i + 1) + ')', new Buffer(fs.readFileSync(step.screenshots[screenshotMessage][i], { encoding: 'base64' }), 'base64'));
                        }
                    }
                }
            }

            allure.endStep('failed');
        });

        this.on('step:broken', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:broken', step);

            this.dumpJSON(allure, 'Errors', step.assertion);

            if (step.assertion.screenshotFilename) {
                allure.addAttachment(step.assertion.message, new Buffer(fs.readFileSync(step.assertion.screenshotFilename, { encoding: 'base64' }), 'base64'));
            }

            allure.endStep('broken');
        });

        this.on('step:unvalidated', function (step) {
            var allure = this.getAllure(step.cid);
            logger('step:unvalidated', step);

            this.dumpJSON(allure, 'unvalidated Specifications', step.err);

            allure.endStep('unknown');
        });

        /*
          attachment : {
            cid: ...,
            event: 'test:attach',
            title: string,
            file: string,
            type: string
          }
         */
        this.on('test:attach', function (attachment) {
            var allure = this.getAllure(attachment.cid);
            logger('test:attach', attachment);

            if (this.isAnyTestRunning(allure)) {
                error('ERROR', 'cannot attach because no test is running', attachment);
                return;
            }
            allure.addAttachment(attachment.title, fs.readFileSync(attachment.file), attachment.type);
        });

        /*
          log : {
            cid: ...,
            event: 'test:log',
            message: string,
            detail: object
          }
         */
        this.on('test:log', function (log) {
            var allure = this.getAllure(log.cid);
            logger('test:log', log);

            if (this.isAnyTestRunning(allure)) {
                error('ERROR', 'cannot log because no test is running', log);
                return;
            }
            var content = log.detail != null ? JSON.stringify(log.detail, null, '    ') : '';
            allure.addAttachment(log.message, content, 'application/json');
        });

        this.on('runner:screenshot', function (command) {
            // const allure = this.getAllure(command.cid)
        });

        this.on('hook:start', function (hook) {
            var allure = _this.getAllure(hook.cid);

            if (!allure.getCurrentSuite() || LOGGING_HOOKS.indexOf(hook.title) === -1) {
                return;
            }

            allure.startCase(hook.title);
        });

        this.on('hook:end', function (hook) {
            var allure = _this.getAllure(hook.cid);

            if (!allure.getCurrentSuite() || LOGGING_HOOKS.indexOf(hook.title) === -1) {
                return;
            }

            allure.endCase('passed');

            if (allure.getCurrentTest().steps.length === 0) {
                allure.getCurrentSuite().testcases.pop();
            }
        });
    }

    _createClass(AllureReporter, [{
        key: 'handleMetadata',
        value: function handleMetadata(meta) {
            var allure = this.getAllure(meta.cid);
            logger('test:meta', meta);

            if (!this.isAnyTestRunning(allure)) {
                error('ERROR', 'test:meta : NO TEST RUNNING');
                return;
            }
            var currentTest = allure.getCurrentTest();

            // manage description
            if (meta.description) {
                currentTest.setDescription(meta.description);
            }
            // manage labels ( feature, story, issue )
            if (meta.feature) {
                if (typeof meta.feature === 'string') {
                    currentTest.addLabel('feature', meta.feature);
                } else {
                    for (var i in meta.feature) {
                        currentTest.addLabel('feature', meta.feature[i]);
                    }
                }
            }
            if (meta.story) {
                if (typeof meta.story === 'string') {
                    currentTest.addLabel('story', meta.story);
                } else {
                    for (var i in meta.story) {
                        currentTest.addLabel('story', meta.story[i]);
                    }
                }
            }
            if (meta.issue) {
                if (typeof meta.issue === 'string') {
                    currentTest.addLabel('issue', meta.issue);
                } else {
                    var _iteratorNormalCompletion = true;
                    var _didIteratorError = false;
                    var _iteratorError = undefined;

                    try {
                        for (var _iterator = _getIterator(meta.issue), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
                            var issue = _step.value;
                            // string array, previously "in"
                            currentTest.addLabel('issue', issue);
                        }
                    } catch (err) {
                        _didIteratorError = true;
                        _iteratorError = err;
                    } finally {
                        try {
                            if (!_iteratorNormalCompletion && _iterator['return']) {
                                _iterator['return']();
                            }
                        } finally {
                            if (_didIteratorError) {
                                throw _iteratorError;
                            }
                        }
                    }
                }
            }
            if (meta.bug) {
                if (typeof meta.bug === 'string') {
                    currentTest.addLabel('issue', this.getBug(meta.bug)); // check if 'bug' can be used instead!
                    currentTest.addLabel('bug', this.getBug(meta.bug));
                } else {
                    var _iteratorNormalCompletion2 = true;
                    var _didIteratorError2 = false;
                    var _iteratorError2 = undefined;

                    try {
                        for (var _iterator2 = _getIterator(meta.bug), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
                            var bug = _step2.value;

                            currentTest.addLabel('issue', this.getBug(bug));
                            currentTest.addLabel('bug', this.getBug(bug));
                        }
                    } catch (err) {
                        _didIteratorError2 = true;
                        _iteratorError2 = err;
                    } finally {
                        try {
                            if (!_iteratorNormalCompletion2 && _iterator2['return']) {
                                _iterator2['return']();
                            }
                        } finally {
                            if (_didIteratorError2) {
                                throw _iteratorError2;
                            }
                        }
                    }
                }
            }
            if (meta.severity) {
                if (typeof meta.severity === 'string') {
                    currentTest.addLabel('severity', meta.severity);
                } else {
                    error('ERROR : meta.severity should be a string', meta);
                }
            }
            // manage parameters
            if (meta.argument) {
                if (typeof meta.argument === 'object') {
                    var keys = _Object$keys(meta.argument);
                    for (var i in keys) {
                        var key = keys[i];
                        var val = meta.argument[key];
                        currentTest.addParameter('argument', key, val);
                    }
                } else {
                    error('ERROR : meta.argument should be an object { name2: val1, name2: val2.. }', meta);
                }
            }
            if (meta.environment) {
                if (typeof meta.environment === 'object') {
                    var keys = _Object$keys(meta.environment);
                    for (var i in keys) {
                        var key = keys[i];
                        var val = meta.environment[key];
                        currentTest.addParameter('environment-variable', key, val);
                    }
                } else {
                    error('ERROR : meta.environment should be an object { name2: val1, name2: val2.. }', meta);
                }
            }
        }
    }, {
        key: 'getBug',
        value: function getBug(bug) {
            if (this.config.allure && this.config.allure.bugAppendix) {
                bug = '' + bug + this.config.allure.bugAppendix;
            }
            if (this.config.allure && this.config.allure.bugPrefix) {
                bug = '' + this.config.allure.bugPrefix + bug;
            }
            return bug;
        }

        // add test.arguments to current test
    }, {
        key: 'addArguments',
        value: function addArguments(test) {
            if (test.arguments) {
                for (var key in test.arguments) {
                    if (test.arguments[key].value) {
                        this.getAllure(test.cid).getCurrentTest().addParameter('argument', test.arguments[key].caption, test.arguments[key].value);
                    }
                }
            }
        }
    }, {
        key: 'buildResultStr',
        value: function buildResultStr(results) {
            var str = '';

            str += results.passing.count + ' passing (~' + Math.round(results.passing.percentage) + '%)';

            if (results.skipped.count > 0) {
                str += ', ' + results.skipped.count + ' skipped (~' + Math.round(results.skipped.percentage) + '%)';
            }

            if (results.unvalidated.count > 0) {
                str += ', ' + results.unvalidated.count + ' unvalidated (~' + Math.round(results.unvalidated.percentage) + '%)';
            }

            if (results.failing.count > 0) {
                str += ', ' + results.failing.count + ' failing (~' + Math.round(results.failing.percentage) + '%)';
            }

            if (results.broken.count > 0) {
                str += ', ' + results.broken.count + ' broken (~' + Math.round(results.broken.percentage) + '%)';
            }

            return str;
        }
    }, {
        key: 'addResultsDummy',
        value: function addResultsDummy(test) {
            if (test.cid) {
                var allure = this.getAllure(test.cid);
                var currentTest = allure.getCurrentTest();

                this.testIds[currentTest] = true;

                currentTest.addParameter('environment-variable', 'TESTCASE RESULTS: ', 'TESTCASE_RESULTS_STR');
                currentTest.addParameter('environment-variable', 'SPEC RESULTS: ', 'SPEC_RESULTS_STR');
            }
        }
    }, {
        key: 'addResults',
        value: function addResults() {
            var tcResults = this.baseReporter.getTestcaseResults();
            var specResults = this.baseReporter.getSpecResults();

            var tcResultsStr = this.buildResultStr(tcResults);
            var specResultsStr = this.buildResultStr(specResults);

            var latestRun = fs.readFileSync(this.config.latestRunPath, 'utf8');

            // replace TESTCASE_RESULTS_STR and SPEC_RESULTS_STR in all xml and json files in results folder
            // unfortunately there is not better way to do this at the moment
            getAllFiles(path.join(this.config.resultsPath, latestRun), '.xml').forEach(function (file) {
                var content = fs.readFileSync(file, 'utf8');

                content = content.replace(/TESTCASE_RESULTS_STR/g, tcResultsStr);
                content = content.replace(/SPEC_RESULTS_STR/g, specResultsStr);

                fs.unlinkSync(file);

                fs.writeFileSync(file, content, 'utf8');
            });
        }
    }, {
        key: 'getAllure',
        value: function getAllure(cid) {
            if (typeof cid === 'undefined') {
                cid = process.workflo.cid;
            } else {
                if (typeof process.workflo === 'undefined') {
                    process.workflo = {};
                } else {
                    process.workflo.currentCid = cid; // REMOVE???
                }
            }

            if (this.allures[cid]) {
                return this.allures[cid];
            }

            var allure = new _allureJsCommonsWorkflo2['default']();
            allure.setOptions({ targetDir: this.options.outputDir || 'allure-results' });
            this.allures[cid] = allure;
            return this.allures[cid];
        }
    }, {
        key: 'isAnyTestRunning',
        value: function isAnyTestRunning(allure) {
            return allure.getCurrentSuite() && allure.getCurrentTest();
        }
    }, {
        key: 'dumpJSON',
        value: function dumpJSON(allure, name, json) {
            var jsonStr = JSON.stringify(json, null, '    ').split('\\"').join('\'').replace(/(?:\\n)/g, '');
            allure.addAttachment(name, jsonStr, 'application/json');
        }
    }]);

    return AllureReporter;
})(_events2['default'].EventEmitter);

var read = function read(dir) {
    return fs.readdirSync(dir).reduce(function (files, file) {
        return fs.statSync(path.join(dir, file)).isDirectory() ? files.concat(read(path.join(dir, file))) : files.concat(path.join(dir, file));
    }, []);
};

function getAllFiles(dirPath, extension) {
    return read(dirPath).filter(function (fileName) {
        return fileName.endsWith(extension);
    });
}

exports['default'] = AllureReporter;
module.exports = exports['default'];