openapi-examples-validator/test/util/setup-tests.js

Validates embedded examples in OpenAPI-JSONs

const fs = require('fs'),
    path = require('path'),
    cloneDeep = require('lodash.clonedeep'),
    chai = require('chai');

// Environment setup (may be used by Babel as well in .babelrc)
process.env.NODE_ENV = 'test';
// Activate `should`-notation
const should = chai.should();

// PUBLIC API

module.exports = {
    should,
    getPathOfTestData,
    loadTestData,
    normalizeValidationResultPaths
};

// IMPLEMENTATION DETAILS

const
    BASE_PATH__TEST_DATA = '../data/',
    BASE_PATH__TEST_DATA_STRING = path.join(__dirname, '../data/'),
    SUFFIX__JSON = '.json';

// Public

/**
 * Loads data from test-data (sub)directory
 * @param {String}  fileName            Filename (without suffix) or path, relative to the test-data path
 * @param {Boolean} [asString=false]    If <code>true</code> Loads file and returns content as string. Otherwise, it
 *                                      will be loaded as JSON
 * @returns {Object|String} Test-data as JSON, or String
 */
function loadTestData(fileName, asString) {
    return asString
        ? fs.readFileSync(path.join(BASE_PATH__TEST_DATA_STRING, fileName), 'utf-8')
        : cloneDeep(require(BASE_PATH__TEST_DATA + fileName + SUFFIX__JSON));
}

function getPathOfTestData(fileName, asString) {
    return path.join(BASE_PATH__TEST_DATA_STRING, fileName + (!asString ? SUFFIX__JSON : ''));
}

/**
 * Normalizes the file paths in the validation results. The passed result will be modified in place.
 * @param {ValidationResult} validationResult   The modified validation-result
 */
function normalizeValidationResultPaths(validationResult) {
    if (!validationResult.errors) { return validationResult; }
    validationResult.errors.forEach(error => {
        ['mapFilePath', 'exampleFilePath'].forEach(prop => {
            if (!error[prop]) { return; }
            error[prop] = path.normalize(error[prop]);
        });
    });
    return validationResult;
}