.net持續整合sonarqube篇之sonarqube安裝與基本配置

周國通發表於2019-07-23

系列目錄

Sonarqube下載與安裝

Sonarqube下載地址是:https://www.sonarqube.org/downloads/下載版本有兩個,一個是長期支援版,另一個是最新版,此處安裝的是最新版,目前版本是7.3,下載的時候點選醒目的藍色按鈕即可(此時下載的是社群版),下面有三個無底色按鈕下載連結,分別對應的是開發者版,企業版和資料中心版,這些版本都不是免費版,需要獲取Licence key方可使用.目前起步階段,使用社群版就Ok了.

注意 Sonarqube是基於java語言開發的,因此執行之前必須先安裝Jre

Sonarqube支援Windows,mac和linux,但是安裝包並不區分平臺,也就是這三個平臺下載包是一樣的,只是啟動方式不同.

下載完成全將下載的壓縮包解壓,進入bin目錄,可以看到這個目錄下有數個資料夾,從資料夾的名稱很容易看出它們對應的是windows,mac,linux平臺下的啟動目錄,由於我們是在windows平臺下執行的,因此進入windows-x86-64目錄(當然,如果你的電腦是32位系統,則進入windows-x86-32目錄)此目錄下面有很多指令碼檔案,我們雙擊StartSonar.bat這個批處理檔案來執行windows下的sonarqube,啟動需要數十秒時間,請耐心等等.當看到控制檯最後一句是SonarQube is up說明sonarqube已經成功啟動.此時在瀏覽器位址列輸入localhost:9000就可以進入Sonarqube web管理頁面.

avatar

這個頁面是一個關於Sonarqube的介紹頁面,從這裡可以很清析地看到Sonarqube支援的語言,點選Read Documentation按鈕可以進入Sonarqube的幫助文件頁面.

Sonarqube基本配置

上一節我們已經成功啟動Sonarqube,然而僅僅把Sonarqube啟動起來並沒有什麼作用,我們還需要進行資料庫配置和掃描器(Sonarqube對特定語言的掃描工具稱為掃描器)配置才能把資料接入Sonarqube管理平臺.

`資料庫配置`

Sonarqube支援內嵌資料庫,mysql,oracle 11g/12c,sql server 2014/2016,postgresql 9.3+,由於oracle需要提供單獨的驅動比較麻煩,這裡就以mysql為例講解.

我們進入Sonarqube目錄下的conf目錄,下面有一個sonar.properties檔案,我們用記錄本開啟它,我們進入mysql欄把sonar.jdbc.url註釋取消掉,並加上以下程式碼

sonar.jdbc.username=root
sonar.jdbc.password=
sonar.sorceEncoding=UTF-8
sonar.login=root
sonar.password=

Sonarqube預設的資料庫名為sonar,需要我們手動建立,我們在自己常用的mysql管理工具裡新建即可.

以上是關於sonarqube mysql連線字串的配置.使用者名稱和密碼讀者根據實際情況填寫

以上筆者使用的是Xampp帶的mysql的預設配置,使用者名稱為root,密碼為空,注意這裡的password不能寫為"",而是什麼都不寫留空,當然如果有密碼就填寫實際密碼.

Sonarqube 7.3僅支援mysql 5.6及以上8.0以下版本,也就是說不支援8.0版本,需要特別注意.

Sonarqube也支援內嵌資料庫,然而內嵌資料庫不便於管理和遷移,強烈不建議在生產環境使用內嵌資料庫.

我們重新啟動Sonarqube,然後進入web管理介面,此時我們開啟mysql管理工具,可以看到sonarqube在sonarqube庫下建立了很多表.

`安裝配置Msbuild Scanner`

上一節我們說過,Sonarqube需要使用Scanner來掃描程式碼資料以供Sonarqube管理平臺使用,這裡我們下載 msbuild scanner掃描工具對c#程式碼進行掃描.

我們把Sonarqube web管理介面往下拉到最底,會看到一拍圖示

avatar

我們點選第一個圖示,也就是Visual Studio圖示,會進入一個頁面

avatar
圖示部分為下載連結,我們選擇.net framework 4.6+

注意,這裡下載連結的名稱雖然是for .net framework 4.6+,實際上仍然支援.net 4.0及以上版本,並不是只支援.net 4.6以上版本.

下載完成後,我們把壓縮包解壓到一個目錄,並把目錄地址新增到系統環境變數裡.

同樣,為了方便使用,我們也需要把msbuild.exe新增到環境變數中,如果你的系統中安裝的visual Studio開發工具,則Visual studio中會自動包含一個msbuild.exe我們找到它的路徑新增到系統環境變數path中.

`配置SonarQube.Analysis.xml檔案`

由於Scanner要通過rest api方式向伺服器提交資料,這裡需要對Sonarqube web伺服器地址和使用者名稱進行配置才能正常提交資料,我們開啟剛解壓的目錄,找到SonarQube.Analysis.xml檔案,新增以下三行配置即可

<Property Name="sonar.host.url">http://localhost:9000</Property>

  <Property Name="sonar.login">admin</Property>
  <Property Name="sonar.password">admin</Property>

以上配置很容易理解,url為Sonarqube伺服器地址,下面為登陸名和密碼(Sonarqube預設帶一個管理員賬號,使用者名稱為admin密碼也是admin,後面我們會講在生產環境中如何更改admin密碼)

再次回到剛才的下載頁面,定位到usage欄,可以看到有一個簡短的示例程式碼如下

SonarScanner.MSBuild.exe begin /k:"project-key"
MSBuild.exe /t:Rebuild
SonarScanner.MSBuild.exe end

我們依照這段程式碼的結構,對本地的一個專案進行編譯(可以是任意c#專案),進入專案sln或者csproj所在的資料夾下依次執行以下程式碼

SonarScanner.MSBuild.exe begin /k:"mygetdata" /v:"1.0"
MSBuild.exe /t:Rebuild
SonarScanner.MSBuild.exe end

第二段是執行msbuild,第三段是一個結束標誌,沒有什麼需要詳細說明的,關於msbuild構建的詳細資訊可以檢視微軟官網,也可以參照本教程其它章節.這裡簡要介紹下第一段的/k和/v引數,/k為key的縮寫,Sonarqube每一個專案都要有一個惟一key,key的規則可以自己定,但是需要方便管理,/v為version,如果兩個構建的key相同,verison不同,Sonarqube會生成一個對比以便直觀看到兩次構建的差異,這樣方便管理員檢視問題的解決情況.

執行完以上命令後,我們再進入Sonarqube首頁,這時候我們點選Login按鈕登陸,只有登陸以後才可以看到與專案相關的內容,點選例如後使用者名稱為admin,密碼也是admin(前面說過Sonarqube預設會帶一個使用者名稱和密碼都是admin的賬戶,後面我們會講如何更改密碼以及如何為不同的開發者分配賬戶)

登陸以後,就會看到一個如下圖所示的介面

avatar