Sonarqube 安装 及与Jenkins sonar scanner插件集成部署

已于 2022-11-16 17:59:26 修改
阅读量3.1k 收藏 12
点赞数 1
分类专栏： # Jenkins 文章标签： jenkins 数据库 运维 sonarqube
于 2022-10-31 18:48:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chj_1224365967/article/details/127618078
版权

一、 SonarQube基本概述

1.什么是SonarQube

SonarQube是一个开源的代码质量管理系统，用于检测代码中的错误，漏洞和代码规范。它可以现有的Gitlab、Jenkins集成，以便在项目拉取后进行连续的代码检查。
在这里插入图片描述

2.使用SonarQube前提

  • SonarQube基于Java开发，所以需要安装 OpenJDK8 版本。
  • SonarQube需要依赖 MySQL 数据库，至少 5.6 版本以上8版本以下。
  • SonarQube的小型实例至少需要4GB 内存，如果是大型实例需要 16GB

二、SonarQube服务安装

分两个步骤，第一步安装sonarqube server端，第二步，jenkins集成sonarqube-scanner（需要连接sonar服务端）

这里SonarQube使用的是7.4版本，mysql版本 mysql>=5.6 && mysql <8.0

1.安装数据库

数据库安装

启动数据库，为sonarqube创建一个专有用户，最后创建一个sonar库

create database sonar default character set utf8;
GRANT ALL PRIVILEGES ON sonar.* TO 'sonar'@'xxx' IDENTIFIED BY 'xxx' WITH GRANT OPTION;

2.安装sonarqube

2.1 官网下载 sonarqube

注意：新版的SonarQube(7.9+)只支持以下数据库：
Microsoft SQL Server、Oracle、PostgreSQL、H2 (默认的嵌入式数据库)
不再支持MySQL，请更换数据库。

这里下载的是7.4版本

#解压
wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-7.4.zip
unzip sonarqube-7.4.zip -d /usr/local/

因为sonarqube不能以root启动，此处需要创建一个普通用户，此处我创建的为sonar

useradd sonar

2.2 更改下sonarqube目录所有权

ln -s /usr/local/sonarqube-7.4 /usr/local/sonarqube
chown -R sonar:sonar /usr/local/sonarqube
chown -R sonar:sonar /usr/local/sonarqube-7.4/

2.3 修改sonarqube连接数据库配置文件

sonar.jdbc.url=jdbc:mysql://xxx:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=sonar
sonar.jdbc.password=xxx
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

2.4 启动sonarqube服务

su sonar  -c "/usr/local/sonarqube/bin/linux-x86-64/sonar.sh start"

2.5 汉化包地址

汉化地址
汉化包版本选择对应版本，此处1.24版本汉化包对应7.4版本sonarqube
把汉化包放在解压地址下/usr/local/sonarqube/extensions/plugins

2.6 访问Sonarqube

1.通过浏览器输入 http://xxx:9000地址来访问sonarqube

点击登录–>输入用户名：admin 用户密码：admin

在这里插入图片描述
在这里插入图片描述

2.如何使用 SonarQube 质量分析；java 代码直接通过mvn即可分析
mvn sonar:sonar \
  -Dsonar.host.url=http://xxx:9000 \
  -Dsonar.login=xxx
3.如何使用SonarQube质量分析；非 java 代码则需要使用 sonar-scanner工具分析；

在这里插入图片描述

sonar-scanner \
  -Dsonar.projectKey=html \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://xxx:9000 \
  -Dsonar.login=xxxx

3.Sonarqube插件管理

Sonarqube默认已经安装了 C Java Python Php 等代码的质量分析工具；那我们为什么还需要安装插件？因为我们还需要检测 html等类型代码，而默认插件没有，所以需要安装；以便将代码检测的更加完善；

3.1 联网安装插件

联网安装插件比较简单，仅需要上应用市场搜索插件名称即可，如下以安装中文语言包插件为例；点击配置> 应用市场--> 搜索框chinese，出现一个Chinese Pack，然后点击install安装好的插件会存储至/usr/local/sonarqube/extensions/plugins/xx.jar
在这里插入图片描述

3.2 离线安装插件

由于 SonarQube 需要安装很多的插件，并且插件安装需要很长的时间；所以我们可以通过导入的方式来完成插件的安装；注意导入后需要重启 Sonarqube

rm -rf /usr/local/sonarqube/extensions/plugins/
tar xf sonar_plugins.tar.gz -C /usr/local/sonarqube/extensions
 chown -R sonar.sonar /usr/local/sonarqube/extensions/plugins/
su sonar -c "/usr/local/sonarqube/bin/linux-x86-64/sonar.sh restart"

三、SonarQube代码检测

前面已经将 SonarQube服务以及插件安装完成，那么接下来只需要将代码推送至 Sonarqube 进行分析即可。

1.Java项目分析

1.1 Java项目可以通过maven进行代码质检，无需使用sonar-scanner 工具，安装maven工具即可。

yum -y install maven

1.2 手动从svn仓库获取java 代码，进入项目目录，使用mvn进行代码扫描

mvn sonar:sonar \
  -Dsonar.host.url=http://xxx:9000 \
  -Dsonar.login=xxx

2 HTML项目分析

Sonarqube 分析 Html、php、go 项目；需要借助sonar-scanner客户端工具来完成代码的分析；
需要在项目所在的主机安装sonar-scanner

2.1 安装 sonar-scanner 命令

sonar-scanner下载地址

2.2 用sonar-scanner进行分析

进入项目目录，使用sonar-scanner工具将代码推送Sonarqube 服务端进行分析；如果没有加入环境变量，则建议使用绝对路径

/usr/local/sonar-scanner/bin/sonar-scanner \
  -Dsonar.projectKey=html \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://xxx:9000 \
  -Dsonar.login=xxx

2.3 登陆 Sonarqube 查看项目分析结果

在这里插入图片描述

四、Jenkins集成SonarQube

Jenkins 需要知道 Sonarqube 服务；以便能将代码推送指定服务节点；
Jenkins 需要知道 Sonar-Scanner 客户端工具，以便能正常调用

4.1 集成Sonarqube

1.插件安装；Manage Jenkins–>Manage Plugins–>SonarQube Scanner
在这里插入图片描述
2.在 Jenkins 上配置 SonarQube 服务端地址；Manage Jenkins–>Configure System–>sonarQube (告诉jenkins SonarQubeServers服务端地址)
Name 可以随意填写
URL 添加 SonarQube服务端地址；确保Jenkins能正常访问；
下面的凭据需要先保存URl的地址信息，在打开进行添加凭据。
在这里插入图片描述
这里Secret为Sonarqube生成的令牌
在这里插入图片描述
进行添加token
在这里插入图片描述
以上SonarQube信息就添加完成了

4.2 集成Sonar-Scanner

在 Jenkins 上配置 Sonar-Scanner 客户端工具路径； Manage Jenkins–>Global Tool Configuration–>sonar-scanner（告诉jenkins SonarScanner在本地哪个路径）
1.Name 可以随意填写，但最好有规范
2.SONAR_RUNNER_HOME 填写 sonar-scanner 在Jenkins本地路径
在这里插入图片描述

4.3 Jenkins为项目添加代码检测

java项目 Scanner质检方式，把执行代码质检拉倒执行shell的前面

sonar.projectName=${JOB_NAME} #项目在sonarqube上的显示名称
sonar.projectKey=java ##项目的唯一标识，不能重复
sonar.scm.provider=svn
sonar.projectVersion=1.0
sonar.projectBaseDir=xxx #项目所在的目录（使用绝对路径）
sonar.sources=xxx  #扫描哪个项目的源码(使用绝对路径)
sonar.java.binaries=xxx

在这里插入图片描述
这样配置后，每次项目CI时候，先会进行质量检测，并将结果传送至SonarQube服务器。

五、Jenkins为项目添加通知阶段

5.1 配置钉钉

1.打开钉钉群组，点击设置–智能群助手–群机器人–添加机人–自定义机器人。(如果你不是群主，且群主开启了仅群主可管理，那么将无法创建机器人。)
2.添加一个自定义机器人
3.可以修改机器人名称，以及机器人的名字。(这块自行修改）
4.机器人修改成功后，会给出一个webhook地址。(此处的webhook后续jenkins需要使用)
在这里插入图片描述
在这里插入图片描述

5.2 Jenkins集成钉钉

1.Jenkins安装dingding插件。
在这里插入图片描述
配置dingding通知token
在这里插入图片描述
2.配置钉钉机器人
在这里插入图片描述

5.3 项目添加通知

5.3.1 CI阶段通知质检结果

质检通知相对繁琐，需要自定义环境变量
1.启用钉钉机器人

- 构建的项目：${JOB_NAME}
- Sonar质检报告：http://xxx

在这里插入图片描述

5.3.2 钉钉通知结果验证

在这里插入图片描述

IT_狂奔者
关注
  • 1
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 7
    评论
专栏目录
jenkins+sonarqube+sonar-scanner.zip
06-10
jenkins集成sonarQube全家桶，此资源中jenkins和sonarqube的集成是经过本人测试多个版本得出的兼容版本，集成无报错
SonarQube+Scanner的安装配置及使用
qq_24953751的博客
03-31 4854
SonarQube+Scanner的安装配置及使用
SonarQube 安装、部署及配置使用
最新发布
乔木的博客
04-20 1170
通过本文的介绍，您应该已经掌握了如何安装、部署和配置使用SonarQube。作为一款强大的代码质量管理平台，SonarQube能够帮助您及时发现并解决潜在的代码问题，提高代码质量和开发效率。希望这篇文章对您有所帮助！
sonarqube插件包
10-12
checkstyle-sonar-plugin-4.23.jar java-i18n-rules-0.1.0.jar sonar-auth-github-plugin-1.5.0.870.jar sonar-auth-saml-plugin-1.1.0.181.jar sonar-csharp-plugin-7.17.0.9346.jar sonar-css-plugin-1.1.1.1010.jar sonar-findbugs-plugin-3.11.0.jar sonar-flex-plugin-2.5.1.1831.jar sonar-go-plugin-1.6.0.719.jar sonar-html-plugin-3.2.0.2082.jar sonar-jacoco-plugin-1.0.2.475.jar sonar-java-plugin-5.14.0.18788.jar sonar-javascript-plugin-5.2.1.7778.jar sonar-kotlin-plugin-1.5.0.315.jar sonar-l10n-zh-plugin-1.29.jar sonar-ldap-plugin-2.2.0.608.jar sonar-php-plugin-3.2.0.4868.jar sonar-pmd-plugin-3.2.1.jar sonar-python-plugin-1.16.0.4432.jar sonar-ruby-plugin-1.5.0.315.jar sonar-scala-plugin-1.5.0.315.jar sonar-scm-cvs-plugin-1.1.1.jar sonar-scm-git-plugin-1.9.0.1725.jar sonar-scm-svn-plugin-1.9.0.1295.jar sonar-sonargraph-integration-4.0.0.jar sonar-typescript-plugin-1.9.0.3766.jar sonar-vbnet-plugin-7.17.0.9346.jar sonar-webdriver-plugin-1.0.3.jar sonar-xml-plugin-2.0.1.2020.jar
SonarQube介绍
热门推荐
zzhongcy的专栏
10-26 2万+
SonarQube 是一个开源的代码分析平台, 用来持续分析和评测项目源代码的质量。 通过SonarQube我们可以检测出项目中重复代码， 潜在bug， 代码规范，安全性漏洞等问题， 并通过SonarQube web UI展示出来。 1 Sonar简介 1.1 sonarQube是什么？ 1、代码质量和安全扫描和分析平台。 2、多维度分析代码：代码量、安全隐患、编写规范隐患、重复度、复杂度、代码增量、测试覆盖率等。 3、支持25+编程语言的代码扫描和分析，包含java\python\C#\jav.
Sonar集成jenkins
intelrain的博客
07-16 350
1、git集成时，Console端报错信息如下 弹出Warning:Permanently added (RSA) to the list of known hosts的警告，看着很碍眼。通过以下方法进行解决： vim /etc/ssh/ssh_config（master和slave1都需要设置） 找到#StrictHostKeyChecking ask去掉注释，并把ask改为no即可 ...
sonarqube中文插件
02-02
sonarqube的中文插件，根据源码编绎而成，适用于4.5及以上版本。使用时放到extentions>plugins目录下重启sonarqube即可。
sonarqube的插件集合
10-16
checkstyle-sonar-plugin-4.11.jar；sonar-findbugs-plugin.jar；sonar-java-plugin-5.8.0.15699.jar；sonar-java-plugin-4.15.0.12310.jar；sonar-l10n-zh-plugin-1.19.jar；其中sonar-java-plugin-5.8.0.15699.jar和sonar-java-plugin-4.15.0.12310.jar随便用一个
jenkins与sonar集成的离线插件sonarqube scanner
10-23
下载解压后放~/.jenkins/plugins/目录，具体的与jenkins集成可以参照文章https://blog.csdn.net/musuny/article/details/102700390
jenkins+sonarqube+sonar-scanner(无ngrok).zip
06-10
jenkins集成sonarQube全家桶，此资源中jenkins和sonarqube的集成是经过本人测试多个版本得出的兼容版本，集成无报错
sonarqube+sonar-scanner+jenkins执行代码检查.doc
02-17
该文档主要描述基于sonarqube+sonar-scanner+jenkins执行代码检查环境的搭建，实现代码自动化构建，并且对sonarqube的相关功能进行了简单的介绍。希望对正在这方面学习的同学有帮助。
sonarqube ldap 插件
09-11
sonarqube ldap plugin 2.2，sonarqube整合openldap必备
sonarqube-4.5.7常用插件
01-21
sonar-checkstyle-plugin-2.4，sonar-cobertura-plugin-1.6.3，sonar-pmd-plugin-2.5，sonar-java-plugin-2.5.1，sonar-l10n-zh-plugin-1.8 将插件放置到plugin下即可，这是我自己编译出来的插件，网上找不到该版本适应的，除非自己编译，，
SonarQube的安装和配置以及与Jenkins和gitlab的集成
08-31
SonarQube的安装和配置以及与Jenkins和gitlab的集成
SonarQube插件汇总
csdn_life18的博客
02-03 6204
SonarQube的功能通过插件形式实现并扩展的，我们还可以通过添加其他插件增加功能或者替换插件。 1.1、默认安装的插件 SonarQube默认集成了Java Ecosystem插件，该插件是一组插件的合集，包含如下的这些插件： 插件名 说明 sonar-java-plugin java源代码解析，计算指标等 sonar-squid-java-plugin 检查潜在缺陷 sonar-checkstyle-plugin 检查代码编写风格 sonar-findbu
sonarqube部署
XMYX-0
04-14 313
SonarQube是一个用于静态代码分析的开源平台，旨在帮助开发团队发现和修复代码中的质量问题。它提供了一系列功能，包括代码质量度量、代码风格检查、代码复杂度评估、代码重复检测、安全漏洞检测等。静态代码分析：SonarQube可以分析源代码，并根据一系列预定义的规则和指标来评估代码的质量。这些规则可以涵盖代码质量、性能、安全性等方面。多语言支持：SonarQube支持多种编程语言，包括Java、C＃、JavaScript、C / C ++、Python等。这使得它成为跨多个项目和团队使用的强大工具。
SonarQube
坚强的尐2b゛的专栏
12-15 878
SonarQube
测试左移之Sonarqube scanner使用
hogwarts_2022的博客
04-21 118
Sonarqube scanner使用，需要先安装好环境及配置文件。 安装 作用：分析代码与数据，并上传，独立客户端程序 独立下载：https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner mac：brew install sonar-scanner scanner 有 2 种类型的配置文件，全局配置文件与项目配置文件。 全局配置文件 scanner 的全局配置文件用于保存一些全局性的配置，比如 sonar 的 toke
jenkins安装sonar-scanner
09-06
要在Jenkins中安装Sonar Scanner，您可以按照以下步骤操作： 1. 首先，确保您已经在系统中安装了Jenkins。如果没有，请根据您的操作系统使用适当的方法进行安装。 2. 打开Jenkins控制台，然后导航到“Manage Jenkins”>“Manage Plugins”。 3. 在“Available”选项卡中搜索“SonarQube Scanner”插件，并选择安装它。这个插件是用于集成SonarQube扫描器的。 4. 安装完成后，在“Manage Jenkins”>“Global Tool Configuration”中找到“SonarQube Scanner”部分。 5. 在该部分，单击“Add SonarQube Scanner”按钮，然后为该扫描器提供一个名称。 6. 在“Name”字段中输入一个描述性的名称，例如“Sonar Scanner”。 7. 在“Download automatically”字段中选择“Install automatically”。 8. 在“Analysis properties”字段中，您可以指定SonarQube服务器的URL和认证令牌。例如： ``` sonar.host.url=http://localhost:9000 sonar.login=your_auth_token ``` 注意替换上面示例中的URL和认证令牌为您自己的值。 9. 点击“Save”保存配置。 10. 现在，您可以在Jenkins作业的构建步骤中使用Sonar Scanner，使用先前创建的名称将其配置为全局工具。 这样，您就可以在Jenkins中成功安装和配置Sonar Scanner，并在构建过程中使用它来执行静态代码分析。注意，您还需要确保您的系统中已经安装了SonarQube服务器，以便与Jenkins集成。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IT_狂奔者

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值