AVA Snapshot Workflow 实战移除快照断言时数据的清理与保留机制【免费下载链接】avaNode.js test runner that lets you develop with confidence 项目地址: https://gitcode.com/gh_mirrors/ava/ava导读在 AVA 测试框架中快照snapshot文件与测试代码的生命周期需要保持同步当测试中的t.snapshot()断言被删除时旧快照数据应当如何处理本文基于 AVA 仓库test/snapshot-workflow目录下的工作流测试套件深入解析移除快照断言这一场景的两种行为——普通运行下旧数据被保留、--update-snapshots更新模式下旧数据被彻底清除——并从源码层面揭示.snap二进制文件与.md报告文件的生成与清理机制。一、场景定位快照工作流测试套件AVA 的test/snapshot-workflow目录专门用于模拟编写和维护基于快照的测试过程中可能出现的各种情境。其核心思路见 README是大多数测试由一个 fixture夹具组成其中包含可以两种方式运行的测试文件带或不带TEMPLATEtrue以模拟用户对测试代码做出修改。fixture 会被复制到临时目录后由 AVA 调用随后测试断言快照文件是否按预期方式发生了变化。本场景对应的测试文件为 removing-snapshots.js其中包含两个串行用例test.serial( Removing a snapshot assertion retains its data, beforeAndAfter, { cwd: cwd(removing-snapshots), expectChanged: false, }, ); test.serial( With --update-snapshots, removing a snapshot assertion removes its data, beforeAndAfter, { cwd: cwd(removing-snapshots), cli: [--update-snapshots], expectChanged: true, }, );两个用例共用一个 fixture仅通过cli参数区分是否传入--update-snapshots从而对照出 AVA 在两种模式下的不同行为。所有用例均使用test.serial()串行执行这是为了避免 CI 机器同时承担多次 AVA 调用的负担见 README。二、Fixture 结构模拟删除一个快照断言fixture 位于 test/snapshot-workflow/fixtures/removing-snapshots其测试文件 test.js 是一个带条件编译的模板const {default: test} await import(process.env.TEST_AVA_IMPORT_FROM); test(foo, t { t.snapshot({foo: one}); if (process.env.TEMPLATE) { t.snapshot({foo: two}); } });当TEMPLATEtrue运行时测试块foo会记录两个快照{foo: one}和{foo: two}用于生成 fixture 的初始快照状态当TEMPLATE未设置时测试只记录一个快照{foo: one}模拟开发者在删除了第二个t.snapshot()断言之后的新代码。fixture 的初始状态运行TEMPLATEtrue npx ava --update-snapshots即 README 中约定的初始化方式后fixture 目录下生成两类文件1. 快照报告 test.js.md人类可读的报告可提交到版本控制用于 diff# Snapshot report for test.js The actual snapshot is saved in test.js.snap. Generated by [AVA](https://avajs.dev). ## foo Snapshot 1 { foo: one, } Snapshot 2 { foo: two, }2. 快照数据文件test.js.snap二进制格式实际比较的依据。从源码 lib/snapshot-manager.js 可知该文件以AVA Snapshot v3的可读前缀开头使用 CBOR 编码序列化由cbor2库完成并附加 SHA-256 校验和以保证完整性。三、测试宏beforeAndAfter 如何验证行为两个用例共用 helpers/macros.js 中定义的beforeAndAfter宏其执行流程如下读取变更前状态通过readSnapshots(cwd)读取 fixture 中的test.js.snap解压后和test.js.md复制到临时目录withTemporaryFixture将 fixture 复制到临时目录避免污染源 fixture运行 AVA在临时目录中执行fixture(cli, ...)cli决定是否携带--update-snapshots读取变更后状态再次读取临时目录中的.snap与.md断言差异若expectChanged: false断言前后.md完全一致t.is、.snap深度相等t.deepEqual若expectChanged: true断言前后均发生变化t.not/t.notDeepEqual并对两个报告做concordance.diff生成差异快照。readSnapshots用到了源码导出的extractCompressedSnapshot函数见 lib/snapshot-manager.js配合gunzipSync解压出快照的真实内容——这正是移除断言场景下检验.snap中数据是否真正被删除的依据。差异快照删除操作的实际表现测试为expectChanged: true的用例录制的快照报告位于 snapshots/removing-snapshots.js.md其内容即为.md报告变更前后的 diff# Snapshot report for test.js ... ## foo Snapshot 1 { foo: one, } - - Snapshot 2 - - { - foo: two, - }带-前缀的行正是被删除的Snapshot 2及其数据{foo: two}。这直观证明在--update-snapshots模式下AVA 不仅更新了.snap二进制数据文件还同步重写了.md报告——两个文件始终保持一致。四、源码剖析快照管理器如何决定保留还是删除理解两种行为的差异关键在于SnapshotManager的加载与保存逻辑lib/snapshot-manager.js。加载阶段根据 updating 初始化新旧块load()函数lib/snapshot-manager.js读取已有.snap后将数据解码为blocksByTitle按测试标题分组的快照块然后分派到两个 MapoldBlocksByTitle: blocksByTitle, newBlocksByTitle: updating ? new Map() : blocksByTitle,普通模式updating: falsenewBlocksByTitle直接引用旧数据。这意味着即使本次运行中没有再次调用某个t.snapshot()旧的快照数据仍然会被视为当前快照而保留下来——对应第一个用例Removing a snapshot assertion retains its data。更新模式updating: truenewBlocksByTitle初始化为空 Map旧的快照块只存在于oldBlocksByTitle中作为参照。每次运行中的t.snapshot()调用都会将新数据写入空 Map见recordSerializedlib/snapshot-manager.js没有被再次记录的旧块自然就消失了。保存阶段重建快照文件save()方法lib/snapshot-manager.js负责将newBlocksByTitle中的内容重新编码为.snap二进制文件并同步生成.md报告generateReport。因此更新模式下被删除断言的快照不会进入新的newBlocksByTitle最终两个文件都被重写旧数据被彻底清除一个有趣的边界情况更新模式下如果newBlocksByTitle为空例如删除的断言恰好是该测试文件中唯一的快照save()会返回changedFiles: [snapPath, reportPath]并触发文件清理——即删除快照文件本身而不是写入空文件。解码容错更新模式忽略损坏load()中还有一个细节lib/snapshot-manager.js解码.snap失败时普通模式会记录snapshotError并在比较时抛出而updating模式下所有解码错误都会被丢弃// Discard all decoding errors when updating snapshots因为更新模式反正会整体重建快照文件。这与移除断言后旧数据失效的理念一脉相承更新模式下旧快照的价值仅在于供skipSnapshot等操作保留引用其余场景一律以本次运行为准。五、从测试到实践开发者的操作指南结合 docs/04-snapshot-testing.md 与 docs/05-command-line.md将本场景映射到真实开发流程1. 删除t.snapshot()断言后直接运行测试$ ava旧快照数据会被保留与本次未删除断言时行为一致测试正常通过.snap与.md均不变。2. 删除断言后主动更新快照$ ava --update-snapshots或使用短标志ava -u见 docs/05-command-line.md。此时被删除断言对应的旧快照数据会从.snap中清除.md报告同步重写便于你在版本控制中通过 diff 审查变化$ git diff test/snapshots/main.js.md3. 只更新特定测试将--update-snapshots与--match或.only()组合使用见 docs/04-snapshot-testing.md避免大范围重写快照文件。4. 利用报告文件做代码审查.md报告如 fixture 的 test.js.md是可提交到版本控制用于 diff的辅助文件真正参与比较的是.snap。删除快照断言后只要运行过--update-snapshots提交.md的 diff 即可清晰展示哪些快照被移除。注意AVA 支持通过package.json中的ava.snapshotDir配置指定快照的固定存放位置见 docs/06-configuration.md 与 docs/04-snapshot-testing.md目录结构会镜像测试文件的相对布局若对预编译测试文件运行 AVA则会借助 source map 定位原始文件来决定快照存放位置。六、总结运行模式删除t.snapshot()断言后的行为底层机制普通运行ava旧快照数据保留.snap/.md均不变newBlocksByTitle复用旧数据lib/snapshot-manager.js更新模式ava --update-snapshots旧快照数据被删除.snap/.md均重写newBlocksByTitle置空后按本次运行重建lib/snapshot-manager.js理解这一机制后你就可以放心地重构测试代码普通运行下删除断言不会造成数据丢失而--update-snapshots则会忠实反映测试代码当前声明了哪些快照。两者配合使用恰好构成一套安全、可审计的快照维护工作流。【免费下载链接】avaNode.js test runner that lets you develop with confidence 项目地址: https://gitcode.com/gh_mirrors/ava/ava创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考