Jest 测试 Node.js 项目：使用 supertest 和 mock-fs
前言
对于 Web 开发和 Node.js 项目，测试是至关重要的一步。然而，测试本身也是一个费时费力的过程，特别是当我们需要对一个完整的 Web API 或者批量处理项目进行测试时。因此，自动化测试工具等于必不可少。
在这篇文章中，我们将介绍 Jest 测试框架，并重点讲解如何使用 supertest 和 mock-fs 来测试 Node.js 项目。
学习目标
在本文中，我们将学习以下内容：
- 对 Jest 的简介和安装
- 如何使用 Jest 做单元测试
- 如何使用 supertest 做 API 测试
- 如何使用 mock-fs 来模拟文件系统
Jest 简介
Jest 是 Facebook 开发的一个简单、快速和可靠的 JavaScript 测试框架。它支持常见的 JavaScript 模块，如 ECMAScript、Babel、TypeScript 等；而且它带有覆盖率报告，快照测试，和自动化测试等功能。Jest 具有简单的配置并且令人愉快地与多个测试库配合使用。
安装 Jest
要安装 Jest，可以使用 npm 命令行工具，在你的项目目录下执行以下命令：
--- - ---------- ----
Jest 单元测试例子
下面是一个 Jest 的单元测试例子：
-------- --- ---- -- -- - ----- --- - --------------------------- ------------- ------------ ------------- --------------- ---
test() 函数是一个 Jest 测试用例。它接受两个参数：测试用例名称和一个测试函数。测试函数应该包含一些代码、断言或者其他行为，以检查被测试的代码是否像预期的那样工作。
这个例子中，我们测试了一个假想的加法函数。我们调用了 add() 函数两次，每次包括两个数字作为参数，并且期望函数能够返回正确的值。注意，第一个断言使用 toBe()，因为它对于基本数据类型的比较非常有用，而第二个断言使用 toEqual()，因为它可以深入比较对象的属性和值。
我们可以使用 Jest 执行这个测试用例：
- ---- ---- ------------------ - -- --- -- -- --- ---- ------- - ------- - ----- ------ - ------- - -----
使用 Supertest 来进行 API 测试
Supertest 是一个基于 Superagent 的库，它为 Node.js HTTP 服务器提供了一种 E2E 的 API 测试语言，并且具有优雅、简单和可读性的特点。同时，它也支持 HTTP 断言库。
我们来看一个例子，假设我们要测试一个 /users/:id API，这个 API 可以通过 GET 请求获取一个用户的详细信息：
----- ------- - --------------------- ----- --- - ----------------- -------- ---------- ----- ----- -- -- - ----- -------- - ----- ----------------------------- ---------------------------------- ------------------------------------------- --------------------------------------------- --------------------------------- ---
在这个例子中，我们使用 supertest 来向我们的 Node.js Express 应用程序发送 HTTP 请求。注意，我们传递了应用程序实例 app 作为 supertest 函数的参数，这是测试服务器的实例化。接下来，我们可以使用 get() 方法来向 /users/1 路径发送一个 GET 请求，并等待响应。
最后，我们期望响应状态码返回 200，期望响应体（包括用户 id 和 name）被返回，而且 id 的值为 1。
使用 mock-fs 来模拟文件系统
如果你的项目依赖于文件系统，那么测试文件的读写操作会变得很麻烦。此时，mock-fs 可以帮助我们模拟文件系统操作，以便为项目编写更清晰和可靠的测试。
在下面的例子中，我们将演示如何使用 mock-fs 来模拟文件系统。
假如我们需要测试一个函数，它将一个相对路径转换成绝对路径。这个函数将使用内置的 fs 模块，因此在测试期间，有两个选项：要么在测试文件夹中创建一个虚拟文件系统，要么使用 mock-fs。
我们将使用第二种选项：我们将使用 mock-fs 模拟一个虚拟文件系统，并在测试期间使用它。
----- ---- - ----------------
----- ---- - -------------------
-------- ---------------------- ---- -- -- -
------
---------------- ----- --------
---
----- ---------------------- - ----------------------------------------------
----- -------- - ------------------
----- ------------ - ---------------------------------
--------------------------------------------------
---------------
---在这个例子中，我们使用 mock-fs 模块来模拟文件系统。首先，我们使用 mock() 函数创建一个虚拟的文件系统，这个文件系统只包括一个文件 some/file.txt。然后，我们调用一个工具函数 filePathToAbsolutePath()，并传递一个相对路径作为参数。最后，我们验证函数是否正确把相对路径转换成绝对路径，并将其与 path.resolve() 的结果进行比较。
最后，调用 mock.restore() 函数来恢复所有 mock 被注入的模块和函数。
总结
在这篇文章中，我们学习了使用 Jest 进行单元测试和集成测试，以及使用 supertest 进行 API 测试和 mock-fs 进行文件系统的模拟。这些都是一个完整的 Web 项目中重要的一部分，也是健全的测试环境所必需的。
在你的下一个项目中，请记住：测试并不是一件让人头疼的事情，而是可以让我们更安全地进行开发和重构，保证代码功能的可靠性。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/66571c92d3423812e4c2f2a4