javascript - Jest 自定义匹配器

Question

我正在尝试在 Jest 中创建一个类似于 stringMatching 但接受空值的自定义匹配器。但是，文档没有说明如何重用现有的匹配器。到目前为止，我有这样的东西:

expect.extend({
    stringMatchingOrNull(received, argument) {
        if (received === null) {
            return {
                pass: true,
                message: () => 'String expected to be null.'
            };
        }

        expect(received).stringMatching(argument);
    }
});

我不确定这是正确的方法，因为当我调用 stringMatching 匹配器时我没有返回任何东西(这是建议的 here )。当我尝试使用这个匹配器时，我得到:expect.stringMatchingOrNull is not a function，即使这是在同一个测试用例中声明的:

expect(player).toMatchObject({
    playerName: expect.any(String),
    rank: expect.stringMatchingOrNull(/^[AD]$/i)
    [...]
});

拜托，有人可以帮我展示正确的方法吗？

我正在使用 Jest 20.0.4 和 Node.js 7.8.0 运行测试。

Answer 1

expect 有两种不同的方法。当您调用 expect(value) 时，您会得到一个带有 matchers 方法的对象，您可以将其用于各种断言(例如 toBe(value)、toMatchSnapshot())。另一种方法直接在 expect 上，它们基本上是辅助方法(expect.extend(matchers) 就是其中之一)。

与 expect.extend(matchers)你添加第一种方法。这意味着它不能直接在 expect 上使用，因此会出现错误。您需要按如下方式调用它:

expect(string).stringMatchingOrNull(regexp);

但是当你调用它时你会得到另一个错误。

TypeError: expect(...).stringMatching is not a function

这次您尝试使用 expect.stringMatching(regexp)作为匹配器，但它是 expect 的辅助方法之一，它为您提供一个伪值，该伪值将被接受为与正则表达式匹配的任何字符串值。这允许您像这样使用它:

expect(received).toEqual(expect.stringMatching(argument));
//     ^^^^^^^^          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//      string                   acts as a string

这个断言只会在它失败时抛出，这意味着当它成功时函数会继续并且不会返回任何东西(undefined)并且 Jest 会提示你必须返回一个带有 pass 的对象 和一个可选的 message。

Unexpected return from a matcher function.
Matcher functions should return an object in the following format:
  {message?: string | function, pass: boolean}
'undefined' was returned

您需要考虑的最后一件事是使用 .not在匹配器之前。当使用 .not 时，您还需要在您在自定义匹配器中所做的断言中使用 .not ，否则它会在应该通过时错误地失败。幸运的是，这非常简单，因为您可以访问 this.isNot。

expect.extend({
    stringMatchingOrNull(received, regexp) {
        if (received === null) {
            return {
                pass: true,
                message: () => 'String expected to be not null.'
            };
        }

        // `this.isNot` indicates whether the assertion was inverted with `.not`
        // which needs to be respected, otherwise it fails incorrectly.
        if (this.isNot) {
            expect(received).not.toEqual(expect.stringMatching(regexp));
        } else {
            expect(received).toEqual(expect.stringMatching(regexp));
        }

        // This point is reached when the above assertion was successful.
        // The test should therefore always pass, that means it needs to be
        // `true` when used normally, and `false` when `.not` was used.
        return { pass: !this.isNot }
    }
});

注意 message 仅在断言未产生正确结果时显示，因此最后一个 return 不需要消息，因为它总是会通过。错误消息只能出现在上面。您可以通过 running this example on repl.it 查看所有可能的测试用例和产生的错误消息。 .