sonarqube+jenkins 构建代码质量管理平台

本文基于已经构建好的jenkins自动化平台，添加sonarqube质量检测平台，本文主要展现sonar环境安装以及接入jenkins的操做（同一台机器）

jenkins自动化平台搭建，请参考链接文章，http://www.javashuo.com/article/p-blsfnbqm-eb.html

sonarqube介绍

SonarQube是一个开源平台, 用于管理源代码的质量，它不只是一个质量数据报告工具，更是代码质量管理平台。 
它经过插件的形式来管理代码，它支持的语言包括：Java，PHP，C#，C，Python等多种开发语言。
七个维度来检测代码质量
1.代码标准
经过PMD，CheckStyle，Findbugs等代码规则检测工具规范代码的编写；
2.潜在的缺陷
经过PMD，CheckStyle，Findbugs等代码规则检测工具检测出潜在的缺陷；
3.代码复杂度分布
文件、类、方法等，若是复杂度太高将难以改变，这使得开发热女难以理解它们，且若是没有自动化的单元测试， 
对于程序中的任何组件的改变都将可能致使须要全面的回归测试；
4.重复
显然程序中包含大量复制粘贴的代码质量低下的，sonar能够展现源码中重复严重的地方；
5.注释不足或者过多
没有注释将使代码可读性变差，特别是当不可避免地出现人员变更时，程序的可读性将大幅度降低；
6.单元测试
sonar能够很方便地统计并展现单元测试覆盖率；
7.架构规则
经过SonarQube能够找出循环，展现包与包、类与类之间的相互依赖关系，能够展现自定义的架构规则。 
经过SonarQube能够管理第三方的jar包，能够利用LCOM4检测单个任务规则的应用秦高，检测耦合。

------------------------------

            系统及应用环境

------------------------------

系统环境

[root@localhost jenkins]# cat /etc/redhat-release 
CentOS Linux release 7.2.1511 (Core) 

修改内核参数
vim /etc/sysctl.conf    增长修改如下参数
vm.max_map_count=262144fs.file-max=65536

sysctl -p 配置生效

修改系统资源限制
vim /etc/security/limits.conf ，在末尾添加以下
sonarqube   -   nofile   65536
sonarqube   -   nproc    2048

jenkins git maven环境

[root@localhost jenkins]# git --version
git version 1.8.3.1

[root@localhost jenkins]# mvn -v
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-11T00:41:47+08:00)
Maven home: /usr/local/apache-maven-3.3.9
Java version: 1.8.0_201, vendor: Oracle Corporation
Java home: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.201.b09-2.el7_6.x86_64/jre
Default locale: zh_CN, platform encoding: UTF-8
OS name: "linux", version: "3.10.0-327.el7.x86_64", arch: "amd64", family: "unix"

[root@localhost ~]# rpm -qa|grep jenkins
jenkins-2.171-1.1.noarch

java环境（sonar必须）

[root@localhost jenkins]# java -version
openjdk version "1.8.0_201"
OpenJDK Runtime Environment (build 1.8.0_201-b09)
OpenJDK 64-Bit Server VM (build 25.201-b09, mixed mode)

若是没有java环境，则执行下面命令安装
yum install java-1.8.0-openjdk.x86_64 -y
yum install java-1.8.0-openjdk*-y

mysql环境（sonar必须mysql5.6以上）

[root@localhost ~]# mysql --version
mysql  Ver 14.14 Distrib 5.6.43, for Linux (x86_64) using  EditLine wrapper

mysql环境安装
cd /home
yum -y install autoconf
wget https://cdn.mysql.com//Downloads/MySQL-5.6/MySQL-5.6.41-1.el7.x86_64.rpm-bundle.tar
tar -xvf MySQL-5.6.43-1.el7.x86_64.rpm-bundle.tar
yum install ./*.rpm
systemctl start mysql  此时启动后 mysql自动生成了root密码，没法登录的
systemctl stop mysql  先中止
mysqld_safe --user=mysql --skip-grant-tables --skip-networking &  免密码方式启动
mysql> use mysql;
mysql> UPDATE user SET Password=PASSWORD('root') where USER='root';  不执行flush privileges 退出
systemctl restart mysql 启动
mysql -uroot -proot
mysql> use mysql;
mysql> select host,user,password from user;
mysql> update user set password=password('123456') where user='root';
mysql> update user set host='%' where user='root' and host='localhost';
mysql> flush privileges;
mysql> exit
而后就能够用root 123456登录了

建立sonar数据库与链接账号

mysql -uroot -p123456
CREATE DATABASE sonarqube_db CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT ALL ON sonarqube_db.* TO 'sonarqube_user'@'localhost' IDENTIFIED BY '12345678';
FLUSH PRIVILEGES;

下载与部署SonarQube

cd /usr/local/

wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-6.7.6.zip

unzip sonarqube-6.7.6.zip

mv sonarqube-6.7.6 sonarqube

vim /etc/profile  增长环境变量

SONAR_HOME=/usr/local/sonarqube
export SONAR_HOME
source /etc/profile  执行生效

建立用户组

groupadd sonarqube

useradd sonarqube -g sonarqube -p sonarqube

chown -R sonarqube.sonarqube /usr/local/sonarqube/

修改sonar配置文件

vim /usr/local/sonarqube/conf/sonar.properties

sonar.jdbc.username=sonarqube_user
sonar.jdbc.password=123456
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonarqube_db?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.web.host=0.0.0.0
sonar.web.port=9000

增长服务启动脚本

vim /etc/init.d/sonar

#!/bin/sh
#
# rc file for SonarQube
#
# chkconfig: 345 96 10
# description: SonarQube system (www.linuxhub.org)
#
### BEGIN INIT INFO
# Provides: sonar
# Required-Start: $network
# Required-Stop: $network
# Default-Start: 3 4 5
# Default-Stop: 0 1 2 6
# Short-Description: SonarQube system (www.linuxhub.org)
# Description: SonarQube system (www.linuxhub.org)
### END INIT INFO
su sonarqube -lc "/usr/local/sonarqube/bin/linux-x86-64/sonar.sh $*"

chmod 755 /etc/init.d/sonar   增长执行权限

/etc/init.d/sonar start       启动sonar   （必须是普通用户才能启动sonar，脚本中是sonarqube）

/etc/init.d/sonar stop      中止sonar

查看进程

[root@localhost ~]# netstat -lnupt |grep java
tcp        0      0 127.0.0.1:32000         0.0.0.0:*               LISTEN      33214/java          
tcp6       0      0 :::9000                 :::*                    LISTEN      33669/java              
tcp6       0      0 127.0.0.1:9001          :::*                    LISTEN      33587/java                  
tcp6       0      0 127.0.0.1:32857         :::*                    LISTEN      33721/java

浏览器访问

192.168.0.88:9000

默认帐号密码 admin：admin 登录后配置安装中文插件包

sonarqube基本安装完成，下面须要安装sonar-scanner

-------------------------------------------------

下载安装sonar-scanner

cd /usr/local/

wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.3.0.1492-linux.zip

unzip sonar-scanner-cli-3.3.0.1492-linux.zip

mv sonar-scanner-3.3.0.1492-linux sonar-scanner

修改配置文件

vim /usr/local/sonar-scanner/conf/sonar-scanner.properties

sonar.host.url=http://localhost:9000
sonar.sourceEncoding=UTF-8

添加环境变量

export SONARRUNNER_HOME=/usr/local/sonar-scanner
export PATH=$SONARRUNNER_HOME/bin:$PATH

source /etc/profile

查看版本信息  sonar-scanner -v

[root@localhost ~]# sonar-scanner -v
INFO: Scanner configuration file: /usr/local/sonar-scanner/conf/sonar-scanner.properties
INFO: Project root configuration file: NONE
INFO: SonarQube Scanner 3.3.0.1492
INFO: Java 1.8.0_121 Oracle Corporation (64-bit)
INFO: Linux 3.10.0-327.el7.x86_64 amd64

登录sonar界面调整配置

生成令牌，jenkins配置中要用

关闭SCM --保存

jenkins界面集成sonar

安装sonar相关插件

安装后重启生效

而后系统管理--系统设置--配置sonarqube

系统管理---全局工具配置--sonar-scanner

而后调整项目的配置，增长sonarqube-scanner

配置

#key和name保持一致且在sonar下惟一
sonar.projectKey=$JOB_NAME
sonar.projectName=$JOB_NAME
#工程版本
sonar.projectVersion=1.0  
#源代码目录
sonar.sources=$WORKSPACE
#分析的语言 
sonar.language=java
#编码sonar.sourceEncoding=UTF-8
sonar.java.binaries=$WORKSPACE

而后执行构建，第一次构建时间比较长

查看sonar报告

可参考文章：http://www.cnblogs.com/sunyllove/p/9857462.html
https://blog.51cto.com/yanconggod/2096583
http://www.fblinux.com/?p=1155