在前端开发中，进行单元测试是非常重要的。而对于一些复杂的函数和模块，我们需要知道它们被调用了多少次，在什么情况下被调用，以及被传递了哪些参数。在这种情况下，sinon.spy() 可以帮助我们进行函数调用跟踪。本文将讲解如何在 Chai 中使用 sinon.spy() 进行函数调用跟踪。
安装 sinon 和 Chai
在开始之前，我们需要安装 sinon 和 Chai。我们可以使用 npm 进行安装。在终端中执行以下命令：
npm install --save-dev sinon chai
使用 sinon.spy()
sinon.spy() 方法可用于跟踪函数的调用，以及所传递的参数。在测试用例中，我们可以将要测试的函数作为参数传递给 sinon.spy()，然后进行测试。以下是一个示例代码：
-- -------------------- ---- -------
----- ----- - ----------------
----- ---- - ---------------
----- ------ - -----------
-------- ------ -- -
------ - - -
-
--------------- -- -- -
---------- ---- --- -------- ------ -- -- -
----- --- - --------------
------ --
---------------------------------
--
--在这个示例中，我们测试了一个 add 函数，并使用 sinon.spy() 对该函数进行了跟踪。接着，我们调用了该函数一次，然后使用 expect(spy.callCount).to.equal(1) 进行了断言。该断言表明该函数仅被调用了一次。
收集函数调用参数
在我们的测试用例中，我们还可以跟踪函数被调用时传递的参数。我们可以通过访问 spy.getCall(n).args 来检索第 n 次调用中传递的参数。以下是一个例子：
-- -------------------- ---- -------
----- ----- - ----------------
----- ---- - ---------------
----- ------ - -----------
-------- ------ -- -
------ - - -
-
--------------- -- -- -
---------- ---- --- -------- ---- ------- ----------- -- -- -
----- --- - --------------
------ --
------ --
--------------------------------------------- ---
--------------------------------------------- ---
--
--在这个示例中，我们还是跟踪了一个 add 函数，并使用 sinon.spy() 方法进行了跟踪。然后我们两次调用了该函数，并使用 expect(spy.getCall(0).args).to.deep.equal([1, 2]) 进行了断言，表明第一次调用该函数传递的参数是 [1, 2]。
跟踪内部函数调用
在我们的测试用例中，我们还可以跟踪内部函数的调用情况。我们可以使用 sinon.spy() 方法跟踪由我们正在测试的函数调用的内部函数。以下是一些示例代码：
-- -------------------- ---- -------
----- ----- - ----------------
----- ---- - ---------------
----- ------ - -----------
-------- --------------- -
-------- --------------- -
------------------ -------
-
---------------
-
------------------------- -- -- -
---------- ---- --- ----- ---------- -- -- -
----- -------- - -----------
----- -------- - ------------------------
---------------
--------------------------------------
--------------------------------------
--
--在这个示例中，我们跟踪了一个名为 outerFunction 的外部函数，并使用 sinon.spy() 对其进行了跟踪。该函数调用了 innerFunction，在这个测试用例中，我们还使用 sinon.spy() 对 innerFunction 进行了跟踪。以下是测试用例的几个方面：
- outerFunction 被调用。
- innerFunction 被调用。
- 在函数调用期间，innerFunction 被 outerFunction 调用了。
注意，在这个示例中，我们使用 innerSpy.calledOnce 和 outerSpy.calledOnce 来检查 outerFunction 和 innerFunction 是否被调用了一次。这是 sinon.spy() 方法提供的便捷方法。
总结
在本文中，我们探讨了如何在 Chai 中使用 sinon.spy() 跟踪函数的调用情况。我们讲解了如何跟踪被测试函数的参数，以及如何跟踪内部函数的调用。学会了这些技巧之后，我们就可以更轻松地进行单元测试，并能够更好地测试我们的代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/654287ee7d4982a6ebc36528