在 Chai 中如何测试函数调用次数

在前端开发中，测试是非常重要的一环，而测试框架和工具也不可或缺。Chai 是一个开放源代码的断言库，它可与多种 JavaScript 测试框架和运行时使用。

在测试中，有时候我们需要确保一个函数被调用了特定的次数。下面我们来详细讲解如何利用 Chai 进行函数调用次数测试。

利用 spies 的方法

首先，要使用 Chai 的这个功能，我们需要先引入 chai-spies 模块。chai-spies 是一个便于测试 JavaScript 代码的支持工具，基于 sinon 和 chai。

引入方法：

const chai = require('chai');
const sinon = require('sinon');
const sinonChai = require('sinon-chai');
const chaiSpies = require('chai-spies');

chai.use(sinonChai);
chai.use(chaiSpies);

接下来我们定义一个简单的函数 plus(a, b) ，该函数实现了两个数相加：

function plus(a, b) {
  return a + b;
}

现在，我们来使用 spies 的 chai.spy() 方法将 plus 函数包装起来，使其能够跟踪 plus 函数的调用次数。然后，调用 chai.expect() 方法，并使用 chai.spy 方法对 plus 函数进行包装。接着，我们调用 plus 函数，使用 chai.expect() 方法将函数调用次数与期望值进行比较：

// javascriptcn.com 代码示例
it('should call function plus() 2 times', function() {
  const plusSpy = chai.spy(plus);

  plusSpy(1, 2);
  plusSpy(3, 4);
  plusSpy(5, 6);

  chai.expect(plusSpy).to.have.been.called.twice;
});

在这个代码片段中，我们创建了一个名为 plusSpy 的 spies 对象，并将它作为参数传递给 chai.expect() 方法。然后我们调用 plus 函数 3 次，但实际上期望的只有 2 次。最后，使用 chai.expect(plusSpy) 方法来验证函数被调用次数是否与期望次数相等。

利用 sinon 的方法

除了 chai-spies，我们也可以使用 sinon 来进行函数调用次数测试。下面是使用 sinon 的示例代码：

// javascriptcn.com 代码示例
it('should call function plus() 3 times', function() {
  const plusSpy = sinon.spy(plus);

  plusSpy(1, 2);
  plusSpy(3, 4);
  plusSpy(5, 6);

  sinon.assert.callCount(plusSpy, 3);
});

在这个示例代码中，我们使用 sinon 的 sinon.spy() 方法创建了一个命名为 plusSpy 的 spies 对象。接下来我们调用 plus 函数 3 次，最后使用 sinon.assert.callCount() 方法来验证函数被调用次数是否与期望次数相等。

需要注意的是，以上两种方法的语法虽然不同，但它们的作用都是类似的，都是用来检查一个函数被调用了几次。

总结

在本文中，我们介绍了如何使用 Chai（包括它的扩展 chai-spies）和 sinon 两个库来进行 JavaScript 函数调用次数测试。任何一个方法都可以用来检查一个函数被调用的次数是否符合我们的预期。此外，这些库也提供了很多其他的实用工具，多了解一些其它功能是非常有好处的。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/653705c87d4982a6ebf55394