Jest 中错误信息的定制与优化-JavaScript中文网-JavaScript教程资源分享门户

Jest 是一个非常流行的 JavaScript 测试框架，它提供了丰富的 API 和插件，可以帮助我们编写高质量的测试用例。在测试过程中，我们经常会遇到各种错误，如断言失败、代码异常等。这些错误信息对于我们来说非常重要，因为它们可以帮助我们定位问题并快速修复。然而，Jest 默认的错误信息可能不够详细或不够清晰，这就需要我们对其进行定制和优化。

本文将介绍 Jest 中错误信息的定制与优化方法，帮助前端开发者提高测试效率和质量。

1. 定制错误信息

1.1. 使用自定义错误消息

在 Jest 中，我们可以使用 expect() 函数来断言测试结果。如果测试失败，Jest 会输出默认的错误信息，如：

expect(received).toBe(expected)

Expected value to be:
  2
Received:
  1

这条错误信息告诉我们，测试结果应该是 2，但实际上是 1。这对于简单的测试用例来说已经足够了，但对于复杂的测试用例来说，我们可能需要更详细的错误信息来定位问题。

为了定制错误信息，我们可以在 expect() 函数中使用自定义错误消息。例如：

test('should return 2', () => {
  const result = add(1, 1);
  expect(result).toBe(2, 'add(1, 1) should return 2');
});

这条测试用例断言 add(1, 1) 的结果应该是 2。如果测试失败，Jest 会输出自定义的错误消息：

expect(received).toBe(expected)

Expected value to be:
  2
Received:
  1

add(1, 1) should return 2

这条错误信息告诉我们，add(1, 1) 的返回值应该是 2，但实际上是 1。同时，它还告诉我们测试用例的期望结果和具体的测试代码，这有助于我们更快地定位问题。

1.2. 使用自定义匹配器

除了使用自定义错误消息，我们还可以使用自定义匹配器来定制错误信息。匹配器是 Jest 中用于断言测试结果的函数，它们可以帮助我们快速判断测试结果是否符合预期。例如，toBe() 匹配器用于比较两个值是否相等，toEqual() 匹配器用于比较两个对象是否相等。

如果默认的匹配器不能满足我们的需求，我们可以使用自定义匹配器来定制错误信息。自定义匹配器是一个函数，它接受实际值和期望值作为参数，返回一个对象。这个对象包含 pass 属性和 message 属性，分别表示测试是否通过和错误信息。例如：

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

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

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

这个自定义匹配器用于判断一个数字是否可以被另一个数字整除。如果测试通过，Jest 会输出默认的成功信息。如果测试失败，Jest 会输出自定义的错误信息：

expect(received).toBeDivisibleBy(argument)

Expected value to be divisible by:
  3
Received:
  5

expected 5 to be divisible by 3

这条错误信息告诉我们，5 不能被 3 整除，但我们期望它可以被整除。同时，它还告诉我们具体的测试代码和自定义匹配器的名称，这有助于我们更快地定位问题。

2. 优化错误信息

除了定制错误信息，我们还可以优化默认的错误信息，使其更加清晰和有用。

2.1. 使用 `toThrowErrorMatchingSnapshot()`

在测试过程中，我们经常需要测试代码中的异常情况。例如，我们需要测试一个函数在接收非法参数时是否会抛出异常。如果测试失败，Jest 会输出默认的错误信息，如：

expect(received).toThrow(expected)

Expected function to throw an error matching:
  "TypeError: Cannot read property 'x' of undefined"
Received:
  [Function]

这条错误信息告诉我们，测试结果应该抛出一个 TypeError 异常，异常信息应该包含 Cannot read property 'x' of undefined。然而，这条错误信息并没有告诉我们具体的异常代码和栈信息，这有助于我们更快地定位问题。

为了优化错误信息，我们可以使用 toThrowErrorMatchingSnapshot() 函数。这个函数会抛出异常并将异常信息保存为快照文件。如果测试失败，Jest 会输出一个链接，让我们可以查看快照文件中的异常信息。例如：

test('should throw an error', () => {
  expect(() => {
    foo.bar();
  }).toThrowErrorMatchingSnapshot();
});

这个测试用例断言 foo.bar() 应该抛出异常，并保存异常信息为快照文件。如果测试失败，Jest 会输出一个链接，让我们可以查看快照文件中的异常信息：

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

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

---------

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

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

这条错误信息告诉我们，foo.bar() 抛出了一个 TypeError 异常，异常信息包含 Cannot read property 'bar' of undefined。同时，它还告诉我们具体的异常代码和栈信息，这有助于我们更快地定位问题。

2.2. 使用 `--runInBand` 参数

在 Jest 中，测试用例默认是并行执行的，这可以提高测试速度。然而，并行执行可能会导致测试结果的顺序不确定，这使得错误信息难以阅读和理解。例如，如果多个测试用例同时失败，Jest 可能会输出多个错误信息，这会让我们感到困惑。

为了优化错误信息，我们可以使用 --runInBand 参数。这个参数可以让测试用例按顺序执行，这样我们可以更容易地理解错误信息。例如：

jest --runInBand

这个命令会让测试用例按顺序执行，这样我们可以更容易地理解错误信息。

结论

在 Jest 中，错误信息对于测试结果的分析和修复非常重要。本文介绍了 Jest 中错误信息的定制与优化方法，包括使用自定义错误消息、自定义匹配器、toThrowErrorMatchingSnapshot() 函数和 --runInBand 参数。通过定制和优化错误信息，我们可以更快地定位问题并快速修复。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/676660b976af2b9a20f67530

Jest 中错误信息的定制与优化