模拟 Capacitor 插件
在应用中创建单元测试时,最佳实践是为被测单元的任何外部依赖项创建模拟对象。这包括您的组件或服务正在使用的 Capacitor 插件。
大多数模拟库通过获取对象并将其包装在 JavaScript 代理中来创建模拟对象,以便可以检查对该对象方法的调用并控制这些方法的返回值。然而,Capacitor 插件在 JavaScript 层中作为代理实现。不支持创建代理的代理并且会失败。可以使用手动模拟来规避此问题。
手动模拟
手动模拟允许用户轻松存根整个 JavaScript 模块的功能。因此,当测试执行 import { Storage } from '@capacitor/storage' 时,不会加载真正的 Storage JavaScript 代理对象,而是加载类似这样的内容:
export const Storage = {
async get(data: { key: string }): Promise<{ value: string | undefined }> {
return { value: undefined };
},
async set(data: { key: string; value: string }): Promise<void> {},
async clear(): Promise<void> {},
};
由于这是一个纯 JavaScript 对象而不是代理对象,因此很容易对其进行监视。此外,由于它是一个模拟对象,它不会尝试进行任何原生调用。这使得使用手动模拟成为测试使用 Capacitor 插件的代码时的理想选择。
Jest
Jest 测试框架内置了手动模拟。在项目根目录创建一个 __mocks__/@capacitor 文件夹,Jest 将自动从那里加载文件,而不是从 node_modules 加载。
例如,假设您有以下目录结构:
.
|
+- __mocks__
| |
| +- @capacitor
| |
| +- storage.ts
| +- toast.ts
...
+- src
您的测试将使用 storage.ts 和 toast.ts 中定义的存根,而不是 node_modules 中真正的 @capacitor/storage 和 @capacitor/toast 插件。
Jasmine
Jasmine 测试框架不包括"手动模拟"的概念,但我们可以通过使用 TypeScript 路径映射轻松模拟这一点。
首先,在项目根目录创建相同的目录结构,就像 Jest 示例一样。
Angular 项目(您将使用 Jasmine 作为测试框架的最常见场景)包含一个 tsconfig.spec.json 文件,该文件在执行单元测试时扩展 tsconfig.json 基本配置。修改此文件以扩展您可能在基本级 别拥有的任何 paths 映射。
例如,如果您的 tsconfig.json 文件包含以下 paths 映射:
"paths": {
"@app/*": ["src/app/*"],
"@env/*": ["src/environments/*"]
},
然后更新您的 tsconfig.spec.json 文件以包含这些路径以及您想用于单元测试的任何路径:
"paths": {
"@app/*": ["src/app/*"],
"@env/*": ["src/environments/*"],
"@test/*": ["test/*"],
"@capacitor/*": ["__mocks__/@capacitor/*"]
}
现在,当编译单元测试时,import { Storage } from '@capacitor/storage'; 将使用 __mocks__/@capacitor 下的存根文件,而不是 node_modules 中的真实文件。
注意: paths 对象被完全替换而不是合并,因此如果您在 tsconfig.json 中定义了任何路径,它们_必须_也包含在 tsconfig.spec.json 中。
模拟存根
有了手动模拟,现在可以编写测试以所有通常的方式模拟和监视方法调用。
Jest
it("gets the first and last name", async () => {
Storage.get = jest.fn().mockImplementation(
async (data: { key: string }): Promise<{ value: string }> => {
return data.key === "firstName"
? { value: "Jimmy" }
: data.key === "lastName"
? { value: "Simms" }
: { value: "unknown" };
}
);
const w = mount(Home);
await flushPromises();
expect(w.vm.firstName).toEqual("Jimmy");
expect(w.vm.lastName).toEqual("Simms");
});
it("clears the storage", () => {
const button = wrapper.findComponent('[data-testid="clear"]');
Storage.clear = jest.fn().mockResolvedValue(undefined);
button.trigger("click");
expect(Storage.clear).toHaveBeenCalledTimes(1);
});
Jasmine
it("gets the first and last name", async () => {
spyOn(Storage, 'get');
(Storage.get as any)
.withArgs({ key: 'firstName' })
.and.returnValue(Promise.resolve({ value: 'Jason' }));
(Storage.get as any)
.withArgs({ key: 'lastName' })
.and.returnValue(Promise.resolve({ value: 'Jones' }));
fixture.detectChanges();
await fixture.whenRenderingDone();
expect(component.firstName).toEqual('Jason');
expect(component.lastName).toEqual('Jones');
});
it('clears the storage', () => {
spyOn(Storage, 'clear');
click(clear.nativeElement);
fixture.detectChanges();
expect(Storage.clear).toHaveBeenCalledTimes(1);
});