Refactoring and completing plugin functionality and tests

Author: Carlos Atencio

Gruntfile.js

@@ -50,7 +50,7 @@ module.exports = function(grunt) {
             test: {
                 src: 'tests/bundle/httpMock.js',
                 options: {
-                    specs: 'tests/plugin.test.js',
+                    specs: 'tests/*.test.js',
                     vendor: [
                         'http://cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.20/angular.js'
                     ],

example/app/app.js

@@ -49,6 +49,11 @@ angular
 						city: city
 					}
 				});
+			},
+			getThroughPlugin: function(){
+				return $http.get('/users', {
+					plugin: {}
+				});
 			}
 		};
 	})
@@ -258,4 +263,14 @@ angular
 	})
 	.controller('HttpDefaultsController', function($http){
 		this.hasHttpDefaults = !!$http.defaults;
+	})
+	.controller('PluginsController', function(userService){
+		var self = this;
+
+		self.get = function(){
+			return userService.getThroughPlugin().then(function(response){
+				console.log('HERE', response);
+				self.result = response.data;
+			});
+		}
 	});

example/index.html

@@ -71,6 +71,11 @@
 			<pre id="http-defaults" ng-show="ctrl.hasHttpDefaults">$http defaults are set</pre>
 		</div>
 
+		<div ng-controller="PluginsController as ctrl">
+			<button id="plugin-request" ng-click="ctrl.get()">Plugin</button>
+			<span id="plugin-result">{{ ctrl.result }}</span>
+		</div>
+
 		<script src="//cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.20/angular.min.js"></script>
 		<script src="app/app.js"></script>
 	</body>

example/protractor-conf.js

@@ -7,6 +7,9 @@ var config = {
       dir: 'mocks',
       default: ['default']
     },
+    httpMockPlugins: {
+      default: ['protractor-http-mock-sample-plugin']
+    },
     onPrepare: function(){
       require('../index').config = {
         rootDirectory: __dirname

example/spec/plugin.spec.js

@@ -0,0 +1,45 @@
+var mock = require('../../index'), //substitute for require('protractor-http-mock')
+	get = require('./get'); 
+
+describe('requests made', function(){
+	
+	afterEach(function(){
+		mock.teardown();
+	});
+
+	beforeEach(function(){
+		mock([
+			{
+				request: {
+					path: '/users',
+					method: 'GET',
+					plugin: {
+						check: true
+					}
+				},
+				response: {
+					data: 'from sample plugin match'
+				}
+			},
+			{
+				request: {
+					path: '/users',
+					method: 'GET',
+					plugin: {
+						check: false
+					}
+				},
+				response: {
+					data: 'my plugin should not match here!'
+				}
+			}
+		]);
+
+		get();
+	});
+
+	it('can match through plugin', function(){
+		element(by.id('plugin-request')).click();
+		expect(element(by.id('plugin-result')).getText()).toBe('from sample plugin match');
+	});
+});

lib/defaultConfig.js

@@ -1,10 +1,13 @@
 module.exports = {
-  moduleConfig: {
-    rootDirectory: process.cwd(),
-    protractorConfig: 'protractor-conf.js'
-  },
-  mocksConfig: {
+  rootDirectory: process.cwd(),
+  protractorConfig: 'protractor-conf.js',
+
+  mocks: {
     dir: 'mocks',
     default: []
+  },
+
+  plugins: {
+  	default: []
   }
 };

lib/initData.js

@@ -4,62 +4,50 @@ var httpMock = require('./httpMock'),
 	path = require('path'),
 	defaultConfig = require('./defaultConfig');
 
-function readDataModule(mockDirectory, mock){
-	return require(path.join(mockDirectory, mock));
-}
-
-function getDefaultKeys(mocksConfig){
-	return mocksConfig.default && mocksConfig.default.length > 0 ? mocksConfig.default : [];
-}
-
-function readModuleConfig(propertyName){
-	return module.exports.config[propertyName] || defaultConfig.moduleConfig[propertyName];
-}
-
-function getModuleConfig(){
-	var moduleConfig = {};
+function getConfig(){
+	var config = defaultConfig;
 
 	if(module.exports.config){
-		moduleConfig.rootDirectory = readModuleConfig('rootDirectory');
-		moduleConfig.protractorConfig = readModuleConfig('protractorConfig');
-	}else{
-		moduleConfig = defaultConfig.moduleConfig; 
+		config.rootDirectory = module.exports.config['rootDirectory'] || config.module.rootDirectory;
 	}
 
-	return moduleConfig;
-}
+	var protractorConfigFile = path.join(config.rootDirectory, module.exports.config['protractorConfig'] || config.protractorConfig);
+	var protractorConfig = require(protractorConfigFile).config;
 
-function getMocksConfig(moduleConfig){
-	var protractorConfigFile = path.join(moduleConfig.rootDirectory, moduleConfig.protractorConfig);
-	var mocksConfig = require(protractorConfigFile).config.mocks;
+	config.mocks = protractorConfig.mocks || defaultConfig.mocks;
+	// TODO: add validation check
+	config.mocks.default = config.mocks.default || [];
 
-	if(!mocksConfig){
-		mocksConfig = defaultConfig.mocksConfig;
-	}
+	config.plugins = protractorConfig.httpMockPlugins || defaultConfig.plugins;
+	// TODO: add validation check
+	config.plugins.default = config.plugins.default || [];
 
-	return mocksConfig;
+	return config;
 }
 
-function getProtractorInstance(){
-	return protractor.getInstance ? protractor.getInstance() : browser;
+function readMockFile(mockDirectory, mock){
+	return require(path.join(mockDirectory, mock));
 }
 
-module.exports = function(mocks, skipDefaults){
+function getDefaultKeys(mocksConfig){
+	return mocksConfig.default && mocksConfig.default.length > 0 ? mocksConfig.default : [];
+}
+
+function buildMocks(mocks, skipDefaults){
 	var data = [],
-		dataModule,
-		moduleConfig = getModuleConfig(),
-		ptor = getProtractorInstance(),
-		mocksConfig = getMocksConfig(moduleConfig),
-		mockDirectory = path.join(moduleConfig.rootDirectory, mocksConfig.dir);
+		config = getConfig(),
+		mockDirectory = path.join(config.rootDirectory, config.mocks.dir);
 
 	mocks = mocks || [];
 
 	if(!skipDefaults){
-		mocks = getDefaultKeys(mocksConfig).concat(mocks);
+		mocks = config.mocks.default.concat(mocks);
 	}
 
 	for(var i = 0; i < mocks.length; i++){
-		dataModule = typeof mocks[i] === 'string' ? readDataModule(mockDirectory, mocks[i]) : mocks[i];
+		// TODO: add validation check
+		var dataModule = typeof mocks[i] === 'string' ? readMockFile(mockDirectory, mocks[i]) : mocks[i];
+		
 		if(Array.isArray(dataModule)){
 			data = data.concat(dataModule);
 		}else{
@@ -68,7 +56,38 @@ module.exports = function(mocks, skipDefaults){
 
 	}
 
-	ptor.addMockModule('httpMock', httpMock(data));
+	return data;
+}
+
+function buildPlugins(plugins, skipDefaults){
+	var data = [],
+		config = getConfig();
+
+	plugins = plugins || [];
+
+	if(!skipDefaults){
+		plugins = config.plugins.default.concat(plugins);
+	}
+
+	for(var i = 0; i < plugins.length; i++){
+		// TODO: add validation check
+		var plugin = typeof plugins[i] === 'string' ? require(plugins[i]) : plugins[i];
+		data.push(plugin);
+	}
+
+	return data;
+}
+
+function getProtractorInstance(){
+	return protractor.getInstance ? protractor.getInstance() : browser;
+}
+
+module.exports = function(mocks, plugins, skipDefaults){
+	var mocks = buildMocks(mocks, skipDefaults),
+		plugins = buildPlugins(plugins);
+
+	var ptor = getProtractorInstance();
+	ptor.addMockModule('httpMock', httpMock(mocks, plugins));
 };
 
 module.exports.teardown = function(){
@@ -106,4 +125,4 @@ module.exports.remove = function(mocks){
 		var callback = arguments[arguments.length - 1]
 		callback(JSON.stringify(true));
 	}, mocks);
-};
+};

package.json

@@ -18,7 +18,8 @@
     "grunt-contrib-jshint": "~0.10.0",
     "grunt-jasmine-node": "~0.2.1",
     "grunt-protractor-runner": "^1.1.4",
-    "phantomjs-prebuilt": "2.1.3"
+    "phantomjs-prebuilt": "2.1.3",
+    "protractor-http-mock-sample-plugin": "0.0.1"
   },
   "repository": {
     "type": "git",

tests/plugin.test.js

@@ -8,7 +8,8 @@ describe('plugins', function(){
 	it('plugins can match', function(done){
 		http({
 			method: 'GET',
-			url: '/plugin'
+			url: '/plugin',
+			plugin: {}
 		}).success(function(data, status){
 			expect(data).toBe('plugin match works!');
 			expect(status).toBe(200);

tests/setup.js

@@ -247,7 +247,7 @@
 			request: {
 				path: '/plugin',
 				method: 'get',
-				form: {
+				plugin: {
 					check: true
 				}
 			},
@@ -259,11 +259,11 @@
 
 	var plugins = [
 		{
-			match: function(expectationRequest, config){
+			match: function(mockRequest, requestConfig){
 				var match = true;
 
-				if(config.url.indexOf('plugin') > 0 && expectationRequest.path == '/plugin'){
-					return expectationRequest.form.check;
+				if(requestConfig.plugin  && mockRequest.plugin){
+					return mockRequest.plugin.check;
 				}
 
 				return match;