【DevOps实践】5. Jenkins流水线集成SonarQube做代码质量分析

1. 摘要

本文讲解使用SonarQube和SonarQube Scanner如何配合做代码检查配置,并完成所有部署实践。

2.实践内容

2.1 前置配置

参考《【DevOps实践】4. Ubuntu下安装配置代码检测工具SonarQube+MySQL》,我们已经完成了SonarQube环境搭建。访问网址为:https://sonar.artarva.com/
参考《【DevOps实践】3. Jenkins流水线搭建golang项目持续集成环境》,我们已经完成了Jenkins集成环境搭建,并且完成了一个GO项目的流水线下载代码,编译,部署的完整持续集成流程。访问网址为:
https://jenkins.artarva.com/
我们接下来要做的是采用SonarQube独立实现代码质量扫码,然后把该功能集成到Jenkins环境中。

2.2 使用sonar单独完成一个GO项目的代码检查

配置好sonar的服务端后,接下来就要使用sonar检测我们的代码了,sonar主要是借助客户端检测工具来检测代码,所以要使用sonar就必须先在我们本地配置好客户端检测工具。
客户端可以通过IDE插件、Sonar-Scanner插件、Ant插件和Maven插件方式进行扫描分析。常用的有扫描器有Sonar-Scanner和Sonar-Runner,使用起来都差不多。这里我使用Sonar-Scanner来作为检测客户端。

2.2.1 安装sonar scanner

(1) 安装
最好用sonar-scanner-2.8版本,支持jdk1.8,否则其他版本会出错。

cd /opt
wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-2.8.zip
unzip sonar-scanner-2.8.zip  # 解压后,目录名改为sonar-scanner
mv sonar-scanner-2.8 sonar-scanner

(2) 配置sonar qube和sonar scanner的环境变量
在root账号下配置sonar用户的sudo权限

chmod u+w /etc/sudoers
vim /etc/sudoers

增加sudo授权

sonar   ALL=(ALL:ALL) ALL

root账号下,编辑/etc/profile 文件,
增加sonar环境变量信息和sonar-scanner 环境变量信息。

#sonar配置
export SONAR_HOME=/opt/sonar
export PATH=${SONAR_HOME}/bin:${PATH}

#set sonar-scanner environment
export SONAR_SCANNER_HOME=/opt/sonar-scanner
export PATH=${SONAR_SCANNER_HOME}/bin:${PATH}

执行source ~/.bash_profile使环境变量生效。
source命令通常用于重新执行刚修改的初始化文件,使之立即生效,而不必注销并重新登录。需要永久生效则需要reboot重启系统。

source ~/.bash_profile

(3)编辑sonar-scanner.properties文件
vim /opt/sonar-scanner/conf/sonar-scanner.properties

#----- Default SonarQube server
sonar.host.url=http://localhost:9000

#----- MySQL
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8

2.2.2 增加工程
(1) 在sonarQube页面,点击右上角的+号,增加一个工程,填写名称。

(2) 产生TOKEN
Analyze "training-ip-demo" 2: 80ecdaf54216297c11a536c4ff905973a10d7f3c

(3)根据提示编辑执行配合
选择预览,执行的系统环境,如下所示:



可以获取运行代码:

sonar-scanner \
  -Dsonar.projectKey=training-ip-demo \
  -Dsonar.sources=. \
  -Dsonar.host.url=https://sonar.artarva.com \
  -Dsonar.login=80ecdaf54216297c11a536c4ff905973a10d7f3c

(3) 在待扫描的项目根目录下创建文件 sonar-project.properties,文件内容
vim sonar-project.properties,内容如下:

# must be unique in a given SonarQube instance
sonar.projectKey=1: e496e00dcc53d285f39a1c1725ba1394c56779ff

# --- optional properties ---
# language
sonar.language=go

# defaults to project key
sonar.projectName=training-ip-demo
# defaults to 'not provided'
#sonar.projectVersion=1.0

# Path is relative to the sonar-project.properties file. Defaults to .
sonar.sources=.
sonar.exclusions=**/*_test.go,**/doc/**,**/docwatermark/**

# test file
sonar.tests=.
sonar.test.inclusions=**/*_test.go


# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8

(4) Linux shell下执行扫码分析工具
执行命令:

sonar-scanner \
>   -Dsonar.projectKey=training-ip-demo \
>   -Dsonar.sources=. \
>   -Dsonar.host.url=https://sonar.artarva.com \
>   -Dsonar.login=80ecdaf54216297c11a536c4ff905973a10d7f3c

执行成功,可以看到

点击地址:https://sonar.artarva.com/dashboard?id=training-ip-demo
可以查看扫码结果。根据分析报告处理代码吧。

2.3 Jenkins流水线集成SonarQube

2.3.1 SonarQube配置准备

(1)打开TOKEN授权开关
使用Admin账号登录Sonar,打开Server authentication token开关。
位置:https://sonar.artarva.com/admin/settings 的Administration/Configuration/Security菜单位置。


(2)获取一个TOKEN
登录后右上角点击用户名称,选择我的账号,进入个人账号设置
选择安全页,在Generate Tokens中输入一个名称,如:preproduct-training-ip-demo,然后点击Generate,生成一个token。
位置:右上角的My Account /Security/Tokens
记录该值,例如:cb4238366e2fb9b8a89324eef5581cdec439a36d

2.3.2 在Jenkins上配置SonarQube token

在Jenkins上,打开Credentials,添加一个Global的Credential,选择Credential类型为Secret text。
输入Secret为上面生成的SonarQube token,例如上面的“cb4238366e2fb9b8a89324eef5581cdec439a36d”
输入一个有意义的描述,ID可以自动产生。

2.3.3 在Jenkins上安装SonarScanner插件

在Jenkins上安装SonarScanner插件,参见:
http://redirect.sonarsource.com/plugins/jenkins.html
位置:系统管理/插件管理/ ,安装成功的截图。

2.3.4 在Jenkins上配置SonarQube server

位置:系统管理/系统配置
Name:填写一个便于记忆的名称。
Server URL:填写sonarQube的服务器地址,例如https://sonar.artarva.com
Server authentication token:选择刚才在授权凭证建立的token。

2.3.5 在Jenkins流水线中使用SonarQube做代码质量检查

《【DevOps实践】3. Jenkins流水线搭建golang项目持续集成环境》的pipeline脚本的基础上增加一个步骤。

        stage('2.代码质量检查') {
            steps {
                sh """
                     /opt/sonar-scanner/bin/sonar-scanner \
                    -Dsonar.projectKey=preproduct-training-ip-demo \
                    -Dsonar.sources=. \
                    -Dsonar.host.url=https://sonar.artarva.com \
                    -Dsonar.login=cb4238366e2fb9b8a89324eef5581cdec439a36d
                """        
            }
        }  

2.3.6 执行流水线脚本,获取结果


根据输出提示,可以查看代码质量检查结果。
【点评】代码重复率太高,评分不合格呢。

https://sonar.artarva.com/dashboard?id=preproduct-training-ip-demo

3.参考

(1)Jenkins 集成 SonarQube Scanner
https://www.cnblogs.com/cjsblog/archive/2019/04/20/10740840.html
【说明】缺少安装 SonarQube服务器的说明

(2)GO语言检查配置
How to run SonarQube for Go code using Jenkins
https://stackoverflow.com/questions/63832311/how-to-run-sonarqube-for-go-code-using-jenkins

https://docs.sonarqube.org/latest/analysis/languages/go/

(3)Jenkins+SonarQube+Gitlab搭建自动化持续代码扫描质量平台
https://blog.csdn.net/zuozewei/article/details/84539396
【说明】介绍sonar的作用整体。

(4) SonarQube集成golang检测
https://blog.csdn.net/baidu_36943075/article/details/90634160

(5)使用Jenkins流水线集成SonarQube做代码质量分析
https://blog.csdn.net/nklinsirui/article/details/90518618

(6)GO项目配置
https://docs.sonarqube.org/latest/analysis/languages/go/

(7) sonarqube SonarGo 搭建和golang代码检视的使用教程
https://www.jianshu.com/p/95ae320aa46d

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容