Chai Assertions for Nock

Nock Chai extends Chai with a language for asserting facts about Nock.

Instead of manually wiring up your expectations to intercepting a nocked request:

1const nockedRequest = nock('http://some-url');
2
3nockedRequest.on('request', function(req, interceptor, body) {
4  expect(body).to.deep.equal({ hello: 'world' });
5});

you can write code that expresses what you really mean:

1return expect(nock('http://some-url')).to.have.been.requestedWith({
2  hello: 'world'
3});

Installation

npm install chai-nock

Then add to your test setup:

1const chai = require('chai');
2const chaiNock = require('chai-nock');
3
4chai.use(chaiNock);

Assertions

requested

Asserts that a request has been made to the nock.

1it('requested', () => {
2  const requestNock = nock('http://bbc.co.uk')
3    .get('/')
4    .reply(200);
5
6  request({
7    uri: 'http://bbc.co.uk',
8  });
9
10  return expect(requestNock).to.have.been.requested;
11});

requestedWith(body)

Asserts that a request has been made to the nock with a body that exactly matches the object provided.

1it('requestedWith', () => {
2  const requestNock = nock('http://bbc.co.uk')
3    .get('/')
4    .reply(200);
5
6  request({
7    json: true,
8    uri: 'http://bbc.co.uk',
9    body: {
10      hello: 'world'
11    }
12  });
13
14  return expect(requestNock).to.have.been.requestedWith({ hello: 'world' });
15});

requestedWithHeaders(headers)

Asserts that a request has been made to the nock with headers that exactly match the object provided.

1it('requestedWithHeaders', () => {
2  const requestNock = nock('http://bbc.co.uk')
3    .get('/')
4    .reply(200);
5
6  request({
7    json: true,
8    uri: 'http://bbc.co.uk',
9    headers: {
10      myHeader: 'myHeaderValue'
11    }
12  });
13
14  return expect(requestNock).to.have.been.requestedWithHeaders({
15    host: 'bbc.co.uk',
16    accept: 'application/json',
17    myHeader: 'myHeaderValue'
18  });
19});

requestedWithHeadersMatch(partialHeaders)

Asserts that a request has been made to the nock with headers that contain the key/value pairs in the object provided.

1it('requestedWithHeadersMatch', () => {
2  const requestNock = nock('http://bbc.co.uk')
3    .get('/')
4    .reply(200);
5
6  request({
7    json: true,
8    uri: 'http://bbc.co.uk',
9    headers: {
10      myHeader: 'myHeaderValue',
11      otherHeader: 'otherHeaderValue'
12    }
13  });
14
15  return expect(requestNock).to.have.been.requestedWithHeadersMatch({
16    myHeader: 'myHeaderValue'
17  });
18});

Setting a Timeout

• By default, a timeout of 2 seconds is applied to assertions on nock requests. This means that if nock has not intercepted the request within the set time, the assertion will be false
• You can set a custom global timeout by calling setTimeout on the chaiNock object:

1const chaiNock = require('chai-nock');
2
3chai.use(chaiNock);
4// Set a timeout of 10 seconds
5chaiNock.setTimeout(10000);

• WARNING: If not set already, the test timeout must be greater than that of chaiNock!

1jest.setTimeout(12000);

Usage

1const { expect } = require('chai');
2const nock = require('nock');
3const request = require('request-promise-native');
4
5describe('example', () => {
6  it('test', () => {
7    const requestNock = nock('http://bbc.co.uk')
8    .get('/')
9    .reply(200);
10
11    request({
12      json: true,
13      uri: 'http://bbc.co.uk',
14      body: {
15        hello: 'world'
16      }
17    });
18
19    return expect(requestNock).to.have.been.requestedWith({ hello: 'world' });
20  });
21});