nock 8.0.0 → 8.2.2

package/lib/request_overrider.js

@@ -192,7 +192,7 @@ function RequestOverrider(req, options, interceptors, remove, cb) {
   req.once = req.on = function(event, listener) {
     // emit a fake socket.
     if (event == 'socket') {
-      listener(req.socket);
+      listener.call(req, req.socket);
       req.socket.emit('connect', req.socket);
       req.socket.emit('secureConnect', req.socket);
     }
@@ -384,7 +384,7 @@ function RequestOverrider(req, options, interceptors, remove, cb) {
           responseBody = responseBody[1];
 
           response.rawHeaders = response.rawHeaders || [];
-          Object.keys(response.headers).forEach(function(key) {
+          Object.keys(response.headers).forEach(function(key) {
             response.rawHeaders.push(key, response.headers[key]);
           });
         }
@@ -450,7 +450,7 @@ function RequestOverrider(req, options, interceptors, remove, cb) {
         var key = response.rawHeaders[rawHeaderIndex];
         var value = response.rawHeaders[rawHeaderIndex + 1];
         if (typeof value === "function") {
-          response.rawHeaders[rawHeaderIndex + 1] = evaluatedHeaders[key];
+          response.rawHeaders[rawHeaderIndex + 1] = evaluatedHeaders[key.toLowerCase()];
         }
       }
 

package/lib/scope.js

@@ -118,39 +118,40 @@ Scope.prototype.delete = function _delete(uri, requestBody, options) {
   return this.intercept(uri, 'DELETE', requestBody, options);
 };
 
+Scope.prototype.options = function _options(uri, requestBody, options) {
+  return this.intercept(uri, 'OPTIONS', requestBody, options);
+};
+
 Scope.prototype.pendingMocks = function pendingMocks() {
-  return Object.keys(this.keyedInterceptors);
+  var self = this;
+
+  var pendingInterceptorKeys = Object.keys(this.keyedInterceptors).filter(function (key) {
+    var interceptorList = self.keyedInterceptors[key];
+    var pendingInterceptors = interceptorList.filter(function (interceptor) {
+      // TODO: This assumes that completed mocks are removed from the keyedInterceptors list
+      // (when persistence is off). We should change that (and this) in future.
+      var persistedAndUsed = self._persist && interceptor.interceptionCounter > 0;
+      return !persistedAndUsed && !interceptor.optional;
+    });
+    return pendingInterceptors.length > 0;
+  });
+
+  return pendingInterceptorKeys;
 };
 
+// Returns all keyedInterceptors that are active.
+// This incomplete interceptors, persisted but complete interceptors, and
+// optional interceptors, but not non-persisted and completed interceptors.
+Scope.prototype.activeMocks = function activeMocks() {
+  return Object.keys(this.keyedInterceptors);
+}
+
 Scope.prototype.isDone = function isDone() {
   var self = this;
   // if nock is turned off, it always says it's done
   if (! globalIntercept.isOn()) { return true; }
 
-  var keys = Object.keys(this.keyedInterceptors);
-  if (keys.length === 0) {
-    return true;
-  } else {
-    var doneHostCount = 0;
-
-    keys.forEach(function(key) {
-      var doneInterceptorCount = 0;
-
-      self.keyedInterceptors[key].forEach(function(interceptor) {
-        var isRequireDoneDefined = !_.isUndefined(interceptor.options.requireDone);
-        if (isRequireDoneDefined && interceptor.options.requireDone === false) {
-          doneInterceptorCount += 1;
-        } else if (self._persist && interceptor.interceptionCounter > 0) {
-          doneInterceptorCount += 1;
-        }
-      });
-
-      if (doneInterceptorCount === self.keyedInterceptors[key].length ) {
-        doneHostCount += 1;
-      }
-    });
-    return (doneHostCount === keys.length);
-  }
+  return this.pendingMocks().length === 0;
 };
 
 Scope.prototype.done = function done() {
@@ -294,7 +295,7 @@ function define(nockDefs) {
       , npath      = nockDef.path
       , method     = nockDef.method.toLowerCase() || "get"
       , status     = getStatusFromDefinition(nockDef)
-      , headers    = nockDef.headers    || {}
+      , rawHeaders = nockDef.rawHeaders || []
       , reqheaders = nockDef.reqheaders || {}
       , body       = nockDef.body       || ''
       , options    = nockDef.options    || {};
@@ -318,7 +319,7 @@ function define(nockDefs) {
     if (body==="*") {
       nock = startScope(nscope, options).filteringRequestBody(function() {
         return "*";
-      })[method](npath, "*").reply(status, response, headers);
+      })[method](npath, "*").reply(status, response, rawHeaders);
     } else {
       nock = startScope(nscope, options);
       //  If request headers were specified filter by them.
@@ -330,7 +331,7 @@ function define(nockDefs) {
       if (nockDef.filteringRequestBody) {
         nock.filteringRequestBody(nockDef.filteringRequestBody);
       }
-      nock.intercept(npath, method, body).reply(status, response, headers);
+      nock.intercept(npath, method, body).reply(status, response, rawHeaders);
     }
 
     nocks.push(nock);
@@ -346,6 +347,7 @@ module.exports = extend(startScope, {
   isActive: globalIntercept.isActive,
   isDone: globalIntercept.isDone,
   pendingMocks: globalIntercept.pendingMocks,
+  activeMocks: globalIntercept.activeMocks,
   removeInterceptor: globalIntercept.removeInterceptor,
   disableNetConnect: globalIntercept.disableNetConnect,
   enableNetConnect: globalIntercept.enableNetConnect,

package/package.json

@@ -7,7 +7,7 @@
     "testing",
     "isolation"
   ],
-  "version": "8.0.0",
+  "version": "8.2.2",
   "author": "Pedro Teixeira <pedro.teixeira@gmail.com>",
   "contributors": [
     {
@@ -167,24 +167,27 @@
     "debug": "^2.2.0",
     "deep-equal": "^1.0.0",
     "json-stringify-safe": "^5.0.1",
-    "lodash": "^4.8.2",
+    "lodash": "~4.9.0",
     "mkdirp": "^0.5.0",
     "propagate": "0.4.0",
     "qs": "^6.0.2"
   },
   "devDependencies": {
-    "async": "^1.5.2",
+    "async": "^2.1.1",
     "aws-sdk": "^2.0.15",
     "browserify": "^13.0.0",
+    "changelog": "^1.0.7",
     "coveralls": "^2.11.2",
     "hyperquest": "^1.3.0",
     "isomorphic-fetch": "^2.2.0",
     "istanbul": "^0.4.2",
     "jshint": "^2.5.6",
+    "markdown-toc": "^0.13.0",
     "needle": "^1.0.0",
     "node-static": "^0.7.7",
+    "nyc": "^8.3.0",
     "pre-commit": "1.1.2",
-    "request": "2.70.0",
+    "request": "2.71.0",
     "request-promise": "^2.0.1",
     "restify": "^4.0.4",
     "restler": "3.4.0",
@@ -194,9 +197,9 @@
     "zombie": "^4.2.1"
   },
   "scripts": {
-    "test": "node --harmony tests/test.js",
-    "coverage": "node --harmony node_modules/istanbul/lib/cli.js cover tests/test.js && istanbul check-coverage",
-    "coveralls": "cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
+    "test": "tap --harmony ./tests/test_*.js",
+    "coverage": "nyc --reporter=lcov tap --harmony ./tests/test_*.js",
+    "coveralls": "cat ./coverage/lcov.info | coveralls",
     "jshint": "jshint lib/*.js",
     "changelog": "changelog nock all -m > CHANGELOG.md"
   },

package/tests/test_back.js

@@ -116,7 +116,10 @@ tap.test('nockBack dryrun tests', function (nw) {
       , port: 80
       }, function(res) {
 
-        t.ok([200, 302].indexOf(res.statusCode) >= 0);
+        res.on('data', function() {
+          //node v 0.10 requires this listener
+        });
+        t.ok([200, 301, 302].indexOf(res.statusCode) >= 0);
         t.end();
 
       });
@@ -156,7 +159,7 @@ tap.test('nockBack dryrun tests', function (nw) {
         , port: 80
         }, function(res) {
 
-          t.ok([200, 302].indexOf(res.statusCode) >= 0);
+          t.ok([200, 301, 302].indexOf(res.statusCode) >= 0);
           res.on('end', function() {
             var doneFails = false;
 

package/tests/test_body_match.js

@@ -26,3 +26,43 @@ test('match body with regex', function (t) {
   });
 
 });
+
+test('match body with regex inside array', function (t) {
+
+  nock('http://encodingsareus.com')
+    .post('/', {items: [{name: /t.+/}]})
+    .reply(200);
+
+  mikealRequest({
+    url: 'http://encodingsareus.com/',
+    method: 'post',
+    json: {
+      items: [{
+        name: 'test'
+      }]
+    },
+  }, function(err, res) {
+    if (err) throw err;
+    assert.equal(res.statusCode, 200);
+    t.end();
+  });
+})
+
+test('match body with empty object inside', function (t) {
+
+  nock('http://encodingsareus.com')
+    .post('/', { obj: {}})
+    .reply(200);
+
+  mikealRequest({
+    url: 'http://encodingsareus.com/',
+    method: 'post',
+    json: {
+      obj: {}
+    },
+  }, function(err, res) {
+    if (err) throw err;
+    assert.equal(res.statusCode, 200);
+    t.end();
+  });
+})

package/tests/test_browserify.js

@@ -1,54 +1,56 @@
 'use strict';
 
-var fs = require('fs');
-var path = require('path');
-var http = require('http');
-var browserify = require('browserify');
-var Static = require('node-static');
-var Browser = require('zombie');
-
-var test = require('tap').test;
-var before = test;
-var after  = test;
-
-var nock = require('../.');
-
-nock.enableNetConnect();
-
-var server;
-
-before('prepare bundle', {timeout: 10000}, function(t) {
-  var b = browserify();
-  b.add(path.join(__dirname, 'fixtures', 'browserify-script.js'));
-  b.bundle().pipe(fs.createWriteStream(path.join(__dirname, 'browserify-public', 'browserify-bundle.js'))).once('finish', function() {
-    t.end();
-  });
-});
-
-before('start server', function(t) {
-  var file = new Static.Server(path.join(__dirname, 'browserify-public'));
-  server = http.createServer(function(req, res) {
-    file.serve(req, res);
-  });
-
-  server.listen(8080, t.end.bind(t));
-});
-
-test('run bundle', function(t) {
-  Browser.localhost('server.com', 8080);
-
-  var browser = new Browser();
-
-  browser.on('error', function(err) {
-    console.error('BROWSER ERROR: ' + err.stack);
-  });
-
-  browser.visit('/', function() {
-    browser.assert.text('#content', 'boop');
-    t.end();
-  });
-});
-
-after('stop server', function(t) {
-  server.close(t.end.bind(t));
-});
+if (process.versions.node >= '0.11' ) {
+    var fs = require('fs');
+    var path = require('path');
+    var http = require('http');
+    var browserify = require('browserify');
+    var Static = require('node-static');
+    var Browser = require('zombie');
+
+    var test = require('tap').test;
+    var before = test;
+    var after  = test;
+
+    var nock = require('../.');
+
+    nock.enableNetConnect();
+
+    var server;
+
+    before('prepare bundle', {timeout: 10000}, function(t) {
+      var b = browserify();
+      b.add(path.join(__dirname, 'fixtures', 'browserify-script.js'));
+      b.bundle().pipe(fs.createWriteStream(path.join(__dirname, 'browserify-public', 'browserify-bundle.js'))).once('finish', function() {
+        t.end();
+      });
+    });
+
+    before('start server', function(t) {
+      var file = new Static.Server(path.join(__dirname, 'browserify-public'));
+      server = http.createServer(function(req, res) {
+        file.serve(req, res);
+      });
+
+      server.listen(8080, t.end.bind(t));
+    });
+
+    test('run bundle', function(t) {
+      Browser.localhost('server.com', 8080);
+
+      var browser = new Browser();
+
+      browser.on('error', function(err) {
+        console.error('BROWSER ERROR: ' + err.stack);
+      });
+
+      browser.visit('/', function() {
+        browser.assert.text('#content', 'boop');
+        t.end();
+      });
+    });
+
+    after('stop server', function(t) {
+      server.close(t.end.bind(t));
+    });
+}

package/tests/test_intercept.js

@@ -622,22 +622,6 @@ test("isDone", function(t) {
   req.end();
 });
 
-test("requireDone", function(t) {
-  var scope = nock('http://www.google.com')
-    .get('/', false, { requireDone: false })
-    .reply(200, "Hello World!");
-
-  t.ok(scope.isDone(), "done when a requireDone is set to false");
-
-  scope.get('/', false, { requireDone: true})
-       .reply(200, "Hello World!");
-
-  t.notOk(scope.isDone(), "not done when a requireDone is explicitly set to true");
-
-  nock.cleanAll()
-  t.end();
-});
-
 test("request headers exposed", function(t) {
 
   var scope = nock('http://www.headdy.com')
@@ -724,7 +708,7 @@ test("reply headers as function work", function(t) {
     path: '/'
   }, function (res) {
     t.equivalent(res.headers, { 'x-my-headers': 'boo!' });
-    t.equivalent(res.rawHeaders, ['x-my-headers', 'boo!']);  // 67
+    t.equivalent(res.rawHeaders, ['X-My-Headers', 'boo!']);  // 67
     t.end();
   });
 });
@@ -745,7 +729,7 @@ test("reply headers as function are evaluated only once per request", function(t
     path: '/'
   }, function (res) {
     t.equivalent(res.headers, { 'x-my-headers': 'boo!' });
-    t.equivalent(res.rawHeaders, ['x-my-headers', 'boo!']);
+    t.equivalent(res.rawHeaders, ['X-My-Headers', 'boo!']);
     t.equal(counter, 1);
     t.end();
   });
@@ -767,14 +751,14 @@ test("reply headers as function are evaluated on each request", function(t) {
     path: '/'
   }, function (res) {
     t.equivalent(res.headers, { 'x-my-headers': '1' });
-    t.equivalent(res.rawHeaders, ['x-my-headers', '1']);
+    t.equivalent(res.rawHeaders, ['X-My-Headers', '1']);
     t.equal(counter, 1);
     http.get({
       host: 'example.com',
       path: '/'
     }, function (res) {
       t.equivalent(res.headers, { 'x-my-headers': '2' });
-      t.equivalent(res.rawHeaders, ['x-my-headers', '2']);
+      t.equivalent(res.rawHeaders, ['X-My-Headers', '2']);
       t.equal(counter, 2);
       t.end();
     });
@@ -2297,6 +2281,129 @@ test('pending mocks works', function(t) {
   });
 });
 
+test('pending mocks doesn\'t include optional mocks', function(t) {
+  var scope = nock('http://example.com')
+    .get('/nonexistent')
+    .optionally()
+    .reply(200);
+
+  t.deepEqual(nock.pendingMocks(), []);
+  t.end();
+});
+
+test('optional mocks are still functional', function(t) {
+  var scope = nock('http://example.com')
+    .get('/abc')
+    .optionally()
+    .reply(200);
+
+  var req = http.get({host: 'example.com', path: '/abc'}, function(res) {
+    t.assert(res.statusCode === 200, "should still mock requests");
+    t.deepEqual(nock.pendingMocks(), []);
+    t.end();
+  });
+});
+
+test('isDone is true with optional mocks outstanding', function(t) {
+  var scope = nock('http://example.com')
+    .get('/abc')
+    .optionally()
+    .reply(200);
+
+  t.ok(scope.isDone());
+  t.end();
+});
+
+test('optional but persisted mocks persist, but never appear as pending', function(t) {
+  var scope = nock('http://example.com')
+    .get('/123')
+    .optionally()
+    .reply(200)
+    .persist();
+
+  t.deepEqual(nock.pendingMocks(), []);
+  var req = http.get({host: 'example.com', path: '/123'}, function(res) {
+    t.assert(res.statusCode === 200, "should mock first request");
+    t.deepEqual(nock.pendingMocks(), []);
+
+    var req = http.get({host: 'example.com', path: '/123'}, function(res) {
+      t.assert(res.statusCode === 200, "should mock second request");
+      t.deepEqual(nock.pendingMocks(), []);
+      t.end();
+    });
+  });
+});
+
+test('optional repeated mocks execute repeatedly, but never appear as pending', function(t) {
+  var scope = nock('http://example.com')
+    .get('/456')
+    .optionally()
+    .times(2)
+    .reply(200);
+
+  t.deepEqual(nock.pendingMocks(), []);
+  var req = http.get({host: 'example.com', path: '/456'}, function(res) {
+    t.assert(res.statusCode === 200, "should mock first request");
+    t.deepEqual(nock.pendingMocks(), []);
+
+    var req = http.get({host: 'example.com', path: '/456'}, function(res) {
+      t.assert(res.statusCode === 200, "should mock second request");
+      t.deepEqual(nock.pendingMocks(), []);
+      t.end();
+    });
+  });
+});
+
+test('activeMocks returns optional mocks only before they\'re completed', function(t) {
+  nock.cleanAll();
+  var scope = nock('http://example.com')
+    .get('/optional')
+    .optionally()
+    .reply(200);
+
+  t.deepEqual(nock.activeMocks(), ["GET http://example.com:80/optional"]);
+  var req = http.get({host: 'example.com', path: '/optional'}, function(res) {
+    t.deepEqual(nock.activeMocks(), []);
+    t.end();
+  });
+});
+
+test('activeMocks always returns persisted mocks', function(t) {
+  nock.cleanAll();
+  var scope = nock('http://example.com')
+    .get('/persisted')
+    .reply(200)
+    .persist();
+
+  t.deepEqual(nock.activeMocks(), ["GET http://example.com:80/persisted"]);
+  var req = http.get({host: 'example.com', path: '/persisted'}, function(res) {
+    t.deepEqual(nock.activeMocks(), ["GET http://example.com:80/persisted"]);
+    t.end();
+  });
+});
+
+test('activeMocks returns incomplete mocks', function(t) {
+  nock.cleanAll();
+  var scope = nock('http://example.com')
+    .get('/incomplete')
+    .reply(200);
+
+  t.deepEqual(nock.activeMocks(), ["GET http://example.com:80/incomplete"]);
+  t.end();
+});
+
+test('activeMocks doesn\'t return completed mocks', function(t) {
+  nock.cleanAll();
+  var scope = nock('http://example.com')
+    .get('/complete-me')
+    .reply(200);
+
+  var req = http.get({host: 'example.com', path: '/complete-me'}, function(res) {
+    t.deepEqual(nock.activeMocks(), []);
+    t.end();
+  });
+});
+
 test('username and password works', function(t) {
   var scope = nock('http://passwordyy.com')
     .get('/')
@@ -2444,6 +2551,28 @@ test('persists interceptors', function(t) {
   }).end();
 });
 
+test('Persisted interceptors are in pendingMocks initially', function(t) {
+  var scope = nock('http://example.com')
+    .get('/abc')
+    .reply(200, "Persisted reply")
+    .persist();
+
+  t.deepEqual(scope.pendingMocks(), ["GET http://example.com:80/abc"]);
+  t.end();
+});
+
+test('Persisted interceptors are not in pendingMocks after the first request', function(t) {
+  var scope = nock('http://example.com')
+    .get('/def')
+    .reply(200, "Persisted reply")
+    .persist();
+
+  http.get('http://example.com/def', function(res) {
+    t.deepEqual(scope.pendingMocks(), []);
+    t.end();
+  });
+});
+
 test("persist reply with file", function(t) {
   var scope = nock('http://www.filereplier.com')
     .persist()
@@ -3438,35 +3567,37 @@ test('define() works with binary buffers', function(t) {
 
 });
 
-test('issue #163 - Authorization header isn\'t mocked', function(t) {
-  nock.enableNetConnect();
-  function makeRequest(cb) {
-    var r = http.request(
-      {
-        hostname: 'www.example.com',
-        path: '/',
-        method: 'GET',
-        auth: 'foo:bar'
-      },
-      function(res) {
-        cb(res.req._headers);
-      }
-    );
-    r.end();
-  }
+if (process.versions.node >= '0.11' ) {
+  test('issue #163 - Authorization header isn\'t mocked', function(t) {
+    nock.enableNetConnect();
+    function makeRequest(cb) {
+      var r = http.request(
+        {
+          hostname: 'www.example.com',
+          path: '/',
+          method: 'GET',
+          auth: 'foo:bar'
+        },
+        function(res) {
+          cb(res.req._headers);
+        }
+      );
+      r.end();
+    }
 
-  makeRequest(function(headers) {
-    var n = nock('http://www.example.com', {
-      reqheaders: { 'authorization': 'Basic Zm9vOmJhcg==' }
-    }).get('/').reply(200);
+    makeRequest(function(headers) {
+      var n = nock('http://www.example.com', {
+        reqheaders: { 'authorization': 'Basic Zm9vOmJhcg==' }
+      }).get('/').reply(200);
 
-    makeRequest(function(nockHeader) {
-      n.done();
-      t.equivalent(headers, nockHeader);
-      t.end();
+      makeRequest(function(nockHeader) {
+        n.done();
+        t.equivalent(headers, nockHeader);
+        t.end();
+      });
     });
   });
-});
+}
 
 test('define() uses reqheaders', function(t) {
   var nockDef = {
@@ -4096,6 +4227,7 @@ test('request emits socket', function(t) {
 
   var req = http.get('http://gotzsocketz.com');
   req.once('socket', function(socket) {
+    t.equal(this, req);
     t.type(socket, Object);
     t.type(socket.getPeerCertificate(), 'string');
     t.end();
@@ -4325,6 +4457,24 @@ test('remove interceptor removes given interceptor', function(t) {
 });
 
 
+test('remove interceptor removes interceptor from pending requests', function(t) {
+  var givenInterceptor = nock('http://example.org')
+    .get('/somepath');
+  var scope = givenInterceptor
+    .reply(200, 'hey');
+
+  var mocks = scope.pendingMocks();
+  t.deepEqual(mocks, ['GET http://example.org:80/somepath']);
+
+  var result = nock.removeInterceptor(givenInterceptor);
+  t.ok(result, 'result should be true');
+
+  var mocksAfterRemove = scope.pendingMocks();
+  t.deepEqual(mocksAfterRemove, [ ]);
+  t.end();
+});
+
+
 test('remove interceptor removes given interceptor for https', function(t) {
   var givenInterceptor = nock('https://example.org')
     .get('/somepath');
@@ -4401,7 +4551,6 @@ test('remove interceptor for not found resource', function(t) {
 });
 
 test('isDone() must consider repeated responses', function(t) {
-
   var scope = nock('http://www.example.com')
     .get('/')
     .times(2)
@@ -4431,7 +4580,6 @@ test('isDone() must consider repeated responses', function(t) {
       t.end();
     });
   });
-
 });
 
 test('you must setup an interceptor for each request', function(t) {