Big update!Announcing Socket for GitHub 1.0. Learn more
Log in


Package Overview
File Explorer

Advanced tools


SuperAgent driven library for testing HTTP servers


Version published
Weekly downloads
decreased by-5.33%

Weekly downloads



  • chore: bump deps 6329e2d
  • Merge pull request #759 from francescobarbera/master e6d371c
  • docs: add an example for complex object in multipart upload 729e818




Coveralls Build Status Dependencies PRs Welcome MIT License

HTTP assertions made easy via superagent.


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');


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.

SuperTest works with any test framework, here is an example without using any test framework at all:

const request = require('supertest'); const assert = require('assert'); const express = require('express'); const app = express(); app.get('/user', function(req, res) { res.status(200).json({ name: 'john' }); }); request(app) .get('/user') .expect('Content-Type', /json/) .expect('Content-Length', '15') .expect(200) .end(function(err, res) { if (err) throw err; });

Here's an example with mocha, note how you can pass done straight to any of the .expect() calls:

describe('GET /user', function() { it('responds with json', function(done) { request(app) .get('/user') .set('Accept', 'application/json') .expect('Content-Type', /json/) .expect(200, done); }); });

You can use auth method to pass HTTP username and password in the same way as in the superagent:

describe('GET /user', function() { it('responds with json', function(done) { request(app) .get('/user') .auth('username', 'password') .set('Accept', 'application/json') .expect('Content-Type', /json/) .expect(200, done); }); });

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:

describe('POST /users', function() { it('responds with json', function(done) { request(app) .post('/users') .send({name: 'john'}) .set('Accept', 'application/json') .expect('Content-Type', /json/) .expect(200) .end(function(err, res) { if (err) return done(err); return done(); }); }); });

You can also use promises:

describe('GET /users', function() { it('responds with json', function(done) { return request(app) .get('/users') .set('Accept', 'application/json') .expect('Content-Type', /json/) .expect(200) .then(response => { assert(, '[email protected]') done(); }) .catch(err => done(err)) }); });

Or async/await syntax:

describe('GET /users', function() { it('responds with json', async function() { const response = await request(app) .get('/users') .set('Accept', 'application/json') expect(response.headers["Content-Type"]).toMatch(/json/); expect(response.status).toEqual(200); expect('[email protected]'); }); });

Expectations are run in the order of definition. This characteristic can be used to modify the response body or headers before executing an assertion.

describe('POST /user', function() { it(' should be an case-insensitive match for "john"', function(done) { request(app) .post('/user') .send('name=john') // x-www-form-urlencoded upload .set('Accept', 'application/json') .expect(function(res) { = 'some fixed id'; =; }) .expect(200, { id: 'some fixed id', name: 'john' }, done); }); });

Anything you can do with superagent, you can do with supertest - for example multipart file uploads!

request(app) .post('/') .field('name', 'my awesome avatar') .field('complex_object', '{"attribute": "value"}', {contentType: 'application/json'}) .attach('avatar', 'test/fixtures/avatar.jpg') ...

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.

request = request('http://localhost:5555'); request.get('/').expect(200, function(err){ console.log(err); }); request.get('/').expect('heya', function(err){ console.log(err); });

Here's an example with mocha that shows how to persist a request and its cookies:

const request = require('supertest'); const should = require('should'); const express = require('express'); const cookieParser = require('cookie-parser'); describe('request.agent(app)', function() { const app = express(); app.use(cookieParser()); app.get('/', function(req, res) { res.cookie('cookie', 'hey'); res.send(); }); app.get('/return', function(req, res) { if (req.cookies.cookie) res.send(req.cookies.cookie); else res.send(':(') }); const agent = request.agent(app); it('should save cookies', function(done) { agent .get('/') .expect('set-cookie', 'cookie=hey; Path=/', done); }); it('should send cookies', function(done) { agent .get('/return') .expect('hey', done); }); });

There is another example that is introduced by the file agency.js

Here is an example where 2 cookies are set on the request.

agent(app) .get('/api/content') .set('Cookie', ['nameOne=valueOne;nameTwo=valueTwo']) .send() .expect(200) .end((err, res) => { if (err) { return done(err); } expect(res.text)'hey'); return done(); });


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 field value with a string 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"); }


Perform the request and invoke fn(err, res).


Inspired by api-easy minus vows coupling.





What is supertest?

SuperAgent driven library for testing HTTP servers

Is supertest popular?

The npm package supertest receives a total of 2,526,927 weekly downloads. As such, supertest popularity was classified as popular.

Is supertest well maintained?

We found that supertest demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 7 open source maintainers collaborating on the project.

Last updated on 26 Apr 2022


Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc