Sinon - 何时使用间谍/模拟/存根或只是简单的断言？

Question

我试图了解Sinon 如何在节点项目中正确使用。我已经浏览了示例和文档，但我仍然没有得到它。我已经设置了一个具有以下结构的目录，以尝试使用各种 Sinon 功能并了解它们适合的位置

|--lib
   |--index.js
|--test
   |--test.js

index.js是

var myFuncs = {};

myFuncs.func1 = function () {
   myFuncs.func2();
   return 200;
};

myFuncs.func2 = function(data) {
};

module.exports = myFuncs;

test.js 开头如下

var assert = require('assert');
var sinon = require('sinon');
var myFuncs = require('../lib/index.js');

var spyFunc1 = sinon.spy(myFuncs.func1);
var spyFunc2 = sinon.spy(myFuncs.func2);

诚然，这是非常做作的，但就目前而言，我想测试对func1 的任何调用都会导致调用func2，所以我会使用

describe('Function 2', function(){
   it('should be called by Function 1', function(){
      myFuncs.func1();
      assert(spyFunc2.calledOnce);
   });
});

我还想测试 func1 将返回 200 以便我可以使用

describe('Function 1', function(){
   it('should return 200', function(){
      assert.equal(myFuncs.func1(), 200);
   });
});

但我也看到了在这种情况下使用stubs 的示例，例如

describe('Function 1', function(){
   it('should return 200', function(){
      var test = sinon.stub().returns(200);
      assert.equal(myFuncs.func1(test), 200);
   });
});

这些有何不同？ stub 给出了什么是简单的断言测试所没有的？

让我最头疼的是，一旦我的程序变得更复杂，这些简单的测试方法将如何演变。假设我开始使用mysql 并添加一个新功能

myFuncs.func3 = function(data, callback) {
   connection.query('SELECT name FROM users WHERE name IN (?)', [data], function(err, rows) {
          if (err) throw err;
          names = _.pluck(rows, 'name');
          return callback(null, names);
       });
    };

我知道当涉及到数据库时，有人建议为此目的使用一个测试数据库，但我的最终目标可能是一个包含许多表的数据库，并且复制它进行测试可能会很麻烦。我已经看到使用 sinon 模拟数据库的参考资料，并尝试关注this answer，但我不知道什么是最好的方法。

Answer 1

你在一个帖子上问了这么多不同的问题……我会尽力解决的。

1. 用两个函数测试 myFuncs。

Sinon 是一个具有广泛功能的模拟库。 “模拟”意味着您应该用模拟或存根替换将要测试的部分内容。 Sinon documentation 中有一篇很好的文章很好地描述了差异。 当您在这种情况下创建间谍时...

var spyFunc1 = sinon.spy(myFuncs.func1);
var spyFunc2 = sinon.spy(myFuncs.func2);

...你刚刚创建了一个观察者。 myFuncs.func1 和 myFuncs.func2 将被一个 spy-function 替换，但它将用于记录调用参数并在此之后调用真实函数。这是一种可能的情况，但请注意 myFuncs.func1/func2 的所有可能复杂的逻辑将在测试中调用后运行（例如：数据库查询）。

2.1。 describe('Function 1', ...) 测试套件对我来说太做作了。

不清楚你真正指的是哪个问题。 返回一个常量值的函数不是现实生活中的例子。在大多数情况下会有一些参数，并且被测函数将实现一些转换输入参数的算法。因此，在您的测试中，您将部分实现相同的算法以检查该功能是否正常工作。这就是 TDD 出现的地方，它实际上假设您从测试开始实现并获取部分单元测试代码来实现正在测试的方法。

2.2。存根。在给定的示例中，单元测试的第二个版本看起来毫无用处。 func1 不接受任何参数。

var test = sinon.stub().returns(200);
assert.equal(myFuncs.func1(test), 200);

即使您将返回部分替换为 100，测试也会成功运行。 一个有意义的方法是，例如，用存根替换 func2 以避免在测试中启动繁重的计算/远程请求（DB 查询、http 或其他 API 请求）。

myFuncs.func2 = sinon.spy();
assert.equal(myFuncs.func1(test), 200);
assert(myFuncs.func2.calledOnce);

单元测试的基本规则是单元测试应尽可能简单，提供对尽可能小的代码片段的检查。在这个测试中，func1 正在被测试，所以我们可以忽略 func2 的逻辑。应该在另一个单元测试中进行测试。 请注意，进行以下尝试是无用的：

myFuncs.func1 = sinon.stub().returns(200);
assert.equal(myFuncs.func1(test), 200);

因为在这种情况下，您使用存根屏蔽了真正的 func1 逻辑，并且您实际上是在测试 sinon.stub().return()。相信我，它运作良好！ :D

1. 模拟数据库查询。 模拟数据库一直是一个障碍。我可以提供一些建议。

3.1。有良好的碎片化环境。即使对于一个小项目，最好也存在一个开发、阶段和生产完全独立的环境。包括数据库。这意味着您有一种自动化的数据库创建方式：脚本或 ORM。 在这种情况下，您将使用 before()/beforeEach() 在测试引擎中轻松维护测试数据库，以便为您的测试提供一个干净的结构。

3.2。有很好的碎片化代码。最好有好几层。最低（DAL）应该与业务逻辑分开。在这种情况下，您将为业务类编写代码，只是模拟 DAL。要测试 DAL，您可以使用您提到的方法（sinon.mock 整个模块）或一些特定的库（例如：用 SQLite 替换 db 引擎以进行测试，如 here 所述）

4. 结论。 “一旦我的程序变得更复杂，这些简单的测试方法将如何发展”。

除非您在开发应用程序时考虑到测试，否则很难维护单元测试，因此非常分散。坚持主要规则 - 使每个单元测试尽可能小。否则你是对的，它最终会变得混乱。因为您的应用程序不断发展的逻辑将涉及您的测试代码。