Jenkins使用sonarQube實現一個代碼質量檢查功能

本篇文章給大家分享的是有關Jenkins使用sonarQube實現一個代碼質量檢查功能，小編覺得挺實用的，因此分享給大家學習，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

1.sonarQube的簡介

SonarQube是一款自動化代碼審查工具，用于檢測代碼中的錯誤、漏洞和代碼異味。它可以與你現有的工作流集成，以支持跨項目分支和拉取請求的連續代碼檢查。

其工作流程如下：

如圖SonarQube由以下4個組件組成：

1.SonarQube Server：

WebServer：供開發人員，管理人員瀏覽高質量的快照并配置SonarQube實例Search Server：基于Elasticsearch的Search Server從UI進行后退搜索(歷史)computeEngine：負責處理代碼分析報告并將其保存在SonarQube數據庫中

2.SonarQube Database：

SonarQube實例的配置（安全性、插件設置等）項目、視圖等的質量快照。

3.SonarQube Plugins：服務器上安裝了多個SonarQube插件，可能包括語言，SCM，集成，身份驗證和管理插件

4.SonarScanners：多種sonar掃描組件，在構建/持續集成服務器上運行以分析項目。

關于sonar的具體介紹可參考其官網。

2.SonarQube的安裝

SonarQube提供了多種安裝方式，本文將使用docker鏡像的安裝方式進行演示。

1.拉取sonarQube的docker容器

$> docker pull sonarqube:8.2-community

2.創建docker數據卷

#包含數據文件，例如嵌入式H2數據庫和Elasticsearch索引
$> docker volume create --name sonarqube_data
#包含插件，例如語言分析器
$> docker volume create --name sonarqube_extensions
#包含有關訪問，Web流程，CE流程和Elasticsearch的SonarQube日志
$> docker volume create --name sonarqube_logs

3.配置本地數據庫（示例使用postgresql）

如果使用postgresql的默認schema "public"，則無需這一步。如果想自定義schema，則執行以下命令

ALTER USER mySonarUser SET search_path to <自定義的schema名稱>

4.啟動sonarQube

$> docker run -d --name sonarqube \
-p 9000:9000 \
#以下為給sonarQube的數據庫配置，推薦postgresql
-e SONAR_JDBC_URL=jdbc:postgresql://xxxx:5432/postgres \
-e SONAR_JDBC_USERNAME=... \
-e SONAR_JDBC_PASSWORD=... \
-v sonarqube_data:/opt/sonarqube/data \
-v sonarqube_extensions:/opt/sonarqube/extensions \
-v sonarqube_logs:/opt/sonarqube/logs \
<image_name>

本地瀏覽器訪問localhost:9000即可訪問。

3.sonarQube中創建項目步驟

1:新建項目

步驟2:填寫項目信息

步驟3:創建令牌

步驟4:記錄令牌

創建項目完成，并且記錄下令牌，后續步驟會用到。

4.jenkins配置sonarQube插件1.安裝sonarQube插件

2.添加sonarQube配置

在jenkins>Manage Jenkins>global configuration中配置sonar的信息，如下圖：

name為自定義的名字，serverURL為sonarqube的訪問地址

最后一項token需要添加。點擊添加，如下圖：

類型選擇 Secret text，并將我們在第三步中得到的token填入secret欄，其余欄目自定義。添加完后，回到上一步Server authentication token選擇剛剛添加的token。

5.項目中引入sonarQube

以下為maven單模塊項目示例：

1.引入sonarqube插件：

<!--添加參數，指定projectKey，即在sonar中創建項目時的名稱-->
<properties>
	<sonar.projectKey>sonar-demo</sonar.projectKey>
</properties>
<!--添加sonarqube插件-->
<plugin>
 <groupId>org.sonarsource.scanner.maven</groupId>
 <artifactId>sonar-maven-plugin</artifactId>
 <version>3.6.0.1398</version>
</plugin>

2.手動代碼掃描

執行以下命令

mvn sonar:sonar \
-Dsonar.projectKey=sonar的項目名稱 \
-Dsonar.host.url=http://sonar的地址 \
-Dsonar.login=第三步記錄的令牌

執行完成回到sonarQube界面，可看到掃描記錄及結果：

6.jenkins

6.jenkins pipeline中集成sonarqube

在jenkinsfile中定義代碼靜態檢查的stage，如下圖：

上圖中定義了兩個stage，1.代碼靜態檢查 2.檢查結果分析

&#9888;&#65039;：檢查結果分析階段jenkins通過sonarqube的回調來得知掃描結果,需要在sonarqube中配置webhook：

webhook域名為jenkins地址域名。

至此，在jenkins pipeline（流水線）中成功集成sonarqube，如下圖：

7.sonarQube

7.sonarQube自定義質量閥

1.創建自定義質量閥

2.

配置質量閥

3.測試

例如當閥值過高時，掃描結果不符合閥值要求，掃描結果則會失敗。

示例中我們隨便調整某個條件至當前項目無法到達的值

此時當pipeline在運行的時候，代碼質量檢查就會失敗，因為沒有達到標準。

所以，我們在自定義自己項目的閥值的時候要視不同的項目情況而定。

8.總結

本文介紹了在jenkins多分支流水線中集成sonarQube,從而實現在持續集成中代碼質量檢查。文章涉及到的某些方面（jenkinsfile，sonarQube詳細使用等等）沒有詳細介紹，只是快速帶過了。sonarQube是業界知名度很高的代碼檢查工具，也是ci/cd中的工具生態成員。深入探索它，還會發現更多有用的，有趣的特性。代碼質量檢查時代碼質量內建的一部分，在流水線中集成代碼質量檢查可以及時的發現代碼中存在的問題和缺陷，從而及時修復問題，防止技術債務的堆積（還是那句話，解決問題最好的時機時問題出現的那一刻），否則當問題堆積到一定程度的時候，修復成本會越來越高。

以上就是Jenkins使用sonarQube實現一個代碼質量檢查功能，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。