Vitest 测试框架模式与最佳实践。适用于编写单元测试、集成测试、配置 vitest.config、使用 vi.mock/vi.fn 进行模拟等...
测试最佳操作 QQ快速引用 Common Assertions.是一项面向实际任务的技能,主要用于Async Testing QQ快速模拟引用 校验门 : 当您添加或更改测试时使用此顺序。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
import { describe, it, expect, beforeEach, vi } from 'vitest';
describe('feature name', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('should do something specific', () => {
expect(actual).toBe(expected);
});
it.todo('planned test');
it.skip('temporarily disabled');
it.only('run only this during dev');
});
// 相等性
expect(value).toBe(42) // 严格相等(===)
expect(obj).toEqual({ a: 1 }) // 深度相等
expect(obj).toStrictEqual({ a: 1 }) // 严格深度相等(检查类型)
// 真值性
expect(value).toBeTruthy();
expect(value).toBeFalsy();
expect(value).toBeNull();
expect(value).toBeUndefined();
// 数值
expect(0.1 + 0.2).toBeCloseTo(0.3);
expect(value).toBeGreaterThan(5);
// 字符串 / 数组
expect(str).toMatch(/pattern/);
expect(str).toContain('substring');
expect(array).toContain(item);
expect(array).toHaveLength(3);
// 对象
expect(obj).toHaveProperty('key');
expect(obj).toHaveProperty('nested.key', 'value');
expect(obj).toMatchObject({ subset: 'of properties' });
// 异常
expect(() => fn()).toThrow();
expect(() => fn()).toThrow('error message');
expect(() => fn()).toThrow(/pattern/);
// Async/await(推荐方式)
it('fetches data', async () => {
const data = await fetchData();
expect(data).toEqual({ id: 1 });
});
// Promise 断言 —— 必须始终使用 await
await expect(fetchData()).resolves.toEqual({ id: 1 });
await expect(fetchData()).rejects.toThrow('Error');
// 错误示例 —— 将导致误报
expect(promise).resolves.toBe(value); // 缺少 await!
const mockFn = vi.fn();
mockFn.mockReturnValue(42);
mockFn.mockResolvedValue({ data: 'value' });
expect(mockFn).toHaveBeenCalled();
expect(mockFn).toHaveBeenCalledWith('arg1', 'arg2');
expect(mockFn).toHaveBeenCalledTimes(2);
在新增或修改测试时,请遵循以下流程;每个步骤均有明确的通过标准。
package.json 中的 scripts;通常为 vitest run、pnpm test 或 npm test)。通过条件:进程退出码为 0,且测试报告中显示失败用例数为 0。expect(...).resolves 和 expect(...).rejects 均以 await 开头(即 await expect(...)),参见「异步测试」章节。若某行中出现 resolves 或 rejects 却未前置 await,则该关卡不通过。| 方法 | 用途 |
|---|---|
it() / test() |
定义单个测试 |
describe() |
对测试进行分组 |
beforeEach() / afterEach() |
每个测试前/后执行的钩子 |
beforeAll() / afterAll() |
整个测试套件前/后执行的钩子 |
.skip |
跳过当前测试或测试套件 |
.only |
仅运行当前测试或测试套件 |
.todo |
占位符测试(标记待实现) |
.concurrent |
启用并发执行 |
.each([...]) |
参数化测试 |