测试指南
LobeHub 的测试策略包括使用 Vitest 进行单元测试,以及使用 Playwright + Cucumber 进行端到端 (E2E) 测试。本指南介绍如何高效地编写和运行测试。
概述
我们的测试策略包括:
- 单元测试 — 使用 Vitest 测试函数、组件和状态存储
- E2E 测试 — 使用 Playwright + Cucumber 测试用户流程
- 类型检查 — TypeScript 编译器(
bun run type-check) - 代码规范 — ESLint、Stylelint
快速参考
命令
Shell
切勿运行完整测试套件(bun run test)—— 这会运行所有测试,耗时约 10 分钟。请始终使用
bunx vitest run --silent='passed-only' '[file-path]' 指定目标文件。
使用 Vitest 进行单元测试
测试文件结构
测试文件与被测代码并列放置,命名为 <filename>.test.ts:
Plaintext
编写测试用例
使用 describe 和 it 组织测试用例,使用 beforeEach/afterEach 管理测试前后的状态:
TypeScript
测试 React 组件
使用 @testing-library/react 测试组件行为:
TypeScript
测试 Zustand 状态存储
在 beforeEach 中重置 store 状态,确保测试互相独立:
TypeScript
Mock(模拟)
优先使用 vi.spyOn 而非 vi.mock
TypeScript
Mock 浏览器 API
TypeScript
Mock 模块
TypeScript
测试异步代码
TypeScript
测试数据库代码
针对包中的数据库和 ORM 测试:
Shell
使用 Playwright 进行 E2E 测试
运行 E2E 测试
Shell
E2E 测试结构
E2E 测试位于 e2e/ 目录下:
Plaintext
编写 E2E 测试
Feature 文件 (e2e/features/chat.feature):
Plaintext
步骤定义 (e2e/step-definitions/chat.steps.ts):
TypeScript
最佳实践
1. 测试行为,而非实现细节
TypeScript
2. 使用语义化查询
TypeScript
3. 每次测试后清理状态
TypeScript
4. 测试边界条件
TypeScript
5. 保持测试相互独立
TypeScript
常用模式
测试 Hooks
TypeScript
测试 Context Provider
TypeScript
测试覆盖率
生成覆盖率报告
bun run test-app:coverage之后打开 coverage/index.html 查看报告。
覆盖率目标
| 类型 | 目标 |
|---|---|
| 关键路径 | 80%+ |
| 工具函数 | 90%+ |
| UI 组件 | 70%+ |
调试测试
VS Code 调试
在 .vscode/launch.json 中添加:
JSON
Vitest UI
bunx vitest --ui在浏览器中打开交互式测试资源管理器。
Console 日志
TypeScript
CI/CD 集成
GitHub Actions 会在每次 PR 时自动运行以下检查:
- 代码规范(ESLint、Stylelint)
- 类型检查
- 单元测试
- E2E 测试
- 构建验证
所有检查通过后 PR 才可合并。