SonarQube代码监测
目录
一、配置环境
1.SonarQube
SonarQube是一个用于管理代码质量的开放平台,可以快速的定位代码中潜在的或者明显的错误
2.环境需求
SonarQube配置在Jenkins服务器上就行,MySql也是安装在Jenkins服务器上
①JDK-1.8
②MySql-5.7
③SonarQube-6.7.4
二、安装SonarQube
1.JDK
jdk直接yum安装就行
yum install -y java-1.8.0-openjdk* -y
如果已经安装过就不需要在安装
2.MySql
这边的版本是5.7
MySQL在前文章有mysql安装,自行查看安装,以下是自动安装mysql脚本
使用source 命令运行脚本
#!/bin/bash
echo "开始安装mysql数据库"
yum -y install gcc gcc-c++ ncurses ncurses-devel bison cmake
useradd -s /sbin/nologin mysql
tar zxvf mysql-5.7.17.tar.gz -C /opt #安装包目录根据自己的目录进行调整,名称也是
tar zxvf boost_1_59_0.tar.gz -C /usr/local #一样,自行调整
mv /usr/local/boost_1_59_0 /usr/local/boost
cd /opt/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_EXTRA_CHARSETS=all -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
make -j 4 && make install #j 后面根据自己的机器进程数进行调整
echo "[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
auto-rehash
[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
bind-address = 0.0.0.0
skip-name-resolve
max_connections=2048
default-storage-engine=INNODB
max_allowed_packet=16M
server-id = 1
sql_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" > /etc/my.cnf
echo "PATH=$PATH:/usr/local/mysql/bin" >> /etc/profile
chown -R mysql:mysql /usr/local/mysql/
chown mysql:mysql /etc/my.cnf
source /etc/profile
cd /usr/local/mysql/bin/
./mysqld --initialize-insecure --user=mysql --basedir=/usr/local/mysql --datadir=/usr/local/mysql/data
cp /usr/local/mysql/usr/lib/systemd/system/mysqld.service /usr/lib/systemd/system/
systemctl daemon-reload
systemctl start mysqld.service
systemctl enable mysqld
netstat -anpt | grep 3306
mysqladmin -u root -p password 密码 #更改mysql密码,默认没密码直接回车即可
mysql -uroot -p密码 #进入数据库
grant all privileges on *.* to 'root'@'%' identified by '' with grant option; #by后面跟自己的数据库密码
3.安装SonarQube
①创建sonar库
create database sonar;
②安装SonarQube
解压并设置权限
yum install unzip
unzip sonarqube-6.7.4.zip 解压
mkdir /opt/sonar 创建目录
mv sonarqube-6.7.4/* /opt/sonar 移动文件
useradd sonar 创建sonar用户,必须sonar用于启动,否则报错
chown -R sonar. /opt/sonar 更改sonar目录及文件权限
③修改sonar配置文件
vim /opt/sonar/conf/sonar.properties
sonar.jdbc.username=root
sonar.jdbc.password=123456
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar? useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs= maxPerformance&useSSL=false #这段取消注释
注意:sonar默认监听9000端口,如果9000端口被占用,需要更改。 启动sonar(注意:切换sonar用户)
cd /opt/sonar
su sonar ./bin/linux-x86-64/sonar.sh start 启动
su sonar ./bin/linux-x86-64/sonar.sh status 查看状态
su sonar ./bin/linux-x86-64/sonar.sh stop 停止
tail -f logs/sonar.logs 查看日志
启动SonarQube,访问SonarQube
192.168.72.15:9000
默认账户;admin/admin
然后继续,跳过即可。
三、配置Jenkins,并实现代码审查
1.安装SonarQube Scanner插件
2.配置Jenkins
配置Jenkins上的SonarQube
如果点这个添加不了就到凭证里添加
添加完之后,保存即可。
3.在项目中添加代码审查(Pipeline项目)
①创建sonar-project.properties文件
添加下面代码到文件中
# must be unique in a given SonarQube instance
sonar.projectKey=项目名
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=项目名
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
②修改Jenkinsfile
加入SonarQube代码审查阶段
script {
//引入了sonarqube-scanner工具
scannerHome = tool 'sonar-scanner'
}
//引入了sonarqube服务器系统环境
withSonarQubeEnv('sonarqube') {
sh "${scannerHome}/bin/sonar-scanner"
}
然后提交代码到gitlab上,查看是否审查代码
我这边使用的是webhook自动构建,可以看之前文章的操作,使用webhook
代码审查完成