如何在 Jest 测试中使用自定义 matcher

Jest 是一款流行的 JavaScript 测试工具，它提供了许多内置的 matcher 函数来帮助我们编写测试用例。但是有时候我们需要编写自定义 matcher 函数来处理一些特殊的情况，本篇文章将会详细介绍如何在 Jest 测试中使用自定义 matcher。

前置条件

在本文中，我们假设您已经熟悉 Jest 的基本语法并且能够写出简单的测试用例。如果您还不了解 Jest，请先参考 Jest 的官方文档。

使用 expect.extend 方法

在 Jest 中，我们可以使用 expect.extend 方法来定义自定义 matcher 函数。这个方法的作用是扩展 Jest 中的 expect 函数，使得我们可以在测试中使用自定义的 matcher。

下面是一个简单的自定义 matcher 函数示例：

// www.javascriptcn.com code example
expect.extend({
  toBeEven(received) {
    const pass = received % 2 === 0;
    if (pass) {
      return {
        message: () => `expected ${received} not to be even`,
        pass: true,
      };
    } else {
      return {
        message: () => `expected ${received} to be even`,
        pass: false,
      };
    }
  }
});

这个自定义 matcher 函数名为 toBeEven，接受一个参数 received，即待断言的值。该函数的实现逻辑非常简单，只需要判断 received 是否为偶数即可。

在实现了自定义 matcher 函数之后，我们就可以在测试用例中使用它了：

test('2 is even', () => {
  expect(2).toBeEven();
});

test('3 is not even', () => {
  expect(3).not.toBeEven();
});

由于我们定义了 toBeEven matcher 函数，因此我们可以在测试用例中使用它，并且该测试用例会通过。

matcher 函数的返回值

需要注意的是，自定义 matcher 函数的返回值必须是一个对象，该对象需要包含两个属性：pass 和 message。

• pass: 表示该 matcher 函数的实际判断结果是否通过，如果是则返回 true，否则返回 false。
• message: 表示该 matcher 函数在不通过时应该输出的提示信息。

需要注意的是，message 属性是一个函数，它返回一个字符串。我们可以在其中使用 received 和 expected 变量来输出更加有意义的提示信息。例如：

// www.javascriptcn.com code example
expect.extend({
  toBeGreaterThanOrEqual(received, expected) {
    const pass = received >= expected;
    if (pass) {
      return {
        message: () => `expected ${received} not to be greater than or equal to ${expected}`,
        pass: true,
      };
    } else {
      return {
        message: () => `expected ${received} to be greater than or equal to ${expected}`,
        pass: false,
      };
    }
  },
});

test('5 is greater than or equal to 3', () => {
  expect(5).toBeGreaterThanOrEqual(3);
});

test('3 is not greater than or equal to 5', () => {
  expect(3).not.toBeGreaterThanOrEqual(5);
});

在这个例子中，我们定义了 toBeGreaterThanOrEqual 自定义 matcher 函数，它接受两个参数：received 和 expected。当 received 大于等于 expected 时，该 matcher 函数通过，否则不通过。在输出提示信息时，我们使用了 received 和 expected 变量来输出更加有意义的提示信息。

结语

本文介绍了如何在 Jest 测试中使用自定义 matcher 函数。通过自定义 matcher 函数，我们可以更加灵活地编写测试用例，从而提高代码的可靠性和稳定性。当然，自定义 matcher 函数并不是万能的，我们需要根据实际情况选择合适的测试方式来确保代码的质量。

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