如何在 Mocha 测试中封装自定义的匹配器

背景

Mocha 是一款 JavaScript 测试框架，它能让开发者写出可靠的测试用例，确保代码的健壮性。在写测试用例时，我们经常需要判断某个值是否符合期望，这时我们就需要使用断言库来实现。Mocha 内置了常用的断言库，比如 assert、should 和 expect，但是有时我们需要自定义一些匹配器，以便于更方便地编写、阅读测试用例。

编写自定义的匹配器

自定义匹配器需要提供一个方法，该方法会被 Mocha 测试框架调用。

方法的签名如下：

function(matcher: string, expected: any): void

其中，matcher 表示匹配器名称，expected 表示期望的值。方法需要抛出一个 AssertionError 异常，以表示断言失败。否则，测试用例会被认为是通过的，这显然是错误的。

下面是一个简单的例子，我们自定义了一个匹配器 toBeEven，用于判断一个数字是否为偶数。

function toBeEven(matcher, expected) {
  if (typeof expected !== "number") {
    throw new Error(`Expected a number, but got ${expected}`);
  }
  if (expected % 2 !== 0) {
    throw new AssertionError(`Expected ${expected} to be even`);
  }
}

使用自定义的匹配器

在 Mocha 测试用例中使用自定义匹配器非常简单，只需要调用 expect 函数，并传入待测试的值即可。

describe("Test custom matcher", function () {
  it("should throw an assert error when a value is not even", function () {
    expect(3).toBeEven();
  });
  it("should not throw any error when a value is even", function () {
    expect(4).toBeEven();
  });
});

我们也可以通过链式调用在同一个 expect 对象中使用多个自定义匹配器。

describe("Test chain matcher", function () {
  it("should not throw any error when a value is even and less than 10", function () {
    expect(4).toBeEven().toBeLessThan(10);
  });
});

指导意义

自定义匹配器能够提高测试用例的可读性和可维护性，因为它能使测试用例更加接近自然语言。此外，自定义匹配器还能够大大减少重复代码。

但是，过多的自定义匹配器也会使测试用例变得难以维护。如果一个项目中存在很多自定义匹配器，那么维护成本会相对较高，因此需要在编写自定义匹配器时加以考虑。

总结

自定义匹配器是 Mocha 测试框架中非常有用的一种特性，可以方便地实现对于某些数据的断言。在编写自定义匹配器时，需要注意保持代码的可读性和可维护性，避免过度使用导致代码变得难以维护。

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