planify/test/reporters/helpers/expected.js

Plan a series of steps and display the output in a beautiful way

'use strict';

const fs = require('fs');
const path = require('path');
const glob = require('glob');
const expect = require('chai').expect;
const camelCase = require('lodash/camelCase');
const assign = require('lodash/assign');
const bufferStdio = require('../../helpers/buffer-stdio');
const fixtures = require('../../fixtures');

function expectations(reporter) {
    const expectations = {};

    glob
    .sync(reporter + '.*', { cwd: __dirname + '/../expected', realpath: true })
    .forEach((file) => {
        const name = path.basename(file).substr(reporter.length + 1);
        const fixture = fixtures[camelCase(name)];
        const expected = fs.readFileSync(file).toString();

        expectations[camelCase(name)] = {
            file,
            name,
            fixture,
            expected,
            run(options) {
                options = assign({
                    reporter,
                }, options);

                const plan = fixture();
                const buffered = bufferStdio.start();

                return plan
                .run(options)
                .finally(() => bufferStdio.finish())
                .catch(() => {})
                .then(() => {
                    return [buffered, expected];
                });
            },
        };
    });

    return expectations;
}

function test(expectations, normalizer) {
    let key;

    normalizer = normalizer || ((str) => str);

    for (key in expectations) {
        const expectation = expectations[key];

        it('should give the correct output for fixtures/' + expectation.name, () => {
            return expectation.run()
            .spread((buffered, expected) => {
                // Uncomment line below to generate expected files output
                // fs.writeFileSync(expectation.file, buffered.stdout);
                expect(normalizer(buffered.stdout)).to.equal(normalizer(expected));
                expect(buffered.stderr).to.equal('');
            });
        });
    }
}

module.exports = {
    expectations,
    test,
};