用玩笑模拟打字稿界面

Question

是否可以用 jest 模拟 typescript 界面？

例如：

import { IMultiplier } from "./IMultiplier";

export class Math {
  multiplier: IMultiplier;

  public multiply (a: number, b: number) {
    return this.multiplier.multiply(a, b);
  }
}

然后在测试中：

import { Math } from "../src/Math";
import { IMultiplier } from "../src/IMultiplier";

describe("Math", () => {

    it("can multiply", () => {
        let mathlib = new Math();
        mathlib.multiplier = // <--- assign this property a mock
        let result = mathlib.multiply(10, 2);
        expect(result).toEqual(20);
    });
});

我尝试了多种方式来创建一个模拟对象来满足这一点，但都没有奏效。例如给它分配这个模拟：

let multiplierMock = jest.fn(() => ({ multiply: jest.fn() }));

会产生以下内容：

Error - Type 'Mock<{ multiply: Mock<{}>; }>' is not assignable to type 'IMultiplier'.

Answer 1

@Brian Adams 的答案不起作用如果 multiplier 属性是 protected 属性。
在这种情况下，我们可以这样做：
目标类：

import { IMultiplier } from "./IMultiplier";

export class Math {
  protected multiplier: IMultiplier;

  public multiply (a: number, b: number) {
    return this.multiplier.multiply(a, b);
  }
}

单元测试：

import { Math } from "../src/Math";
import { IMultiplier } from "../src/IMultiplier";

describe("Math", () => {
    class DummyMultiplier implements IMultiplier {
        public multiply(a, b) {
            // dummy behavior
            return a * b;
        }
    }

    class TestableMathClass extends Math {
        constructor() {
            super();
            // set the multiplier equal to DummyMultiplier
            this.multiplier = new DummyMultiplier();
        }
    }

    it("can multiply", () => {
        // here we use the right TestableMathClass
        let mathlib = new TestableMathClass();
        let result = mathlib.multiply(10, 2);
        expect(result).toEqual(20);
    });

    it("can multiply and spy something...", () => {
        // with spy we can verify if the function was called
        const spy = jest
            .spyOn(DummyMultiplier.prototype, 'multiply')
            .mockImplementation((_a, _b) => 0);

        let mathlib = new TestableMathClass();
        let result = mathlib.multiply(10, 2);
        expect(result).toEqual(20);
        expect(spy).toBeCalledTimes(1);
    });
});

如果您正在使用 private 属性，也许您可以注入该属性。因此，在单元测试中，您还可以创建一个虚拟行为并注入它。

Answer 2

试用moq.ts 库。

import {Mock} from "moq.ts";

const multiplier = new Mock<IMultiplier>()
   .setup(instance => instance.multiply(3, 4))
   .returns(12)
   .object();

let mathlib = new Math();
mathlib.multiplier = multiplier;

Answer 3

我创建了一个库，允许您模拟 TypeScript 接口 - https://github.com/marchaos/jest-mock-extended。

似乎没有库可以干净地做到这一点，同时保持完全的类型安全。它大致基于这里的讨论 -https://github.com/facebook/jest/issues/7832

Answer 4

模拟只需要与界面具有相同的形状。

（来自docs：TypeScript 的核心原则之一是类型检查关注值的形状。这有时被称为“鸭子类型”或“结构子类型”。）

所以mathlib.multiplier只需分配给符合IMultiplier的对象即可。

我猜示例中的 IMultiplier 看起来像这样：

interface IMultiplier {
  multiply(a: number, b: number): number
}

因此，通过将有问题的行更改为以下内容，示例测试将正常工作：

mathlib.multiplier = {
  multiply: jest.fn((a, b) => a * b)
};