SonarQube上代码扫描报告效果图
多模块maven项目结构大概如下：
cfw-project #父工程
-module-One #子工程（1）
-src
-main
-pom.xml
-module-Two #子工程（n）
-src
-main
-pom.xml
-sonar-project.properties #文件与子工程同级目录
准备工作：
- 宿主机：centos7.5（192.168.1.107 localhost）
- 安装Jenkins
https://www.jianshu.com/p/42e2771dcc94
- 安装、汉化SonarQube(8+) + postgres
- 安装sonar-scanner
- 编写 sonar-project.properties文件
- 创建jenkins流水线工程，触发构建，查看代码扫描报告
备注：
（1）通过此文章，不需要在jenkins上安装sonar插件 （SonarQube Scanner for Jenkins），即不需要在jenkins上配置SonarQube相关配置
1、安装、汉化SonarQube(8+) + postgres
编写docker-compose.yml
mkdir -p /data/sonar && cd /data/sonar
cat docker-compose.yml #编写docker-compose.yml
version: '3'
services:
postgres:
image: postgres #基础镜像名字
restart: always #在容器退出时总是重启容器
container_name: sonarqube_postgres #自定义sonarqube容器名字
ports:
- 5432:5432 #-宿主机端口:容器暴露端口 ； 即将容器暴露端口映射到宿主机上某个端口
volumes:
- /data/sonar/postgres/postgresql:/var/lib/postgresql #将容器目录文件映射到宿主机上
- /data/sonar/postgres/data:/var/lib/postgresql/data
environment:
TZ: Asia/Shanghai #指定容器时区
POSTGRES_USER: sonar #自定义postgres数据库登录用户
POSTGRES_PASSWORD: sonar #自定义postgres数据库登录密码
POSTGRES_DB: sonar #自定义postgres数据库 “库”
networks:
- sonar-network #使用文件末定义的网络模式
sonarqube:
image: sonarqube #8.5.1
restart: always
container_name: sonarqube_master
ports:
- 9000:9000
volumes:
- /data/sonar/sonarqube/extensions:/opt/sonarqube/extensions
- /data/sonar/sonarqube/logs:/opt/sonarqube/logs
- /data/sonar/sonarqube/data:/opt/sonarqube/data
- /data/sonar/sonarqube/conf:/opt/sonarqube/conf
environment:
SONARQUBE_JDBC_USERNAME: sonar #指定postgres数据库连接信息
SONARQUBE_JDBC_PASSWORD: sonar
SONARQUBE_JDBC_URL: jdbc:postgresql://postgres:5432/sonar
depends_on: #指定依赖某个服务 （本实例sonarqube依赖postgres）
- postgres
networks:
- sonar-network
networks:
sonar-network:
driver: bridge #定义网络模式为bridge (缺省值bridge; 支持bridge，host，none，container四种类型)
运行
1、修改宿主机内核参数
echo "vm.max_map_count = 655360" >> /etc/sysctl.conf
sysctl -p
2、赋权给sonarqube/data目录下所有目录、文件
mkdir -p /data/sonar/sonarqube/data
chmod -R 777 /data/sonar/sonarqube/data
3、运行SonarQube(8+) + postgres
docker-compose up -d #启动容器
docker ps #查看容器状态
容器启动成功
访问：http://localhost:9000 #默认用户密码都是admin
sonarqube-web.png
汉化
- 登录后操作
-
找到“Chinese Pack”插件，安装并重启sonarqube服务即可汉化成功
2、安装sonar-scanner
- 由于jenkins服务我是用docker方式安装（https://www.jianshu.com/p/42e2771dcc94
），jenkins容器与宿主机环境隔离，想要jenkins流水线引用sonar-scanner命令，那就把sonar-scanner扫描工具安装到jenkins容器里面。
docker cp sonar-scanner-cli-3.2.0.1227-linux.zip jenkins:/usr/local/ #将压缩包复制到容器里（前提jenkins容器启动成功）
docker exec -it jenkins /bin/bash #进入jenkins容器
cd /usr/local
unzip sonar-scanner-cli-3.2.0.1227-linux.zip #解压得到sonar-scanner-3.2.0.1227-linux
ln -s sonar-scanner-3.2.0.1227-linux/bin/sonar-scanner /usr/sbin/sonar-scanner #做软链接
sonar-scanner -v #jenkins容器终端可以直接使用sonar-scanner命令即为安装、配置成功
3、编写 sonar-project.properties文件
sonar.projectKey=cfw-project #自定义项目唯一标识
sonar.projectName=cfw-project #自定义项目名字
sonar.sourceEncoding=UTF-8
sonar.projectVersion=v3.2 #自定义版本
sonar.ce.workerCount=1
sonar.language=java
sonar.forceAnalysis=true
sonar.ce.workerCount=1
sonar.java.binaries=target/classes
sonar.sources=src/main/java
sonar.host.url=http://192.168.1.107:9000 #指定SonarQube服务地址
sonar.login=88288b599e11b4d86a23ge6r85e81774619c2c8b #SonarQube服务生成的登录令牌
#sonar.login相当于登录用户 & 密码
sonar.modules=module-One,module-Two #多个子工程用逗号隔开
module-One.sonar.projectName=module-One #子工程名字
module-Two.sonar.projectName=module-Two
SonarQube服务生成登录令牌
4、创建jenkins流水线工程，触发构建，查看代码扫描报告
- 当前只有一个多模块maven项目（cfw-project），因为往后会有n个多模块maven项目，所以创建jenkins流水线工程时使用“选择参数”指定多模块maven项目
编写声明式Jenkinsfile
pipeline {
agent any
options {
timestamps() //设置在项目打印日志时带上对应时间
disableConcurrentBuilds() //不允许同时执行流水线，被用来防止同时访问共享资源等
timeout(time: 5, unit: 'MINUTES') // 设置流水线运行超过n分钟，Jenkins将中止流水线
buildDiscarder(logRotator(numToKeepStr: '20')) // 表示保留n次构建历史
}
//gitlab webhook触发器
//triggers{
// gitlab( triggerOnPush: true, //代码有push动作就会触发job
// triggerOnMergeRequest: true, //代码有merge动作就会触发job
// branchFilterType: "NameBasedFilter", //只有符合条件的分支才会触发构建 “ALL/NameBasedFilter/RegexBasedFilter”
// includeBranchesSpec: "${JOB_BASE_NAME}") //基于branchFilterType值，输入期望包括的分支的规则
//}
stages{
stage('Print Message') { //打印信息
steps {
echo '打印信息'
echo "project: ${Project_name}"
echo "workspace: ${WORKSPACE}"
echo "branch: ${Branch_name}" //gitlab分支名
echo "build_id: ${BUILD_ID}"
}
}
//此步骤在调试Jenkinsfile时可以注释以便了解目录结构
stage('Delete Workspace') { //清理工作目录
steps {
echo "清理工作目录: ${WORKSPACE}"
deleteDir() //表示删除当前目录(${WORKSPACE})下内容，通常用在构建完毕之后清空工作空间
}
}
stage ('Checkout'){ //拉取代码
steps{
echo '拉取代码'
script {
checkout([$class: 'GitSCM', branches: [[name: '${Branch_name}']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [],
userRemoteConfigs: [[credentialsId: '7ff3778d-124f-40b1-a5e6-05db20a7e59e', //gitlab登录令牌，设置自行搜索方法
url: 'http://192.168.1.101/java/${Project_name}.git']]]) //gitlab项目clone地址
}
}
}
stage('Sonar-canner') { //sonar-scanner代码检查
steps {
echo '代码检查'
dir ('./') { //指定工作目录（默认为${WORKSPACE}）
script {
sh 'source /etc/profile && mvn clean package -Dmaven.test.skip=true'
sh 'sonar-scanner' //执行命令开始扫描代码(前提要maven编译生成classes文件)
}
}
}
}
}
}
触发构建流水线工程（代码扫描报告自动上传到SonarQube服务）
SonarQube服务上查看代码扫描报告 http://localhost:9000
