为什么 Jest 测试失败了?

Jest 是一个非常流行的 JavaScript 测试框架,许多前端开发人员都喜欢使用它进行单元测试、集成测试甚至端到端测试。但是,有时你可能会看到 Jest 测试失败了,甚至找不到问题出在哪里,这是很令人沮丧的。所以,在这篇文章中,我们将解决一些 Jest 测试失败的常见问题,帮助您更快地找到失败原因并解决问题。

1. 错误信息不够清楚

很多时候,Jest 给出的错误信息只是一个调用栈,对于测验代码中的错误而言还是不够明确。有时候,错误信息可能会满屏幕,而很难找到真正的问题所在。例如,以下是一个模糊的错误信息示例:

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

这通常是因为 Jest 没有为您提供足够的上下文信息。要解决这个问题,您可以使用 Jest 提供的 --verbose 标志来获取更多的信息。例如:

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

这将会输出更多的详细信息,包括测试名称以及正在运行的测试套件和测试用例的完整列表。当您遇到一个失败的测试时,这些信息可能会非常有用,因为它们将帮助您定位更准确的问题。

2. 使用了异步代码

Jest 默认情况下是同步运行测试用例的,但是当您的测试用例包含异步代码时,您需要告诉 Jest 注意这一点。否则,异步代码可能尚未完成就导致测试失败。为此,您可以使用 Jest 提供的 done 参数或使用 async/await 语法来将测试用例变为异步。

例如,以下是一个包含异步代码的测试用例:

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

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

在这个例子中,我们从数据库中查找一个用户,然后断言该用户的用户名是否为 "john"。注意 test 函数是异步的,并且接受一个 done 参数。当我们完成测试用例时,我们需要调用 done() 回调来告诉 Jest 这个测试用例已经完成了。

3. Mock 了错误的函数/对象

在 JavaScript 中,我们经常需要使用第三方库或其他模块,这些模块会影响我们的测试结果。为了避免这种情况,我们可以使用 Jest 提供的 Mock 功能,Mock 这些依赖模块。但是,如果您 Mock 了错误的函数或对象,就可能导致测试失败。

例如,以下代码演示了如何用 Jest Mock axios 库,以便测试异步操作:

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

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

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

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

在这个例子中,我们使用 Jest Mock axios.get() 的方法来处理异步操作,以便在测试中验证我们的代码逻辑是否正确。但是,如果您的 Mock 对象并没有得到正确设置,您的测试可能会失败。在这种情况下,您应该仔细审查您的测试代码,确保 Mock 对象被正确设置。

4. 包含随机因素

在测试中使用随机因素是一个非常不好的习惯。测试应该是可重复的,而随机因素会导致测试结果不可预测。如果您的测试包含随机因素,那么可能与其他测试结果不同,很难找到问题。

例如,以下测试演示了添加随机因素的错误做法:

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

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

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

在这个例子中,我们在测试中使用 Math.random() 函数生成一个随机索引,然后将其传递给 cart.addToCart() 方法。由于索引是随机生成的,每次测试运行时都可能会产生不同的结果,导致测试失败。因此,在编写测试时,应该避免使用随机因素。

5. 断言不完整或错误

最后,测试用例可能会因为断言不完整或错误而失败。在 Jest 中,断言可以使用许多不同的方法,如 expect()toBe()toMatchObject() 等。如果您的断言不正确或不完整,那么测试就会失败。

例如,以下测试示例演示了如果断言不完整或错误的问题:

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

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

在这个例子中,我们正在测试一个将 snake case 转换为 camel case 的函数。由于我们使用了错误的断言方法,导致测试存在问题。 toBe() 方法用来比较值是否完全相等,而 toEqual() 方法则用来比较对象是否部分相等。在这个例子中,我们应该使用 toEqual() 断言方法。

结论

在 Jest 测试中,测试用例失败是一件非常常见的事情。然而,对于每个失败,都有一个解决方案。在这篇文章中,我们涵盖了最常见的问题,并提供了相应的解决方案。使用这些技巧,您应该能够更快地找到失败的原因并解决问题,帮助您编写更可靠的代码。

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