
在 javascript 应用开发中,尤其是在构建 sdk 或需要与第三方库交互的场景下,我们经常会遇到代码直接依赖 window 对象上定义的全局属性或方法。例如,一个外部库 ats 可能通过 window.ats 提供服务:
private getFromATS(): string {
return window.ats.retrieveEnvelope(function (envelope: string) {
console.log('Located ATS.js');
return JSON.parse(envelope).envelope;
});
}当我们需要对包含此类依赖的代码进行单元测试时,问题便出现了。在没有实际加载 ats 库的环境下(如 Karma/Jasmine 测试),window.ats 将是 undefined,导致测试失败。传统的 Jasmine 模拟方法,如 spyOn,通常用于模拟对象上的现有方法,但对于 window 对象上可能不存在的属性或需要完全替换整个属性的情况,它们往往力不从心。尝试直接 spyOn(window, 'ats') 或使用 Object.defineProperty 可能会遇到各种限制或不符合预期。
解决这一问题的最直接且有效的方法是,在每个测试用例或测试套件运行前,手动在 window 对象上定义或重写所需的属性,并在测试结束后将其清理。Jasmine 提供了 beforeEach 和 afterEach 钩子函数,非常适合实现这种设置(setup)和清理(teardown)逻辑。
核心思想:
示例代码:
假设我们有一个 MySDK 类,其中包含 getFromATS 方法:
// src/my-sdk.ts
class MySDK {
public getFromATS(): string {
return window.ats.retrieveEnvelope(function (envelope: string) {
// 假设这里有一些日志或解析逻辑
return JSON.parse(envelope).envelope;
});
}
}
// 假设 Callback 是一个类型定义
type Callback<T> = (data: T) => any;
// test/my-sdk.spec.ts
describe('MySDK', () => {
let mySdkInstance: MySDK;
beforeEach(() => {
// 实例化 MySDK
mySdkInstance = new MySDK();
// 在每个测试用例运行前,设置模拟的 window.ats 对象
// 模拟 retrieveEnvelope 方法,使其调用传入的回调函数并返回期望的数据
window.ats = {
retrieveEnvelope: function (callback: Callback<string>) {
// 模拟外部库返回的 JSON 字符串
const mockEnvelopeJson = '{"envelope":"mocked_envelope_data_from_ats"}';
// 调用回调函数,并返回回调函数的结果,以匹配原始行为
return callback(mockEnvelopeJson);
},
};
});
afterEach(() => {
// 在每个测试用例运行后,清理模拟对象
// 将 window.ats 设置为 undefined,或者使用 delete 运算符彻底删除属性
window.ats = undefined;
// 或者:delete (window as any).ats;
});
it('should retrieve envelope from mocked window.ats', () => {
// 调用被测试的方法
const result = mySdkInstance.getFromATS();
// 验证结果是否符合模拟数据
expect(result).toBe('mocked_envelope_data_from_ats');
});
// 可以添加更多测试用例,它们都会在独立的模拟环境中运行
it('should handle different mocked data if needed', () => {
// 在这个测试用例中,可以重新定义 window.ats 来模拟不同的场景
window.ats = {
retrieveEnvelope: function (callback: Callback<string>) {
return callback('{"envelope":"another_mocked_value"}');
},
};
const result = mySdkInstance.getFromATS();
expect(result).toBe('another_mocked_value');
});
});这种方法的有效性在于:
在 Karma 和 Jasmine 中测试依赖于 window 对象上外部库的代码时,直接在 beforeEach 中设置模拟的 window 属性,并在 afterEach 中进行清理,是一种简洁、高效且非侵入性的策略。它确保了测试环境的隔离性和可预测性,使得单元测试能够专注于验证核心业务逻辑,而无需关心外部依赖的实际存在。正确使用 beforeEach 和 afterEach,能够有效管理测试状态,编写出健壮可靠的单元测试。
以上就是Jasmine/Karma 测试:如何模拟 window 对象上的外部库的详细内容,更多请关注php中文网其它相关文章!
Windows激活工具是正版认证的激活工具,永久激活,一键解决windows许可证即将过期。可激活win7系统、win8.1系统、win10系统、win11系统。下载后先看完视频激活教程,再进行操作,100%激活成功。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号