jenkins与SonarQube集成

Posted 低级知识传播者

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了jenkins与SonarQube集成相关的知识,希望对你有一定的参考价值。

一、SonarQube

我的理解是,SonarQube就是一个对代码进行分析的平台,其功能可以通过插件扩展。支持多种语言,也支持静态代码检查、发现潜在bug等。

以下是参考信息:

维基百科:https://zh.wikipedia.org/wiki/SonarQube

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

文档:https://docs.sonarqube.org/display/SONAR/Documentation

 

二、下载安装

1.下载

访问官网:https://www.sonarqube.org/

点击“Download”,

 

然后我们可以选择长期支持版本或者最近的稳定版本,

 

2.安装运行

该软件是绿色版,不需要安装,手动解压即可。windows或者linux都支持。

解压后,如果是windows,执行以下路径的bat(如果是32位操作系统,请切换到bin\\windows-x86-32目录)

运行如下,如果显示如下图,表示已成功启动SonarQube。

 

 3.尝试使用

访问:

http://localhost:9000

用户名/密码是:admin/admin

接下来可以照着网页上的提示,完成token生成等,该token用处很大,需要牢记。

 

针对maven项目,我们可以测试一下。

找到想要测试的项目的根路径,比如:

在命令行执行:(sonar.login就是上文生成的token值)

mvn sonar:sonar   -Dsonar.host.url=http://localhost:9000   -Dsonar.login=429cf9cccb1c1dc96aea29c2f69f74669ed7fdc5

执行结果如下:

 

根据以下日志,

[INFO] ANALYSIS SUCCESSFUL, you can browse http://localhost:9000/dashboard/index
/com.ceiec:bdmp

我们访问:http://localhost:9000/dashboard/index/com.ceiec:bdmp,页面如下:

 

 SonarQube的功能很多,以上只展示了基本功能。

更多功能可以参考官方文档:

https://docs.sonarqube.org/display/SONAR/Get+Started+in+Two+Minutes

 

三、与jenkins集成

参考:

https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner

1.安装

依次进入,“系统管理”--》“管理插件”--》“可选插件”--》“SonarQube Scanner for Jenkins”,然后点“直接安装”。安装完成后,重启一下。

2.配置SonarQube服务器的地址

依次进入,“系统管理”--》“系统设置”,配置以下部分:

3.配置SonarQube Scanner

依次进入,“系统管理”--》“全局工具配置”,配置以下部分:

 

 我这边采用了自动安装,但是,这个“自动安装”的运行条件是:

当你在job中配置了,要使用该指定名称“my-jenkins-SonarQube Scanner”的工具(当然,如果不指定,因为没有默认值,所以会在job配置页面上报错,红字提示),然后在“立即构建”时,才会去下载该工具。

并不是这里点了自动安装,点击保存后,马上就会下载安装的。

 

4.配置job

SonarQube,针对java来说,是基于class来检测的,所以在这前面,需要配置一个maven的编译步骤。

如下:

 

上图中,要指定给SonarQube Scanner使用的jdk,在Analysis properties中,

“sonar.projectKey”可随意指定;

“sonar.sources”指定了我的源文件路径;

“sonar.java.binaries”是编译后的class文件的路径。

以下是我的jenkins的该job的工作目录树(请读者参考自己的目录配置):

 

5.构建结果

6.异常情形

INFO: ------------------------------------------------------------------------
ERROR: Error during SonarQube Scanner execution
ERROR: Error when executing blame for file bdmp-api/pom.xml
ERROR: Caused by: svn: E170001: Authentication required for \'<http://192.168.19.225:80> CollabNet Subversion Repository\'
ERROR: 
ERROR: Re-run SonarQube Scanner using the -X switch to enable full debug logging.
WARN: Unable to locate \'report-task.txt\' in the workspace. Did the SonarScanner succedeed?
ERROR: SonarQube scanner exited with non-zero code: 1
Finished: FAILURE

解决方法:
登录SonarQube,按下图所示,关闭“从scm获取blame信息”即可:

 


 

以上是关于jenkins与SonarQube集成的主要内容,如果未能解决你的问题,请参考以下文章

jenkins与SonarQube集成

利用Jenkins和SonarQube集成对代码进行持续检测

SonarQube 9.x与Jenkins进行集成并扫描后端java以及前端vue代码;

jenkins集成sonarQube实现代码质量检查

持续集成Jenkins+sonarqube部署教程

持续集成Jenkins+sonarqube部署教程