sinon.js基础使用教程---单元测试

Nodejs

1. 使用npm install sinon安装sinon
2. 在测试项中引入sinon：var sinon = require('sinon');

浏览器

1. 你可以选择npm install sinon，或使用CDN，也可以从官网下载到本地
2. 在你的测试页面引入sinon.js

入门指南

sinon包含许多功能，但它们多数都存在关系。你只需要掌握一部分，就会了解剩余部分。这让sinon很容易使用，只需要你了解了基本用法并知道它们之间的差别。

只要我们的代码调用了一个不容易控制的函数，我们通常就需要sinon。

对于Ajax，它可能是$.get或者XMLHttpResquest。对于timer，它可能是setTimeout。对于数据库，它可能是mongodb.findOne。

为了方便我们讨论，后面我将成这类函数为依赖方。我们测试的目标函数依赖其它函数的返回结果。

最常见的使用sinon方式是使用test-doubles替换掉问题依赖方。

• 当测试Ajax时，我们使用test-doubles替换XMLHttpResquest来伪造ajax请求
• 当测试timer时，我们伪造替换setTimeout
• 当测试数据库时，我们使用test-doubles来替换mongodb.findOne来直接返回伪造数据

让我们写点代码吧。

Spies

Spies很简单，但其它很多功能依赖它。

spies的主要用法是收集函数的调用信息。你可以用来验证一些事儿，例如函数是否被调用。

var user = {
  ...
  setName: function(name){
    this.name = name;
  }
}

//为user.setName创建一个spy
var setNameSpy = sinon.spy(user, 'setName');

//现在，每次调用目标函数，spy都会记录相关信息
user.setName('Darth Vader');

//我们可以使用spy对象查看相关信息
console.log(setNameSpy.callCount); //output: 1

//非常重要的步骤--拆除spy
setNameSpy.restore();

function myFunction(condition, callback){
  if(condition){
    callback();
  }
}

describe('myFunction', function() {
  it('should call the callback function', function() {
    var callback = sinon.spy();

    myFunction(true, callback);

    assert(callback.calledOnce);
  });
});

assert(callback.calledOnce);

assert(callback.calledOnce, 'Callback was not called once');

describe('myFunction', function() {
  it('should call the callback function', function() {
    var callback = sinon.spy();

    myFunction(true, callback);

    sinon.assert.calledOnce(callback);
  });
});

var stub = sinon.stub();

stub('hello');

console.log(stub.firstCall.args); //output: ['hello']

function saveUser(user, callback) {
  $.post('/users', {
    first: user.firstname,
    last: user.lastname
  }, callback);
}

describe('saveUser', function() {
  it('should call callback after saving', function() {

    //We'll stub $.post so a request is not sent
    var post = sinon.stub($, 'post');
    post.yields();

    //We can use a spy as the callback so it's easy to verify
    var callback = sinon.spy();

    saveUser({ firstname: 'Han', lastname: 'Solo' }, callback);

    post.restore();
    sinon.assert.calledOnce(callback);
  });
});

See the Pen Sinon Tutorial: JavaScript Testing with Mocks, Spies & Stubs。

使用mocks时，我们可以使用链式调用风格来定义期望的调用和结果。这和使用断言验证结果一样，除了我们需要提前定义，并在测试结束时校验它们storeMock.verify()。

调用mock对象的mock.expects(something)会创建一个期望值。意味着mock.something()方法期望被调用。Each expectation, in addition to mock-specific functionality, supports the same functions as spies and stubs.（译者注：只能意会无法言表啊）

你可能会觉得通常stub都比mock更简单 - 没错。Mocks要小心使用。

mock特定的特性，可以查看sinon的mock文档。

重要的最佳实践：使用sinon.test()

这里有个使用sion的很重要的最佳实践，不管是使用spies，stubs还是mocks都应该牢记。

如果你用test-doubles替换了一个存在的函数，则使用sinon.test()。

前面的例子中，我们使用stub.restore()或mock.restore()来在我们使用完后清理它们。这很有必要，否则test-doubles将持续有效，这将可能影响其他的测试项并导致错误。

但是，直接使用restore()可能很难，有可能因为某个异常导致restore()没有被调用！

我们有两种方法来解决这个问题：我们可以自己包装完整的try catch块。这允许我们将restore()放在finally块中调用来确保一切正常。

或者，一个更好的做法是我们可以将测试体写在sinon.test()中：

//A simple spy helper
function createSpy(targetFunc) {
  var spy = function() {
    spy.args = arguments;
    spy.returnValue = targetFunc.apply(this, arguments);
    return spy.returnValue;
  };

  return spy;
}

//Let's spy on a simple function:
function sum(a, b) { return a + b; }

var spiedSum = createSpy(sum);

spiedSum(10, 5);

console.log(spiedSum.args); //Output: [10, 5]
console.log(spiedSum.returnValue); //Output: 15

我们可以很容易的使用自定义函数来实现spy的功能。但注意sinon的spies提供了非常多的特性 – 包括断言的支持。这让sinon更方便使用。

关于Stub Then？

实现一个简单的stub， 你可以简单的替换成一个新的：

var stub = function() { };

var original = thing.otherFunction;
thing.otherFunction = stub;

//Now any calls to thing.otherFunction will call our stub instead