使用 Jenkins 與 Sonar 集成對代碼進行持續檢測

SonarQube 與 Jenkins 簡介

1. SonarQube是 一個開源的代碼質量分析平臺，便於管理代碼的質量，可檢查出項目代碼的漏洞和潛在的邏輯問題。同時，它提供了豐富的插件，支持多種語言的檢測， 如 Java、Python、Groovy、C、C++等幾十種編程語言的檢測。它主要的核心價值體如今以下幾個方面：

   • 檢查代碼是否遵循編程標準：如命名規範，編寫的規範等。
   • 檢查設計存在的潛在缺陷：SonarQube 經過插件 Findbugs、Checkstyle等 工具檢測代碼存在的缺陷。
   • 檢測代碼的重複代碼量：SonarQube能夠展現項目中存在大量複製粘貼的代碼。
   • 檢測代碼中註釋的程度：源碼註釋過多或者太少都很差，影響程序的可讀可理解性。
   • 檢測代碼中包、類之間的關係：分析類之間的關係是否合理，複雜度狀況。

2. SonarQube 平臺是由4個部分組成:

   • SonarQube Server
   • SonarQube Database
   • SonarQube Plugins
   • SonarQube Scanner

Jenkins 與 SonarQube 集成插件的安裝與配置

Jenkins 是一個支持自動化框架的服務器，咱們這裏不作詳細介紹。Jenkins 提供了相關的插件，使得 SonarQube 能夠很容易地集成 。

1. 登錄 jenkins，點擊"系統管理"，如圖。
   
2. Jenkins 管理插件

   

3. Jenkins 安裝 SonarQube 插件

   

4. 進入 Jenkins 系統管理 – 系統設置，配置 SonarQube Server 信息

   

5. 進入 Jenkins 系統管理 - Global Tool Configuration，配置 SonarQube Scanner

   

6. 新建 Jenkis 項目

   

7. 在 Jenkins 項目構建過程當中加入 SonarScanner 進行代碼分析

   首先須要在新建的 Jenkins 項目的構建環境標籤頁中勾選"Prepare SonarQube Scanner evironment"

   

8. 增長 Execute SonarQube Scanner 構建步驟

   

9. 配置 SonarQube Scanner 構建步驟，在 Task to run 輸入框中輸入 scan，即分析代碼；在 JDK 選擇框中選擇 SonarQube Scanner 使用的 JDK（注意這裏必須是 JDK 不能是 JRE）；Path to project properties 是可選擇的輸入框，這裏能夠指定一個 sonar-project.properties 文件，若是不指定的話會使用項目默認的 properties 文件；Analysis properties 輸入框，這裏須要輸入一些配置參數用來傳遞給 SonarQube，這裏的參數優先級高於 sonar-project.properties 文件裏面的參數，因此能夠在這裏來配置全部的參數以替代 sonar-project.properties 文件，下面列出了一些參數，sonar.language 指定了要分析的開發語言（特定的開發語言對應了特定的規則），sonar.sources 定義了須要分析的源代碼位置（示例中的$WORKSPACE 所指示的是當前 Jenkins 項目的目錄），sonar.java.binaries 定義了須要分析代碼的編譯後 class 文件位置；Additional arguments 輸入框中能夠輸入一些附加的參數，示例中的-X 意思是進入 SonarQube Scanner 的 Debug 模式，這樣會輸出更多的日誌信息；JVM Options 能夠輸入在執行 SonarQube Scanner 是須要的 JVM 參數

   sonar.projectKey=testSonar 
   sonar.projectName=testSonar 
   sonar.projectVersion=1.0 
   sonar.language=java 
   sonar.java.binaries=$WORKSPACE/testSonar/target/test-classes/ 
    sonar.sources=$WORKSPACE/testSonar/src

10. 配置 Execute SonarQube Scanner 構建步驟

    

11. Jenkins 項目構建結果

    

12. 分析結果報告

    

13. 具體問題展現

    

參考資源

Jenkins 官網
Sonarqube 官網

如感受文章對你有所幫助，能夠關注微信公衆號鼓勵一下