SonarQube系列一、Linux安裝與部署

本文轉載自查看原文 2019-08-12 11:29 4506 DevOps

【前言】

隨着項目團隊規模日益壯大，項目代碼量也越來越多。且不說團隊成員編碼水平層次不齊，即便是老手，也難免因為代碼量的增加和任務的繁重而忽略代碼的質量，最終的問題便是bug的增多和代碼債務的堆積。因此，代碼review便日益提上了日程。當然人工review的效率還是相當低下的，於是我們采用了自動化代碼review的工具，便是今天的主角：SonarQube。

本系列主要講述sonarqube的安裝部署以及如何集成jenkins自動化分析.netcore項目。目錄如下：

【SonarQube簡介】

SonarQube® 是一種自動代碼審查工具，用於檢測代碼中的錯誤，漏洞和多余的代碼。它可以與您現有的工作流程集成，以便在項目分支和拉取請求之間進行連續的代碼檢查。比如：

SonarQube集成 gitlab，在分支推送的時候自動進行代碼檢查分析，生成代碼報告。
SonarQube集成 jenkins，在代碼構建的時候自動進行代碼分析，生成代碼報告。

總之，SonarQube是可以配合一切好用的CI/CD工具進行自動化分析代碼並生成代碼報告，通過報告我們可以看到代碼中可能存在的bug和代碼債務。

官方網站：https://www.sonarqube.org/

【SonarQube安裝】

打開官網（上述官網地址），便可以很容易看到官方文檔的菜單，安裝步驟在官網很清楚了，我們參考文檔進行安裝，這里記錄整個安裝的過程以便幫助一些看文檔迷惑的學者。

官方文檔地址：https://docs.sonarqube.org/latest/

1.首先別忙着下載

左側有下拉框可以選擇sonarqube的各個版本，我們可以選擇切換不同的版本以查看不同時期的文檔

我們首先打開 Requirements ，查看當前版本的軟硬件支持。

SonarQube 依賴於Java 環境，也就是需要安裝Jre，在這里寫了支持的版本：

SonarQube 支持的數據庫有：PostgreSQL，Microsoft SQL Server，Oracle，注意7.9版本已經不對MySql進行官方的支持了，如果執意要用 Mysql 可能會遇到很多坑（我就被坑的不輕）。當然有的朋友想用Mysql數據庫，那么可以選擇安裝 7.7 以下版本（包括7.7）。
SonarQube 運行需要ES（ElasticSearch），當然這個不用我們安裝，下載的安裝包已經包含了ES。

因為我用到了Mysql數據庫，綜合軟硬件說明我選擇了7.6版本的SonarQube進行下載安裝。

2.下載 SonarQube

同樣在左側菜單找到 Setup and Upgrade 選項，打開以后按步驟找到 Download 鏈接，下載對應版本的安裝包。

SonarQube 的安裝包是不分平台的，默認把所有平台的運行命令都下載下來，使用者根據不同環境運行不同的運行腳本。

下載完成后，我們把安裝包 sonarqube-7.6.zip 放在linux服務器的安裝目錄（喜歡的任意位置），然后用解壓命令解壓

unzip sonarqube-7.6.zip

進入文件夾，我們了解幾個重要的目錄

bin目錄存放了各個環境的啟動腳本
conf目錄存放着sonarqube的配置文件
logs目錄存放着啟動和運行時的日志文件

3.配置 SonarQube

關於jdk的安裝這里就不多說了，我們直接進入sonarqube 的配置。

我們首先需要通過配置文件修改 sonarqube 的 mysql 連接字符串等信息，打開 conf 目錄的 sonar.properties

我們只需要修改mysql部分就ok了，其他不用過多設置

#----- DEPRECATED 
#----- MySQL >=5.6 && <8.0
# Support of MySQL is dropped in Data Center Editions and deprecated in all other editions
# Only InnoDB storage engine is supported (not myISAM).
# Only the bundled driver is supported. It can not be changed.
sonar.jdbc.url=jdbc:mysql://localhost:39901/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&maxAllowedPacket = 16777216&useSSL=false
sonar.jdbc.username=sonarqube
sonar.jdbc.password=xxxxx

這里的配置是按照官方文檔的介紹，在mysql添加了一個 sonarqube 的用戶，並且創建了一個數據庫叫 sonarqube ，且將數據庫的讀寫執行權限賦給 sonarqube用戶，用於在站點初始化以及后續存儲設置數據時對數據庫進行修改。

sonarqube web 默認端口號為 9000 如果想修改成其他端口可以通過下面這個設置修改其他端口號。