前言
在进行前端开发时，我们不光需要实现功能，并且需要对实现的功能进行接口测试。针对接口测试，我们可以使用一些工具来进行自动化测试。在本文中，我们将介绍使用 Chai 和 SuperTest 工具进行 API 测试时遇到的坑点和技巧以及解析。
Chai 简介
Chai 是一个 BDD/TDD 断言库，可以用于 Node.js 和浏览器环境。Chai 可以与多种测试框架结合使用，并带有易于使用的接口和内置的错误消息。
Chai 断言库分为三个部分：
expect将一个对象包装，并提供断言方法，可以直接给出期望的值。assert提供了许多函数，用于判断测试结果是否符合预期。should将所有属性添加到Object.prototype，可以让你使用链式调用的方式编写断言。
SuperTest 简介
SuperTest 是一个优秀的基于 Node.js 的 HTTP 测试框架。它可以轻松地测试可用于 Node.js 应用程序的 API 接口。它是一个测试套件之间的一个非常好的中间件，可以用来测试本地 Node.js 服务器或者部署在服务上的 HTTP 服务器。
坑点和技巧
在使用 Chai 和 SuperTest 进行 API 测试时，有些坑需要注意。
坑点一：异步
由于接口测试是异步的，需要使用类似 done() 或者 Promise 等方式来处理异步。在使用 Chai 和 SuperTest 进行接口测试时也是同样的处理方式。
-- -------------------- ---- -------
----- --------- - ---------------------
----- ---- - ----------------
----- ------ - ------------
----- --- - -----------------
----- ------- - ---------------
------------- ------ -- -- -
---------- ------ ----- ------ -- -
----------------
------------
---------- ---- -- -
-- ----- ------ ----------
-------
---
---
---在上面的代码中，使用 done() 来处理异步请求。
坑点二：Body parsing
在测试 API 接口时，处理请求时会使用一些中间件来解析请求头、请求体等参数。需要注意的是，出于安全原因，通常禁用了工程应用程序中的解析功能。在使用 SuperTest 进行测试时，需要在测试脚本中设置正确的解析器。
-- -------------------- ---- ------- ----- --------- - --------------------- ----- ------- - ------------------- ----- ---------- - ----------------------- ----- --- - ---------- --------------------------- ------------------------------- --------- ----- ---- -- ------ -------------- - ----
-- -------------------- ---- -------
----- --------- - ---------------------
----- ---- - ----------------
----- --- - -----------------
----- ------- - ---------------
----- ------ - ------------
------------- ------ -- -- -
---------- ------ --- --- ------ ------ -- -
----- ---- - -
----- ------
--
--------------------
-----------
------------
---------- ---- -- -
----- ---- - ---------
-----------------------------------------
----------
---
---
---在上面的代码中，使用 body-parser 解析请求体，确保测试请求可以正常工作。
坑点三：ContentType
当我们编写 send 请求时，需要注意指定请求的类型格式。
-- -------------------- ---- -------
----- --------- - ---------------------
----- ---- - ----------------
----- --- - -----------------
----- ------- - ---------------
----- ------ - ------------
------------- ------ -- -- -
---------- ------ --- --- ------ ------ -- -
----- ---- - -
----- ------
--
--------------------
-----------
-------------------------
------------
---------- ---- -- -
----- ---- - ---------
-----------------------------------------
----------
---
---
---在上面的代码中，使用 type 方法设置请求格式为 application/json，这样可以确保测试请求可以正常工作。
技巧一：使用 Chai 的 deep 匹配进行 JSON 对象检查
Chai 允许使用深层比较进行比较操作，这样我们可以更加方便地进行 JSON 对象和数组的测试。
-- -------------------- ---- -------
----- --------- - ---------------------
----- ---- - ----------------
----- --- - -----------------
----- ------- - ---------------
----- ------ - ------------
------------- ------ -- -- -
---------- ------ --- --- ------ ------ -- -
----- ---- - -
----- -------
--------- -
-
----- --------
--
-
----- --------
-
-
--
--------------------
-----------
-------------------------
------------
---------- ---- -- -
----- ---- - ---------
---------------------------------
----------
---
---
---在上面的代码中，使用 expect.body.to.deep.equal(data) 进行 JSON 对象的深度匹配操作。
技巧二：Mock 数据
在测试 API 接口时，请求到真实的数据库是不可取的，因此我们需要 Mock 一些测试数据。可以考虑使用 sinon.js 和 faker.js 来生成 Mock 数据。
const sinon = require('sinon');
const faker = require('faker');
sinon.stub(User, 'findOne').returns({
username: faker.name.firstName(),
email: faker.internet.email(),
password: faker.internet.password()
});在上面的代码中，使用 sinon.stub 对数据进行 Mock。使用 faker 库生成 Mock 数据。
结论
在本文中，我们介绍了使用 Chai 和 SuperTest 进行 API 测试时的坑点和技巧。希望本文可以对读者们进行指导和帮助。同时，也希望读者们在编写测试代码时能够注意到以上内容，以确保测试代码的正确性和有效性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/672fbf9aeedcc8a97c903f91