【Linux运维入门】Linux环境安装SonarQube和SonarQube Runner

SonarQube简介

Sonar 是一个用于代码质量管理的开放平台。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具。比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。同时 Sonar 还对大量的持续集成工具提供了接口支持，可以很方便地在持续集成中使用 Sonar。

此外，Sonar 的插件还可以对 Java 以外的其他编程语言（支持的语言包括：Java、PHP、C#、C、Cobol、PL/SQL、Flex等）提供支持，对国际化以及报告文档化也有良好的支持。可以说Sonar是目前最强大的代码质量管理工具之一。

下面就来揭开Sonar的神秘面纱，看看如何在Linux环境上安装Sonar。

1.安装环境

系统环境：centos7.0 -x86_64（最小化安装）
前置条件：jdk1.8 , mysql-5.1.57
软件下载目录：/storage/software
软件安装目录：/usr/local/sonarqube
软件版本：sonarqube-5.2，sonar-runner-dist-2.4
下载地址：http://www.sonarqube.org/downloads/

2.预置条件

2.1 需要JDK1.6+支持；（如何安装见【Linux运维入门】Linux环境安装配置JDK）

2.2 需要Mysql数据库支持；（虽然SonarQube自带了H2数据库，但是为了方便管理数据推荐使用Mysql数据库，如何安装见：【Linux运维入门】Linux环境编译安装、配置Mysql）

JDK是必须安装的，Mysql数据库并不是必须要安装的，如果公司有Mysql服务器，直接拿来使用就行，但是需要更改mysql的默认引擎为INNODB，否则会报错。下一篇博客讲解如何解决这些错误。

3.安装

在安装之前，介绍一下SonarQube和SonarQube Runner之间的关系。
SonarQube是服务器端，它主要有两个功能：1.分析源代码；2.因为它内嵌了Apache模块，所以提供Web端的界面访问。

SonarQube Runner是一个利用SonarQube服务端分析代码的命令行工具，可以把它简单理解为客户端。

所以，为了安装和调试方便，建议SonarQube和SonarQube Runner都下载。

3.1 安装SonarQube

第一步：将下载的sonarqube-5.2.zip解压后移动到/usr/local目录下。具体步骤如下：

[root@master ~]# cd /storage/software/
[root@master software]# unzip sonarqube-5.2.zip 
[root@master software]# mv sonarqube-5.2  /usr/local/sonarqube

第二步：配置环境变量

[root@master ~]# vi + /etc/profile

添加

SONAR_HOME=/usr/local/sonarqube
export SONAR_HOME

保存退出并使配置生效

[root@master ~]# source /etc/profile

第三步：配置sonar.properties

[root@master ~]# vi /usr/local/sonarqube/conf/sonar.properties

打开后，修改

#----- MySQL 5.x
# Only InnoDB storage engine is supported (not myISAM).
# Only the bundled driver is supported. It can not be changed.
sonar.jdbc.url=jdbc:mysql://192.168.22.220:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.username=root
sonar.jdbc.password=123456
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

第四步：启动服务

[root@master ~]# /usr/local/sonarqube/bin/linux-x86-64/sonar.sh start

另外，启动/停止/重启命令如下：

#./sonar.sh start   启动服务 
#./sonar.sh stop    停止服务 
#./sonar.sh restart 重启服务

第四步：访问SonarQube Web管理界面。如果能够看到sonar主页证明SonarQube安装成功啦。但是我安装的时候并没有这么顺利，遇到的错误下篇博客讲解。

3.2 安装SonarQube Runner

第一步：将下载的sonar-runner-dist-2.4.zip解压后放到/usr/local目录下。具体步骤如下：

[root@master ~]# cd /storage/software/
[root@master opt]# unzip sonar-runner-dist-2.4.zip
[root@master opt]# mv sonar-runner-2.4/ /usr/local/ 

第二步：配置环境变量

[root@master ~]# vi + /etc/profile

#添加
SONAR_RUNNER_HOME=/usr/local/sonar-runner-2.4/
PATH=.:$SONAR_RUNNER_HOME/bin 
export SONAR_RUNNER_HOME

保存并退出

[root@master ~]# source /etc/profile

第三步：配置sonar-runner.properties

[root@master conf]# vi /usr/local/sonar-runner/conf/sonar-runner.properties

#修改
sonar.jdbc.url=jdbc:mysql://192.168.22.220:3306/sonar?useUnicode=true&;characterEncoding=utf8
sonar.jdbc.username=root
sonar.jdbc.password=123456
sonar.login=admin
sonar.password=admin

第四步：运行sonar-runner分析源代码

Sonar官方已经提供了非常全的代码样例便于新手入门用。

下载地址：https://github.com/SonarSource/sonar-examples/archive/master.zip

下载后使用unzip解压。执行sonar-runner命令即可。操作命令如下：

[root@master software]# wget -c https://github.com/SonarSource/sonar-examples/archive/master.zip
[root@master software]# unzip sonar-examples-master.zip
[root@master software]# mv sonar-examples-master /usr/local/sonar-examples
[root@master software]#cd /usr/local/sonar-examples/projects/languages/java/sonar-runner/java-sonar-runner-simple
[root@master java-sonar-runner-simple]# /usr/local/sonar-runner/bin/sonar-runner

如果能够看到下面的输出信息，证明你的SonarQube Runner安装并配置正确啦。

INFO: ------------------------------------------------------------------------
INFO: EXECUTION SUCCESS
INFO: ------------------------------------------------------------------------
Total time: 2:59.167s
Final Memory: 17M/204M
INFO: ------------------------------------------------------------------------

第五步：看看SonarQube的Web界面，是否已经可以看到分析的结果啦。

SonarQube默认是没有安装中文语言包的。需要安装的话，进入SonarQube插件目录，下载语言包即可。步骤如下：

root@master ~]# cd /usr/local/sonarqube/extensions/plugins
[root@master plugins]# wget -c http://repo1.maven.org/maven2/org/codehaus/sonar-plugins/l10n/sonar-l10n-zh-plugin/1.8/sonar-l10n-zh-plugin-1.8.jar

下载完成后重启sonar即可看到中文界面，当然也可以将下载好的插件直接上传到该目录。

PS：最新版本的语言包是sonar-l10n-zh-plugin-1.8.jar

这是中文语言包的下载地址：https://github.com/SonarCommunity/sonar-l10n-zh

小结

作为代码质量管理平台，通过插件机制，Sonar可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins等等。以前使用这些工具的时候都是单个安装，并且相互之间独立。而Sonar就是测试工具的集大成者，将这些独立的工具整合到一起，一统江湖，使其共同提供服务。从而使我们可以方便地对不同规模和种类的工程进行代码质量管理。