Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisandrews7/chai-nock
Chai Nock extends Chai with a language for asserting facts about Nock.
https://github.com/chrisandrews7/chai-nock
Last synced: about 2 months ago
JSON representation
Chai Nock extends Chai with a language for asserting facts about Nock.
- Host: GitHub
- URL: https://github.com/chrisandrews7/chai-nock
- Owner: chrisandrews7
- License: mit
- Created: 2019-07-24T14:17:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T10:46:17.000Z (over 1 year ago)
- Last Synced: 2024-06-18T21:49:37.815Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 159 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chai Assertions for Nock
[](https://travis-ci.org/chrisandrews7/chai-nock) [](https://coveralls.io/github/chrisandrews7/chai-nock?branch=master) [](https://www.npmjs.com/package/chai-nock)
**Nock Chai** extends [Chai](http://chaijs.com/) with a language for asserting facts about [Nock](https://www.npmjs.com/package/nock).
Instead of manually wiring up your expectations to intercepting a nocked request:
```javascript
const nockedRequest = nock('http://some-url');
nockedRequest.on('request', function(req, interceptor, body) {
expect(body).to.deep.equal({ hello: 'world' });
});
```
you can write code that expresses what you really mean:
```javascript
return expect(nock('http://some-url')).to.have.been.requestedWith({
hello: 'world'
});
```
## Installation
`npm install chai-nock`
Then add to your test setup:
```javascript
const chai = require('chai');
const chaiNock = require('chai-nock');
chai.use(chaiNock);
```
## Assertions
### requested
Asserts that a request has been made to the nock.
```javascript
it('requested', () => {
const requestNock = nock('http://bbc.co.uk')
.get('/')
.reply(200);
request({
uri: 'http://bbc.co.uk',
});
return expect(requestNock).to.have.been.requested;
});
```
### requestedWith(body)
Asserts that a request has been made to the nock with a body that exactly matches the object provided.
```javascript
it('requestedWith', () => {
const requestNock = nock('http://bbc.co.uk')
.get('/')
.reply(200);
request({
json: true,
uri: 'http://bbc.co.uk',
body: {
hello: 'world'
}
});
return expect(requestNock).to.have.been.requestedWith({ hello: 'world' });
});
```
### requestedWithHeaders(headers)
Asserts that a request has been made to the nock with headers that exactly match the object provided.
```javascript
it('requestedWithHeaders', () => {
const requestNock = nock('http://bbc.co.uk')
.get('/')
.reply(200);
request({
json: true,
uri: 'http://bbc.co.uk',
headers: {
myHeader: 'myHeaderValue'
}
});
return expect(requestNock).to.have.been.requestedWithHeaders({
host: 'bbc.co.uk',
accept: 'application/json',
myHeader: 'myHeaderValue'
});
});
```
### requestedWithHeadersMatch(partialHeaders)
Asserts that a request has been made to the nock with headers that contain the key/value pairs in the object provided.
```javascript
it('requestedWithHeadersMatch', () => {
const requestNock = nock('http://bbc.co.uk')
.get('/')
.reply(200);
request({
json: true,
uri: 'http://bbc.co.uk',
headers: {
myHeader: 'myHeaderValue',
otherHeader: 'otherHeaderValue'
}
});
return expect(requestNock).to.have.been.requestedWithHeadersMatch({
myHeader: 'myHeaderValue'
});
});
```
## 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:
```javascript
const chaiNock = require('chai-nock');
chai.use(chaiNock);
// Set a timeout of 10 seconds
chaiNock.setTimeout(10000);
```
* WARNING: If not set already, the test timeout must be greater than that of chaiNock!
```javascript
jest.setTimeout(12000);
```
## Usage
```javascript
const { expect } = require('chai');
const nock = require('nock');
const request = require('request-promise-native');
describe('example', () => {
it('test', () => {
const requestNock = nock('http://bbc.co.uk')
.get('/')
.reply(200);
request({
json: true,
uri: 'http://bbc.co.uk',
body: {
hello: 'world'
}
});
return expect(requestNock).to.have.been.requestedWith({ hello: 'world' });
});
});
```