轻松清理sinon存根

有没有一种方法可以轻松重置所有可与Mocha的beforeEach块完美配合的s​​inon间谍模拟和存根。

我看到沙盒是一个选项，但是我看不到如何使用沙盒

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

Sinon通过使用沙箱提供了此功能，可以使用以下两种方式：

// 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"
}

要么

// 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"
}));

先前的答案建议使用sandboxes来完成此操作，但根据文档：

从sinon@5.0.0开始，sinon对象是默认的沙箱。

这意味着清理存根/模拟/间谍现在变得很容易：

var sinon = require('sinon');

it('should do my bidding', function() {
    sinon.stub(some, 'method');
}

afterEach(function () {
    sinon.restore();
});

@keithjgrant答案的更新。

从版本V2.0.0起，sinon.test方法已被转移到一个独立的sinon-test模块。要使旧的测试通过，您需要在每个测试中配置此额外的依赖项：

var sinonTest = require('sinon-test');
sinon.test = sinonTest.configureTest(sinon);

另外，您可以不sinon-test使用沙箱，而使用沙箱：

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"
} 

您可以使用sinon库的作者在此博客文章（日期为2010年5月）中说明的sinon.collection。

sinon.collection API已更改，并且使用它的方法如下：

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');
}

restore()仅恢复存根功能的行为，但不重置存根的状态。您必须将测试包装在一起sinon.test并使用，this.stub或者单独调用reset()存根

如果您想要一个具有sinon的设置，请在所有测试中始终将其重置：

在helper.js中：

import sinon from 'sinon'

var sandbox;

beforeEach(function() {
    this.sinon = sandbox = sinon.sandbox.create();
});

afterEach(function() {
    sandbox.restore();
});

然后，在您的测试中：

it("some test", function() {
    this.sinon.stub(obj, 'hi').returns(null)
})

请注意，使用qunit代替mocha时，需要将它们包装在模块中，例如

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');
    }
);

创建一个沙箱，将其用作所有间谍，存根，模拟和假货的黑匣子容器。

您所要做的就是在第一个describe块中创建一个沙箱，以便可以在所有测试用例中访问它。一旦完成所有测试用例，就应该释放原始方法，并sandbox.restore()在afterEach挂钩中使用该方法清理存根 ，以便在运行时释放保留的资源afterEach测试用例通过或失败。

这是一个例子：

 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(); 
    });
});