phenomnomnominal / tractor-plugin-mock-requests

tractor plugin for mocking async requests
MIT License
1 stars 0 forks source link

@tractor-plugins/mock-requests

Plugin for tractor for mocking HTTP/Fetch requests.

Greenkeeper badge npm version Code Climate Test Coverage

How to install

npm install @tractor-plugins/mock-requests --dev

Configuration

// tractor.conf.js
module.exports = {
    // ...
    mockRequests: {
        directory: './path/to/app/',
        domain: 'custom.domain.co.nz',
        headers: {
            'Custom Header': 'Custom Value'
        },
        port: 5000
    },
    // ...
};

For more information see here

What does this plugin do?

When testing an application, it is often useful to use fake API data. This can speed up creating tests, and can also make it faster to run the tests.

This plugin provides a mechanism for intercepting XHR and Fetch requests, and allows you to respond with pre-defined responses, based on the request URL. This is done with a proxy that injects the pre-defined responses into your running app, greatly reducing the overhead of a real request. It also provides a UI for creating JSON data files which are used as the response.

You'll probably want to use it with @tractor-plugins/mocha-specs.

Development

To set up development:

npm install # install dependencies
npm run dev # link dependencies
tractor init

To run plugin...

npm run tractor:test # in one tab
npm run tractor # in another tab

To run tests...

npm run tractor:test # in one tab
npm run test:e2e # in another tab