tests: add tests for recipe command

Author: shakyShane

lib/cli/command.recipe.js

@@ -1,5 +1,5 @@
 "use strict";
-var logger = require('../logger').logger;
+var logger = require("../logger").logger;
 
 /**
  * $ browser-sync recipe <name> <options>
@@ -12,32 +12,31 @@ var logger = require('../logger').logger;
  */
 module.exports = function (opts) {
 
-    var path      = require('path');
-    var fs        = require('fs-extra');
+    var path      = require("path");
+    var fs        = require("fs-extra");
     var input     = opts.cli.input.slice(1);
-    var resolved  = require.resolve('bs-recipes');
+    var resolved  = require.resolve("bs-recipes");
     var dir       = path.dirname(resolved);
 
-    var logRecipes = function (cb) {
-        fs.readdir(path.join(dir, 'recipes'), function (err, output) {
-            logger.info('Install one of the following with {cyan:browser-sync recipe <name>\n');
-            output.forEach(function (name) {
-                console.log('    ', name);
-            });
-            cb();
+    var logRecipes = function () {
+        var dirs = fs.readdirSync(path.join(dir, "recipes"), function (err, output) {
+        });
+        logger.info("Install one of the following with {cyan:browser-sync recipe <name>\n");
+        dirs.forEach(function (name) {
+            console.log("    " + name);
         });
     }
 
     if (!input.length) {
-        logger.info('No recipe name provided!');
-        return logRecipes(opts.cb);
+        logger.info("No recipe name provided!");
+        logRecipes();
+        return opts.cb();
     }
 
     input         = input[0];
     var flags     = opts.cli.flags;
     var output    = flags.output ? path.resolve(flags.output) : path.join(process.cwd(), input);
-    var targetDir = path.join(dir, 'recipes', input);
-
+    var targetDir = path.join(dir, "recipes", input);
 
     if (fs.existsSync(output)) {
         return opts.cb(new Error("Target folder exists remove it first and then try again"));
@@ -48,13 +47,14 @@ module.exports = function (opts) {
             if (err) {
                 opts.cb(err);
             } else {
-                logger.info('Recipe copied into {cyan:%s}', output);
-                logger.info('Next, inside that folder, run {cyan:npm i && npm start}');
+                logger.info("Recipe copied into {cyan:%s}", output);
+                logger.info("Next, inside that folder, run {cyan:npm i && npm start}");
                 opts.cb(null);
             }
         });
     } else {
-        logger.info('Recipe {cyan:%s} not found. The following are available though', input);
+        logger.info("Recipe {cyan:%s} not found. The following are available though", input);
         logRecipes();
+        opts.cb();
     }
 };

package.json

@@ -74,6 +74,7 @@
     "mocha": "2.3.0",
     "q": "1.4.1",
     "request": "2.61.0",
+    "rimraf": "^2.4.3",
     "sinon": "1.15.4",
     "slugify": "0.1.1",
     "socket.io-client": "1.3.7",

test/specs/commands/recipes.js

@@ -0,0 +1,120 @@
+"use strict";
+
+var path        = require("path");
+var browserSync = require(path.resolve("./"));
+
+var pkg         = require(path.resolve("package.json"));
+var sinon       = require("sinon");
+var logger      = require("../../../lib/logger").logger;
+var assert      = require("chai").assert;
+var cli         = require(path.resolve(pkg.bin));
+var fs          = require("fs");
+var rim         = require("rimraf").sync;
+
+describe("E2E CLI `recipes` command", function () {
+    it("works with no output flag", function (done) {
+        rim("./server");
+        cli({
+            cli: {
+                input: ["recipe", "server"],
+                flags: {}
+            },
+            cb: function () {
+                assert.isTrue(fs.existsSync("./server"));
+                rim("./server");
+                done();
+            }
+        });
+    });
+    it("lists all available when no second arg given", function (done) {
+        var stub1 = sinon.stub(logger, "info");
+        var stub2 = sinon.stub(console, "log");
+
+        cli({
+            cli: {
+                input: ["recipe"],
+                flags: {}
+            },
+            cb: function () {
+                sinon.assert.calledWith(stub1, "No recipe name provided!");
+                sinon.assert.calledWith(stub1, "Install one of the following with {cyan:browser-sync recipe <name>\n");
+
+                logger.info.restore();
+                console.log.restore();
+
+                var calls = stub2.getCalls().map(function (call) {
+                    return call.args[0].trim();
+                });
+
+                assert.include(calls, "gulp.jade");
+                assert.include(calls, "server");
+                assert.include(calls, "html.injection");
+                done();
+            }
+        });
+    });
+    it("Does not overwrite existing dir", function (done) {
+        cli({
+            cli: {
+                input: ["recipe", "server"],
+                flags: {
+                    output: "test/fixtures"
+                }
+            },
+            cb: function (err) {
+                assert.equal(err.message, "Target folder exists remove it first and then try again");
+                done();
+            }
+        });
+    });
+    it("accepts --output flag", function (done) {
+        var stub1 = sinon.stub(logger, "info");
+        cli({
+            cli: {
+                input: ["recipe", "server"],
+                flags: {
+                    output: "test/recipes/server1"
+                }
+            },
+            cb: function () {
+                var dir = path.resolve("./test/recipes/server1");
+                assert.isTrue(fs.existsSync("test/recipes/server1"));
+                rim("test/recipes/server1");
+                var call1 = stub1.getCall(0).args;
+                assert.equal(call1[0], "Recipe copied into {cyan:%s}");
+                assert.equal(call1[1], dir);
+                sinon.assert.calledWith(stub1, "Next, inside that folder, run {cyan:npm i && npm start}");
+                logger.info.restore();
+                done();
+            }
+        });
+    });
+    it("Loges recipes when not found", function (done) {
+        var stub1 = sinon.stub(logger, "info");
+        var stub2 = sinon.stub(console, "log");
+
+        cli({
+            cli: {
+                input: ["recipe", "beepboop"],
+                flags: {}
+            },
+            cb: function (err) {
+                var call1 = stub1.getCall(0).args;
+                assert.equal(call1[0], "Recipe {cyan:%s} not found. The following are available though");
+
+                var calls = stub2.getCalls().map(function (call) {
+                    return call.args[0].trim();
+                });
+
+                assert.include(calls, "gulp.jade");
+                assert.include(calls, "server");
+                assert.include(calls, "html.injection");
+
+                logger.info.restore();
+                console.log.restore();
+
+                done();
+            }
+        });
+    });
+});