The motivation with this module is to provide a high-level abstraction for testing
HTTP, while still allowing you to drop down to the lower-level API provided by superagent.
Getting Started
Install supertest as an npm module and save it to your package.json file as a development dependency:
npm install supertest --save-dev
Once installed it can now be referenced by simply calling require('supertest');
Example
You may pass an http.Server, or a Function to request() - if the server is not
already listening for connections then it is bound to an ephemeral port for you so
there is no need to keep track of ports. Requests made from the same app share that
server, which closes once the last request sent to it finishes and starts again for
the next one.
supertest works with any test framework, here is an example without using any
test framework at all:
One thing to note with the above statement is that superagent now sends any HTTP
error (anything other than a 2XX response code) to the callback as the first argument if
you do not add a status code expect (i.e. .expect(302)).
If you are using the .end() method .expect() assertions that fail will
not throw - they will return the assertion as an error to the .end() callback. In
order to fail the test case, you will need to rethrow or pass err to done(), as follows:
Passing the app or url each time is not necessary, if you're testing
the same host you may simply re-assign the request variable with the
initialization app or url, a new Test is created per request.VERB() call.
You may use any superagent methods,
including .write(), .pipe() etc and perform assertions in the .end() callback
for lower-level needs.
.expect(status[, fn])
Assert response status code.
.expect(status, body[, fn])
Assert response status code and body.
.expect(body[, fn])
Assert response body text with a string, regular expression, or
parsed body object.
.expect(field, value[, fn])
Assert header fieldvalue with a string, number, or regular expression.
.expect(function(res) {})
Pass a custom assertion function. It'll be given the response object to check. If the check fails, throw an error.
request(app) .get('/') .expect(hasPreviousAndNextKeys) .end(done);function hasPreviousAndNextKeys(res) { if (!('next' in res.body)) throw new Error("missing next key"); if (!('prev' in res.body)) throw new Error("missing prev key");}
.end(fn)
Perform the request and invoke fn(err, res).
Cookies
Here is an example of using the set and not cookie assertions:
// setup super-testconst request = require('supertest');const express = require('express');const cookies = request.cookies;// setup express test serviceconst app = express();app.get('/users', function(req, res) { res.cookie('alpha', 'one', { domain: 'domain.com', path: '/', httpOnly: true }); res.send(200, { name: 'tobi' });});// test request to servicerequest(app) .get('/users') .expect('Content-Type', /json/) .expect('Content-Length', '15') .expect(200) // assert 'alpha' cookie is set with domain, path, and httpOnly options .expect(cookies.set({ name: 'alpha', options: ['domain', 'path', 'httponly'] })) // assert 'bravo' cookie is NOT set .expect(cookies.not('set', { name: 'bravo' })) .end(function(err, res) { if (err) { throw err; } });
It is also possible to chain assertions:
cookies.set({/* ... */}).not('set', {/* ... */})
Cookie assertions
Functions and methods are chainable.
cookies([secret], [asserts])
Get assertion function for super-test.expect() method.
Arguments
secret - String or array of strings. Cookie signature secrets.
asserts(req, res) - Function or array of functions. Failed custom assertions should throw.