mocha-nock-fixtures
v0.2.0
Published
A simple library that makes saving fixtures with nock and mocha easy.
Downloads
10
Readme
Mocha Nock Fixtures
About
A simple library that makes saving fixtures with
nock and
mocha easy. Just
use describeFixture
instead of describe
and it will record outbound requests
using nock into test/fixtures
and read from them the next time you run the
tests.
Install
npm install --save-dev mocha-nock-fixtures
Usage
Use describeFixture
instead of describe
and it will use nock to record all
requests into your test/fixtures
directory. It also supports .skip
and
.only
as mocha does.
var request = require('request');
var assert = require('assert');
var describeFixture = require('mocha-nock-fixtures');
describeFixture('normal test', function() {
it('works', function(done) {
request('http://localhost:4000/users', function(err, res, body) {
assert(!err, 'was success');
done();
});
});
describe('some other test', function() {
// You can use mocha how you normally would to group tests
});
});
describeFixture.skip('skipped test', function() {
// Anything in here will be skipped
});
describeFixture.only('only test', function() {
// This will be the only test run
});
// Usage with test specific options
//
// This test will not record the request to localhost:4000 and anything it does
// record it will also record the reqheaders
describeFixture('normal test', {
excludeScope: 'localhost:4000',
recorder: {
enable_reqheaders_recording: true
}
}, function() {
it('works', function(done) {
request('http://localhost:4000/users', function(err, res, body) {
assert(!err, 'was success');
done();
});
});
describe('some other test', function() {
// You can use mocha how you normally would to group tests
});
});
Configuration
Defaults:
{
// Don't record any requests to this scope
// It can be an array or string
excludeScope: ['localhost', '127.0.0.1', '0.0.0.0'],
// Re-record and overwrite your current fixtures
overwrite: false,
// Record fixtures when test fails
recordOnFailure: false,
// These options are passed to the nock recorder that runs behind the scenes
// to capture requests
recorder: {
output_objects: true,
dont_print: true
}
}
To overide these you can call describeFixture.setDefaults
with an object to
override them for ALL tests. It must be called before any describeFixture()
is
called to work properly. The best place is in a test helper file.
You also are able to pass in test specific options as the last parameter to
describeFixture()
. See the "Usage" section above for an example.
Authors
Versioning
This library follows Semantic Versioning
Want to help?
Please do! We are always looking to improve this library. If you have any ideas please open an issue or a pull requests and we'll work on getting them in.
Legal
Poetic Systems, Inc © 2014