Jest 是一个流行的 JavaScript 测试框架，它提供了丰富的功能和易于使用的 API，使得编写和运行测试变得极其简单。在本篇文章中，我们将学习如何使用 Jest 框架测试 Node.js 应用程序。
准备工作
在开始之前，我们需要进行一些准备工作。首先，我们需要安装 Node.js 和 npm（Node 包管理工具）。如果您已经安装了这些工具，请跳过此步骤。否则，请访问 Node.js 官网 下载安装文件并安装。
安装完成后，我们需要在终端中验证一下是否安装成功：
---- --------- --- ---------
如果您的命令行分别显示您的 Node.js 和 npm 的版本号，则说明您已经成功安装。
接下来，我们需要创建一个新的 Node.js 项目。请在项目的根目录中执行以下命令：
--- ---- --
此命令将会创建一个新的 package.json 文件，其中包含了我们的项目信息以及用到的依赖。我们还需要安装 Jest 框架作为开发依赖：
--- ------- ---------- ----
现在，我们已经准备好使用 Jest 框架进行 Node.js 应用程序的测试了。
第一个测试用例
在开始编写测试用例之前，我们需要编写一些代码，将其作为被测试的程序。创建一个名为 index.js 的文件，并将以下内容复制到其中：
-------- ------ -- - ------ - - -- - -------------- - ----
该代码定义了一个名为 add 的函数，该函数接收两个参数并返回它们的总和。我们将使用 Jest 框架测试该函数是否按预期工作。
现在，我们需要在项目根目录中创建一个名为 index.test.js 的文件，该文件将包含我们的测试用例。
----- --- - ------------------- ---------- - - - -- ----- --- -- -- - ------------- ------------ ---
上述代码定义了一个名为 adds 1 + 2 to equal 3 的测试用例，该用例将测试我们的 add 函数是否正确计算了 1 和 2 的总和是否等于 3。
要运行测试，请在终端中运行以下命令：
----
Jest 将会开始执行我们的测试用例，并输出测试结果：
---- --------------- - ---- - - - -- ----- - ----- ---- ------- - ------- - ----- ------ - ------- - ----- ---------- - ----- ----- ------- --------- -- --- --- ---- ------ -------- ----
测试已经通过！现在我们已经编写了一个简单的测试用例，可以开始编写更加复杂的测试用例了。
常见的 Jest API
在编写测试用例时，我们将使用 Jest API 来验证代码是否按照预期方式工作。以下是一些常见的 Jest API：
test(name, fn, timeout): 定义一个测试用例。describe(name, fn): 用来定义一个测试套件，一个测试套件包括多个相关的测试用例。expect(value): 用来对一个值进行断言。beforeAll(fn, timeout): 在所有测试用例运行之前只执行一次的方法。afterAll(fn, timeout): 在所有测试用例运行之后只执行一次的方法。beforeEach(fn, timeout): 在每个测试用例运行之前都执行的方法。afterEach(fn, timeout): 在每个测试用例运行之后都执行的方法。
使用 Matchers 进行断言
我们在上述第一个测试用例中已经使用了 Matchers 进行断言，它允许我们验证代码是否按照预期方式工作。以下是一些常见的 Matchers：
toBe(value): 检查变量是否等于指定值。toEqual(value): 检查变量是否等于指定值。not.toBe(value): 检查变量是否不等于指定值。not.toEqual(value): 检查变量是否不等于指定值。toBeTruthy(): 检查变量是否为 true。toBeFalsy(): 检查变量是否为 false。toBeNull(): 检查变量是否为 null。toBeDefined(): 检查变量是否已定义。toBeUndefined(): 检查变量是否未定义。toMatch(pattern): 检查变量是否与指定的正则表达式匹配。toContain(value): 检查数组是否包含指定的值。
以下是一个使用 Matchers 的示例：
--------- ---- -- ------ -------- -- -- - ----------------------------------------- --------- ---
上述代码使用 resolves.toBe Matchers 验证一个异步函数是否按照预期方式工作。
Mock Functions
在测试 Node.js 应用程序时，我们通常需要模拟 API，网络请求以及其他外部依赖。为此，Jest 框架提供了 Mock Functions 功能，它允许您创建虚拟方法以测试代码。
以下是一些 Mock Functions 的用例：
-- -----------
--------------- ---- ---- -------- -- -- -
----- -------- - ----------
--------------
------------------------------------
---
-- ------
--------- ------- ------- ------ ----- -- -- -
----- ---- - -
--- --
------ ------
----- ------
--
--------- - ----------------------------------
----- -------------------------------------------
----------------------------------------------------
---上述代码分别测试了回调函数和模拟网络请求的用例。
使用 Snapshot 进行快照测试
Jest 框架提供了快照测试功能，允许您创建一个模板，用于比较输出结果是否与预期一致。以下是一个使用快照进行测试的示例：
------------- ----------- -- -- - ----- ---- - ----------------------------- ----------------------- ------------------------------- ---
上述代码使用 toMatchSnapshot 方法将组件的输出保存为一个快照，然后比较新的输出与原有的快照进行比较。
结论
在本篇文章中，我们学习了如何使用 Jest 框架测试 Node.js 应用程序。我们已经了解了 Jest API，Matchers，Mock Functions 和 Snapshot 等功能，这些功能允许我们编写可靠的测试用例来验证我们的代码是否按照预期方式工作。通过使用 Jest 框架，我们可以同时提高代码的质量和开发效率。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67120bfead1e889fe2025b1a