nadda/lib/nadda.js

A zero config plugin for BDD acceptance testing in the browser using a combination of yadda and nightwatch

'use strict';

var PATHS = require('./paths'),
	LOCALISATIONS = require('./options/localisation'),
	BROWSERS = require('./options/browser'),
	glob = require('glob-all'),
	mkdirp = require('mkdirp'),
	q = require('q'),
	path = require('path'),
	rimraf = require('rimraf'),
	Nightwatch = require('nightwatch'),
  mergeSettingsFile = require('./utils/merge-settings-file'),
  copyFileWithReplacements = require('./utils/copy-file-with-replacements'),
	processOptions = require('./utils/process-options');

function nadda (options) {
	var def = q.defer();

	try {
		//process options
		options = processOptions(options);

		//create sandbox skeleton folder structure
		try {
			mkdirp.sync(path.resolve(PATHS.NADDA, 'sandbox/features'));
		} catch (e) {
			if (e.code !== 'EEXIST') {
				throw e;
			}
		}

		//nightwatch settings (merge internal defaults and external)
		mergeSettingsFile(options.config);

    //write step lib wrapper
    copyFileWithReplacements(path.resolve(PATHS.NADDA, 'templates/steps-lib-template.txt'),
                            path.resolve(PATHS.NADDA, 'sandbox/steps-lib.js'),
                            {
								'{create_steps_location}': path.resolve(PATHS.NADDA, 'utils/create-steps-lib').replace(/\\/g, '\\\\'),
								'{steps_location}': JSON.stringify(
																				options.steps
																				.map(function (step) {
																						return path.resolve(PATHS.PROJ, step).replace(/\\/g, '\\\\');
																				})
																			),
								'{localisation}' : options.localisation
							});

    //write wrapper for each test
    glob.sync(options.features).forEach(function (featureFile) {
        var featureTitle = path.basename(featureFile).replace(/\..*/, ''),
					dirname = path.dirname(featureFile).replace(PATHS.PROJ + '/', '');
				mkdirp.sync(path.resolve(PATHS.NADDA, 'sandbox/features', dirname));
        copyFileWithReplacements(path.resolve(PATHS.NADDA, 'templates/feature-wrapper-template.txt'),
                                path.resolve(PATHS.NADDA, 'sandbox/features', dirname, featureTitle + '.js'),
                                {
									'{feature_location}': path.resolve(PATHS.PROJ, featureFile).replace(/\\/g, '\\\\'),
									'{decode_feature_location}': path.resolve(PATHS.NADDA, 'utils/decode-feature').replace(/\\/g, '\\\\'),
									'{tag_rules}': JSON.stringify(options.tags)
								});
    });

		//Run nightwatch
		Nightwatch.runner({
			config : path.resolve(PATHS.NADDA, 'sandbox/nightwatch.json'),
			env : options.env
		}, function () {
			rimraf.sync(path.resolve(PATHS.NADDA, 'sandbox'));
			def.resolve();
		}, {});

	} catch (e) {
		def.reject();
		console.log('ERROR:', e);
	}

	return def.promise;
}

nadda.LOCALISATIONS = LOCALISATIONS.options;
nadda.BROWSERS = BROWSERS.options;

module.exports = nadda;