Mock 'http' objects for testing Express routing functions

Mock 'http' objects for testing Express routing functions, but could be used for testing any Node.js web server applications that have code that requires mockups of the request and response objects.

This project is available as a NPM package.

$ npm install --save-dev node-mocks-http

Our example includes --save-dev based on the assumption that node-mocks-http will be used as a development dependency..

After installing the package include the following in your test files:

var httpMocks = require('node-mocks-http');

Suppose you have the following Express route:

app.get('/user/:id', routeHandler);

And you have created a function to handle that route's call:

var routeHandler = function( requestresponse ) { ... };

You can easily test the routeHandler function with some code like this using the testing framework of your choice:

exports['routeHandler - Simple testing'] = function(test) {
    var request  = httpMocks.createRequest({
        method: 'GET',
        url: '/user/42',
        params: {
          id: 42
    var response = httpMocks.createResponse();
    routeHandler(request, response);
    var data = JSON.parse( response._getData() );
    test.equal("Bob Dog",;
    test.equal(42, data.age);
    test.equal(200, response.statusCode );
    test.ok( response._isEndCalled());
    test.ok( response._isJSON());
    test.ok( response._isUTF8());

Where options is an object hash with any of the following values:

optiondescriptiondefault value
methodrequest HTTP method'GET'
urlrequest URL''
originalUrlrequest original URLurl
pathrequest path''
paramsobject hash with params{}
sessionobject hash with session valuesundefined
cookiesobject hash with request cookies{}
signedCookiesobject hash with signed cookiesundefined
headersobject hash with request headers{}
bodyobject hash with body{}
queryobject hash with query values{}
filesobject hash with values{}

Where options is an object hash with any of the following values:

optiondescriptiondefault value
eventEmitterevent emitter used by response objectmockEventEmitter
writableStreamwritable stream used by response objectmockWritableStream

NOTE: The out-of-the-box mock event emitter included with node-mocks-http is not a functional event emitter and as such does not actually emit events. If you wish to test your event handlers you will need to bring your own event emitter.

Here's an example:

var httpMocks = require('node-mocks-http');
var res = httpMocks.createResponse({
  eventEmitter: require('events').EventEmitter
// ... 
  it('should do something', function(done) {
    res.on('end', function() {
// ... 

We wanted some simple mocks without a large framework.

We also wanted the mocks to act like the original framework being mocked, but allow for setting of values before calling and inspecting of values after calling.

We are looking for more volunteers to bring value to this project, including the creation of more objects from the HTTP module.

This project doesn't address all features that must be mocked, but it is a good start. Feel free to send pull requests, and a member of the team will be timely in merging them.

If you wish to contribute please read our Contributing Guidelines.

Most releases fix bugs with our mocks or add features similar to the actual Request and Response objects offered by Node.js and extended by Express.

Most Recent Release Notes

Licensed under MIT.