使用匹配器

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

常见匹配器

测试值的最简单方法是完全相等。

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

在此代码中，expect(2 + 2) 返回一个 "expectation" 对象。 除了调用匹配器之外，你通常不会对这些期望对象做太多事情。 在此代码中，.toBe(4) 是匹配器。 当 Jest 运行时，它会跟踪所有失败的匹配器，以便它可以为你打印出不错的错误消息。

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 测试匹配器的反面：

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 语句视为 true 的任何内容
• toBeFalsy 匹配 if 语句视为 false 的任何内容

例如：

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();
});

你应该使用与你希望代码执行的操作最精确对应的匹配器。

数字

大多数比较数字的方法都有匹配器等价物。

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 断言将失败。

以及更多

这只是一个味道。 有关匹配器的完整列表，请查看 参考文档。

一旦你了解了可用的匹配器，下一步最好是查看 Jest 如何让你 测试异步代码。