如何在 Chai 中测试一个函数是否被调用

如何在 Chai 中测试一个函数是否被调用

在编写 JavaScript 前端代码时，我们需要测试函数是否被调用以确保代码的正确性和可靠性。在使用 Chai 进行单元测试时，可以使用 spy 方法来监视函数的调用情况。本文将详细介绍如何在 Chai 中测试一个函数是否被调用，并提供相关代码示例。

1. 安装 Chai

首先，需要在项目中安装 Chai。可以使用 npm 命令进行安装：

npm install chai --save-dev

1. 初始化 Chai

在测试文件中，需要使用 require() 方法引入 Chai 并进行初始化。

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

chai.use(sinonChai);

其中，sinon 用于创建 spy，并与 Chai 进行配合使用，而 sinon-chai 则用于扩展 Chai 的断言方法，使其能够更方便地使用 spy 进行断言。

1. 创建 spy

接下来，可以使用 sinon.spy() 方法创建一个 spy 对象。例如，对于以下代码：

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

可以使用以下代码创建一个名为 addSpy 的 spy 对象：

const addSpy = sinon.spy(add);

在创建 spy 对象时，可以将要监视的函数作为参数传入。这里，我们将 add() 函数作为参数传入 spy 中。

1. 调用被监视的函数并断言

现在，可以使用 spy 对象监视 add() 函数的调用情况。例如，对于以下代码：

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

function calculate(a, b) {
  const result = add(a, b);
  return result * 2;
}

可以使用以下代码测试 calculate() 函数是否调用了 add() 函数：

describe('calculate()', () => {
  it('should call add()', () => {
    const addSpy = sinon.spy(window, 'add');
    calculate(1, 2);
    chai.expect(addSpy).to.have.been.calledOnce;
  });
});

这里，我们创建了一个测试套件，并在其中创建了一个测试用例。在测试用例中，我们首先使用 sinon.spy() 方法创建了一个名为 addSpy 的 spy 对象，并将其绑定到 add() 函数上。

然后，在调用被监视的 calculate() 函数之后，我们使用 chai.expect(...) 语句对 addSpy 对象进行断言，以确定 add() 函数是否被调用。

1. 结论

通过本文的介绍，我们学习了如何在 Chai 中测试一个函数是否被调用。通过这种方法，我们能够有效地监视并验证前端代码中的函数调用，从而确保代码的可靠性和正确性。希望本文能够提供帮助，让你在编写前端代码时能够更加高效和自信。下面是完整的测试文件代码：

-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- --------- - ----------------------

--------------------

-------- ------ -- -
  ------ - - --
-

-------- ------------ -- -
  ----- ------ - ------ ---
  ------ ------ - --
-

----------------------- -- -- -
  ---------- ---- ------- -- -- -
    ----- ------ - ----------------- -------
    ------------ ---
    --------------------------------------------
  ---
---

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