Sinon-Chai 的使用及常见问题解决方法-JavaScript中文网-JavaScript教程资源分享门户

什么是 Sinon-Chai？

Sinon-Chai 是一个结合了 Sinon 和 Chai 两个 JavaScript 测试库的工具，它提供了一些方便的语法糖来帮助我们更方便地编写测试用例。

Sinon 是一个用于创建测试替身（test doubles）的库，其中包括：spy（监视函数）、stub（替换函数）和 mock（模拟对象）。Chai 是一个断言库，它提供了丰富的断言语法，可以让我们更方便地编写测试用例。

将 Sinon 和 Chai 结合使用，我们可以更方便地编写测试用例，尤其是在测试异步代码时，Sinon-Chai 的语法糖可以帮助我们更加简洁地编写测试用例，提高代码的可读性和可维护性。

如何使用 Sinon-Chai？

安装

我们可以通过 npm 安装 Sinon-Chai：

npm install sinon-chai --save-dev

引入

在测试文件中引入 Sinon-Chai：

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

chai.use(sinonChai);

这样就可以开始使用 Sinon-Chai 提供的语法糖了。

语法糖

spy

我们可以使用 Sinon 的 spy 方法来监视一个函数的调用情况，比如我们有一个 getUser 函数，我们可以使用 spy 来监视这个函数的调用情况：

const getUser = sinon.spy();

getUser();

expect(getUser).to.have.been.calledOnce;

这里我们使用 expect 断言库来断言 getUser 函数被调用了一次。

stub

我们可以使用 Sinon 的 stub 方法来替换一个函数，比如我们有一个 getUser 函数，我们可以使用 stub 来替换这个函数：

const getUser = sinon.stub().returns({ name: '张三' });

const user = getUser();

expect(user).to.deep.equal({ name: '张三' });

这里我们使用 deep.equal 方法来比较 user 和 { name: '张三' } 是否相等。

mock

我们可以使用 Sinon 的 mock 方法来模拟一个对象，比如我们有一个 User 类，我们可以使用 mock 来模拟这个对象：

// javascriptcn.com 代码示例
class User {
  constructor(name) {
    this.name = name;
  }
}

const userMock = sinon.mock(User.prototype);

userMock.expects('constructor').once().withArgs('张三');

new User('张三');

userMock.verify();

这里我们使用 expects 方法来断言 User.prototype.constructor 方法被调用了一次，并且参数为 '张三'。

常见问题解决方法

Sinon-Chai 的 expect 断言不生效

在使用 Sinon-Chai 的 expect 断言时，有时候会出现断言不生效的情况，这是因为 Sinon-Chai 的 expect 断言和 Chai 的 expect 断言有一些区别，需要注意一下使用方式。

比如我们有一个 getUser 函数，我们想要断言这个函数被调用了一次：

const getUser = sinon.spy();

getUser();

// 这里会报错，expect 断言不生效
expect(getUser).to.have.been.calledOnce;

这里我们使用了 Sinon-Chai 的 to.have.been.calledOnce 断言，但是会报错，因为这个断言不是 Chai 的 expect 断言。

正确的使用方式是：

const getUser = sinon.spy();

getUser();

// 这里使用 Chai 的 expect 断言
chai.expect(getUser).to.have.been.calledOnce;

这里我们使用了 Chai 的 expect 方法，然后在断言中使用 Sinon-Chai 的 to.have.been.calledOnce 断言，这样就不会出现断言不生效的情况了。

总结

Sinon-Chai 是一个非常实用的测试工具，它结合了 Sinon 和 Chai 两个测试库的优点，提供了方便的语法糖来帮助我们更方便地编写测试用例。在使用 Sinon-Chai 时，需要注意它的 expect 断言和 Chai 的 expect 断言有一些区别，正确使用方式可以避免断言不生效的情况。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6506a9dc95b1f8cacd267c73