使用 Jest 测试 Node.js 应用的正确姿势

随着 Node.js 服务器端应用开发的不断普及,对于多数前端开发者而言,对 Node.js 的开发不再是一个陌生的领域。然而,在快速开发 Node.js 应用的过程中,如何保证应用的质量,以及如何有效地进行测试,仍然是一个需要掌握的技能。在本文中,我们将探讨使用 Jest 测试 Node.js 应用的正确姿势,并给出相关的指导和示例代码。

什么是 Jest?

Jest 是由 Facebook 开发的一个开源的 JavaScript 测试框架,它既可以用于前端应用的测试,也可以用于后端应用的测试。Jest 提供了完善的功能,如 mock(模拟)功能、snapshot(快照)测试、异步测试等等。Jest 广泛应用于 React 和 Node.js 社区,并且已经成为了很多公司的首选测试框架。

为什么使用 Jest 进行测试?

与其他测试框架相比,使用 Jest 有以下优点:

  1. 易于上手:Jest 是一个非常易于上手的测试框架,它提供了完善的文档和示例代码,让开发者能够快速上手使用。

  2. 全面支持异步测试:Node.js 服务器端应用通常需要进行异步操作,而 Jest 提供了完善的异步测试支持,帮助开发者更好地测试异步函数。

  3. 提供完善的 Mock 功能:在进行测试过程中,我们需要模拟一些数据或者函数,以方便测试。对于这个问题,Jest 提供了完善的 Mock 功能,使得开发者可以更加简单地进行测试。

  4. 提供了 Snapshot 测试:Jest 中的 Snapshot 功能可以帮助我们记录测试结果,并进行比较。这项功能可以帮助我们解决一些奇特的测试问题。

开始使用 Jest 测试

接下来,我们将介绍如何使用 Jest 进行 Node.js 应用的测试。在介绍之前,我们需要先进行以下两个步骤:

  1. 安装 Jest

Jest 的安装非常简单,可以使用 NPM 安装。在终端或命令行中,输入以下命令:

--- ------- ---- ----------

安装完成后,我们就可以开始使用 Jest 了。

  1. 编写待测试代码

在进行测试之前,我们需要编写待测试的代码。在本文中,我们将使用一个简单的 Node.js 的例子:

-- -----------

-------------- - -
  ---- -------- ------ ----- -
    ------ ---- - -----
  -
--

我们的应用相当简单 —— 只有一个加法模块,用于向数值添加数字并返回结果。现在,让我们实现一个基本的单元测试来测试这个模块。

-- ----------------------

----- ----- - -----------------------

---------- - - - -- ----- --- -- -- -
  ------------- ------------
---

以上代码中,我们使用 Jest 进行单元测试了。Jest 提供了一个 test 函数,用于封装我们的单元测试。test 函数接收两个参数:第一个参数是把待测试的块封装起来的函数,第二个参数是一个可选参数,用于描述测试案例。

在我们的例子中,我们描述了一条测试案例:“adds 1+2 to equal 3”。在 this case 中,我们调用 add 方法,将 1 和 2 作为参数传入,然后使用 expect 函数对 test 进行对比。expect 函数在 jest 中非常方便,我们可以使用 expect 来检查测试中的一些基本的断言。

使用 Mock 进行测试

在测试中,我们通常会遇到需要模拟一些数据或方法的情况。在 Jest 中,我们可以使用 Jest 的全局 Mock API。接下来,我们看一个使用 Jest 进行 Mock 的例子。回到我们的示例代码,我们增加一个模块来模拟实际的计算结果:

-- -----------------

-------------- - -
  ---- ----------- -- -- - - --
--

以上我们创建了一个 mock 文件,在其中我们增加了一个 add 方法。在应用代码中,我们可以使用 require() 引入 math 模块,但是在测试中,我们将使用 Jest 提供的 mock 模块。现在让我们完成一个使用 Jest 进行 Mock 的测试例子:

-- ----------------------

----- ----- - -----------------------
----- ---------- - -----------------------------

-------------------------

--------- ------ -- ------ ---- - --- - --- ------ --- -- -- -
  ------ ---
  ---------------------------------------- ---
  ---------------------------------------------
---

在以上代码中,我们首先引入了 mocks 中的 math.js 文件,并且使用 Jest 提供的 global.mock 来在我们的测试中修改引入了 math.js 文件的引用。接下来,我们在测试中调用 add(1, 2) 函数。我们现在可以使用 Jest 提供的方法来测试 add 函数。

toBeCalledWith(a, b) 测试函数是否被传入正确的参数。当传递的参数和预期的参数相符时,则返回 true。而 toHaveReturnedWith() 方法用于测试函数是否返回了正确的值。将这两个函数组合使用,我们可以测试函数调用是否满足我们的预期。

使用快照进行测试

快照测试是一个在前端应用中非常流行的测试方式。它可以帮助我们记录一些组件的渲染输出,并比对预期的输出,从而确定渲染输出是否正确。在 Node.js 应用中,快照测试也同样同样适用。在 Jest 中,我们可以轻松地实现快照测试。我们以 Node.js 的翻译服务为例,来用 Jest 实现快照测试。

-- ----------------

----- --------- - --------- -- -
  ------ ----- -- --- ---------- ------
--

-------------- - ----------

在我们的应用中,我们有一个 translate 方法,用于将一些指定的文本转换成翻译文本。现在我们使用 Jest 实现一个快照测试:

-- ---------------------------

----- ------------------ - --------------------------------
----- --------- - -------------------------------

-------------------------------------------------

--------------- ------ ------ --- ---------- -- -- -
  ----- ------ - ----------------
  ---------------------------------
---

在以上例子中,我们首先引入了 jest-serializer-html 库,并将其添加到我们的 test 环境中,这样我们可以将快照渲染成 html。接下来,我们调用我们的 the translate() 方法。我们可以使用 toMatchSnapshot() 函数来比较当前的渲染输出快照和期望的渲染输出快照。

总结

在本文中,我们学习了如何使用 Jest 对我们的 Node.js 应用进行单元测试。我们介绍了使用 Jest 的 Mock 功能,讨论了如何进行异步测试,以及如何使用快照测试记录渲染输出。通过掌握这些内容,我们可以轻松地进行可靠的测试,从而帮助我们提高 Node.js 应用的质量,提供更加优秀的用户体验。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/665266b8d3423812e46c8125