在 Chai 中使用 sinon 进行 mock 和 spy 的技巧教程-JavaScript中文网-JavaScript教程资源分享门户

在 Chai 中使用 sinon 进行 mock 和 spy 的技巧教程

前端开发离不开单元测试，而 sinon 是一个强大的测试库，其中包含了 mock、spy 等功能，可以快速方便地进行单元测试。本文将介绍如何在 Chai 中使用 sinon 进行 mock 和 spy，帮助读者更好地使用 sinon 进行单元测试。

安装和使用 sinon

首先，需要在项目中安装 sinon：

npm install sinon --save-dev

在测试文件中引入 sinon：

const sinon = require('sinon');

这样就可以使用 sinon 的各种功能了。

mock

mock 的作用是模拟某些行为，来测试代码的逻辑。在 sinon 中，可以通过 stub 和 mock 来实现 mock 的功能。

在 chai 中，可以使用 expect().to.have.been.calledOnce 来检验一个方法是否被调用。如下面的例子：

const func = sinon.stub();
func();
expect(func).to.have.been.calledOnce;

上面的例子中，先创建了一个 stub，然后调用了这个方法，接着使用 expect() 来检查这个方法是否被调用。expect().to.have.been.calledOnce 即为这个检测方法。

除了这种方式，我们还可以使用 sinon-chai，一个 chai 的插件来使用 expect().to.have.been.calledOnce。需要安装 sinon-chai，然后在测试文件中引入：

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

chai.use(sinonChai);

然后就可以使用 expect().to.have.been.calledOnce 来进行检测了。

下面是一个使用 mock 的例子，假设有一个业务逻辑如下，需要查询用户信息：

class UserService {
  async getUserById(id) {
    // 从后端查询用户信息
  }
}

为了测试这个方法，可以使用 sinon 的 mock 来模拟这个查询过程：

const userService = new UserService();
const mock = sinon.mock(userService);
mock.expects('getUserById').once().withArgs(1).returns(Promise.resolve({ id: 1, name: 'test' }));
await userService.getUserById(1);
mock.verify();

上面的代码，在 userService 中创建了一个 mock，并且期望 getUserById 方法被调用一次，参数为 1，返回值为 { id: 1, name: 'test' }。接着调用 getUserById 方法，最后使用 mock.verify() 来检查 getUserById 方法是否被调用。

spy 是一种覆盖调用其他函数的函数，通过它可以检测到函数是否被调用，以及是否被调用了特定的参数和次数。和 mock 不同的是，spy 并不会影响被调用的函数本身。

下面是一个使用 spy 的例子。假设有一个业务逻辑如下，需要调用两个方法，output1 和 output2：

// javascriptcn.com 代码示例
class OutputService {
  async output1(str) {
    console.log(str);
  }

  async output2(str) {
    console.log(str);
  }
}

class SomeService {
  async someMethod() {
    const outputService = new OutputService();
    await outputService.output1('test');
    await outputService.output2('test');
  }
}

我们可以使用 spyOn 来检查调用了哪些方法：

// javascriptcn.com 代码示例
const outputService = new OutputService();
const spy1 = sinon.spy(outputService, 'output1');
const spy2 = sinon.spy(outputService, 'output2');

const someService = new SomeService();
await someService.someMethod();

expect(spy1).to.have.been.calledWith('test');
expect(spy2).to.have.been.calledWith('test');

上面代码中，我们使用 spyOn 来创建了两个 spy，分别监控 output1 和 output2。然后调用 someMethod，接着使用 expect().to.have.been.calledWith('test') 来检查这两个方法是否被调用，并检查调用的参数。

总结

本文介绍了在 Chai 中使用 sinon 进行 mock 和 spy 的技巧，希望对读者进行了指导。其中 mock 可以使用 stub 和 mock 进行，check 可以使用 expect().to.have.been.calledOnce，而 spy 则可以使用 spyOn 进行。更多信息可以参考 sinon 的官方文档。

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