paulmelnikow / icedfrisby-nock Goto Github PK

View Code? Open in Web Editor NEW

3.0 3.0 2.0 968 KB

Concise support for mock requests in IcedFrisby

License: MIT License

JavaScript 100.00%

api-testing mock nock frisby

icedfrisby-nock's Introduction

icedfrisby-nock

Concise support for mock requests in IcedFrisby.

Usage

Compose icedfrisby with icedfrisby-nock.

const frisby = require('icedfrisby-nock')(require('icedfrisby'))

or, more semantically, using the delightful mixwith:

const { mix } = require('mixwith')

const frisby = mix(require('icedfrisby')).with(require('./icedfrisby-nock'))

Allow connections to localhost, but simulate failure for any other HTTP connections.

await frisby.create(...)
  .get(...)
  .networkOff()
  .expectJSON(...)
  .run()

Mock one request, and simulate failure for any other HTTP connection.

intercept() automatically invokes networkOff().

await frisby.create(...)
  .get(...)
  .intercept(nock => nock('http://example.com')
    .get('/foobar')
    .reply(200))
  .expectJSON(...)
  .run()

Mock one request and allow all other HTTP connections.

await frisby.create(...)
  .get(...)
  .intercept(nock => nock('http://example.com')
    .get('/foobar')
    .reply(200))
  .networkOn()
  .expectJSON(...)
  .run()

Mock one request only if a condition is truthy.

const someCondition = true
await frisby.create(...)
  .get(...)
  .interceptIf(someCondition, nock => nock('http://example.com')
    .get('/foobar')
    .reply(200))
  .expectJSON(...)
  .run()

When using intercept(), interceptIf() or networkOff(), the plugin restores network access when the test finishes.

To check if a Frisby object has an intercept set, inspect the hasIntercept property.

To skip the test if an intercept is present, invoke .skipIfIntercepted() on the chain. This is useful with when invoked from a shared setup function or when performing conditional intercepts.

For the Nock API, refer to the Nock docs.

For the IcedFrisby API, refer to the IcedFrisby docs.

Installation

npm install --save-dev icedfrisby nock icedfrisby-nock

Who's using this

This project was developed for testing Shields.io.

Contribute

Issue Tracker: https://github.com/paulmelnikow/icedfrisby-nock/issues
Source Code: https://github.com/paulmelnikow/icedfrisby-nock

Pull requests welcome!

Support

If you are having issues, please let me know.

License

The project is licensed under the MIT license.

icedfrisby-nock's People

Contributors

Stargazers

Watchers

Forkers

pyvesb calebcartwright

icedfrisby-nock's Issues

Error when chaining open call after networkOn

Hello there!

I've been working on adding some tests to the CodeClimate service in shields (see pull request 1613). I need to mock one request and allow other HTTP connections and therefore followed the example in the Readme.

Nevertheless the following error is thrown:
TypeError: t.create(...).get(...).intercept(...).networkOn(...).open is not a function

In the end I've come up with a solution that seems to work, but I'm reporting this issue anyway. 😉

Cheers,

Pyves

Regression in 2.1.0

See badges/shields#5305

https://app.circleci.com/pipelines/github/badges/shields/2135/workflows/86b47726-8fc5-4d14-a857-0194da24eac7/jobs/110276/steps

Cleanup sometimes doesn't run

In these test runs:

after reaching the error "TypeError: Cannot read property 'startsWith' of undefined", it appears that nock is not being cleaned up correctly. None of the subsequent pass.

See badges/shields#3616 (comment) for a little more explanation.

Swap istanbul -> nyc

Add `skipIfIntercepted()` method

As mentioned in #27, it would be helpful to provide a skipIfIntercepted option that can be passed through config and/or chained on – any time before toss() or run().

This would be helpful for badges/shields#2195, we wanted to configure tests so the intercept()ed tests were skipped and the others were run.

This will need a skip() method added in IcedFrisby.

Cleanup

I want to track the bits of work related to finishing the upstream plugin support.

Upstream changes
- baseUri(): IcedFrisby/IcedFrisby#26
- before(): IcedFrisby/IcedFrisby#28
- finally()
- Export the constructor: IcedFrisby/IcedFrisby#29
- Release in npm
Tasks
- Update devDependencies
- Remove constructor hack
- Use finally, clean up better, and disable net connect by default

Provide a property getter for inspecting intercepted tests

In badges/shields#2195, we wanted to configure tests so the intercept()ed tests were skipped and the others were run. This required a way to check whether or not a test had an intercept in the chain.

With the tooling we had in place it was easy enough to conditionally call toss(). However there was no way to tell whether intercept() had been called.

Two possible fixes to this:

Add a property getter to allow inspecting whether an intercept has been placed. This seems useful regardless of whether the next option is also done.
Provide a skipIfIntercepted option that can be passed through config and/or chained on – any time before toss().