使用 TypeScript 在 Jest 中模拟依赖

Question

当测试在不同文件中具有依赖关系的模块并将该模块分配为jest.mock时，TypeScript 会给出一个错误，即方法mockReturnThisOnce （或任何其他jest.mock方法）在依赖项中不存在，这是因为它是以前键入的。

让 TypeScript 从jest.mock继承类型的正确方法是什么？

这是一个简单的例子。

依赖

const myDep = (name: string) => name;
export default myDep;

测试.ts

import * as dep from '../depenendency';
jest.mock('../dependency');

it('should do what I need', () => {
  //this throws ts error
  // Property mockReturnValueOnce does not exist on type (name: string)....
  dep.default.mockReturnValueOnce('return')
}

我觉得这是一个非常常见的用例，不知道如何正确输入。

Answer 1

您可以使用类型转换，您的test.ts应该如下所示：

import * as dep from '../dependency';
jest.mock('../dependency');

const mockedDependency = <jest.Mock<typeof dep.default>>dep.default;

it('should do what I need', () => {
  //this throws ts error
  // Property mockReturnValueOnce does not exist on type (name: string)....
  mockedDependency.mockReturnValueOnce('return');
});

TS 编译器不知道jest.mock('../dependency'); 更改dep的类型，因此您必须使用类型转换。 由于导入的dep不是类型定义，因此您必须使用typeof dep.default获取其类型。

以下是我在使用 Jest 和 TS 的过程中发现的其他一些有用的模式

当导入的元素是一个类时，您不必使用 typeof 例如：

import { SomeClass } from './SomeClass';

jest.mock('./SomeClass');

const mockedClass = <jest.Mock<SomeClass>>SomeClass;

当您必须模拟一些节点本机模块时，此解决方案也很有用：

import { existsSync } from 'fs';

jest.mock('fs');

const mockedExistsSync = <jest.Mock<typeof existsSync>>existsSync;

如果您不想使用 jest 自动模拟并更喜欢创建手动模拟

import TestedClass from './TestedClass';
import TestedClassDependency from './TestedClassDependency';

const testedClassDependencyMock = jest.fn<TestedClassDependency>(() => ({
  // implementation
}));

it('Should throw an error when calling playSomethingCool', () => {
  const testedClass = new TestedClass(testedClassDependencyMock());
});

testedClassDependencyMock()创建模拟对象实例TestedClassDependency可以是类或类型或接口

Answer 2

使用此处解释的mocked助手

// foo.spec.ts
import { foo } from './foo'
jest.mock('./foo')

// here the whole foo var is mocked deeply
const mockedFoo = jest.mocked(foo, true)

test('deep', () => {
  // there will be no TS error here, and you'll have completion in modern IDEs
  mockedFoo.a.b.c.hello('me')
  // same here
  expect(mockedFoo.a.b.c.hello.mock.calls).toHaveLength(1)
})

test('direct', () => {
  foo.name()
  // here only foo.name is mocked (or its methods if it's an object)
  expect(jest.mocked(foo.name).mock.calls).toHaveLength(1)
})

Answer 3

针对TypeScript 版本 3.x 和 4.x测试了两种解决方案，两者都在转换所需的功能

1) 使用 jest.MockedFunction

import * as dep from './dependency';

jest.mock('./dependency');

const mockMyFunction = dep.myFunction as jest.MockedFunction<typeof dep.myFunction>;

2) 使用 jest.Mock

import * as dep from './dependency';

jest.mock('./dependency');

const mockMyFunction = dep.default as jest.Mock;

---

这两种解决方案之间没有区别。 第二个更短，因此我建议使用那个。

两种铸造解决方案都允许在mockMyFunction上调用任何 jest 模拟函数，例如mockReturnValue或mockResolvedValue https://jestjs.io/docs/en/mock-function-api.html

mockMyFunction.mockReturnValue('value');

mockMyFunction可以正常用于 expect

expect(mockMyFunction).toHaveBeenCalledTimes(1);

Answer 4

我使用来自 @types/jest/index.d.ts 的模式，就在 Mocked 的类型 def 上方（第 515 行）：

import { Api } from "../api";
jest.mock("../api");

const myApi: jest.Mocked<Api> = new Api() as any;
myApi.myApiMethod.mockImplementation(() => "test");

Answer 5

as jest.Mock

只需将函数转换为jest.Mock就可以了：

(dep.default as jest.Mock).mockReturnValueOnce('return')

Answer 6

as jest.Mock ，仅此而已

我能想到的在 ts-jest 中模拟default导出的模块的最简洁方法实际上归结为将模块转换为jest.Mock 。

代码：

import myDep from '../dependency' // No `* as` here

jest.mock('../dependency')

it('does what I need', () => {
  // Only diff with pure JavaScript is the presence of `as jest.Mock`
  (myDep as jest.Mock).mockReturnValueOnce('return')

  // Call function that calls the mocked module here

  // Notice there's no reference to `.default` below
  expect(myDep).toHaveBeenCalled()
})

好处：

• 不需要在测试代码中的任何地方引用default属性 - 您可以引用实际导出的函数名称，
• 您可以使用相同的技术来模拟命名导出，
• 没有* as在 import 语句中，
• 无需使用typeof关键字进行复杂的转换，
• 没有像mocked这样的额外依赖项。

Answer 7

这是我对jest@24.8.0和ts-jest@24.0.2 所做的：

资源：

class OAuth {

  static isLogIn() {
    // return true/false;
  }

  static getOAuthService() {
    // ...
  }
}

测试：

import { OAuth } from '../src/to/the/OAuth'

jest.mock('../src/utils/OAuth', () => ({
  OAuth: class {
    public static getOAuthService() {
      return {
        getAuthorizationUrl() {
          return '';
        }
      };
    }
  }
}));

describe('createMeeting', () => {
  test('should call conferenceLoginBuild when not login', () => {
    OAuth.isLogIn = jest.fn().mockImplementationOnce(() => {
      return false;
    });

    // Other tests
  });
});

这是模拟非默认类及其静态方法的方法：

jest.mock('../src/to/the/OAuth', () => ({
  OAuth: class {
    public static getOAuthService() {
      return {
        getAuthorizationUrl() {
          return '';
        }
      };
    }
  }
}));

这应该是从您的类的类型到jest.MockedClass或类似的类型的某种类型转换。 但它总是以错误告终。 所以我只是直接使用它，它工作。

test('Some test', () => {
  OAuth.isLogIn = jest.fn().mockImplementationOnce(() => {
    return false;
  });
});

但是，如果它是一个函数，您可以模拟它并进行类型对话。

jest.mock('../src/to/the/Conference', () => ({
  conferenceSuccessDataBuild: jest.fn(),
  conferenceLoginBuild: jest.fn()
}));
const mockedConferenceLoginBuild = conferenceLoginBuild as 
jest.MockedFunction<
  typeof conferenceLoginBuild
>;
const mockedConferenceSuccessDataBuild = conferenceSuccessDataBuild as 
jest.MockedFunction<
  typeof conferenceSuccessDataBuild
>;

Answer 8

我在@types/jest找到了这个：

/**
  * Wrap a function with mock definitions
  *
  * @example
  *
  *  import { myFunction } from "./library";
  *  jest.mock("./library");
  *
  *  const mockMyFunction = myFunction as jest.MockedFunction<typeof myFunction>;
  *  expect(mockMyFunction.mock.calls[0][0]).toBe(42);
*/

注意：当您执行const mockMyFunction = myFunction然后执行类似mockFunction.mockReturnValue('foo')时，您也是一个不断变化的myFunction 。

来源： https ://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/jest/index.d.ts#L1089

Answer 9

从 Jest 24.9.0开始，您可以模拟和正确键入 Class/Object/function 和 Jest 属性。

jest.MockedFunction

jest.MockedClass

对于类型化的模拟，我们想要的是模拟对象类型包含模拟对象类型和 Jest 模拟类型的联合。

import foo from 'foo';
jest.mock('foo');

const mockedFoo = foo as jest.MockedFunction<typeof foo>;
// or: const mockedFooClass = foo as jest.MockedClass<typeof FooClass>;


mockedFoo.mockResolvedValue('mockResult');

// Or:
(mockedFoo.getSomething as jest.MockedFunction<typeof mockedFoo.getSomething>).mockResolvedValue('mockResult');

如您所见，您可以手动转换您需要的内容，或者您​​需要一些东西来遍历所有foo的属性/方法来键入/转换所有内容。

为此（深度模拟类型），您可以使用 Jest 27.4.0中引入的jest.mocked()

import foo from 'foo';
jest.mock('foo');

const mockedFoo = jest.mocked(foo, true); 

mockedFoo.mockImplementation() // correctly typed
mockedFoo.getSomething.mockImplementation() // also correctly typed

Answer 10

Artur Górski 评价最高的解决方案不适用于最后一个 TS 和 Jest。 使用模拟类

import SoundPlayer from '../sound-player';

jest.mock('../sound-player'); // SoundPlayer is now a mock constructor

const SoundPlayerMock = SoundPlayer as jest.MockedClass<typeof SoundPlayer>;

Answer 11

最新的 jest 允许您使用jest.mocked轻松完成此操作

import * as dep from '../dependency';

jest.mock('../dependency');

const mockedDependency = jest.mocked(dep);

it('should do what I need', () => {
  mockedDependency.mockReturnValueOnce('return');
});

Answer 12

import api from 'api'
jest.mock('api')
const mockApi = (api as unknown) as jest.Mock

Answer 13

这很丑陋，实际上摆脱这种丑陋是我什至看这个问题的原因，但是要从模块模拟中获得强类型，您可以执行以下操作：

const myDep = (require('./dependency') as import('./__mocks__/dependency')).default;

jest.mock('./dependency');

确保您需要'./dependency'而不是直接模拟，否则您将获得两个不同的实例化。

Answer 14

对我来说，这就足够了：

let itemQ: queueItemType
jest.mock('../dependency/queue', () => {
    return {
        add: async (item: queueItemType, ..._args: any) => {
            // then we can use the item that would be pushed to the queue in our tests
            itemQ = item
            return new Promise(resolve => {
                resolve('Mocked')
            })
        },
    }
})

然后，无论何时调用 add 方法，它都会执行上面的代码，而不是将其推送到队列中，在这种情况下。

Answer 15

使用ReturnType 2.8 我们可以使用 ReturnType 这样做：

import * as dep from "./depenendency"

jest.mock("./dependency")

const mockedDependency = <jest.Mock<ReturnType<typeof dep.default>>>dep.default

it("should do what I need", () => {
  mockedDependency.mockReturnValueOnce("return")
})

Answer 16

由于我们在谈论测试，因此一种快速而肮脏的方法是仅告诉TypeScript忽略此行：

//@ts-ignore
dep.default.mockReturnValueOnce('return')

Answer 17

最近的一个库用 babel 插件解决了这个问题： https ://github.com/userlike/joke

例子：

import { mock, mockSome } from 'userlike/joke';

const dep = mock(import('./dependency'));

// You can partially mock a module too, completely typesafe!
// thisIsAMock has mock related methods
// thisIsReal does not have mock related methods
const { thisIsAMock, thisIsReal } = mockSome(import('./dependency2'), () => ({ 
  thisIsAMock: jest.fn() 
}));

it('should do what I need', () => {
  dep.mockReturnValueOnce('return');
}

请注意dep和mockReturnValueOnce是完全类型安全的。 最重要的是， depencency知道依赖已导入并分配给dep ，因此 tsserver 支持的所有自动重构也将起作用。

注意：我维护图书馆。