Add support for mocking services

bin/blueoak-server.js

@@ -11,7 +11,10 @@ cli = parseOptions();
 
 server.init({
     appDir: process.cwd(),
-    mockServices: cli.mockServices
+    mocks: {
+        services: cli.mockServices,
+        middleware: cli.mockMiddleware
+    }
 }, function(err) {
     if (err) {
         console.warn('Startup failed', err);
@@ -25,6 +28,7 @@ function parseOptions() {
     // parse cli options
     cli.version(pkg.version)
         .option('--mock-services <services>', 'comma separated list of service names to mock', toList)
+        .option('--mock-middleware <middleware>', 'comma separated list of middleware to mock', toList)
         .parse(process.argv);
 
     return cli;

index.js

@@ -32,8 +32,8 @@ module.exports.init = function (opts, callback) {
         global.__appDir = opts.appDir;
     }
 
-    if (opts.mockServices) {
-        global.__mockServices = opts.mockServices;
+    if (opts.mocks) {
+        global.__mocks = opts.mocks;
     }
 
     //Load the bootstrap services first (config and logging) since they're only needed for the master

lib/loader.js

@@ -53,7 +53,7 @@ function createLoader() {
         //if parent id is a consumer, i.e. was registered with a prefix,
         //strip the prefix off since that's not part of the module name
         parentId = parentId.indexOf('.') > -1 ? parentId.substring(parentId.indexOf('.') + 1) : parentId;
-        
+
         var mod = subRequire(id, parentId);
         moduleMap[id] = mod;
         dependencyMap[id] = normalizeServiceNames(di.getParamNames(mod.init));
@@ -180,7 +180,7 @@ function createLoader() {
                 var modPath = path.resolve(dir, file);
                 var mod;
                 try {
-                    mod = require(modPath);
+                    mod = subRequire(modPath);
                 } catch (e) {
                     throw new Error('Could not load ' + modPath + ': ' + e.message);
                 }

lib/subRequire.js

@@ -13,6 +13,8 @@
  * In this case we could call subRequire(Y, X), and it would require Y from the context of X.
  */
 var path = require('path'),
+    util = require('util'),
+    fs = require('fs'),
     _ = require('lodash');
 
 var modulePath = {}; //maintain a list of the paths where we resolved files - needed for unloading the modules
@@ -25,15 +27,7 @@ var modulePath = {}; //maintain a list of the paths where we resolved files - ne
  * but also provides a way to load submodules by passing the optional parentId argument.
  */
 module.exports = function (id, parentId) {
-    // load mock if appropriate
-    if (global.__mockServices &&
-        _.includes(global.__mockServices, path.basename(id, path.extname(id)))
-    ) {
-        var mockPath = path.resolve(global.__appDir, 'test', 'bos-mocks', 'services', path.basename(id));
-        if (mockPath) {
-            id = mockPath;
-        }
-    }
+    id = resolveMock(id);
 
     if (id.indexOf('.js') > -1) {
         return loadJsFile(id);
@@ -54,6 +48,47 @@ module.exports.unload = function (id) {
     }
 };
 
+//Attempts to resolve mock modules
+function resolveMock(id, type) {
+    // short circuit if no mocks are declared
+    if (!global.__mocks) {
+        return id;
+    }
+
+    // recurse to resolve different mock types
+    if (arguments.length < 2) {
+        id = resolveMock(id, 'services');
+        id = resolveMock(id, 'middleware');
+        return id;
+    }
+
+    // if the mock type declares our mock, attempt to resolve it
+    if (global.__mocks[type] &&
+        _.includes(global.__mocks[type], path.basename(id, path.extname(id)))
+    ) {
+        var mockId = path.basename(id);
+        var mockPath = path.resolve(global.__appDir, 'test', 'bos-mocks', type, mockId);
+        var mockExists = fs.existsSync(mockPath) || fs.existsSync(mockPath + '.js');
+
+        // if we have a mock path and the mock exists, load it
+        // otherwise, warn the user
+        if (mockPath && mockExists) {
+            id = mockPath;
+        } else if (!mockExists) {
+            var logger = this.services.get('logger');
+            if (logger) {
+                this.services.get('logger').warn(
+                    util.format('The requested mock %s "%s" were not found in the mock %s directory (%s)',
+                        type,
+                        mockId,
+                        type,
+                        path.dirname(mockPath)
+                    ));
+            }
+        }
+    }
+    return id;
+}
 
 //Performs a require directly on a file
 //A module id is calculated based on the name of the file, e.g.

test/integration/fixtures/server12/config/default.json

@@ -1,6 +1,7 @@
 {
   "express": {
-    "port": "5000"
+    "port": "5000",
+    "middleware": ["pet-middleware1", "pet-middleware2"]
   },
 
   "cluster": {

test/integration/fixtures/server12/handlers/petstore.js

@@ -2,23 +2,27 @@
  * Copyright (c) 2015-2016 PointSource, LLC.
  * MIT Licensed
  */
-var service1;
-var service2;
-var serviceModule;
-exports.init = function (logger, petService1, petService2, petServiceModule) {
+var service1,
+    service2,
+    serviceModule;
+
+exports.init = function (petService1, petService2, petServiceModule) {
     service1 = petService1;
     service2 = petService2;
     serviceModule = petServiceModule;
 };
 
 exports.getPets1 = function (req, res, next) {
     res.send(service1.getPets());
+    next();
 };
 
 exports.getPets2 = function (req, res, next) {
     res.send(service2.getPets());
+    next();
 };
 
 exports.getPets3 = function (req, res, next) {
     res.send(serviceModule.getPets());
+    next();
 };

test/integration/fixtures/server12/middleware/pet-middleware1.js

@@ -0,0 +1,10 @@
+exports.init = function (app, config, logger, callback) {
+    app.use(middleware);
+    logger.info('Pet Middleware1 initialized');
+    callback();
+};
+
+function middleware(req, res, next) {
+    res.header('x-pet-middleware1', 'pet-middleware1');
+    next();
+}

test/integration/fixtures/server12/middleware/pet-middleware2.js

@@ -0,0 +1,10 @@
+exports.init = function (app, config, logger, callback) {
+    app.use(middleware);
+    logger.info('Pet Middleware2 initialized');
+    callback();
+};
+
+function middleware(req, res, next) {
+    res.header('x-pet-middleware2', 'pet-middleware2');
+    next();
+}

test/integration/fixtures/server12/test/bos-mocks/middleware/pet-middleware1.js

@@ -0,0 +1,10 @@
+exports.init = function (app, config, logger, callback) {
+    app.use(middleware);
+    logger.info('Pet Middleware1 Mock initialized');
+    callback();
+};
+
+function middleware(req, res, next) {
+    res.header('x-pet-middleware1', 'pet-middleware1-mock');
+    next();
+}

test/integration/fixtures/server12/test/bos-mocks/middleware/pet-middleware2.js

@@ -0,0 +1,10 @@
+exports.init = function (app, config, logger, callback) {
+    app.use(middleware);
+    logger.info('Pet Middleware2 Mock initialized');
+    callback();
+};
+
+function middleware(req, res, next) {
+    res.header('x-pet-middleware2', 'pet-middleware2-mock');
+    next();
+}

test/integration/fixtures/server13/config/default.json

@@ -0,0 +1,10 @@
+{
+  "express": {
+    "port": "5000",
+    "middleware": ["pet-middleware"]
+  },
+
+  "cluster": {
+    "maxWorkers": 1
+  }
+}

test/integration/fixtures/server13/handlers/petstore.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2015-2016 PointSource, LLC.
+ * MIT Licensed
+ */
+var service1;
+var service2;
+var serviceModule;
+exports.init = function (logger, petService1, petService2, petServiceModule) {
+    service1 = petService1;
+    service2 = petService2;
+    serviceModule = petServiceModule;
+};
+
+exports.getPets1 = function (req, res, next) {
+    res.send(service1.getPets());
+};
+
+exports.getPets2 = function (req, res, next) {
+    res.send(service2.getPets());
+};
+
+exports.getPets3 = function (req, res, next) {
+    res.send(serviceModule.getPets());
+};

test/integration/fixtures/server13/middleware/pet-middleware.js

@@ -0,0 +1,3 @@
+exports.init = function () {
+
+};

test/integration/fixtures/server13/services/pet-service1.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2015-2016 PointSource, LLC.
+ * MIT Licensed
+ */
+exports.init = function(logger) {
+    logger.info('Pet Service1 initialized');
+};
+
+exports.getPets = function() {
+    return {
+        id: 1,
+        name: 'service1 pet'
+    };
+};

test/integration/fixtures/server13/services/pet-service2.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2015-2016 PointSource, LLC.
+ * MIT Licensed
+ */
+exports.init = function(logger) {
+    logger.info('Pet Service2 initialized');
+};
+
+exports.getPets = function() {
+    return {
+        id: 2,
+        name: 'service2 pet'
+    };
+};