如何在 Vitest 或 Jest 快照测试中用 faker 种子保持结果稳定【免费下载链接】fakerGenerate massive amounts of fake data in the browser and node.js项目地址: https://gitcode.com/GitHub_Trending/faker/faker如果你的测试用faker生成随机数据快照测试会天然不稳定每次运行faker.person.fullName()都返回不同的值toMatchSnapshot()在第一次写入快照后后续运行就可能持续失败。Faker 官方文档给出的解法是把 faker 实例用固定值播种seed让同一种子下的随机序列每次都相同这正是 框架集成指南 中 seeded tests 一节的内容It can sometimes be useful to do seeded tests, where we seed our faker instance with a static value so that it will generate the same random value each time. These are especially useful in tests that are meant to be deterministic, such as snapshot tests.下面的步骤覆盖安装、种子写法、快照测试代码以及种子无法覆盖的边界情况。安装 faker 并选择 locale 入口按 README 的安装命令以开发依赖方式安装npm install --save-dev faker-js/faker导入入口建议用 locale 子路径而不是默认实例。框架指南 中的所有示例都从faker-js/faker/locale/en导入并说明原因是性能Note that these examples use only theenlocale for better performance.本地化指南 也指出指定具体 locale 会减少启动所需时间which has a compounding effect on testing frameworks that reload the imports every execution每次执行都重新加载导入的测试框架会被放大。如果你的测试不需要英文以外的数据用这个入口即可import { faker } from faker-js/faker/locale/en;需要其他语言时参考 本地化指南 中的 locale 列表选择对应的导入名如fakerDE。种子如何让生成结果可复现faker.seed(number)是核心 API。使用指南 的 Reproducible results 一节说明正常使用时每次调用都得到不同的随机值设置了种子后再次设置同一个种子会重置序列因此两次取到的值相同faker.seed(123); const firstRandom faker.number.int(); // Setting the seed again resets the sequence. faker.seed(123); const secondRandom faker.number.int(); console.log(firstRandom secondRandom);两个要点直接决定测试写法种子是顺序相关的相同种子下第 N 次调用取到的值相同但调用顺序变化会改变结果。测试里生成值的调用顺序要保持固定。种子会改变全局实例状态。如果只想让某一个测试确定化需要在测试前后处理种子否则其他测试会被顺带播种。在 Vitest 中写带种子的快照测试框架指南 给出了一个完整的 Vitest 示例按文档原样使用即可import { faker } from faker-js/faker/locale/en; import { afterEach, describe, expect, it } from vitest; // We might want other tests to *not* be seeded. This will re-seed our faker instance after each test. afterEach(() { faker.seed(); }); describe(reverse array, () { it(should reverse the array, () { // Seed our faker instance with some static number. faker.seed(1234); const title faker.person.jobTitle(); const name faker.person.fullName(); const animal faker.animal.bear(); const array [title, name, animal]; expect(array.reverse()).toStrictEqual([animal, name, title]); // Expect our value to always match a generated snapshot. expect(array.reverse()).toMatchSnapshot(); }); });各部分的作用faker.seed(1234)在测试体内、任何生成调用之前用静态数字播种保证这一组person.jobTitle()/person.fullName()/animal.bear()每次运行都返回相同值。afterEach(() { faker.seed(); })不带参数调用seed()在每次测试结束后重新播种。文档注释说明其目的是让其他测试不处于播种状态We might want other tests tonotbe seeded避免测试之间相互影响。expect(...).toMatchSnapshot()断言生成的值始终匹配已写入的快照。文档说明的效果就是generate the same random value each time即该断言在重复运行时持续通过而不是每次都产生新快照。迁移到 Jest 时改什么Vitest 和 Jest 的写法几乎完全一样文档指出的主要差异只有一处Vitest 需要显式导入测试方法Jest 里describe、expect、it等是全局可用的。文档原文The main difference is that testing methods need to be imported in Vitest. Simply crop that line out for a Jest integration.也就是把上面的import { afterEach, describe, expect, it } from vitest;这一行删掉其余代码不变。边界种子管不住的方法使用指南 明确指出有一批基于相对日期相对于今天的方法只设种子不足以得到可复现结果因为today取决于代码何时运行。文档列出的方法是faker.date.pastfaker.date.futurefaker.date.recentfaker.date.soonfaker.git.commitEntryfaker.string.uuid({ version: 7 })文档给出的两种修复方式对单次调用传固定的refDateDate 或字符串// creates a date soon after 2023-01-01 faker.date.soon({ refDate: 2023-01-01T00:00:00.000Z });一次性为所有相关方法设置默认参考日期// affects all future faker.date.* calls faker.setDefaultRefDate(2023-01-01T00:00:00.000Z);如果你的快照覆盖到上面列出的任何方法必须同时固定refDate否则即使种子相同快照仍会随运行日期漂移。升级 faker 版本的影响文档有一个直接影响快照维护的提示同样在 使用指南 中When upgrading to a new version of Faker, you may get different values for the same seed, as the underlying data (lists of names, words etc) may have changed.即升级 faker 后相同种子可能产生不同的值已写入的快照可能需要重新生成。做版本迁移时要把快照 diff 是否来自 faker 升级纳入判断。参考faker 仓库自身的种子化快照测试如果想看一个规模化的写法仓库自己的测试基础设施 test/support/seeded-runs.ts 是一个现成范例。它维护一组种子seededRuns [42, 1337, 1211]用describe.each(seededRuns)对每个种子各跑一遍完整用例每个断言块执行前先调用setup()重置种子this.faker.seed(this.seed)再用toMatchSnapshot()校验返回值在跨种子、跨运行之间保持一致。这个固定种子集合 每次断言前重置 快照断言的结构可以直接借鉴到项目自己的测试里。小结必做测试体内先faker.seed(静态数字)再做任何生成调用需要隔离时用afterEach(() faker.seed())恢复随机状态。必查快照是否覆盖了faker.date.past/future/recent/soon、faker.git.commitEntry、faker.string.uuid({ version: 7 })覆盖则需额外固定refDate或setDefaultRefDate。迁移时注意Vitest 到 Jest 只需删掉测试方法的 import 行升级 faker 版本时同一种子可能产生不同值快照需重新核对。【免费下载链接】fakerGenerate massive amounts of fake data in the browser and node.js项目地址: https://gitcode.com/GitHub_Trending/faker/faker创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考