如何使用Jest模拟待测模块中函数作用域外的本地变量
问题本质说明
在测试文件中声明的同名变量,属于测试文件自身的模块作用域,和sample.js内部的模块私有作用域完全隔离,不会被原模块内函数的闭包引用,因此这种写法完全无法影响原模块的计算逻辑,最终测试结果不符合预期。
对应解决方案
方案1:利用ES模块的活绑定特性,导出内部变量供测试修改
ES模块的导出是动态实时绑定,只要把原模块内的本地变量同步导出,测试场景就可以通过修改导入的绑定值,同步更新原模块闭包内引用的变量值,不需要改动原模块的核心业务逻辑。
- 调整原模块代码,增加变量导出:
// sample.js // 原有逻辑保持不变,仅将内部变量加上export关键字 export var num1 = 10; export var num2 = 20; export const add = () => num1 + num2; export const sub = () => num1 - num2; export const mul = () => num1 * num2; - 编写对应测试用例:
注意不要用解构的方式导入变量值,ES模块直接解构导入的绑定是只读的,无法修改,必须通过模块命名空间对象来操作绑定值。这种改动对生产环境无影响:正常业务代码不会主动读取导出的num1、num2,仅在测试场景下会通过模块导入修改这些值,原模块的私有变量语义不会被破坏。// sample.test.js import * as sampleModule from './sample'; // 每个测试前重置模块状态,避免变量值跨用例污染 beforeEach(() => { jest.resetModules(); // 恢复变量到模块初始默认值 sampleModule.num1 = 10; sampleModule.num2 = 20; }); test('add', () => { // 直接修改导入的变量绑定值,原模块闭包会同步拿到最新值 sampleModule.num1 = 5; sampleModule.num2 = 5; expect(sampleModule.add()).toEqual(10); });
方案2:无法修改原模块时,通过jest.mock全量替换模块实现
如果原模块的私有变量完全不能改动、不能增加导出,可以直接用Jest的模块mock能力,用自定义实现替换整个原模块的导出逻辑,在mock实现的闭包里持有可修改的变量值。
示例代码:
// sample.test.js // 定义可在测试用例中修改的变量,供mock实现引用 let num1, num2; // 拦截对原模块的导入,使用自定义工厂替换原模块逻辑 jest.mock('./sample', () => ({ add: () => num1 + num2, sub: () => num1 - num2, mul: () => num1 * num2, })); import { add } from './sample'; beforeEach(() => { // 每个测试前恢复变量的初始值,避免用例间污染 num1 = 10; num2 = 20; }); test('add', () => { num1 = 5; num2 = 5; expect(add()).toEqual(10); });
这种方式会完全替换原模块的实现,适合需要完全模拟原模块逻辑的场景,如果需要保留原模块的其他逻辑、仅修改几个私有变量,不适合使用该方案。
方案3:侵入性配置的变量替换方案
如果需要在完全不改动原模块代码、不全量mock模块的前提下模拟私有变量,可以配合Babel的编译插件,在代码编译阶段将原模块内的本地变量标记为可被测试访问,这种方式对项目构建配置有一定侵入,更适合大型项目做统一的测试配置,不适合小范围的零散测试场景。
内容的提问来源于stack exchange,提问作者Abhishek
相关产品推荐
相关产品推荐

