使用 Matchers

Jest 使用“matchers” 让你以不同的方式测试值。本文档将介绍一些常用的 matchers。有关完整列表，请参阅 expect API 文档.

常用 Matchers

测试值的**最简单**方法是使用精确相等性。

test('two plus two is four', () => {
  expect(2 + 2).toBe(4);
});

在此代码中，expect(2 + 2) 返回一个“期望”对象。通常你不会对这些期望对象做太多操作，除了在它们上面调用 matchers。在此代码中，.toBe(4) 是 matcher。当 Jest 运行时，它会跟踪所有失败的 matchers，以便为你打印出清晰的错误消息。

toBe 使用 Object.is 来测试精确相等性。如果你想检查对象的**值**，请使用 toEqual

test('object assignment', () => {
  const data = {one: 1};
  data['two'] = 2;
  expect(data).toEqual({one: 1, two: 2});
});

toEqual 递归地检查对象或数组的每个字段。

提示

toEqual 会忽略具有 undefined 属性的对象键、undefined 数组项、数组稀疏性或对象类型不匹配。要考虑这些因素，请改用 toStrictEqual。

你还可以使用 not 来测试 matcher 的反面。

test('adding positive numbers is not zero', () => {
  for (let a = 1; a < 10; a++) {
    for (let b = 1; b < 10; b++) {
      expect(a + b).not.toBe(0);
    }
  }
});

真值

在测试中，有时你需要区分 undefined、null 和 false，但有时你不想将它们区别对待。Jest 包含一些助手，让你可以明确地表达你想要什么。

• toBeNull 仅匹配 null
• toBeUndefined 仅匹配 undefined
• toBeDefined 是 toBeUndefined 的反面
• toBeTruthy 匹配 if 语句视为真的任何内容
• toBeFalsy 匹配 if 语句视为假的任何内容

例如

test('null', () => {
  const n = null;
  expect(n).toBeNull();
  expect(n).toBeDefined();
  expect(n).not.toBeUndefined();
  expect(n).not.toBeTruthy();
  expect(n).toBeFalsy();
});

test('zero', () => {
  const z = 0;
  expect(z).not.toBeNull();
  expect(z).toBeDefined();
  expect(z).not.toBeUndefined();
  expect(z).not.toBeTruthy();
  expect(z).toBeFalsy();
});

你应该使用最精确地对应于你希望代码执行的操作的 matcher。

数字

大多数比较数字的方法都有 matcher 等效项。

test('two plus two', () => {
  const value = 2 + 2;
  expect(value).toBeGreaterThan(3);
  expect(value).toBeGreaterThanOrEqual(3.5);
  expect(value).toBeLessThan(5);
  expect(value).toBeLessThanOrEqual(4.5);

  // toBe and toEqual are equivalent for numbers
  expect(value).toBe(4);
  expect(value).toEqual(4);
});

对于浮点相等性，请使用 toBeCloseTo 而不是 toEqual，因为你不想让测试依赖于微小的舍入误差。

test('adding floating point numbers', () => {
  const value = 0.1 + 0.2;
  //expect(value).toBe(0.3);           This won't work because of rounding error
  expect(value).toBeCloseTo(0.3); // This works.
});

字符串

你可以使用 toMatch 检查字符串是否与正则表达式匹配。

test('there is no I in team', () => {
  expect('team').not.toMatch(/I/);
});

test('but there is a "stop" in Christoph', () => {
  expect('Christoph').toMatch(/stop/);
});

数组和可迭代对象

你可以使用 toContain 检查数组或可迭代对象是否包含特定项。

const shoppingList = [
  'diapers',
  'kleenex',
  'trash bags',
  'paper towels',
  'milk',
];

test('the shopping list has milk on it', () => {
  expect(shoppingList).toContain('milk');
  expect(new Set(shoppingList)).toContain('milk');
});

异常

如果你想测试特定函数在调用时是否会抛出错误，请使用 toThrow。

function compileAndroidCode() {
  throw new Error('you are using the wrong JDK!');
}

test('compiling android goes as expected', () => {
  expect(() => compileAndroidCode()).toThrow();
  expect(() => compileAndroidCode()).toThrow(Error);

  // You can also use a string that must be contained in the error message or a regexp
  expect(() => compileAndroidCode()).toThrow('you are using the wrong JDK');
  expect(() => compileAndroidCode()).toThrow(/JDK/);

  // Or you can match an exact error message using a regexp like below
  expect(() => compileAndroidCode()).toThrow(/^you are using the wrong JDK$/); // Test fails
  expect(() => compileAndroidCode()).toThrow(/^you are using the wrong JDK!$/); // Test pass
});

提示

抛出异常的函数需要在包装函数中调用，否则 toThrow 断言将失败。

更多

这仅仅是尝鲜。有关 matchers 的完整列表，请查看 参考文档.

了解了可用的 matchers 之后，下一步是了解 Jest 如何让你 测试异步代码.