testRunner.js

'use strict';

var fs = require('fs');
var path = require('path');
var util = require('util');
var rr = require('recursive-readdir');
var yaml = require('js-yaml');

var validator2 = require('swagger-parser');
var validator3 = require('oas-validator');

var argv = require('yargs')
    .usage('testRunner [options] [{path-to-specs}...]')
    .string('encoding')
    .alias('e', 'encoding')
    .default('encoding', 'utf8')
    .describe('encoding', 'encoding for input/output files')
    .string('fail')
    .describe('fail', 'path to specs expected to fail')
    .alias('f', 'fail')
    .boolean('stop')
    .alias('s', 'stop')
    .describe('stop', 'stop on first error')
    .boolean('quiet')
    .alias('q', 'quiet')
    .describe('quiet', 'do not show test passes on console, for CI')
    .count('verbose')
    .alias('v', 'verbose')
    .describe('verbose', 'increase verbosity')
    .help('h')
    .alias('h', 'help')
    .strict()
    .version(function () {
        return require('../package.json').version;
    })
    .argv;

var red = process.env.NODE_DISABLE_COLORS ? '' : '\x1b[31m';
var green = process.env.NODE_DISABLE_COLORS ? '' : '\x1b[32m';
var normal = process.env.NODE_DISABLE_COLORS ? '' : '\x1b[0m';

var pass = 0;
var fail = 0;
var failures = [];
var warnings = [];

var options = argv;
options.patch = true;

async function check(file, force, expectFailure) {
    var result = false;
    options.context = [];
    var components = file.split(path.sep);
    var name = components[components.length - 1];

    if ((name.indexOf('swagger.yaml') >= 0) || (name.indexOf('swagger.json') >= 0) ||
        (name.indexOf('openapi.yaml') >= 0) || (name.indexOf('openapi.json') >= 0) || force) {

        var srcStr = fs.readFileSync(path.resolve(file), options.encoding);
        var src;
        try {
            if (name.indexOf('.yaml') >= 0) {
                src = yaml.safeLoad(srcStr);
            }
            else {
                src = JSON.parse(srcStr);
            }
        }
        catch (ex) {
            var warning = 'Could not parse file ' + file;
            console.log(red + warning);
            warnings.push(warning);
        }

        //if (!src || ((!src.swagger && !src.openapi))) return true;

        if (src && src.swagger) {
            validator2.validate(src, function (err, api) {
                if (!argv.quiet) console.log(normal + file);
                if (err) {
                    if (argv.quiet) console.log(normal + file);
                    console.log(red + util.inspect(err));
                    result = false;
                    failures.push(file);
                }
                else {
                    if (!argv.quiet) {
                        console.log(green + '%s %s', src.info.title, src.info.version);
                        console.log('  %s', src.swagger ? (src.host ? src.host : 'relative') : (src.servers && src.servers.length ? src.servers[0].url : 'relative'));
                    }
                    result = true;
                }
                if (expectFailure) result = !result;
                if (result) {
                    pass++;
                }
                else {
                    fail++;
                    if (argv.stop) process.exit(1);
                }
            });
        }
        else if (src && typeof src.openapi === 'string') {
            try {
                if (!argv.quiet) console.log(normal + file);
                let valRes = await validator3.validate(src, options);
                console.log(green + '%s %s', src.info.title, src.info.version);
                result = true;
                pass++;
            }
            catch (ex) {
                fail++;
                console.log(red + util.inspect(ex));
                result = false;
                failures.push(file);
            }
        }
        else {
            result = true;
        }
        return result;
    }
}

function processPathSpec(pathspec, expectFailure) {
    pathspec = path.resolve(pathspec);
    var stats = fs.statSync(pathspec);
    if (stats.isFile()) {
        check(pathspec, true, expectFailure);
    }
    else {
        rr(pathspec, function (err, files) {
            for (var i in files) {
                check(files[i], false, expectFailure);
            }
        });
    }
}

process.exitCode = 1;
if ((!argv._.length) && (!argv.fail)) {
    argv._.push('.');
}
for (var pathspec of argv._) {
    processPathSpec(pathspec, false);
}
if (argv.fail) {
    if (!Array.isArray(argv.fail)) argv.fail = [argv.fail];
    for (var pathspec of argv.fail) {
        processPathSpec(pathspec, true);
    }
}

process.on('exit', function (code) {
    if (failures.length) {
        failures.sort();
        console.log(normal + '\nFailures:' + red);
        for (var f in failures) {
            console.log(failures[f]);
        }
    }
    if (warnings.length) {
        warnings.sort();
        console.log(normal + '\nWarnings:' + red);
        for (var w in warnings) {
            console.log(warnings[w]);
        }
    }
    console.log(normal);
    console.log('Tests: %s passing, %s failing, %s warnings', pass, fail, warnings.length);
    process.exitCode = ((fail === 0) && (pass > 0)) ? 0 : 1;
});