如何在 Chai 中使用 sinon 进行函数的模拟

前言

作为前端开发人员，我们需要编写高质量的测试用例以确保代码的正确性和可靠性。在编写测试用例时，经常需要模拟函数的行为以捕获预期结果。在此过程中，sinon.js 是一个非常流行的库，它可以帮助我们模拟函数的行为以及许多其他测试用例的实用功能。在本文中，我们将学习如何在 Chai 中使用 sinon.js 进行函数模拟。

安装 sinon.js 和 Chai

在开始本教程前，我们需要先安装 sinon.js 和 Chai。

npm install --save-dev sinon chai

sinon.js 需要 chai 插件来运行，我们需要安装它们两个。

示例代码

下面我们使用一个简单的示例代码，在本教程中使用它来说明如何在 Chai 中使用 sinon.js 进行函数模拟。此示例代码通过传递数字来计算乘法，并将其返回给我们的调用函数。现在我们将使用 sinon.js 模拟该函数，以便我们可以在测试用例中断言它的返回值。

function multiplyNumbers(a, b) {
  return a * b;
}

使用 sinon.js 进行函数模拟

创建模拟函数

通过使用 sinon.js 的 sinon.stub() 函数，可以轻松地模拟函数的行为。下面是如何使用 sinon.js 模拟的示例代码。

const sinon = require('sinon');

const multiplyNumbers = sinon.stub();

我们可以通过在这里调用 sinon.stub() 来创建一个名为 multiplyNumbers 的模拟函数。接下来，我们需要添加要模拟的函数的行为。

模拟函数的行为

对于我们的示例代码，我们可以编写如下所示的行为来模拟multiplyNumbers函数。

const sinon = require('sinon');

const multiplyNumbers = sinon.stub();
multiplyNumbers.withArgs(2, 3).returns(6);

在这里，我们使用 multiplyNumbers() 函数和它的函数调用的构造函数来指定我们要模拟的参数。这是通过使用 withArgs() 方法实现的。接下来，我们使用 .returns() 方法来指定该函数的返回值。

在本示例中，我们将参数设置为 2 和 3 ，并且我们指定函数的返回值为 6 。

现在，multiplyNumbers() 函数被模拟并准备好在测试用例中使用。

在测试用例中使用模拟函数

现在，我们已经创建并准备了我们的模拟函数，我们可以在我们的测试用例中使用它。让我们编写一个简单的测试用例来验证我们的函数调用的行为。下面是测试用例示例代码。

const { expect } = require('chai');

describe('multiplyNumbers', () => {
  it('should return 6 when passed 2 and 3', () => {
    const result = multiplyNumbers(2, 3);
    expect(result).to.equal(6);
  });
});

在这里，我们简单地调用了模拟函数并检查其返回结果是否符合预期。在 expect() 断言中，我们期望 result 的值等于 6 。

结论

在本教程中，我们学习了如何在 Chai 中使用 sinon.js 进行函数模拟。我们编写了简单的示例代码，展示了如何创建模拟函数，模拟其行为，并在测试用例中使用它。使用这些概念，您可以开始编写更高质量的测试用例，以确保代码的正确性和可靠性。

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