Cleaning up sinon stubs easily
JavascriptTestingmocha.jsStubbingSinonJavascript Problem Overview
Is there a way to easily reset all sinon spys mocks and stubs that will work cleanly with mocha's beforeEach blocks.
I see sandboxing is an option but I do not see how you can use a sandbox for this
beforeEach ->
sinon.stub some, 'method'
sinon.stub some, 'mother'
afterEach ->
# I want to avoid these lines
some.method.restore()
some.other.restore()
it 'should call a some method and not other', ->
some.method()
assert.called some.method
Javascript Solutions
Solution 1 - Javascript
Sinon provides this functionality through the use of Sandboxes, which can be used a couple ways:
// manually create and restore the sandbox
var sandbox;
beforeEach(function () {
sandbox = sinon.sandbox.create();
});
afterEach(function () {
sandbox.restore();
});
it('should restore all mocks stubs and spies between tests', function() {
sandbox.stub(some, 'method'); // note the use of "sandbox"
}
or
// wrap your test function in sinon.test()
it("should automatically restore all mocks stubs and spies", sinon.test(function() {
this.stub(some, 'method'); // note the use of "this"
}));
Solution 2 - Javascript
Previous answers suggest using sandboxes
to accomplish this, but according to the documentation:
> Since [email protected], the sinon object is a default sandbox.
That means that cleaning up your stubs/mocks/spies is now as easy as:
var sinon = require('sinon');
it('should do my bidding', function() {
sinon.stub(some, 'method');
}
afterEach(function () {
sinon.restore();
});
Solution 3 - Javascript
An update to @keithjgrant answer.
From version v2.0.0 onwards, the sinon.test method has been moved to a separate sinon-test
module. To make the old tests pass you need to configure this extra dependency in each test:
var sinonTest = require('sinon-test');
sinon.test = sinonTest.configureTest(sinon);
Alternatively, you do without sinon-test
and use sandboxes:
var sandbox = sinon.sandbox.create();
afterEach(function () {
sandbox.restore();
});
it('should restore all mocks stubs and spies between tests', function() {
sandbox.stub(some, 'method'); // note the use of "sandbox"
}
Solution 4 - Javascript
You may use sinon.collection as illustrated in this blog post (dated May 2010) by the author of the sinon library.
The sinon.collection api has changed and a way to use it is the following:
beforeEach(function () {
fakes = sinon.collection;
});
afterEach(function () {
fakes.restore();
});
it('should restore all mocks stubs and spies between tests', function() {
stub = fakes.stub(window, 'someFunction');
}
Solution 5 - Javascript
restore()
just restores the behavior of the stubbed functionality but it doesn't reset the state of the stubs. You'll have to either wrap your tests with sinon.test
and use this.stub
or individually call reset()
on the stubs
Solution 6 - Javascript
If you want a setup that will have sinon always reset itself for all tests:
in helper.js:
import sinon from 'sinon'
var sandbox;
beforeEach(function() {
this.sinon = sandbox = sinon.sandbox.create();
});
afterEach(function() {
sandbox.restore();
});
Then, in your test:
it("some test", function() {
this.sinon.stub(obj, 'hi').returns(null)
})
Solution 7 - Javascript
Note that when using qunit instead of mocha, you need to wrap these in a module, e.g.
module("module name"
{
//For QUnit2 use
beforeEach: function() {
//For QUnit1 use
setup: function () {
fakes = sinon.collection;
},
//For QUnit2 use
afterEach: function() {
//For QUnit1 use
teardown: function () {
fakes.restore();
}
});
test("should restore all mocks stubs and spies between tests", function() {
stub = fakes.stub(window, 'someFunction');
}
);
Solution 8 - Javascript
Create a sandbox which will act as a black box container for all your spies, stubs, mocks and fakes.
All you have to do is create a sandbox in the very first describe block so that, it is accessible throughout all the test cases. And once you are done with all the test cases you should release the original methods and clean up the stubs using the method sandbox.restore()
in the afterEach hook so that at runtime it releases held up resources afterEach
test case is passed or failed.
Here is an example:
describe('MyController', () => {
//Creates a new sandbox object
const sandbox = sinon.createSandbox();
let myControllerInstance: MyController;
let loginStub: sinon.SinonStub;
beforeEach(async () => {
let config = {key: 'value'};
myControllerInstance = new MyController(config);
loginStub = sandbox.stub(ThirdPartyModule, 'login').resolves({success: true});
});
describe('MyControllerMethod1', () => {
it('should run successfully', async () => {
loginStub.withArgs({username: 'Test', password: 'Test'}).resolves();
let ret = await myControllerInstance.run();
expect(ret.status).to.eq('200');
expect(loginStub.called).to.be.true;
});
});
afterEach(async () => {
//clean and release the original methods afterEach test case at runtime
sandbox.restore();
});
});
Solution 9 - Javascript
below will reset all the stubs and nested stubs.
sinon.reset();
or you do
NameOfFunctiontionYouWantToReset.resetHistory();
like
addingStub.resetHistory();