课程大纲 第 118 课,共 148 课 · 发明你的工具
发明你的工具

一个差异风险摘要器

为什么重要 评审者会略读。拉取请求顶部的一行摘要(“触及了一个迁移,削弱了测试”)会告诉他们在哪里放慢速度,而且它每次都一样,不像让一个对话去“评审这个差异”那样。

你的团队写下了它的评审规则,想要一个把这些规则应用到统一差异(git diff 的输出)上的工具。差异中的每个文件都是一个以 diff --git a/OLD b/NEW 行开头的部分。接下来是头部行(index、---、+++、new file mode、deleted file mode、rename from/to、similarity index、Binary files ... differ)。在一个部分的第一个 @@ 行之后,每一行都是内容:+ 是新增,- 是删除,一个空格表示上下文。

真实的差异比教科书里的那个更乱。一次纯粹的重命名没有 ---/+++ 行,也没有内容。一个二进制文件两者都没有。一个被删除文件的 +++ 行写的是 /dev/null。而一条被删除的 SQL 注释 -- old note,在差异中会显示为 --- old note。

轮到你了

编写 risk_summary(diff)。一个文件的路径是它的 diff --git 行中的 NEW,如果这个部分有一行 deleted file mode,就是 OLD。路径中没有空格。返回一个从类别映射到其中路径的排序列表的字典(省略空的类别):

  • schema:路径中有一个目录名为 migrations,或者文件名以 .sql 结尾。
  • secrets:一行新增的行包含 password、secret、api_key 或 token,不区分大小写。
  • tests-weakened:一个测试文件(名字以 test_ 开头,或者有一个目录名为 tests)被删除了,或者包含 assert 的被删除行多于新增行。
  • dependencies:文件名是 requirements.txt、pyproject.toml、package.json 或 package-lock.json。
  • config:文件名以 .yml、.yaml、.ini 或 .env 结尾,或者是 settings.py。
要战胜的陷阱:测试使用了重命名、二进制文件、被删除和新增的文件,以及 SQL 注释,正如上面所描述的。

发现这节课有问题?报告它 · 就这节课提问

这个练习即将开放

完成它前面的那一课,这一课就会解锁。整门课程免费,无需账号,而且你现在就可以阅读这节课。