sonar+Jenkins 构建代码质量自动化分析平台

1.Sonar 介绍

Sonar 是一个用于管理代码质量的开源工具，能够分析代码中的bug和漏洞以及Code Smells，支持20多种编程语言的检测，如java，c/c++，python，php等语言，当前有超过85000家组织在使用sonar。Sonar能够与DevOps工具链彻底整合，能够与大多数构建工具进行内置集成，与Jenkins，TFS / VSTS，TeamCity，Bamboo等持续整合引擎轻松集成，支持众多源代码管理配置工具，如git，svn，cvs等。

官方地址：https://www.sonarqube.org/

早在2007年，当建立第一行代码时，Sonar的创始人就梦想有一天可以为每一个开发人员提供测量其项目代码质量的能力。他的座右铭：“持续检测必须成为持续整合的主流”。

本文的目的就是安装一个sonar，并集成到Jenkins中，实现代码的一个持续质量监测。

2.Sonar 安装

2.1.安装环境介绍

注意：sonar服务器至少须要2G的内存才能有效运行，而操做系统则须要1GB的可用内存。

• Centos 7.2
• 安装JDK 1.8
• 安装Jenkins 2.89
• 安装 maven 3.5.2（非必需，用于编译一些插件）
• 安装mysql 5.6 数据库 （要求版本，不低于5.6）

安装完mysql后建立sonar数据库和帐号，方式以下：

CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT ALL PRIVILEGES ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY '123456' WITH GRANT OPTION;
FLUSH PRIVILEGES;

2.2.SonarQube安装

cd /data/package/
wget https://sonarsource.bintray.com/Distribution/sonarqube/sonarqube-6.6.zip
mkdir /data/service/sonar/
unzip sonarqube-6.6.zip -d /data/service/sonar/

配置启动脚本：

[root@c7-node1 ~]# cat /etc/init.d/sonar
#!/bin/sh
#
# rc file for SonarQube
#
# chkconfig: 345 96 10
# description: SonarQube system (www.sonarsource.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.sonarsource.org)
# Description: SonarQube system (www.sonarsource.org)
### END INIT INFO
/usr/bin/sonar $*

受权启动脚本执行权限，并配置路径

chmod +x /etc/init.d/sonar
ln -s /data/service/sonar/sonarqube-6.6/bin/linux-x86-64/sonar.sh /usr/bin/sonar
chkconfig sonar on

修改配置文件

[root@c7-node1 ~]# cd /data/service/sonar/sonarqube-6.6/conf/
[root@c7-node1 conf]# cp sonar.properties{,.bak}
sonar.jdbc.username=sonar
sonar.jdbc.password=123456
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false

2.3.sonarQube Scanner 安装

cd /data/package/
wget https://sonarsource.bintray.com/Distribution/sonar-scanner-cli/sonar-scanner-2.8.zip
unzip sonar-scanner-2.8.zip -d /data/service/sonar/
ln -s /data/service/sonar/sonar-scanner-2.8/bin/sonar-scanner /usr/bin/sonar-scanner

修改配置文件

[root@c7-node1 ~]# cd /data/service/sonar/sonar-scanner-2.8/conf/
[root@c7-node1 conf]# cp sonar-scanner.properties{,.bak}
[root@c7-node1 conf]# vim sonar-scanner.propertiessonar.jdbc.username=sonarsonar.jdbc.password=123456sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8

2.4.sonarQube runner 安装

cd /data/service/
wget http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip
unzip sonar-runner-dist-2.4.zip -d /data/service/sonar/
ln -s /data/service/sonar/sonar-runner-2.4/bin/sonar-runner /usr/bin/sonar-runner

修改配置文件

[root@c7-node1 ~]# cd /data/service/sonar/sonar-runner-2.4/conf/
[root@c7-node1 conf]# cp sonar-runner.properties{,.bak}
[root@c7-node1 conf]# vim sonar-runner.propertiessonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8sonar.jdbc.username=sonarsonar.jdbc.password=123456

添加环境变量

[root@c7-node1 ~]# vim /etc/profile.d/sonar.sh
export SONAR_HOME=/data/service/sonar/sonarqube-6.6
export SONAR_RUNNER_HOME=/data/service/sonar/sonar-runner-2.4
export PATH=$SONAR_RUNNER_HOME/bin:$PATH
[root@c7-node1 ~]# source /etc/profile.d/sonar.sh

2.5.启动sonar

注意：sonar默认不容许使用root用户启动，因此咱们须要建立sonar用户，并以sonar用户启动

[root@c7-node1 ~]# useradd sonar
[root@c7-node1 ~]# chown -R sonar:sonar /data/service/sonar/
[root@c7-node1 ~]# su sonar
[sonar@c7-node1 root]$ /etc/init.d/sonar start

sonar启动成功后，访问服务器的9000端口便可打开sonar的web界面，默认帐号和密码为admin:admin注意：sonar默认不容许使用root用户启动，因此咱们须要建立sonar用户，并以sonar用户启动。

出现以下页面说明sonar安装成功，若是sonar安装失败，则根据日志报错内容进行排查便可。

3.Sonar 插件使用及汉化

Sonar能够经过安装插件的方式来扩展本身的功能，具体信息能够访问sonar的插件库，里面提供了众多代码分析插件，认证受权插件，外部分析插件，语言插件，可视化／报告插件等。下面咱们就经过安装sonar等中文插件来演示sonar插件的安装。

sonar的插件库：https://docs.sonarqube.org/display/PLUG/Plugin+Library

3.1.后台安装中文插件

登录sonar后，在Administration–>System–>Update Center–>Available中搜索Chinese就能够看到中文插件包，点击install便可安装。可是安装时间很是慢，甚至还会失败，建议仍是手动安装。

3.2.手动安装插件

中文插件github地址：https://github.com/SonarQubeCommunity/sonar-l10n-zh

咱们把中文插件源码下载到咱们本地，而且切换到相应的版本（我安装的sonar6.6版本，须要切换到1.18tag），进行编译

git clone https://github.com/SonarQubeCommunity/sonar-l10n-zh.git
cd sonar-l10n-zh/
git checkout sonar-l10n-zh-plugin-1.18
mvn package
cp target/sonar-l10n-zh-plugin-1.18-SNAPSHOT.jar /data/service/sonar/sonarqube-6.6/extensions/plugins/

复制中文插件到sonar插件目录后，重启sonar生效

重启sonar后，访问web验证效果，能够看到汉化成功了

这样咱们的中文插件就完成安装了，若是须要安装其它的插件，能够直接访问官方插件库进行寻找安装。

4.Sonar 分析Python代码小例

Sonar 安装汉化完成就能够用来实际的分析代码了，我准备了一个分析python代码的小例子用来演示sonar分析代码过程。

例：个人python项目是使用3.0版本开发，可是使用了2.0的语法，咱们试试sonar能不能分析出来（sonar内置了python 3.0分析插件，咱们无须额外安装）。演示脚本就一个，功能为发送邮件，其中的print为2.0语法，在3.0环境下是没法正常运行的，咱们经过分析这个脚本，来演示sonar的分析代码过程。

[sonar@c7-node1 ~]$ cat python_test/sendEmail.py
#!/usr/bin/python
# -*- coding: UTF-8 -*-

import sys
import smtplib
from email.mime.text import MIMEText
from email.header import Header

# 第三方 SMTP 服务
mail_host="xxx" #设置服务器
mail_user="xxx" #用户名
mail_pass="xxx" #口令


sender = 'bigdata_monitor@xueleyun.com'
receivers = sys.argv[1]

content=sys.argv[3]
message = MIMEText(content, 'plain', 'utf-8')

message['From'] = Header(sender, 'utf-8')
message['To'] = Header(receivers, 'utf-8')

subject = sys.argv[2]
message['Subject'] = Header(subject, 'utf-8')


try:
smtpObj = smtplib.SMTP()
smtpObj.connect(mail_host, 25) # 25 为 SMTP 端口号
smtpObj.login(mail_user,mail_pass)
smtpObj.sendmail(sender, receivers, message.as_string())
print "邮件发送成功"
except smtplib.SMTPException:
print "Error: 没法发送邮件"

在项目根目录下建立一个配置文件sonar-project.properties，项目若是在sonar中没有建立，首次分析会自动根据填入到配置文件的名称和key自动建立

[sonar@c7-node1 ~]$ cat python_test/sonar-project.properties
sonar.projectKey=python_test
sonar.projectName=python_test
sonar.projectVersion=1.0
sonar.sources=.
sonar.sourceEncoding=UTF-8

在项目根目录下运行下面的命令启动分析

sonar-scanner

扫描完成以后，咱们再次打开web页面就能够看到，咱们的sonar根据配置文件填入的内容自动建立了python_test的项目，而且分析出来了两个bug

点击项目名称，能够进入到项目，查看项目的详细分析信息

点击bugs，能够看到具体的bug信息，咱们能够看到bug的信息为python print语句有问题

sonar不只能够找到bug，并且还会告诉咱们咱们这样为何错误，还会给出正确示例子；

查看bug具体信息：说print语句在python3.0中被删除。应该使用内置函数，而且给出了正确实例。

5.Sonar 集成Jenkins使用

5.1.设置sonar中的令牌

用 admin 用户登录 sonarQube，【配置】–>【权限】 –>【用户】

5.2.Jenkins 安装sonar相关插件

安装红框中的两个插件便可

5.3.Jenkins配置sonar插件

点击【系统管理】 –> 【系统设置】 配置 Sonar认证信息，设置完保存

点击【系统管理】 –> 【全局工具配置】，配置sonar扫描器信息

5.4.Jenkins job 中配置sonar

为了操做方便我这里就不把刚才的代码放到git中进行拉取了，并且直接配置工做目录为刚才的python_test目录，生产环境你能够根据公司实际状况，选择是从svn或者git获取须要分析的代码

增长一个构建步骤，选择Execute SonarQube Scanner，选择一个用于分析的jdk，并填入Analysis properties为刚才手动扫描的sonar-project.properties配置文件便可

这样咱们Jenkins中sonar的部分就配置完了，咱们能够保存job进行构建，构建完成，能够经过构建历史，直接跳转到sonar到分析页面，以下图所示，并附Jenkins job 完整内容及构建视频。

6.后记

本文到这里就结束了，虽然sonar的一些内容，好比项目管理，安全，监控，邮件通知等内容文章中并无说起，但我认为汉化后的sonar管理仍是比较方便易操做的，这里你们能够本身登陆到后台进行摸索。

还有就是sonar+Jenkins的这个job并非很全面，缺乏代码自动获取和发布的配置，可是sonar的配置仍是正确的，你只须要把他加入到你代码获取后的第一个操做，或者编译以前的操做都可。