Integration Testing

Chai HTTP provides an interface for live integration
testing via superagent.
To do this, you must first
construct a request to an application or url.

Upon construction you are provided a chainable api that
allows you to specify the http VERB request (get, post, etc)
that you wish to invoke.

Application / Server

You may use a function (such as an express or connect app)
or a node.js http(s) server as the foundation for your request.
If the server is not running, chai-http will find a suitable
port to listen on for a given test.

Note: This feature is only supported on Node.js, not in web browsers.

chai.request(app)

.get('/')

When passing an app to request; it will automatically open the server for
incoming requests (by calling listen()) and, once a request has been made
the server will automatically shut down (by calling .close()). If you want to
keep the server open, perhaps if you're making multiple requests, you must call
.keepOpen() after .request(), and manually close the server down:

var requester =chai.request(app).keepOpen()

Promise.all([

requester.get('/a'),

requester.get('/b'),

])

.then(responses=>....)

.then(()=>requester.close())

URL

You may also use a base url as the foundation of your request.

chai.request('http://localhost:8080')

.get('/')

Setting up requests

Once a request is created with a given VERB, it can have headers, form data,
json, or even file attachments added to it, all with a simple API:

// Send some JSON

chai.request(app)

.put('/user/me')

.set('X-API-Key','foobar')

.send({ password:'123', confirmPassword:'123'})

// Send some Form Data

chai.request(app)

.post('/user/me')

.type('form')

.send({

'_method':'put',

'password':'123',

'confirmPassword':'123'

})

// Attach a file

chai.request(app)

.post('/user/avatar')

.attach('imageField',fs.readFileSync('avatar.png'),'avatar.png')

// Authenticate with Basic authentication

chai.request(app)

.get('/protected')

.auth('user','pass')

// Chain some GET query parameters

chai.request(app)

.get('/search')

.query({name:'foo', limit:10})// /search?name=foo&limit=10

Dealing with the response - traditional

In the following examples we use Chai's Expect assertion library:

var expect =chai.expect;

To make the request and assert on its response, the end method can be used:

chai.request(app)

.put('/user/me')

.send({ password:'123', confirmPassword:'123'})

.end(function(err,res){

expect(err).to.be.null;

expect(res).to.have.status(200);

});

Caveat

Because the end function is passed a callback, assertions are run
asynchronously. Therefore, a mechanism must be used to notify the testing
framework that the callback has completed. Otherwise, the test will pass before
the assertions are checked.

For example, in the Mocha test framework, this is
accomplished using the
done callback, which signal that the
callback has completed, and the assertions can be verified:

it('fails, as expected',function(done){// <= Pass in done callback

chai.request('http://localhost:8080')

.get('/')

.end(function(err,res){

expect(res).to.have.status(123);

done();// <= Call done to signal callback end

});

});

it('succeeds silently!',function(){// <= No done callback

chai.request('http://localhost:8080')

.get('/')

.end(function(err,res){

expect(res).to.have.status(123);// <= Test completes before this runs

});

});

When done is passed in, Mocha will wait until the call to done(), or until
the timeout expires. done also accepts an
error parameter when signaling completion.

then/promise
You will need to set the library you use to global.Promise, before
requiring in chai-http. For example:

// Add promise support if this does not exist natively.

if(!global.Promise){

global.Promise=require('q');

}

var chai =require('chai');

chai.use(require('chai-http'));

Retaining cookies with each request

Sometimes you need to keep cookies from one request, and send them with the
next (for example, when you want to login with the first request, then access an authenticated-only resource later). For this, .request.agent() is available:

// Log in

var agent =chai.request.agent(app)

agent

.post('/session')

.send({ username:'me', password:'123'})

.then(function(res){

expect(res).to.have.cookie('sessionid');

// The `agent` now has the sessionid cookie saved, and will send it

// back to the server in the next request:

returnagent.get('/user/me')

.then(function(res){

expect(res).to.have.status(200);

});

});

Note: The server started by chai.request.agent(app) will not automatically close following the test(s). You should call agent.close() after your tests to ensure your program exits.

Assertions

The Chai HTTP module provides a number of assertions
for the expect and should interfaces.

.status (code)

@param{Number} status number

Assert that a response has a supplied status.

expect(res).to.have.status(200);

.header (key[, value])

@param{String} header key (case insensitive)

@param{String|RegExp} header value (optional)

Assert that a Response or Request object has a header.
If a value is provided, equality to value will be asserted.
You may also pass a regular expression to check.

License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.