天天看点

代码审查工具Sonar(一)-- 简介与安装

代码审查是持续集成理论里重要的一部分。审查软件和测试软件之间存在着微妙的差别。测试是动态的,它执行软件,目的是测试软件的功能。审查则基于一组预先定义的规则分析代码。审查也不同于编译。编译是从语法的角度来检查代码,审查则是从语法以外的角度着手,例如,编码风格,编码规范,重码率,复杂度,代码注释率等等。众所周知,编译正确的代码不一定就没有问题,那么除了测试人员从运行整个软件的角度来排查功能点,从源代码分析的角度找到潜在的问题点也是一项重要的补充工作。Sonar(也叫SonarQube)就是一款优秀的代码审查工具。其官网地址:http://www.sonarqube.org/

下图展示的是Sonar的架构。

代码审查工具Sonar(一)-- 简介与安装

最上面一层代表输入,也就是我们要检查的源代码。这些源代码可以是Java代码, Cobol代码,C#代码等。目前Sonar支持对20多种语言的源代码的检查。

中间一层有两部分,右边绿色方框标记的"Eclipse"是指Sonar针对Eclipse的插件,方便用户在Eclipse里直接进行与Sonar相关的操作。这部分不在本文的讨论范围之内。

中间层的左边是Analysers,指的是进行代码分析的程序,统称为plugin。这些程序既包括Sonar自己提供的分析程序,也包括第三方的分析程序,例如,针对C++代码,有Sonar的程序检查代码行数,重码率,注释率,也有做静态检查的第三方工具cppcheck,做运行时内存检测的Valgrind,做风格检查的Vera++,以及做安全性检查的RATS等。所有这些工具将检查结果生成xml格式的report,由sonar程序读取到数据库中,也就是第三层左边的database。

在第三层,Sonar的web应用程序读取database里的代码检查结果,并以丰富的图像界面形式呈现在用户面前。Sonar有相当数量的plugin是与界面效果相关的。

通过Sonar进行一次代码审查的过程就是从第一层开始,沿着箭头一直行进到Server呈现部分结束的工作流程。

下面介绍Sonar server的安装:

1. 安装database

Sonar自带一个简易的database,如果是想真正将Sonar投入项目使用,而不是实验性的在本地操作一下,最好安装专门的数据库。我们选择的是免费的mysql版本。http://dev.mysql.com/downloads/mysql/

在安装目录/bin/windowsxxxxx下运行:mysqld --install 将mysql安装为windows service,在service列表里start mysql service。

运行:mysql -u root,进入mysql client

运行下面的命令行创建database sonar并创建用户sonar,密码sonar

create user 'sonar'@'localhost' identified by 'sonar';

create database sonar;

grant all privileges on *.* to 'sonar'@'localhost';

2. 安装Sonar server

需要先安装JDK6或7

然后下载并解压Sonar包即可。http://www.sonarqube.org/downloads/ 选择download最新的SonarQube。

3. 修改配置文件

<install_directory>/conf/sonar.properties,重点打开注释(删除行首的#符号)并修改下面几个部分:

a. web settings->sonar.web.host/port/context

b. sonar.jdbc.url,因为我安装的是mysql,所以将原本打开的h2行注释掉,将mysql的部分打开。

<install_directory>/conf/wrapper.conf, 因为安装的是JDK,将wrapper.java.additional.4=-server行首的注释符号 # 删掉

4. 运行<install_directory>/bin下的InstallNTService.bat可以将sonar安装为windows service,如果开启service有任何问题,应该在命令行窗口中手工运行StartSonar.bat来查看问题点,并参考<install_directory>/logs里的日志文件。

5. 安装analyser,这个要根据语言来选择。详情可参见http://docs.codehaus.org/display/SONAR/Languages

例如:C#代码推荐sonar runner,而C++代码推荐maven。因为笔者要分析的是C#代码,因此下面介绍sonar runner的安装方法。

a. 登录sonar,缺省的管理员账号是admin/admin,选择Update Center->Available Plugins->C#和.NET

代码审查工具Sonar(一)-- 简介与安装

b.安装C#代码的第三方分析器,安装列表详见http://docs.codehaus.org/display/SONAR/C%23+Ecosystem+Installation+Guide

c. 安装sonar runner。http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.3/sonar-runner-dist-2.3.zip

d. 创建环境变量SONAR_RUNNER_HOME用来指向sonar runner的安装目录。把<install_directory>/bin加到环境变量path中去。

e. 修改sonar runner安装目录下的配置文件<install_directory>/conf/sonar-runner.properties,删除对应database行首的#,在本例中是mysql行。打开sonar.host.url行的注释。

f. 如果能在cmd窗口中正确运行sonar-runner -h则表示sonar-runner安装配置成功。

继续阅读