持续集成实践二之Jenkins与Sonar Qube集成

时间 2019-12-12

原文原文链接

前言

做为一名码农，曾几什么时候，无数次挑灯夜战，只为次日为客户稳定演示系统，奈何到关键时候，会发现代码中会有不少坑，这个时候，每每是最使人崩溃的。如何能作到提早发现程序潜在的问题，找到隐藏的八阿哥，保证系统的稳定，一直是困扰着咱们的问题。记得之前为了解决这个问题，部门专门组织每周一次代码走查，虽然最后状况有所改善，但费事费力，并未获得根本上的解决。html

所幸的是，有些大牛开发出了一系列代码质量检测工具，给咱们这些码农带来了福音。下面就来介绍一款开源的代码质量管理系统——SonarQube。相信经过下面简单的介绍，你会跟我同样有种相见恨晚的感受。mysql

Sonar Qube简介

SonarQube（曾用名Sonar（声纳））是一个开源的代码质量管理系统。它支持C/C++、JavaScript、C#、Java、COBOL、TypeScript、PL/SQL、PL/I、PHP、FLEX、Python、Swift、XML等超过20种编程语言的检测。Sonar能够经过插件Findbugs、Checkstyle等工具持续对代码进行检测，可使咱们尽早发现项目中的Bugs，漏洞及坏味道，从而保证软件产品质量。git

环境准备

操做系统：Windows10github
Java环境：下载 jdk-1.8.0-131-X64.zip，配置Java环境变量（参考：http://jingyan.baidu.com/article/02027811629b941bcc9ce521.html）sql

Maven环境：下载apache-maven-3.5.2-bin.zip，配置Maven环境变量（参考：http://wiki.jikexueyuan.com/project/maven/environment-setup.html）数据库
Jenkins安装及配置，请参考上一篇文章，连接：https://my.oschina.net/lsjcoder/blog/1573648。apache
数据库：mysql-5.6.23-winx64编程

Sonar 安装

SonarQube下载。首先，到Sonar官网https://www.sonarqube.org/downloads/）下载安装包，目前最新版本为SonarQube 6.7 (LTS *)。将SonarQube解压到本地任意目录。windows
配置Sonar数据库。Sonar默认使用的是H2的内嵌数据库，内嵌数据库只能用户测试场景，本例中使用mysql数据库，具体配置方法以下：浏览器

在mysql中建立sonar数据库，以用户名root，密码admin为例。打开...\sonarqube-6.6\conf文件夹，找到sonar.properties文件，修改如下几个地方：

配置数据库用户名及密码：

#sonar.properties

sonar.jdbc.username=root
sonar.jdbc.password=admin

设置数据库库链接：

#sonar.properties
 
 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
 sonar.jdbc.driverClassName:com.mysql.jdbc.Driver
 sonar.jdbc.validationQuery:select 1

设置链接池：

#sonar.properties

 sonar.jdbc.maxActive:                               20
 sonar.jdbc.maxIdle:                                 5
 sonar.jdbc.minIdle:                                 2
 sonar.jdbc.maxWait:                                 5000
 sonar.jdbc.minEvictableIdleTimeMillis:      600000
 sonar.jdbc.timeBetweenEvictionRunsMillis:  30000

启动Sonar。

启动Sonar有两种方式：一种，直接执行...\sonarqube-6.6\bin\windows-x86-64\StartSonar.bat；另外一种，将Sonar安装为Windows服务，注意必定要以管理员身份运行...\sonarqube-6.6\bin\windows-x86-64\InstallNTService.bat，安装成功之后，运行...\sonarqube-6.6\bin\windows-x86-64\StartNTService.bat启动Sonar。Sonar启动之后，在浏览器中输入地址http://localhost:9000访问Sonar主页。

Sonar汉化。

下载Sonar汉化插件，连接：https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases/tag/sonar-l10n-zh-plugin-1.18，将汉化插件拷贝到...\sonarqube-6.6\extensions\plugins文件夹，重启Sonar。Sonar重启之后，在浏览器中输入地址http://localhost:9000访问Sonar主页。

Sonar插件安装。

安装 SonarJava 插件Java代码分析器；
安装SonarJS插件，JavaScript代码分析器；
安装SonarXML插件，XML分析器；
安装Web插件，HTML, JSP, JSF, ..代码分析器；
安装CSS / SCSS / Less插件，CSS、Less代码分析器；
安装SonarC# 插件，C#代码分析器；
安装SonarQube :: Plugins :: SCM :: SVN插件；
安装Checkstyle插件，Provide Checkstyle rules for Java projects；
安装Findugs 插件，Provide Findbugs rules for analysis of Java projects。

配置SCM权限。

Scanner安装

下载SonarQube Scanner 3.0.3安装包（连接：https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner）。将SonarQube Scanner 3.0.3安装包解压到任意目录。
配置SonarQube Scanner。打开...\sonar-scanner-3.0.3.778-windows\conf文件夹，找到sonar-scanner.properties并以文本编辑器打开，配置以下：
```
# ----- Default SonarQube server
sonar.host.url=http://localhost:9000

# ----- Default source code encoding
sonar.sourceEncoding=UTF-8
```

Jenkins集成

Jenkins安装。请参照上一篇文章，连接：https://my.oschina.net/lsjcoder/blog/1573648。
安装SonarQube Scanner for Jenkins插件安装。系统管理->管理插件，找到SonarQube Scanner for Jenkins插件，安装完成后重启Jenkins。
配置SonarQube Server。
配置SonarQube Scanner。
项目中增长SonarQube Scanner扫描配置。
当即构建，查看控制台日志输出。

分析结果

点击上面的连接，便可打开SonarQube，查看项目分析结果。

总结

在整合流程中，须要注意一下几点：

mysql版本必需要安装5.6及以上版本，不然会致使Sonar因不兼容而没法正常运行；
SonarQube未配置SCM权限，会致使报”SVNAuthenticationException“的错误；
注意必定要安装各类语言分析插件，不然会报”No quality profiles have been found, you probably don't have any language plugin installed“的错误；

至此，Jenkins与Sonar Qube的初步集成工做已初步完成，下面就会针对自动检测出来的Bugs、漏洞及坏味道，进行逐一修复，还掉之前欠下来的技术债务。

欢迎关注个人微信公众号：