一次评审指出,有一个测试在动手改代码之前就已经失败了。把调用 git 的九个测试文件放进一份全新副本里重跑,失败的不是一个,是六个。另有 206 个通过,10 个被跳过。
这套测试的做法是故意把代码改坏,看测试能不能抓住。每次改坏都在项目的一份临时副本里跑,副本里有 git 跟踪的文件,但没有 .git 文件夹——有代码,没有历史。
六个测试为什么失败
这六个测试都要读 git 的输出再做判断。五个用 git show 或 git log 去读一个旧提交或文件的旧版本;一个用 git grep 列出所有调用某个函数的文件,并检查这份清单里正好有两个文件。
没有 .git 文件夹,git 什么都不打印,每个测试都把这份空输出读成了错误答案。测试套件里另一些测试在没有历史的副本里本来就会自动跳过,这六个没有。
第一次修复被评审打回
第一版修复加了一个跳过条件:git 返回非零退出码,就跳过这个测试。副本里全绿了。
随后的评审把它否了。git grep 找不到匹配时返回退出码 1,在仓库之外 git 返回 128。那个 git grep 测试存在的意义,是抓住一种回归:函数的调用方消失了。在真实仓库里,这种回归会让 git grep 什么都找不到并返回 1,测试就会跳过而不是失败。这个修复恰好藏起了测试本来要抓的失败。
第二次修复换了判断对象
跳过条件改成看环境,不看结果:只有当项目里没有 .git 文件夹时,测试才跳过。在真实仓库里,git 报错或匹配为空仍然会走到断言并失败。
另有一个新测试把这条规则钉住。它在真实仓库里伪造退出码 1 和 128,检查没有任何测试被跳过:辅助函数交回空输出,git grep 测试抛出断言错误。它还会在没有历史的副本里跑每一个调用 git 的测试文件,并期望它们在那里通过。
在副本里,整套测试跑完:4,312 个通过,18 个跳过,0 个失败,用时 4 分 45 秒。那次运行用的是第一版修复;在没有 .git 的情况下,两版修复跳过的是同一批测试。在真实仓库里,受影响的测试文件加上新测试共跑了 126 个测试,没有一个被跳过。另外手工埋了三个破坏:去掉一个跳过条件,把两个测试改回按退出码跳过。新测试在每一次都失败了。
同样的形状还有十二处
接着在套件其余部分搜索同一种写法:调用 git,然后根据它的退出码做决定。又找到十二处,分布在四个测试文件里,每一处检查的都是某条书面结论所依赖的 git 历史。
- 九处在退出码非零时跳过。
- 三处只在退出码为零时才跑 git 检查,于是 git 一出错,这些检查就被丢掉,测试照样通过。
- 这十二处现在都改用文件夹检查,并对退出码做断言,而不是在退出码上分支。
第三次评审又发现一处:git 输出为空时它就跳过。它得到了同样的修复。
最初给这类问题上的锁是一张形状清单,评审不断找出它漏掉的形状:> 0、bool(...)、包住一段检查的 == 0。最后留下来的锁更笨也更硬:在每一个直接启动 git 的测试文件里,任何提到 .returncode 的 if、elif 或 while 行都会让一个测试失败。它看不见基于空输出的跳过,也看不见退出码先被复制到另一个名字的情况,这些仍然靠手工检查。
留下的规则
- 测试在某个地方跑不了时,按环境跳过,不按结果跳过。结果分不清"没能检查"和"检查过、发现了 bug"。
- 在把非零读成"不可用"之前,先弄清每个退出码的含义。对 git grep 来说,没有匹配就是 1。
- 评审说一个测试失败时,把整组重跑一遍。评审说一个,实际是六个。
热门跟贴