From 18d61975b9883830fe30a83b0a5ff51ef0c2a3e8 Mon Sep 17 00:00:00 2001 From: Jason Parrott Date: Sun, 21 Aug 2016 15:03:38 -0400 Subject: [PATCH] Add end to end tests with mocks --- .travis.yml | 14 +- e2e/mocks/get-users.js | 12 + e2e/protractor.conf.js | 42 ++ e2e/run.sh | 17 + e2e/specs/browser.js | 46 ++ js/config.js | 2 +- js/libs/jquery.mockjax.js | 1003 +++++++++++++++++++++++++++++++++++++ js/main.js | 13 +- js/mocks.js | 99 ++++ 9 files changed, 1241 insertions(+), 7 deletions(-) create mode 100644 e2e/mocks/get-users.js create mode 100644 e2e/protractor.conf.js create mode 100755 e2e/run.sh create mode 100644 e2e/specs/browser.js create mode 100644 js/libs/jquery.mockjax.js create mode 100644 js/mocks.js diff --git a/.travis.yml b/.travis.yml index 8c26373..0f9f5ea 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,15 @@ language: node_js node_js: - - "0.10" - + - '4' before_script: - - /bin/env - - /bin/ps auxf + - env + - ps auxf - hostname - uname -a + - npm install -g protractor +script: e2e/run.sh +addons: + sauce_connect: + username: "fanatic" + access_key: + secure: Yhe4v48+JYDcaByL3/ZZf2qUbCYx9p1WjNa6nR6lW3Q7BJbLFERzyvTMoLyGfDRHNlnLE3cRfZM6NHNmAb8s8idtzilnC+RYEGLLi2KlGz2p6Xp9fKg0rkhIMGbuwQ4Z0pQMHeuYYCEp69/HKocQcaqiYtCtiLz4UTft+Tq0VQI= diff --git a/e2e/mocks/get-users.js b/e2e/mocks/get-users.js new file mode 100644 index 0000000..ea689b4 --- /dev/null +++ b/e2e/mocks/get-users.js @@ -0,0 +1,12 @@ +{ + request: { + path: '/users/1', + method: 'GET' + }, + response: { + data: { + userName: 'pro-mock', + email: 'pro-mock@email.com' + } + } +} \ No newline at end of file diff --git a/e2e/protractor.conf.js b/e2e/protractor.conf.js new file mode 100644 index 0000000..627b8d4 --- /dev/null +++ b/e2e/protractor.conf.js @@ -0,0 +1,42 @@ +exports.config = { + baseUrl: 'http://localhost:8888/', + //seleniumAddress: 'http://localhost:4444/wd/hub', + specs: ['specs/*.js'], + + // Sauce Labs Setup + sauceUser: process.env.SAUCE_USERNAME, + sauceKey: process.env.SAUCE_ACCESS_KEY, + + // restartBrowserBetweenTests: true, + + onPrepare: function(){ + var caps = browser.getCapabilities() + }, + + multiCapabilities: [{ + browserName: 'firefox', + version: '32', + platform: 'OS X 10.10', + name: "firefox-tests", + shardTestFiles: true, + maxInstances: 2, + 'tunnel-identifier': process.env.TRAVIS_JOB_NUMBER + }, { + browserName: 'chrome', + version: '41', + platform: 'Windows 7', + name: "chrome-tests", + shardTestFiles: true, + maxInstances: 2, + 'tunnel-identifier': process.env.TRAVIS_JOB_NUMBER + }], + + onComplete: function() { + var printSessionId = function(jobName){ + browser.getSession().then(function(session) { + console.log('SauceOnDemandSessionID=' + session.getId() + ' job-name=' + jobName); + }); + } + printSessionId("Insert Job Name Here"); + } +}; diff --git a/e2e/run.sh b/e2e/run.sh new file mode 100755 index 0000000..7cc84ef --- /dev/null +++ b/e2e/run.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +if [[ "$(basename `pwd`)" == "e2e" ]]; then + echo "Run from the root of the project instead" + echo "./e2e/run.sh" + exit 1 +fi + +python -m SimpleHTTPServer 8888 & +http_pid=$! + +function finish { + kill -9 $http_pid +} +trap finish EXIT + +protractor e2e/protractor.conf.js diff --git a/e2e/specs/browser.js b/e2e/specs/browser.js new file mode 100644 index 0000000..edab710 --- /dev/null +++ b/e2e/specs/browser.js @@ -0,0 +1,46 @@ +describe('swift-ui homepage', function() { + beforeEach(function () { + browser.driver.get('http://localhost:8888/index.html'); + }); + + it('should log in', function() { + //browser.pause(); + // Allow page to load + browser.sleep(10000); + + expect(browser.driver.getTitle()).toEqual('Swift UI'); + browser.driver.findElement(by.id('loginButton')).click(); + + // Wait for login + browser.sleep(1000); + + var loginText = browser.driver.findElement(by.css('#login-entry .navbar-text')); + expect(loginText.getText()).toEqual('Signed in as test:tester'); + }); + + it('should list accounts and details', function() { + browser.sleep(10000); + browser.driver.findElement(by.id('loginButton')).click(); + + // Wait for login + browser.sleep(2000); + + //browser.pause(); + + var account = browser.driver.findElement(by.css('#test[rel="account"] a')); + expect(account.getText()).toEqual(' test'); + account.click(); + + // Wait for account details to laod + browser.sleep(1000); + + var breadcrumb = browser.driver.findElement(by.css('.breadcrumb > li:first-child')); + expect(breadcrumb.getText()).toEqual('test'); + + var header = browser.driver.findElement(by.css('.page-header > h1 > small')); + expect(header.getText()).toEqual('Account'); + + var metadata = browser.driver.findElement(by.css('#Color.metadata')); + expect(metadata.getText()).toEqual('blue'); + }); +}); diff --git a/js/config.js b/js/config.js index c0fcde0..4a08fd6 100644 --- a/js/config.js +++ b/js/config.js @@ -2,7 +2,7 @@ var appConfig = { "auth": { "username": "test:tester", "key": "testing", - "endpoint": "http://192.168.2.77:8080/auth/v1.0" + "endpoint": "http://example.com:8080/auth/v1.0" } }; diff --git a/js/libs/jquery.mockjax.js b/js/libs/jquery.mockjax.js new file mode 100644 index 0000000..67e09c0 --- /dev/null +++ b/js/libs/jquery.mockjax.js @@ -0,0 +1,1003 @@ +/*! jQuery Mockjax + * A Plugin providing simple and flexible mocking of ajax requests and responses + * + * Version: 2.2.0 + * Home: https://github.com/jakerella/jquery-mockjax + * Copyright (c) 2016 Jordan Kasper, formerly appendTo; + * NOTE: This repository was taken over by Jordan Kasper (@jakerella) October, 2014 + * + * Dual licensed under the MIT or GPL licenses. + * http://opensource.org/licenses/MIT OR http://www.gnu.org/licenses/gpl-2.0.html + */ +(function(root, factory) { + 'use strict'; + + // AMDJS module definition + if ( typeof define === 'function' && define.amd && define.amd.jQuery ) { + define(['jquery'], function($) { + return factory($, root); + }); + + // CommonJS module definition + } else if ( typeof exports === 'object') { + + // NOTE: To use Mockjax as a Node module you MUST provide the factory with + // a valid version of jQuery and a window object (the global scope): + // var mockjax = require('jquery.mockjax')(jQuery, window); + + module.exports = factory; + + // Global jQuery in web browsers + } else { + return factory(root.jQuery || root.$, root); + } +}(this, function($, window) { + 'use strict'; + + var _ajax = $.ajax, + mockHandlers = [], + mockedAjaxCalls = [], + unmockedAjaxCalls = [], + CALLBACK_REGEX = /=\?(&|$)/, + jsc = (new Date()).getTime(), + DEFAULT_RESPONSE_TIME = 500; + + // Parse the given XML string. + function parseXML(xml) { + if ( window.DOMParser === undefined && window.ActiveXObject ) { + window.DOMParser = function() { }; + DOMParser.prototype.parseFromString = function( xmlString ) { + var doc = new ActiveXObject('Microsoft.XMLDOM'); + doc.async = 'false'; + doc.loadXML( xmlString ); + return doc; + }; + } + + try { + var xmlDoc = ( new DOMParser() ).parseFromString( xml, 'text/xml' ); + if ( $.isXMLDoc( xmlDoc ) ) { + var err = $('parsererror', xmlDoc); + if ( err.length === 1 ) { + throw new Error('Error: ' + $(xmlDoc).text() ); + } + } else { + throw new Error('Unable to parse XML'); + } + return xmlDoc; + } catch( e ) { + var msg = ( e.name === undefined ? e : e.name + ': ' + e.message ); + $(document).trigger('xmlParseError', [ msg ]); + return undefined; + } + } + + // Check if the data field on the mock handler and the request match. This + // can be used to restrict a mock handler to being used only when a certain + // set of data is passed to it. + function isMockDataEqual( mock, live ) { + logger.debug( mock, ['Checking mock data against request data', mock, live] ); + var identical = true; + + if ( $.isFunction(mock) ) { + return !!mock(live); + } + + // Test for situations where the data is a querystring (not an object) + if (typeof live === 'string') { + // Querystring may be a regex + if ($.isFunction( mock.test )) { + return mock.test(live); + } else if (typeof mock === 'object') { + live = getQueryParams(live); + } else { + return mock === live; + } + } + + $.each(mock, function(k) { + if ( live[k] === undefined ) { + identical = false; + return identical; + } else { + if ( typeof live[k] === 'object' && live[k] !== null ) { + if ( identical && $.isArray( live[k] ) ) { + identical = $.isArray( mock[k] ) && live[k].length === mock[k].length; + } + identical = identical && isMockDataEqual(mock[k], live[k]); + } else { + if ( mock[k] && $.isFunction( mock[k].test ) ) { + identical = identical && mock[k].test(live[k]); + } else { + identical = identical && ( mock[k] === live[k] ); + } + } + } + }); + + return identical; + } + + function getQueryParams(queryString) { + var i, l, param, tmp, + paramsObj = {}, + params = String(queryString).split(/&/); + + for (i=0, l=params.length; i= 0; + } + + function parseResponseTimeOpt(responseTime) { + if ($.isArray(responseTime) && responseTime.length === 2) { + var min = responseTime[0]; + var max = responseTime[1]; + if(isPosNum(min) && isPosNum(max)) { + return Math.floor(Math.random() * (max - min)) + min; + } + } else if(isPosNum(responseTime)) { + return responseTime; + } + return DEFAULT_RESPONSE_TIME; + } + + // Process the xhr objects send operation + function _xhrSend(mockHandler, requestSettings, origSettings) { + logger.debug( mockHandler, ['Sending fake XHR request', mockHandler, requestSettings, origSettings] ); + + // This is a substitute for < 1.4 which lacks $.proxy + var process = (function(that) { + return function() { + return (function() { + // The request has returned + this.status = mockHandler.status; + this.statusText = mockHandler.statusText; + this.readyState = 1; + + var finishRequest = function () { + this.readyState = 4; + + var onReady; + // Copy over our mock to our xhr object before passing control back to + // jQuery's onreadystatechange callback + if ( requestSettings.dataType === 'json' && ( typeof mockHandler.responseText === 'object' ) ) { + this.responseText = JSON.stringify(mockHandler.responseText); + } else if ( requestSettings.dataType === 'xml' ) { + if ( typeof mockHandler.responseXML === 'string' ) { + this.responseXML = parseXML(mockHandler.responseXML); + //in jQuery 1.9.1+, responseXML is processed differently and relies on responseText + this.responseText = mockHandler.responseXML; + } else { + this.responseXML = mockHandler.responseXML; + } + } else if (typeof mockHandler.responseText === 'object' && mockHandler.responseText !== null) { + // since jQuery 1.9 responseText type has to match contentType + mockHandler.contentType = 'application/json'; + this.responseText = JSON.stringify(mockHandler.responseText); + } else { + this.responseText = mockHandler.responseText; + } + if( typeof mockHandler.status === 'number' || typeof mockHandler.status === 'string' ) { + this.status = mockHandler.status; + } + if( typeof mockHandler.statusText === 'string') { + this.statusText = mockHandler.statusText; + } + // jQuery 2.0 renamed onreadystatechange to onload + onReady = this.onload || this.onreadystatechange; + + // jQuery < 1.4 doesn't have onreadystate change for xhr + if ( $.isFunction( onReady ) ) { + if( mockHandler.isTimeout) { + this.status = -1; + } + onReady.call( this, mockHandler.isTimeout ? 'timeout' : undefined ); + } else if ( mockHandler.isTimeout ) { + // Fix for 1.3.2 timeout to keep success from firing. + this.status = -1; + } + }; + + // We have an executable function, call it to give + // the mock handler a chance to update it's data + if ( $.isFunction(mockHandler.response) ) { + // Wait for it to finish + if ( mockHandler.response.length === 2 ) { + mockHandler.response(origSettings, function () { + finishRequest.call(that); + }); + return; + } else { + mockHandler.response(origSettings); + } + } + + finishRequest.call(that); + }).apply(that); + }; + })(this); + + if ( mockHandler.proxy ) { + logger.info( mockHandler, ['Retrieving proxy file: ' + mockHandler.proxy, mockHandler] ); + // We're proxying this request and loading in an external file instead + _ajax({ + global: false, + url: mockHandler.proxy, + type: mockHandler.proxyType, + data: mockHandler.data, + async: requestSettings.async, + dataType: requestSettings.dataType === 'script' ? 'text/plain' : requestSettings.dataType, + complete: function(xhr) { + // Fix for bug #105 + // jQuery will convert the text to XML for us, and if we use the actual responseXML here + // then some other things don't happen, resulting in no data given to the 'success' cb + mockHandler.responseXML = mockHandler.responseText = xhr.responseText; + + // Don't override the handler status/statusText if it's specified by the config + if (isDefaultSetting(mockHandler, 'status')) { + mockHandler.status = xhr.status; + } + if (isDefaultSetting(mockHandler, 'statusText')) { + mockHandler.statusText = xhr.statusText; + } + + if ( requestSettings.async === false ) { + // TODO: Blocking delay + process(); + } else { + this.responseTimer = setTimeout(process, parseResponseTimeOpt(mockHandler.responseTime)); + } + } + }); + } else { + // type === 'POST' || 'GET' || 'DELETE' + if ( requestSettings.async === false ) { + // TODO: Blocking delay + process(); + } else { + this.responseTimer = setTimeout(process, parseResponseTimeOpt(mockHandler.responseTime)); + } + } + + } + + // Construct a mocked XHR Object + function xhr(mockHandler, requestSettings, origSettings, origHandler) { + logger.debug( mockHandler, ['Creating new mock XHR object', mockHandler, requestSettings, origSettings, origHandler] ); + + // Extend with our default mockjax settings + mockHandler = $.extend(true, {}, $.mockjaxSettings, mockHandler); + + if (typeof mockHandler.headers === 'undefined') { + mockHandler.headers = {}; + } + if (typeof requestSettings.headers === 'undefined') { + requestSettings.headers = {}; + } + if ( mockHandler.contentType ) { + mockHandler.headers['content-type'] = mockHandler.contentType; + } + + return { + status: mockHandler.status, + statusText: mockHandler.statusText, + readyState: 1, + open: function() { }, + send: function() { + origHandler.fired = true; + _xhrSend.call(this, mockHandler, requestSettings, origSettings); + }, + abort: function() { + clearTimeout(this.responseTimer); + }, + setRequestHeader: function(header, value) { + requestSettings.headers[header] = value; + }, + getResponseHeader: function(header) { + // 'Last-modified', 'Etag', 'content-type' are all checked by jQuery + if ( mockHandler.headers && mockHandler.headers[header] ) { + // Return arbitrary headers + return mockHandler.headers[header]; + } else if ( header.toLowerCase() === 'last-modified' ) { + return mockHandler.lastModified || (new Date()).toString(); + } else if ( header.toLowerCase() === 'etag' ) { + return mockHandler.etag || ''; + } else if ( header.toLowerCase() === 'content-type' ) { + return mockHandler.contentType || 'text/plain'; + } + }, + getAllResponseHeaders: function() { + var headers = ''; + // since jQuery 1.9 responseText type has to match contentType + if (mockHandler.contentType) { + mockHandler.headers['Content-Type'] = mockHandler.contentType; + } + $.each(mockHandler.headers, function(k, v) { + headers += k + ': ' + v + '\n'; + }); + return headers; + } + }; + } + + // Process a JSONP mock request. + function processJsonpMock( requestSettings, mockHandler, origSettings ) { + // Handle JSONP Parameter Callbacks, we need to replicate some of the jQuery core here + // because there isn't an easy hook for the cross domain script tag of jsonp + + processJsonpUrl( requestSettings ); + + requestSettings.dataType = 'json'; + if(requestSettings.data && CALLBACK_REGEX.test(requestSettings.data) || CALLBACK_REGEX.test(requestSettings.url)) { + createJsonpCallback(requestSettings, mockHandler, origSettings); + + // We need to make sure + // that a JSONP style response is executed properly + + var rurl = /^(\w+:)?\/\/([^\/?#]+)/, + parts = rurl.exec( requestSettings.url ), + remote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host); + + requestSettings.dataType = 'script'; + if(requestSettings.type.toUpperCase() === 'GET' && remote ) { + var newMockReturn = processJsonpRequest( requestSettings, mockHandler, origSettings ); + + // Check if we are supposed to return a Deferred back to the mock call, or just + // signal success + if(newMockReturn) { + return newMockReturn; + } else { + return true; + } + } + } + return null; + } + + // Append the required callback parameter to the end of the request URL, for a JSONP request + function processJsonpUrl( requestSettings ) { + if ( requestSettings.type.toUpperCase() === 'GET' ) { + if ( !CALLBACK_REGEX.test( requestSettings.url ) ) { + requestSettings.url += (/\?/.test( requestSettings.url ) ? '&' : '?') + + (requestSettings.jsonp || 'callback') + '=?'; + } + } else if ( !requestSettings.data || !CALLBACK_REGEX.test(requestSettings.data) ) { + requestSettings.data = (requestSettings.data ? requestSettings.data + '&' : '') + (requestSettings.jsonp || 'callback') + '=?'; + } + } + + // Process a JSONP request by evaluating the mocked response text + function processJsonpRequest( requestSettings, mockHandler, origSettings ) { + logger.debug( mockHandler, ['Performing JSONP request', mockHandler, requestSettings, origSettings] ); + + // Synthesize the mock request for adding a script tag + var callbackContext = origSettings && origSettings.context || requestSettings, + // If we are running under jQuery 1.5+, return a deferred object + newMock = ($.Deferred) ? (new $.Deferred()) : null; + + // If the response handler on the moock is a function, call it + if ( mockHandler.response && $.isFunction(mockHandler.response) ) { + + mockHandler.response(origSettings); + + + } else if ( typeof mockHandler.responseText === 'object' ) { + // Evaluate the responseText javascript in a global context + $.globalEval( '(' + JSON.stringify( mockHandler.responseText ) + ')'); + + } else if (mockHandler.proxy) { + logger.info( mockHandler, ['Performing JSONP proxy request: ' + mockHandler.proxy, mockHandler] ); + + // This handles the unique case where we have a remote URL, but want to proxy the JSONP + // response to another file (not the same URL as the mock matching) + _ajax({ + global: false, + url: mockHandler.proxy, + type: mockHandler.proxyType, + data: mockHandler.data, + dataType: requestSettings.dataType === 'script' ? 'text/plain' : requestSettings.dataType, + complete: function(xhr) { + $.globalEval( '(' + xhr.responseText + ')'); + completeJsonpCall( requestSettings, mockHandler, callbackContext, newMock ); + } + }); + + return newMock; + + } else { + $.globalEval( '(' + + ((typeof mockHandler.responseText === 'string') ? + ('"' + mockHandler.responseText + '"') : mockHandler.responseText) + + ')'); + } + + completeJsonpCall( requestSettings, mockHandler, callbackContext, newMock ); + + return newMock; + } + + function completeJsonpCall( requestSettings, mockHandler, callbackContext, newMock ) { + var json; + + // Successful response + setTimeout(function() { + jsonpSuccess( requestSettings, callbackContext, mockHandler ); + jsonpComplete( requestSettings, callbackContext ); + + if ( newMock ) { + try { + json = $.parseJSON( mockHandler.responseText ); + } catch (err) { /* just checking... */ } + + newMock.resolveWith( callbackContext, [json || mockHandler.responseText] ); + logger.log( mockHandler, ['JSONP mock call complete', mockHandler, newMock] ); + } + }, parseResponseTimeOpt( mockHandler.responseTime )); + } + + + // Create the required JSONP callback function for the request + function createJsonpCallback( requestSettings, mockHandler, origSettings ) { + var callbackContext = origSettings && origSettings.context || requestSettings; + var jsonp = (typeof requestSettings.jsonpCallback === 'string' && requestSettings.jsonpCallback) || ('jsonp' + jsc++); + + // Replace the =? sequence both in the query string and the data + if ( requestSettings.data ) { + requestSettings.data = (requestSettings.data + '').replace(CALLBACK_REGEX, '=' + jsonp + '$1'); + } + + requestSettings.url = requestSettings.url.replace(CALLBACK_REGEX, '=' + jsonp + '$1'); + + + // Handle JSONP-style loading + window[ jsonp ] = window[ jsonp ] || function() { + jsonpSuccess( requestSettings, callbackContext, mockHandler ); + jsonpComplete( requestSettings, callbackContext ); + // Garbage collect + window[ jsonp ] = undefined; + + try { + delete window[ jsonp ]; + } catch(e) {} + }; + requestSettings.jsonpCallback = jsonp; + } + + // The JSONP request was successful + function jsonpSuccess(requestSettings, callbackContext, mockHandler) { + // If a local callback was specified, fire it and pass it the data + if ( requestSettings.success ) { + requestSettings.success.call( callbackContext, mockHandler.responseText || '', 'success', {} ); + } + + // Fire the global callback + if ( requestSettings.global ) { + (requestSettings.context ? $(requestSettings.context) : $.event).trigger('ajaxSuccess', [{}, requestSettings]); + } + } + + // The JSONP request was completed + function jsonpComplete(requestSettings, callbackContext) { + if ( requestSettings.complete ) { + requestSettings.complete.call( callbackContext, { + statusText: 'success', + status: 200 + } , 'success' ); + } + + // The request was completed + if ( requestSettings.global ) { + (requestSettings.context ? $(requestSettings.context) : $.event).trigger('ajaxComplete', [{}, requestSettings]); + } + + // Handle the global AJAX counter + if ( requestSettings.global && ! --$.active ) { + $.event.trigger( 'ajaxStop' ); + } + } + + + // The core $.ajax replacement. + function handleAjax( url, origSettings ) { + var mockRequest, requestSettings, mockHandler, overrideCallback; + + logger.debug( null, ['Ajax call intercepted', url, origSettings] ); + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === 'object' ) { + origSettings = url; + url = undefined; + } else { + // work around to support 1.5 signature + origSettings = origSettings || {}; + origSettings.url = url || origSettings.url; + } + + // Extend the original settings for the request + requestSettings = $.ajaxSetup({}, origSettings); + requestSettings.type = requestSettings.method = requestSettings.method || requestSettings.type; + + // Generic function to override callback methods for use with + // callback options (onAfterSuccess, onAfterError, onAfterComplete) + overrideCallback = function(action, mockHandler) { + var origHandler = origSettings[action.toLowerCase()]; + return function() { + if ( $.isFunction(origHandler) ) { + origHandler.apply(this, [].slice.call(arguments)); + } + mockHandler['onAfter' + action](); + }; + }; + + // Iterate over our mock handlers (in registration order) until we find + // one that is willing to intercept the request + for(var k = 0; k < mockHandlers.length; k++) { + if ( !mockHandlers[k] ) { + continue; + } + + mockHandler = getMockForRequest( mockHandlers[k], requestSettings ); + if(!mockHandler) { + logger.debug( mockHandlers[k], ['Mock does not match request', url, requestSettings] ); + // No valid mock found for this request + continue; + } + + if ($.mockjaxSettings.retainAjaxCalls) { + mockedAjaxCalls.push(requestSettings); + } + + // If logging is enabled, log the mock to the console + logger.info( mockHandler, [ + 'MOCK ' + requestSettings.type.toUpperCase() + ': ' + requestSettings.url, + $.ajaxSetup({}, requestSettings) + ] ); + + + if ( requestSettings.dataType && requestSettings.dataType.toUpperCase() === 'JSONP' ) { + if ((mockRequest = processJsonpMock( requestSettings, mockHandler, origSettings ))) { + // This mock will handle the JSONP request + return mockRequest; + } + } + + // We are mocking, so there will be no cross domain request, however, jQuery + // aggressively pursues this if the domains don't match, so we need to + // explicitly disallow it. (See #136) + origSettings.crossDomain = false; + + // Removed to fix #54 - keep the mocking data object intact + //mockHandler.data = requestSettings.data; + + mockHandler.cache = requestSettings.cache; + mockHandler.timeout = requestSettings.timeout; + mockHandler.global = requestSettings.global; + + // In the case of a timeout, we just need to ensure + // an actual jQuery timeout (That is, our reponse won't) + // return faster than the timeout setting. + if ( mockHandler.isTimeout ) { + if ( mockHandler.responseTime > 1 ) { + origSettings.timeout = mockHandler.responseTime - 1; + } else { + mockHandler.responseTime = 2; + origSettings.timeout = 1; + } + } + + // Set up onAfter[X] callback functions + if ( $.isFunction( mockHandler.onAfterSuccess ) ) { + origSettings.success = overrideCallback('Success', mockHandler); + } + if ( $.isFunction( mockHandler.onAfterError ) ) { + origSettings.error = overrideCallback('Error', mockHandler); + } + if ( $.isFunction( mockHandler.onAfterComplete ) ) { + origSettings.complete = overrideCallback('Complete', mockHandler); + } + + copyUrlParameters(mockHandler, origSettings); + + /* jshint loopfunc:true */ + (function(mockHandler, requestSettings, origSettings, origHandler) { + + mockRequest = _ajax.call($, $.extend(true, {}, origSettings, { + // Mock the XHR object + xhr: function() { return xhr( mockHandler, requestSettings, origSettings, origHandler ); } + })); + })(mockHandler, requestSettings, origSettings, mockHandlers[k]); + /* jshint loopfunc:false */ + + return mockRequest; + } + + // We don't have a mock request + logger.log( null, ['No mock matched to request', url, origSettings] ); + if ($.mockjaxSettings.retainAjaxCalls) { + unmockedAjaxCalls.push(origSettings); + } + if($.mockjaxSettings.throwUnmocked === true) { + throw new Error('AJAX not mocked: ' + origSettings.url); + } + else { // trigger a normal request + return _ajax.apply($, [origSettings]); + } + } + + /** + * Copies URL parameter values if they were captured by a regular expression + * @param {Object} mockHandler + * @param {Object} origSettings + */ + function copyUrlParameters(mockHandler, origSettings) { + //parameters aren't captured if the URL isn't a RegExp + if (!(mockHandler.url instanceof RegExp)) { + return; + } + //if no URL params were defined on the handler, don't attempt a capture + if (!mockHandler.hasOwnProperty('urlParams')) { + return; + } + var captures = mockHandler.url.exec(origSettings.url); + //the whole RegExp match is always the first value in the capture results + if (captures.length === 1) { + return; + } + captures.shift(); + //use handler params as keys and capture resuts as values + var i = 0, + capturesLength = captures.length, + paramsLength = mockHandler.urlParams.length, + //in case the number of params specified is less than actual captures + maxIterations = Math.min(capturesLength, paramsLength), + paramValues = {}; + for (i; i < maxIterations; i++) { + var key = mockHandler.urlParams[i]; + paramValues[key] = captures[i]; + } + origSettings.urlParams = paramValues; + } + + /** + * Clears handlers that mock given url + * @param url + * @returns {Array} + */ + function clearByUrl(url) { + var i, len, + handler, + results = [], + match=url instanceof RegExp ? + function(testUrl) { return url.test(testUrl); } : + function(testUrl) { return url === testUrl; }; + for (i=0, len=mockHandlers.length; i