A test runner agnostic stubbing library for NodeJS, supporting dependency injection and auto stubbing
MIT License
A stubbing library with a focus on having:
Note: Currently this project is using Sinon and Rewire. Check them out!
npm install mimus
var mimus = require('mimus')
This is the main method that you will use. It will require only the module you want to test against, while stubbing any specified internal modules, that can be retrieved with other methods.
Require a stubbed db
module and also stub the mongodb
and zlib
module.
var db = mimus.require('./lib/db', __dirname, ['mongodb', 'zlib'])
Why the whitelist approach?
This way, unexpected clashes with mocking low level modules can be controlled by the user.
Get an internal variable.
Uses rewire.__get__
.
mimus.get(required_module, 'internal_var_name')
Set an internal variable.
Uses rewire.__set__
.
mimus.set(required_module, 'internal_var_name', 'value')
Create a (Sinon.JS) stub.
var stub = mimus.stub()
stub.returns...
Create a (Sinon.JS) spy.
var spy = mimus.spy()
Calls reset on every (Sinon.JS) stub/spy.
mimus.reset()
Calls restore on every (Sinon.JS) stub.
mimus.restore()
See the system tests.
Current list of contributors.
Any contributions are welcome. Please consider tests and code quality before submitting.
See bantik's contributor covenant!
Current issue tracker is on github.
Please read any docs available before opening an issue.
git clone [email protected]:brentlintner/mimus.git
cd mimus
npm install
npm run test
npm run test-cov
npm run lint
npm run lint-cov
npm run dev &
The top level API's main goal is to be a one method level interface with the object
returned via mimus.require
being passed around by reference. This keeps api methods off
of the main object, and also provides a more functional way to interact with mimus.
This project ascribes to semantic versioning.
Also, see all other deps.