《基于CodeCollaborator和Reviewboard的代码审工具试用对比说明》由会员分享，可在线阅读，更多相关《基于CodeCollaborator和Reviewboard的代码审工具试用对比说明（20页珍藏版）》请在金锄头文库上搜索。
1、 1 / 20 Code CollaboratorCode Collaborator 和和 Review Review B Boardoard 试用说明试用说明 代码评审(Code Review)是敏捷开发很重要的一环，是保证软件质量的最佳实践之一。要做好代码评审, 就需要有一套简单，高效，功能完善且界面友好的工具，来支持代码审查审查流程。 目前部门还没有采用 Pair Programming 那种时时刻刻都在 review 代码的工作方式，代码 Review 多采用走查方式，即代码写完后召开一个 Code Review 的 Meeting，集中时间和经验丰富的人力对重点代码进行筛查，这种方式
2、的代码 Review 有利，但也有弊。其弊端在于低效和覆盖面小。 做一次走查需要 N 多人参与若干个小时， 而在这段时间里不是每个参与者都能极其高效的参与到走查中的， 实践证明只有少数几个人能真正在一次代码审查会议上起到关键的作用。另外走查一次能覆盖的代码范围又较小，一些看似不重要却很可能带来BUG 的代码在走查会上很容易被遗漏。Code Collaborator 和 Code Review 等工具是对代码审查是一种很好的补充。Code Collaborator 是一款收费工具，目前我部门 ANM2000 专项正在使用，效果较好。当前比较流行的开源 Code Review 工具有 Review
3、 Board、CodeStriker等。 依据我代码审查流程 ，综合分析，备选的两款工具分别是：Code CollaboratorCode Collaborator（代码合作者）和 Review boardReview board（评审委员会） 。在完成两款工具的使用对比后，根据试用的实际情况对两款工具进行比较见下表： n 【基于 Code Collaborator 和 Review board 的代码审工具试用对比表】 两款工具的安装与试用说明见： n 附件一： 基于 ReivewBoard 的代码审查平台搭建简要说明 n 附件二： 基于 Code Collaborator 的代码审查平台搭
4、建简要说明 【基于【基于 Code CollaboratorCode Collaborator 和和 Review boardReview board 的代码审的代码审工具试用工具试用对比对比表表】 要要 素素 Code CollaboratorCode Collaborator解决方案解决方案 ReviewBoardReviewBoard 解决方案解决方案 优点优点 缺缺点点 优点优点 缺点缺点 2 / 20 1.1.安安装装 安装简便，不易出错。 支持 Windows、Linux、 Max OS X、Solaris、 BSD 上安装。 收费 软件，故成本高 开源软件， 成本低。 官方推荐在
5、Linux 和 Windows 下安装 ReivewBoard（开源工具）的安装的确有些让人头痛，一堆互相依赖的软件包，版本稍有差异就很可能导致安装运行失败。而且失败的原因还很难得知。目前安装时仍有不稳定现象出现（一般报错有两种： error1: Download error for http:/www.pycrypto.org/files/pycrypto-2.3.tar.gz: error2: Setup script exited with error: Python was built with Visual Studio 2003; extensions must be built
6、with a compiler than can generate compatible binaries. Visual Studio 2003 was not found on this system.If you have Cygwin installed,you can try comiling with MingW32,by passing “-c mingw32“to setup.py.） 安装最后创建出来的站点的时区是默认的美国太平洋时间,而不是北京时间。尝试在站点配置页面修改时区的时候，整个站点就挂了。 2.2.中中文文支支持持 对中文支持较好，试用期间没有发现问题 按照默认的
7、步骤安装和配置后，输入和保存英文均没有问题。但是一旦输入中文，保存后页面显示的都是乱码，甚至某些时候在保存中文数据时 ReivewBoard 还提示错误。 3.3.版版本本控控制制系系统统 支持集成许多版本控制系统,包括SVN， CVS,Clearcase, Visual SourceSafe 、等。 一个叫做“提交审查”的工具被用来和SCM 系统进行连接 （当前支持SVNSVN、CVS、Perforce、Git和 Mercurial等） 3 / 20 4.4.用用户户基基础础界界面面信信息息 1.多个同时评论 2.工作流支持评论/被许多作家在不同时区分开 3.版本控制集成 4.缺陷跟踪与严重
8、程度，类型，分类，清单，和外部的问题跟踪器集成 5.全方面的度量指标，报告和数据出口 6.项目和角色为基础的规则和报告 7.基于 Web 的客户端和命令行跨平台客户端 8.命令行 API 的集成，扩展，自动化，并触发 1.在本地检出的代码的修改。 2.通过公布 diff、 编写描述和选择一些审查者来创建一个审查请求。 3.审查请求中点击“发布”并等待审查者看到它。 4.其他人看了你的审查请求。 5.你根据他们的评论更新了你的代码。 6.你公布了更新后的 diff，以及对他们评论的解答以指明你修改了什么（或者你要说明为什么你不打算按照他们的建议修改代码）。 7.大家看了你更新后的代码，并请你继续
9、。 8.你将修改提交到仓库中。 9.你在审查请求中点击“设置为已提交”来从其他人的面板中移除你的审查请求。 5.5.实实时时问问题题沟沟通通 基于 Web 的即时“聊天”界面。 基于 Web 的即时“聊天”界面。 4 / 20 6.6.审审查查对对象象 不仅仅是文本文件，还可以是图片、HTML、WIKI网页、文件托管在 Intranet 或基于 Web 的文档管理系统。（测试用例也可以评） 仅是文本文件 7.7.度度量量 自动收集在审查花费时间、缺陷数据 （缺陷密度，和缺陷数） ， 可定制输出审计报告 有数据统计，但不可定制 8.8.邮邮件件 无问题 ReivewBoard 的 Mail 通知
10、设置问题，公司采用 SSL 协议加密 Mail, ReivewBoard 仅支持 TSL，在网上查了一下这两个协议应该是兼容的，但是设置后就是无法将 Mail 发送出去。 9.9.可可定定制制的的工工作作流流程程 可 配 置 不 同 类型的审查规则。“ 自 我 检 查 ”审 查 可 能 只 要求 看 在 他 提 交自 己 的 文 件 。 “ 正 式 的 ” 审查 可 能 需 要 一个主持人，作家及多个审查者，并记录。可配置的 角 色 让 你 可以 注 明 每 个 人不可定制工作流程 5 / 20 的 期 望 检 查 和控 制 每 个 用 户可 以 做 什 么 和发表评论。每个用 户 在 流 程
11、 控制 允 许 标 记 评论，也可以选择哪 些 事 件 将 重新 审 查 或 审 查相关通知更新。 10.10.数数据据库库支支持持 支 持 微 软 SQL Serve 和 Oracle数据库等。 支持三种数据库服务器：MySQL、PostgreSQL 、SQLite 11.11.其其 它它 中文的学习资料还比较少 中文的学习资料较少； 如果有代码是在 Unix GBK 环境下开发的，所有源代码文件都是以 GBK编码格式存储。一旦提交了这些源文件的 diff,在 ReivewBoard 中“View Diff”时看到的中文将全是乱码，更严重的是某些时候ReivewBoard 显示的代码差异的位
12、置与真实代码修改的位置不符合。 6 / 20 附件一：附件一：基于基于 ReivewBoardReivewBoard 的的代码审查平台搭建代码审查平台搭建简要简要说明说明 1. Review Board1. Review Board 简介简介 Review Board（简称 RB）起源于 VMware 的一些开发者，是基于 Django 的网络应用，界面友好，功能也非常强大，包含一套完整的 Review 流程，支持现在几种流行的 SCM 工具和数据库。令人高兴的是它提供了在 diffs 里进行语法彩色编码，使得代码阅读变得简便。此外，它还实现了基于 Lucene 的搜索来帮助管理较大的 dif
13、fs 组。 2. 2. 服务器安装服务器安装 RB 可以安装在多种平台。本文是在 WinXP SP3 上安装，其他平台请参考其他文档。 7 / 20 需要先安装 PytPython 2.5hon 2.5 和 Apache Http Server 2.2Apache Http Server 2.2，安装完成后，必须要先保证“C:Python25;C:Python25Scripts”在你的环境变量里 。其他软件（针对 Python2.5）我已打包，见附件安装包。 1 1）安装和 Python 相关的一些工具 在软件包中，安装 mod_python，PIL，setuptools。这几个都是双击之后，
14、一路 NEXT即可。 2 2）安装 memcached for windows（在软件包中） 先使用命令行 memcached.exe -d install 安装服务，再去 WinXP 服务管理界面启动该服务。然后用命令行 easy_install python-memcached 安装 python-memcached. (NOTE: 最近发现 easy_install 也被墙了，所以用 easy_install 时可能有点问题。如果是那样，请找个代理，然后设置 HTTP_PROXY 环境变量翻墙） 。 3 3）安装数据库 RB 支持三种数据库服务器：MySQL、PostgreSQL 、SQ
15、Lite 。 4 4）安装 GNU patch（在软件包中） 它的安装也是一路 NEXT。安装完成之后，把它 EXE 所在的路径放到 PATH 里。 5 5）安装 SVN 安装 SVN，建立 SVN 仓库，创建用户名和密码。 6 6）安装 RB RB 团队已经把它放到 easy_install 的源里了，所以可以用 easy_install ReviewBoard 安装， 该装的都完成了，下一站就是建站。 3. 3. 建站建站 在命令行中打一句命令：rb-site install “站名“ 之后，它会问你一会问题，比如用什么数据库，什么 Http Server, 请按之前的安装回答。还会让你输
16、入管理员密码之类的。 命令完成之后，会在当前工作路径下成一个的站名一样的目录。请到里面找到confapache-modpython.txt，这里面是一段 apache server 配置的片断,请把这片断复制到真正的 httpd.conf 里。 8 / 20 4. RB4. RB 中添加中添加 RepositoryRepository 在建站完成后，你应该可以访问到 RBweb 页面。 添加 Repository, 需要用 admin 用户。然后是 Perforce 的配置。 首先有你在建站时用的 admin 用户登录， 然后就会进入到 Admin 的页面 （最上面有一个 Admin的链接） 。 9 / 20 10 / 20 点击 Repositories 进入到 SCM 的配置页面。然后“Add Repository“, 输入 Perforce 的相关参数。 保存之后，Perforce 就配置完成了。 RB 的 Admin 页面做得还算友好，
