强制 code review：reviewboard+svn 的方案

赖勇浩（http://laiyonghao.com）

2012 年 2 月 22 日更新：保持文档与 0.1.2-r14 版本同步（变更部分使用蓝色#3333FF）。

2012 年 3 月 8 日更新：保持文档与 0.1.2-r16 版本同步（变更部分使用红色#CC0000）。

2012 年 4 月 28 日更新：保持文档与 0.1.3-r16 版本同步（变更部分使用深紫色#993399）。

2013 年 10 月 17 日更新：保持文档与 0.2.1-r20 版本同步（变更部分使用洋红色#FF6666）。

我们团队在开发《天下盛境》项目的时候，制定和执行了比较好的 code review 策略，总结下来有几个优点：一是代码风格可控，代码质量有一定提升；二是新员工入职后能够得到更多人的指导，成长非常快；三是小 bug 频出的情况比我做《天》之前的项目少了至少一个数量组。当时我们的 code review 策略是这样的：

使用 reviewboard 作为工具，通过 SVN hooks 强制每一次签入都是经过 review 的；
至少要有 2 个团队成员 ship it，才能够签入。
ship it 的成员中，至少有一个是资深的团队成员。

code review 是如此的有效，以至于我经常向朋友推荐，有一些朋友使用之后，觉得把 reviewboard 跟 SVN 结果起来还是蛮有挑战的，主要是编写 SVN hooks 还是需要学习不少东西，所以基本上他们都放弃了。今天我把 reviewboard-svn-hooks 项目修改、发布出来，方便大家使用。

首先感谢大家对 reviewboard-svn-hooks 的支持，在 0.1.0 版本发布后，很多朋友开始尝试使用，遇到了许多问题，也坚持不放弃，积极跟我沟通，提供非常详尽的出错信息，在此感谢你们！
0.1.2 版本找到了在 windows 下运行时出现 WindowsError[Error:6] 出错原因，并给出绕过的解决方案（见下文）；找到了安装时没有创建配置文件的原因，并给出绕过的解决方案（见下文）；增加了只要求 review 指定特性的文件的功能（如只 review src 目录下的文件）。

0.1.2 -r16 进一步增强了与 windows 的兼容性；同时 debug log 也标注上时间了；当 review_path 为空时，表示强制 review 所有的 svn 提交请求。

0.1.3-r16 取消了对 python2.6 的依赖，能够兼容 py2.5；修正了 review_path、experts 分切的错误。

升级

如果你是从 0.1.0 版本升级，需要注意事有两点：

请备份好 $CONFDIR/reviewboard-svn-hooks/conf.ini，升级后这个文件将被新文件覆盖，为避免你重新配置的麻烦，请先备份。
$CONFDIR/rb-svn-hooks-used-rid.db 文件已经移到 $CONFDIR/reviewboard-svn-hooks/rb-svn-hooks-used-rid.db。所以升级后请手动把旧位置的 .db 文件移动到新位置。关于 $CONFDIR 的值，在 linux 系统下是 /etc，在 windows 下它的位置在 %ALLUSERSPROFILE% 环境变量所指定的值处。

从任何一个之前的版本升级，都需要使用上述方法备份好 conf.ini。

安装

因为 easy_install/pip 等自身的原因，直接使用 easy_install -U reviewboard-svn-hooks 进行安装或升级的时候，会出现沙盒错误。所以安装时请前往 http://pypi.python.org/pypi/reviewboard-svn-hooks 手动下载压缩文件，解压后进入 reviewboard-svn-hooks 目录执行以下命令来安装：

python setup.py install

配置

安装后，需要对 reviewboard-svn-hook 项目进行配置。根据操作系统的不同，存储配置文件的目录也是不同的。在 linux 系统下，它的位置是在 /etc 下，在 windows 系统下，它的位置在 %ALLUSERSPROFILE% 目录下（具体指哪个目录，请参考http://en.wikipedia.org/wiki/Environment_variable#Default_Values_on_Microsoft_Windows）。在本文中，以 $CONFDIR 指代之。打开 $CONFDIR/reviewboard-svn-hooks/conf.ini 文件，解释如下：

[common]
# 是否记录 debugging 输出，0 为不输出，其它值为输出
debug = 0[reviewboard]
# reviewboard 的网址
# 如果使用的是目录，如 http://example.com/reviewboard/ 那请务必不要忘记最后的那个“/”
url=
# reviewboard 的用户名密码，这样才能够通过 http API 访问到 reviewboard 中的 review request 的状态
username=
password=[rule]
# 最少需要有几个 ship it
min_ship_it_count =
# 最少需要有几个专家 ship it
min_expert_ship_it_count =
# 专家的 reviewboard 用户名，使用半角逗号分格
experts =# ---------此处对 0.1.2-r16 有更新---------
# ---------此处对 0.1.2-r14 有更新---------
# 指定必须 review 的目录，半角逗号分隔，即如果所有改变的文件路径都不含其中的特性字符串，那就不检查 review 状态
# 默认为空，即表示强制 review 所有提交请求
# 例子： review_path = src, "cc/d,oc"
# 表示只有当改变的文件的路径中包含 src 或 cc/d,oc 目录时才要求 review，
# 关键路径中不能带有半角逗号review_path = # ---------此处对 0.2.1-r20 有更新---------
# 如果变更的文件全部在 ignore_path 里，则不会触发检测。ignore_path =

SVN hooks 配置

假定你的 SVN 仓库目录的 $REPOS，并且从来没有设置过 SVN hooks。如果你之前已经配置过 pre-commit，请参考下述脚本自己想办法调用 strict_review 应用程序。

linux

打开 $REPOS/hooks 目录，把 pre-commit.tmpl 改名为 pre-commit，记得加上执行权限。用文本编辑器打开 pre-commit 文件，把里面的内容全部删除掉，替换为下列内容：

REPOS="$1"
TXN="$2"
strict_review $REPOS $TXN
exit $?

至此，配置就完成了。

windows

打开 $REPOS/hooks 目录，把 pre-commit.tmpl 改名为 pre-commit.bat。用文本编辑器打开 pre-commit 文件，把里面的内容全部删除掉，替换为下列内容：

setlocal
set REPOS=%1
set TXN=%2
; ---------此处对 0.1.2-r16 有更新---------
; ---------此处对 0.1.2-r14 有更新---------
C:\python26\python.exe C:\python26\Scripts\strict_review-script.py %REPOS% %TXN%
exit %errorlevel%

记得把 C:\python26 这个目录替换为你本机上的 python 安装路径。至此，配置就完成了。

与已经使用过的 reviewboard 集成

如果你之前已经使用 reviewboard 做过若干次 code review，那么你还有一步工作需要做：把之前使用过的 review request id 废掉。首先请找出并记下你们使用过的最大的 review request id，然后在命令行执行如下命令：

# ---------此处对 0.1.2-r14 有更新---------init_used_rid_db $CONFDIR/reviewboard-svn-hooks/rb-svn-hooks-used-rid.db $MAX_REQ_ID

其中 $CONFDIR 的值在上文已经提到，$MAX_REQ_ID 就是前面说的使用过的最大的 review request id。

review 流程

团队成员在提交代码之前，需要先使用 post-review 工具在 reviewboard 上创建一个 review request。一个配置良好的 reviewboard 能够自动发送邮件给所有成员，收到邮件通知后大家抽空去 review 代码，而 review 结果也会通过邮件知会给大家，所以发起 review 的同事能够即时了解到 review request 的状态。当收集到足够多的 ship it 时，他就能够向 SVN 提交变更了，唯一需要注意的事项是要在 log message 里写上符合正则表达式 r'review:([0-9]+)' 的信息，比如 review:199 表示这次提交的变更对应 ID 为 199 的 review request，当 strict_review 这个 hook 检测到 review request 199 符合预设的条件后，就会放行让变更进入仓库。

其它

最后，如果在使用中有任何问题，请到 http://code.google.com/p/reviewboard-svn-hooks/issues/list 提 issue 告诉我