Merge pull request #10 from mglezer/matching-improvements

Matching improvements

Author: bigodines

README.md

@@ -70,11 +70,12 @@ This will match http://localhost:3012/news/007 as well as http://localhost:3012/
 > responseCode: 200,  
 > responseBody: 'whatever you want' }  
 
-##### Fake-server supports "POST" calls and uses payload for matching. Regexs are supported for payload matching:
+##### Fake-server supports "POST" calls and uses payload for matching. Regexs are supported for payload matching, and paths can be used to specify inner properties of JSON payloads:
 
 > { route: '/news'  
 >   payload: {  
 >     id: [\\d+],
+>     requests[1].user.login: 'jdoe',
 >     month: "february"
 >   },  
 >   responseCode: 200,  

fakeresponse.js

@@ -12,6 +12,7 @@ var glob = require('glob');
 var path = require('path');
 var when = require('when');
 var url = require('url');
+var _ = require('lodash');
 
 var FakeResponse = {
     _items: [],
@@ -50,7 +51,7 @@ var FakeResponse = {
         FakeResponse._items = [];
     },
 
-    /*Lexicographic comparison based on: (at, num params matched, num headers matched)*/
+    /*Lexicographic comparison based on: (at, num query + payload params matched, num headers matched)*/
     compareMatches: function(matchA, matchB) {
         /*First rank on 'at' match*/
         if (!matchA.hasOwnProperty('at') && matchB.hasOwnProperty('at')) {
@@ -61,7 +62,11 @@ var FakeResponse = {
         }
 
         /*Second rank on quality of 'params' match*/
-        var queryCmp = Object.keys(matchB.queryParams || {}).length - Object.keys(matchA.queryParams || {}).length;
+        var numParamsMatchedB = Object.keys(matchB.queryParams || {}).length +
+            Object.keys(matchB.payload || {}).length;
+        var numParamsMatchedA = Object.keys(matchA.queryParams || {}).length +
+            Object.keys(matchA.payload || {}).length;
+        var queryCmp = numParamsMatchedB - numParamsMatchedA;
         if (queryCmp !== 0) {
             return queryCmp;
         }
@@ -81,9 +86,9 @@ var FakeResponse = {
             if (doPathsMatch !== null) {
                 item.numCalls += 1;
                 if(item.queryParams && !FakeResponse.matchRegex(item.queryParams, uri.query)) return false;
-                if(item.payload && !FakeResponse.matchRegex(item.payload, payload)) return false; 
+                if(item.payload && !FakeResponse.matchRegex(item.payload, payload)) return false;
                 if(item.requiredHeaders && !FakeResponse.matchRegex(item.requiredHeaders, headers)) return false;
-                if (item.at) return (item.numCalls === item.at); 
+                if (item.at) return (item.numCalls === item.at);
                 return true;
             }
             return false;
@@ -99,14 +104,14 @@ var FakeResponse = {
     matchRegex: function(objA, objB) {
         if (typeof(objB) !== "object" || typeof(objA) !== "object") return false;
 
-        for (var ppty in objA) {
-            if (!objA.hasOwnProperty(ppty) || !objB.hasOwnProperty(ppty)) return false;
+        return Object.keys(objA).every(function(path) {
+            var value = _.get(objB, path);
+            if (!value) return false;
 
             // Evalute regex match
-            var matches = String(objB[ppty]).match(new RegExp(objA[ppty]));
-            if (matches === null) return false;
-        }
-        return true;
+            var matches = String(value).match(new RegExp(objA[path]));
+            return matches;
+        });
     }
 };
 

package.json

@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "glob": "~5.0.14",
+    "lodash": "~3.10.1",
     "merge": "^1.2.0",
     "restify": "=2.6.2",
     "rewire": "~2.3.4",

test/fakeresponse.js

@@ -134,7 +134,7 @@ describe('FakeResponse model tests', function () {
     });
 
     /* POST request tests */
-    it('should use payload to match against for POST requests', function() {
+    it('should not match route if payload doesn\'t match', function() {
         model.add({
             route: '/match/me',
             payload: {
@@ -171,6 +171,46 @@ describe('FakeResponse model tests', function () {
         assert.deepEqual(response.responseCode, 200);
      });
 
+     it('should support paths in payload', function() {
+        model.add({
+            route: '/match/me',
+            payload: {
+                'outer[0].inner': 1
+            },
+            responseCode: 200,
+            responseBody: 'weba'
+        });
+        model.add({
+            route: '/match/me',
+            payload: {
+                'id': 2
+            },
+            responseCode: 403,
+            responseBody: 'buuu'
+        });
+
+        var response = model.match('/match/me', { outer: [{inner: 1 }]});
+        assert.deepEqual(response.responseBody, 'weba');
+        assert.deepEqual(response.responseCode, 200);
+     });
+
+     it('paths should not break query param matching', function() {
+        model.add({
+            route: '/match/me',
+            queryParams: {
+                'outer[0].inner': 1
+            },
+            responseCode: 200,
+            responseBody: 'weba'
+        });
+
+        var response = model.match('/match/me?outer[0].inner=1');
+        assert.deepEqual(response.responseBody, 'weba');
+        assert.deepEqual(response.responseCode, 200);
+
+        response = model.match('/match/me?param=1');
+        assert.deepEqual(response, null);
+     });
      it('should match POST request payloads using explicit regular expressions', function() {
         model.add({
             route: '/match/me',
@@ -285,33 +325,39 @@ describe('FakeResponse model tests', function () {
          assert.deepEqual(response.responseBody, 'Regex success');
      });
 
-     it('should use number of query params matched to break ties (not order added)', function() {
+     it('should use number of params (query and payload) matched to break ties (not order added)', function() {
          var route1 = {
              route: '/match/me',
              queryParams: {
                  a: '[0-9]+'
              },
+             payload: {
+                 b: '^[a-z]+$'
+             },
              responseCode: 200
          };
          var route2 = {
              route: '/match/me',
+             queryParams: {
+                 a: '[0-9]+'
+             },
              responseCode: 400
          };
          model.add(route1);
          model.add(route2);
 
-         var response = model.match('/match/me?a=1234');
+         var response = model.match('/match/me?a=1234', {b: 'abcd'});
          assert.equal(response.responseCode, 200);
-         response = model.match('/match/me');
+         response = model.match('/match/me?a=1234', {b: 'abc123'});
          assert.equal(response.responseCode, 400);
 
          model.flush();
          model.add(route2);
          model.add(route1);
 
-         response = model.match('/match/me?a=1234');
+         response = model.match('/match/me?a=1234', {b: 'abcd'});
          assert.equal(response.responseCode, 200);
-         response = model.match('/match/me');
+         response = model.match('/match/me?a=1234', {b: 'abc123'});
          assert.equal(response.responseCode, 400);
      });