Jenkins代码审查

1、安装SonarQube

2、实现代码审查

1、安装SonarQube

SonarQube简介：是一个用于管理代码质量的开放平台，可以快速的定位代码中潜在的或者明显的错误。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十几种编程语言的代码质量管理与检测，底层使用elasticsearch作为代码检索工具。

官网：https://www.sonarqube.org/

环境需求：JDK1.8、MySQL5.7、SonarQube6.7.4

按要求安装MySQL，安装SonarQube，在MySQL创建sonar数据库

安装MySQL5.7

[root@jenkins ~]# yum -y install gcc gcc-c++ ncurses ncurses-devel bison cmake
[root@jenkins ~]# useradd -s /sbin/nologin mysql
[root@jenkins ~]# tar zxvf mysql-5.7.17.tar.gz -C /opt/
[root@jenkins ~]# tar zxvf boost_1_59_0.tar.gz -C /usr/local/
[root@jenkins ~]# cd /usr/local/
[root@jenkins ~]# mv boost_1_59_0 boost
[root@jenkins ~]# cd /opt/mysql-5.7.17/
[root@jenkins mysql-5.7.17~]# cmake \
-DCMAKE_INSTALL_PREFIX=/usr/local/mysql \
-DMYSQL_UNIX_ADDR=/usr/local/mysql/mysql.sock \
-DSYSCONFDIR=/etc \
-DSYSTEMD_PID_DIR=/usr/local/mysql \
-DDEFAULT_CHARSET=utf8  \
-DDEFAULT_COLLATION=utf8_general_ci \
-DWITH_INNOBASE_STORAGE_ENGINE=1 \
-DWITH_ARCHIVE_STORAGE_ENGINE=1 \
-DWITH_BLACKHOLE_STORAGE_ENGINE=1 \
-DWITH_PERFSCHEMA_STORAGE_ENGINE=1 \
-DMYSQL_DATADIR=/usr/local/mysql/data \
-DWITH_BOOST=/usr/local/boost \
-DWITH_SYSTEMD=1
[root@jenkins mysql-5.7.17~]# make -j4 && make install
[root@jenkins mysql-5.7.17~]# chown -R mysql.mysql /usr/local/mysql/

[root@jenkins mysql-5.7.17~]# vim /etc/my.cnf
[client]
port = 3306
default-character-set=utf8
socket = /usr/local/mysql/mysql.sock[mysql]
port = 3306
default-character-set=utf8
socket = /usr/local/mysql/mysql.sock[mysqld]
user = mysql
basedir = /usr/local/mysql
datadir = /usr/local/mysql/data
port = 3306
character_set_server=utf8
pid-file = /usr/local/mysql/mysqld.pid
socket = /usr/local/mysql/mysql.sock
server-id = 1sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,PIPES_AS_CONCAT,ANSI_QUOTES

[root@jenkins mysql-5.7.17~]# chown mysql:mysql /etc/my.cnf
[root@jenkins mysql-5.7.17~]# vim /etc/profile
...
export PATH=/usr/local/mysql/bin:/usr/local/mysql/lib:$PATH   #末行添加
[root@jenkins mysql-5.7.17~]# source /etc/profile         #刷新配置生效
[root@jenkins mysql-5.7.17~]# cd /usr/local/mysql
[root@jenkins mysql~]# bin/mysqld \
--initialize-insecure \
--user=mysql \
--basedir=/usr/local/mysql \
--datadir=/usr/local/mysql/data
[root@jenkins mysql~]# cp /usr/local/mysql/usr/lib/systemd/system/mysqld.service /usr/lib/systemd/system/
[root@jenkins mysql~]# systemctl daemon-reload
[root@jenkins mysql~]# systemctl start mysqld
[root@jenkins mysql~]# systemctl enable mysqld
[root@jenkins mysql~]# mysqladmin -u root -p password "abc123"   #在mysql外部定义密码
mysql> set password = password('abc123');                        #在mysql内部定义密码
[root@jenkins mysql~]# mysql -u root -p
[root@jenkins mysql~]# grant all privileges on *.* to 'root'@'%' identified by 'abc123' with grant option;

数据库安装完成后，在MySQL创建sonar数据库

安装SonarQube

[root@jenkins ~]# unzip sonarqube-6.7.4.zip         #解压
[root@jenkins ~]# mkdir /opt/sonar                  #创建目录
[root@jenkins ~]# mv sonarqube-6.7.4/* /opt/sonar   #移动文件
[root@jenkins ~]# useradd sonar                    #创建sonar用户，必须sonar用于启动，否则报错
[root@jenkins ~]# chown -R sonar.  /opt/sonar      #更改sonar目录及文件权限
[root@jenkins ~]# vim /opt/sonar/conf/sonar.properties
...
sonar.jdbc.username=root
sonar.jdbc.password=abc123
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar? useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConﬁgs= maxPerformance&useSSL=false      #取消注释即可
注意：sonar默认监听9000端口，如果9000端口被占用，需要更改。 启动sonar（注意：切换sonar用户）

切换用户，启动服务

[root@jenkins ~]# su sonar
[sonar@jenkins root]$ cd /opt/sonar/
[sonar@jenkins root]$ ./bin/linux-x86-64/sonar.sh start      #启动
[sonar@jenkins root]$ ./bin/linux-x86-64/sonar.sh status     #查看状态

配置没错的情况下会进入界面

创建用户和密码

创建token

2、实现代码审查

实现代码审查的流程图

安装SonarQube Scanner插件

回到主界面

进去找到SonarQube Scanner

添加SonarQube凭证

进行SonarQube配置

在项目添加SonaQube代码审查（非流水线项目）

打开之前创建的web_demo_freestyle

# must be unique in a given SonarQube instance
sonar.projectKey=web_demo_freestyle
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=web_demo_freestyle
sonar.projectVersion=1.0# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# This property is optional if sonar.modules is set.
sonar.sources=.
sonar.exclusions=**/test/**,**/target/**sonar.java.source=1.8
sonar.java.target=1.8# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8

保存设置，进行构建

在sonarqube服务器上刷新，查看结果

测试错误代码

在main目录下新建Java和resource目录

配置pom.xml文件添加对servlet的依赖

<dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>4.0.1</version>
</dependency

新建编写Servlet文件

package com.kgc;import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;public class HelloServlet extends HttpServlet {@Overrideprotected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {super.doPost(req,resp);}@Overrideprotected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {//模拟错误代码int i = 100/0;//模拟代码冗余int j = 100;j = 200;resp.getWriter().write("hello Servlet");}
}

代码提交

进行构建测试结果

如果构建maven项目报错，查看JDK版本符不符合

在项目添加SonaQube代码审查（流水线项目）

在项目根目录下，创建sonar-project.properties文件

# must be unique in a given SonarQube instance
sonar.projectKey=web_demo_pipeline
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=web_demo_pipeline
sonar.projectVersion=1.0# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# This property is optional if sonar.modules is set.
sonar.sources=.
sonar.exclusions=**/test/**,**/target/**sonar.java.source=1.8
sonar.java.target=1.8# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8

修改Jenkinsﬁle，加入SonarQube代码审查阶段

stage('code checking') {steps {script {//引入了sonarqube-scanner工具scannerHome = tool 'sonar-scanner'}//引入了sonarqube服务器系统环境withSonarQubeEnv('sonarqube') {sh "${scannerHome}/bin/sonar-scanner"}}}

把更改后的sonar-project.properties和Jenkinsfile进行提交

开始构建web_demo_pipeline