Jest 模块方法模拟与断言：解决作用域问题

本文详细介绍了在jest测试框架中如何正确地模拟（mock）模块方法并对其进行断言。针对`jest.mock()`模块工厂无法引用外部作用域变量的问题，文章提供了javascript和typescript两种解决方案，核心在于通过`import`语句引入待模拟方法，并在typescript中进行类型断言，确保测试的有效性和类型安全。

理解Jest模块模拟中的作用域挑战

在Jest中进行单元测试时，我们经常需要模拟（mock）外部模块或服务，以隔离测试单元并控制其行为。jest.mock()函数是实现这一目标的核心工具。然而，在使用jest.mock()时，开发者可能会遇到一个常见的问题：无法直接在jest.mock()的回调函数内部引用外部作用域的变量，这会导致The module factory of jest.mock() is not allowed to reference any out-of-scope variables.这样的错误。

例如，假设我们有一个日志服务logs.service.js，其中包含一个log方法：

// services/logs.service.js
export const log = (count, message) => {
    console.log(`[LOG] Called ${count} times with: ${message}`);
};

在测试文件中，我们可能尝试这样模拟log方法并进行断言：

// test.spec.js
const log = jest.fn(); // 尝试在外部定义
jest.mock('../../../../services/logs.service.js', () => ({
    log // 引用外部的log
}));

// 在这里尝试断言 log
// expect(log).toHaveBeenCalledWith(2, "foo"); // 这将失败，因为无法访问外部的log

上述代码将抛出“out-of-scope variables”错误，原因在于Jest的模块工厂（即jest.mock()的第二个参数）被设计为隔离的，它不允许访问定义在其自身作用域之外的变量。这意味着，即使你在测试文件顶部声明了一个log的jest.fn()实例，模块工厂也无法“看到”它，从而导致无法在测试的其余部分对这个模拟函数进行断言。

解决方案：通过导入引用模拟函数

解决这个问题的关键在于，即使我们打算模拟一个模块，我们仍然需要通过标准的ESM（ECMAScript Module）import语句来引入它。Jest会在运行时拦截这个导入，并将其指向我们定义的模拟实现。

ChatBA

AI幻灯片生成工具

74

查看详情

JavaScript环境下的实现

在JavaScript中，你可以直接导入你想要模拟的函数，然后在jest.mock()中提供一个模拟实现。Jest会确保当你导入log时，你实际上得到的是你的模拟版本，而不是原始的实现。

// test.spec.js
// 1. 首先导入你需要模拟的函数
import { log } from '../../../../services/logs.service.js';

// 2. 使用jest.mock()来提供模拟实现
// Jest会拦截对'../../../../services/logs.service.js'的导入，
// 并将其替换为这个工厂函数返回的对象。
// 这里的log: jest.fn()会创建一个新的模拟函数，并将其绑定到导入的log变量上。
jest.mock('../../../../services/logs.service.js', () => ({
    log: jest.fn() // 注意：这里创建的是一个新的jest.fn()实例
}));

describe('Log Service', () => {
    it('should call the log method with correct arguments', () => {
        // 假设某个被测试函数调用了log
        // someFunctionThatCallsLog();

        // 示例：直接调用模拟的log函数以进行测试
        log(2, "foo");
        log(1, "bar");

        // 3. 现在你可以直接对导入的log进行断言
        expect(log).toHaveBeenCalledTimes(2);
        expect(log).toHaveBeenCalledWith(2, "foo");
        expect(log).toHaveBeenCalledWith(1, "bar");
    });
});

工作原理说明： 当你import { log } from '...'时，Jest在加载测试文件时会识别到jest.mock()对该模块的模拟。因此，当import语句执行时，它实际上会从jest.mock()提供的工厂函数中获取log函数（即那个jest.fn()实例），并将其赋值给你的log变量。这样，你就可以在测试的其余部分访问并断言这个模拟函数了。

TypeScript环境下的实现

在TypeScript中，除了上述JavaScript的解决方案外，我们还需要进行类型断言，以确保TypeScript编译器知道log变量现在是一个Jest模拟函数，从而允许我们访问jest.fn()特有的匹配器（如toHaveBeenCalledWith）。

// test.spec.ts
// 1. 导入你需要模拟的函数
import { log } from '../../../../services/logs.service.js';

// 2. 使用jest.mock()来提供模拟实现
jest.mock('../../../../services/logs.service.js', () => ({
    log: jest.fn() // 这里创建的是一个新的jest.fn()实例
}));

describe('Log Service', () => {
    it('should call the log method with correct arguments', () => {
        // 3. 对导入的log进行类型断言，告知TypeScript它现在是一个Jest模拟函数
        const mockedLog = log as jest.MockedFunction<typeof log>;

        // 假设某个被测试函数调用了log
        // someFunctionThatCallsLog();

        // 示例：直接调用模拟的log函数以进行测试
        mockedLog(2, "foo");
        mockedLog(1, "bar");

        // 4. 现在你可以对mockedLog进行类型安全的断言
        expect(mockedLog).toHaveBeenCalledTimes(2);
        expect(mockedLog).toHaveBeenCalledWith(2, "foo");
        expect(mockedLog).toHaveBeenCalledWith(1, "bar");
    });
});

类型断言的必要性：jest.MockedFunction<typeof log>是一个泛型类型，它将原始的log函数类型转换为一个Jest模拟函数的类型。这使得mockedLog变量能够拥有jest.fn()实例的所有属性和方法，如toHaveBeenCalledWith、mockClear等，同时保持原始函数的参数和返回值类型，提供了更好的类型安全性和开发体验。

注意事项与最佳实践

• 始终导入待模拟模块/函数： 即使你打算完全模拟一个模块，也请通过import语句将其引入到你的测试文件中。这是Jest连接模拟实现与你的测试代码的关键。
• 理解jest.mock()的作用域： jest.mock()的模块工厂函数是一个独立的作用域。避免在其中直接引用外部变量，除非这些变量是全局可访问的（不推荐）。
• TypeScript中的类型安全： 在TypeScript项目中，为了获得更好的开发体验和类型检查，务必对模拟函数进行jest.MockedFunction或jest.Mock的类型断言。
• 模拟的生命周期： 每次测试运行时，jest.mock()通常会重新初始化模拟。如果你需要在每个测试用例之间重置模拟函数的状态（例如清除调用历史），可以使用beforeEach钩子结合mockClear()或mockReset()。

总结

正确地在Jest中模拟模块方法并进行断言是编写健壮单元测试的基础。通过理解jest.mock()的作用域限制，并采用import后置入模拟实现的策略，我们可以有效地解决“out-of-scope variables”的问题。无论是JavaScript还是TypeScript环境，核心思想都是让Jest在模块加载阶段介入，将原始模块的引用替换为我们的模拟版本，从而使我们能够在测试代码中访问并验证这些模拟函数的行为。

以上就是Jest 模块方法模拟与断言：解决作用域问题的详细内容，更多请关注php中文网其它相关文章！