Mocha 测试框架中如何使用 Sinon 插件
在前端开发中，测试是不可缺少的一环。而 Mocha 是一个流行的 JavaScript 测试框架，它提供了丰富的函数和 API，使得测试变得更加容易和优雅。另外，Sinon 是一个流行的 Mock、Stub、Spy 库，它可以帮助我们对代码进行模拟和监控。本文将介绍 Mocha 如何集成 Sinon 插件，以及如何使用它们进行测试。
安装和配置 Mocha 和 Sinon
首先，需要安装 Mocha 和 Sinon。可以使用 npm 进行安装：
- --- ------- ----- ----- ----------
然后，在测试脚本中引入 Mocha 和 Sinon：
----- ------ - ------------------ ----- ----- - ----------------- ----- - --------- -- - - -----------------
接着，配置 Mocha 的运行环境， 可以使用 mocha.opts 文件或命令行参数。例如，要在 Node.js 环境下运行测试，可以在 mocha.opts 文件中添加以下内容：
--------- ------------- ----------- ---------- ---- ---- --- -----------------
其中，--require 表示要在运行测试前先载入一个 JavaScript 模块，这里使用 test/setup.js，可以在该文件中进行一些初始化的操作。--recursive 表示递归遍历子目录，--reporter 表示使用什么样式的运行报告，这里使用的是 spec 格式，--ui 表示使用什么样的接口测试风格，这里使用的是 BDD（行为驱动开发）风格。最后的 test/**/*.spec.js 表示要运行的测试脚本，可以匹配多个目录和文件。有了这个配置，就可以在命令行运行 mocha 命令，自动运行所有的测试脚本。
Sinon 的基本用法
在开始使用 Mocha + Sinon 进行测试之前，需要了解一些 Sinon 的基本用法。Sinon 主要有三个功能：Mock、Stub 和 Spy。下面以一个例子来介绍它们。
假设有这么一个函数：
-------- -------------- --------- -
-- ---- --- --------------------------- -
---------- ----- ------- ------- ---
- ---- -
-------------- --- -------------- -------
-
-这个函数接收一个 URL 参数和一个回调函数参数，会根据 URL 参数去获取远程数据。如果 URL 是正确的，则返回一个包含数据的对象；否则，返回一个错误对象。现在想要对这个函数进行测试。
首先，可以使用 Sinon 的 Mock 功能来模拟 HTTP 请求，并验证回调函数是否被正确调用。示例如下：
--------------------- -------- -- -
---------- ---- -------- ---- ---- -- --- -- ------- -------- -- -
-- -- ----
----- ---- - -------------
------------------------------------------ ----- ------- ------- ---
-- -- ---------
------------------------------------- ---------------
-- -- ----
--------------
---
---------- ---- -------- ---- ----- -- --- -- --------- -------- -- -
-- -- ----
----- ---- - -------------
-------------------- --------- -- -
-------------- --- -------------- -------
---
-- -- ---------
------------------------ ------
-- ----------
----------------------------- ---------------
------------------------------
---------------------------------------------------- --- -------------- -------
-- -- ----
---------------
---
---在第一个测试用例中，使用 sinon.mock() 创建一个 Mock 对象，然后设置 callback 方法期望被调用一次，参数为 { data: 'Hello, world!' }。在实际调用 fetchData 函数之后，用 mock.verify() 验证 Mock 对象是否被调用了一次。如果没有被调用，就会抛出一个错误。可以使用 mock.restore() 重置 Mock 对象。
在第二个测试用例中，使用 sinon.stub() 创建一个 Stub 对象，然后设置回调函数的行为。在实际调用 fetchData 函数之后，使用 sinon.assert.calledWith() 和 sinon.assert.calledOnce() 验证 Stub 对象是否被正确调用。在验证参数和返回值之后，要使用 stub.restore() 恢复 Stub 对象。
除了 Mock 和 Stub，Sinon 还提供了 Spy 功能，可以跟踪函数的调用和行为。例如，在验证回调函数是否被调用之前，可以在 fetchData 函数中添加一个 Spy，记录真实的调用时间和参数。示例如下：
--------------------- -------- -- -
---------- ---- -------- ---- ---- -- --- -- ------- -------- -- -
-- -- ---- - ---
----- ---- - -------------
----- --- - ---------------------
-- -- ---------
------------------------------------- ---------------
-- -- ---
---------------------------- --------------------------- ---------------
-----------------------------------
-- -- ----
--------------
-- -- ---
--------------
---
---在这个例子中，使用了 sinon.spy() 创建了一个 Spy 对象，用于记录 fetchData 函数的真实调用情况。然后，在实际调用 fetchData 函数之后，可以使用 sinon.assert.calledWith() 验证 Spy 对象是否被正确调用，使用 spy.returned() 验证函数是否返回了正确的值。验证之后，要使用 spy.restore() 恢复 Spy 对象。
在 Mocha 中使用 Sinon 插件
Mocha 和 Sinon 可以非常好地配合使用，可以使用 Sinon-Chai 插件来进行更简单的断言语法。例如，在验证 Mock 对象是否被正确调用时，可以将句子翻译为人类可读的形式，例如 expect(mock.verify()).to.have.been.calledOnce。下面介绍在 Mocha 中使用 Sinon-Chai 的方法：
首先，在测试脚本中引入 chai 和 sinon-chai：
----- ---- - ---------------- ----- --------- - ---------------------- --------------------
然后，在编写测试用例时，可以使用 chai.expect 断言语法和 Sinon 对象。例如，在验证 Mock 对象是否被正确调用时，可以写成这样：
--------------------- -------- -- -
---------- ---- -------- ---- ---- -- --- -- ------- -------- -- -
-- -- ----
----- ---- - -------------
------------------------------------------ ----- ------- ------- ---
-- -- ---------
------------------------------------- ---------------
-- -- ----
----------------------------------------------
-- -- ----
---------------
---
---在这个例子中，使用了 sinon.mock() 创建了一个 Mock 对象，使用了 chai.expect 断言语法来验证 Mock 对象是否被正确调用。在验证之后，要使用 mock.restore() 恢复 Mock 对象。
总结
Mocha 和 Sinon 是前端开发过程中用得比较多的测试框架和库。其中，Mocha 提供了丰富的函数和 API，使得测试变得更加容易和优雅；Sinon 则提供了 Mock、Stub 和 Spy 三种功能，可以帮助我们对代码进行模拟和监控。在使用 Mocha 进行测试时，可以结合 Sinon-Chai 插件提供的语法糖，使测试用例更加简洁和易读。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/645c8f45968c7c53b0ef9982