WXT浏览器插件开发中文教程(26)----单元测试与E2E测试

前言

大家好,我是倔强青铜三 。是一名热情的软件工程师,我热衷于分享和传播IT技术,致力于通过我的知识和技能推动技术交流与创新,欢迎关注我,微信公众号:倔强青铜三。欢迎点赞、收藏、关注,一键三连!!!

单元测试

Vitest

WXT 为 Vitest 提供了顶级支持,用于单元测试:

ts 复制代码
// vitest.config.ts
import { defineConfig } from 'vitest/config';
import { WxtVitest } from 'wxt/testing';
export default defineConfig({
  plugins: [WxtVitest()],
});

此插件执行以下操作:

  • 使用内存实现的扩展 API browser,通过 webext-core.aklinker1.io/fake-browse... 提供的 @webext-core/fake-browser 进行 polyfill
  • 添加 wxt.config.ts 中的所有 Vite 配置或插件
  • 配置自动导入(如果启用)
  • 应用内部 WXT Vite 插件,例如 wxt.dev/guide/essen... 中的远程代码打包
  • 设置 WXT 提供的全局变量(import.meta.env.BROWSERimport.meta.env.MANIFEST_VERSIONimport.meta.env.IS_CHROME 等)
  • 配置别名(@/*@@/* 等),以便解析导入

以下是一些设置了单元测试的真实项目。查看代码和测试,了解它们的编写方式。

示例测试

此示例展示了在测试中无需模拟 browser.storage(由 wxt/utils/storage 使用)------webext-core.aklinker1.io/fake-browse... 提供的 @webext-core/fake-browser 在内存中实现了存储功能,因此其行为与真实扩展中一致!

ts 复制代码
import { describe, it, expect } from 'vitest';
import { fakeBrowser } from 'wxt/testing';
const accountStorage = storage.defineItem<Account>('local:account');
async function isLoggedIn(): Promise<Account> {
  const value = await accountStorage.getValue();
  return value != null;
}
describe('isLoggedIn', () => {
  beforeEach(() => {
    // 参考 <https://webext-core.aklinker1.io/fake-browser/reseting-state> 
    fakeBrowser.reset();
  });
  it('当存储中存在账户时应返回 true', async () => {
    const account: Account = {
      username: '...',
      preferences: {
        // ...
      },
    };
    await accountStorage.setValue(account);
    expect(await isLoggedIn()).toBe(true);
  });
  it('当存储中不存在账户时应返回 false', async () => {
    await accountStorage.deleteValue();
    expect(await isLoggedIn()).toBe(false);
  });
});

模拟 WXT API [​](#模拟 WXT API "#%E6%A8%A1%E6%8B%9F-wxt-api")

首先,您需要了解 #imports 模块的工作方式。当 WXT(以及 Vitest)在预处理步骤中看到此导入时,导入将被替换为指向其"真实"导入路径的多个导入。

例如,这是您在源代码中编写的内容:

ts 复制代码
// 您编写的代码
import { injectScript, createShadowRootUi } from '#imports';

但 Vitest 看到的是:

ts 复制代码
import { injectScript } from 'wxt/browser';
import { createShadowRootUi } from 'wxt/utils/content-script-ui/shadow-root';

因此,在这种情况下,如果您想模拟 injectScript,需要传入 "wxt/utils/inject-script",而不是 "#imports"

ts 复制代码
vi.mock("wxt/utils/inject-script", () => ({
  injectScript: ...
}))

请参考项目中的 .wxt/types/imports-module.d.ts 文件,查找 #imports 的真实导入路径。如果文件不存在,请运行 wxt.dev/guide/essen... 中的 wxt prepare

其他测试框架

如果要使用其他框架,您可能需要禁用自动导入,设置导入别名,手动模拟扩展 API,并设置测试环境以支持您使用的 WXT 的所有功能。

这是可能的,但需要更多的设置。可以参考 Vitest 的设置,了解如何设置测试环境:

github.com/wxt-dev/wxt...

E2E 测试 [​](#E2E 测试 "#e2e-testing")

Playwright

Playwright 是编写 Chrome 扩展端到端测试的唯一好选择。

要为您的项目添加 E2E 测试,请遵循 Playwright 的 Chrome 扩展文档。当您需要传递扩展的路径时,请传递输出目录,/path/to/project/.output/chrome-mv3

完整的示例请参考 WXT 的 Playwright 示例

最后感谢阅读!欢迎关注我,微信公众号倔强青铜三。欢迎点赞收藏关注,一键三连!!!

相关推荐
月起星九1 分钟前
为什么package.json里的npm和npm -v版本不一致?
前端·npm·node.js
孤客网络科技工作室12 分钟前
每天学一个 Linux 命令(7):cd
java·linux·前端
JSON_L17 分钟前
Vue 组件通信 - Ref组件通信
javascript·vue.js·ecmascript
努力的搬砖人.17 分钟前
Vue 2 和 Vue 3 有什么区别
前端·vue.js·经验分享·面试
Json_1817901448036 分钟前
python采集淘宝拍立淘按图搜索API接口,json数据示例参考
服务器·前端·数据库
珹洺1 小时前
Java-servlet(十)使用过滤器,请求调度程序和Servlet线程(附带图谱表格更好对比理解)
java·开发语言·前端·hive·hadoop·servlet·html
Fri_1 小时前
Vue 使用 xlsx 插件导出 excel 文件
javascript·vue.js·excel
熙曦Sakura1 小时前
【C++】map
前端·c++
黑贝是条狗1 小时前
html 列表循环滚动,动态初始化字段数据
前端·javascript·html
萌萌哒草头将军2 小时前
🔥🔥🔥4 月 1 日尤雨溪突然宣布使用 Go 语言重写 Rolldown 和 Oxc!
前端·javascript·vue.js