使用 Jest 的 it.each 在测试描述中动态插入变量

本文介绍了如何在 Jest 中使用 it.each 动态生成测试用例，并如何在测试描述中使用测试数据中的变量。通过示例代码，详细讲解了两种实现方式：使用数组形式的测试数据配合格式化字符串，以及使用 describe.each 配合模板字符串。掌握这些技巧，可以编写更具可读性和可维护性的测试用例。

在 Jest 中，it.each 提供了一种便捷的方式来运行参数化的测试，即使用不同的输入数据多次运行同一个测试用例。然而，有时我们需要在测试描述中包含这些输入数据，以便更清晰地了解每个测试用例的具体内容。本文将介绍两种实现此目的的方法。

方法一：使用数组形式的测试数据和格式化字符串

it.each 接受一个数组作为参数，数组中的每个元素都代表一组测试数据。我们可以将测试数据组织成数组的形式，并使用格式化字符串在测试描述中引用这些数据。

it.each([
  ["nice test", "nice test"],
  ["failed test", "nice failed test"],
])(
  "Should property and expectedResult be the same for property: %s",
  (property, expectedResult) => {
    expect(property).toBe(expectedResult);
  }
);

在这个例子中，测试数据被组织成一个二维数组，每个子数组包含 property 和 expectedResult 两个值。测试描述使用了 %s 占位符，它会被对应位置的测试数据替换。运行结果将显示如下：

Should property and expectedResult be the same for property: nice test
Should property and expectedResult be the same for property: failed test

注意事项：

百度智能云·曦灵

百度旗下的AI数字人平台

83

查看详情

• %s 用于替换字符串类型的数据。如果需要替换其他类型的数据，可以使用相应的格式化字符串，例如 %d 用于数字类型。
• 这种方法要求测试数据必须以数组形式组织。

方法二：使用 describe.each 和模板字符串

另一种方法是使用 describe.each 结合模板字符串。describe.each 允许我们在 describe 块中对一组数据进行迭代，并在每个迭代中定义多个测试用例。

describe.each([
  { property: 'nice test', expectedResult:'nice test' },
  { property: 'failed test', expectedResult: 'nice failed test' },
])('description', ({ property, expectedResult }) => {
  it(
    `Should property and expectedResult be the same for property: ${property}`,
    () => {
      expect(property).toBe(expectedResult);
    }
  );
})

在这个例子中，测试数据被组织成一个对象数组，每个对象包含 property 和 expectedResult 两个属性。在 it 块的测试描述中，我们使用模板字符串 ${property} 来引用 property 属性的值。运行结果与第一种方法相同：

Should property and expectedResult be the same for property: nice test
Should property and expectedResult be the same for property: failed test

注意事项：

• describe.each 将测试数据解构到上层作用域，因此可以直接在 it 块中使用 property 和 expectedResult 变量。
• 模板字符串使用反引号 (`) 包裹，并使用${}` 来引用变量。

总结

本文介绍了两种在 Jest 的 it.each 测试描述中动态插入变量的方法。第一种方法使用数组形式的测试数据和格式化字符串，简单直接，但要求数据必须以数组形式组织。第二种方法使用 describe.each 和模板字符串，更加灵活，可以处理对象形式的测试数据，并且代码可读性更强。选择哪种方法取决于具体的测试场景和个人偏好。掌握这些技巧可以帮助您编写更具可读性和可维护性的 Jest 测试用例。

以上就是使用 Jest 的 it.each 在测试描述中动态插入变量的详细内容，更多请关注php中文网其它相关文章！