@tapjs/nock

A tap extension that integrates nock.

Features

• t.nock()
  • automatically calls nock.disableNetConnect()
  • arguments are passed directly to nock, and the result from nock returned
  • asserts all nock scopes created within a test have been consumed
  • cleans only the nock scopes created within the current test, keeping nocks from parent tests
  • if no parent tests have nocks, calls nock.enableNetConnect() in teardown
• t.nock.snapshot()
  • when snapshots are enabled, sends real requests and records responses to a fixture
  • when snapshots are not enabled, loads fixture data and sets up nock scopes for you

Usage

Load the @tapjs/nock plugin in your tap config.

For example, in .taprc:

1plugins:
2  - @tapjs/nock

Or in package.json:

1{
2  "tap": {
3    "plugins": ["@tapjs/nock"]
4  }
5}

Then use it in your tests like so:

1import t from 'tap'
2
3t.test('sends a request', async t => {
4  t.nock('https://registry.npmjs.org')
5    .get('/')
6    .reply(200, { hello: 'world' })
7
8  const res = await fetch('https://registry.npmjs.org')
9  t.equal(res.status, 200)
10  const body = await res.json()
11  t.same(body, { hello: 'world' })
12})
13
14// when snapshots are enabled, this test will send a real request
15// and record the response
16// when they are disabled, the recorded response will be
17// automatically loaded into a nock scope, and the test will
18// receive that response
19// This requires that the @tapjs/snapshot plugin is enabled.
20t.test('snapshots a request', async t => {
21  t.nock.snapshot()
22
23  const res = await fetch('https://registry.npmjs.org')
24  t.equal(res.status, 200)
25  const body = await res.json()
26  t.match(body, { db_name: 'registry' })
27})

You may use it directly, though that is a bit more clunky, because it won't be automatically applied to child tests, but it can be good if you only need nock in a small number of tests.

1import { plugin as tapNock } from '@tapjs/nock'
2import t from 'tap'
3
4t.test('sends a request', async t => {
5  const tn = tapNock(t)
6  tn.nock('https://registry.npmjs.org')
7    .get('/')
8    .reply(200, { hello: 'world' })
9
10  const res = await fetch('https://registry.npmjs.org')
11  t.equal(res.status, 200)
12  const body = await res.json()
13  t.same(body, { hello: 'world' })
14})
15
16// when snapshots are enabled, this test will send a real request
17// and record the response
18// when they are disabled, the recorded response will be
19// automatically loaded into a nock scope, and the test will
20// receive that response
21// This requires that the @tapjs/snapshot plugin is enabled.
22t.test('snapshots a request', async t => {
23  const tn = tapNock(t)
24  tn.nock.snapshot()
25
26  const res = await fetch('https://registry.npmjs.org')
27  t.equal(res.status, 200)
28  const body = await res.json()
29  t.match(body, { db_name: 'registry' })
30})

Credits

This plugin was originally developed by nlf as the standalone extension @npmcli/tap-nock, and the use case was a major inspiration for tap's plugin eventual architecture.