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管理頁面.
這個頁面是一個關於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管理界面往下拉到最底,會看到一拍圖標
我們點擊第一個圖標,也就是Visual Studio圖標,會進入一個頁面
圖示部分為下載鏈接,我們選擇.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的賬戶,后面我們會講如何更改密碼以及如何為不同的開發者分配賬戶)
登陸以后,就會看到一個如下圖所示的界面
從圖中我們可以看到我們剛才創建的key 為mygetdata的構建了,從圖中可以簡要的看到此項目的嚴重bug,一般bug,代碼不規范,代碼單元測試覆蓋率,代碼重復度,代碼最后一次分析時間等.
我們點擊mygetdata這個標題,便會進去關於這個構建任務的更為詳細信息
可以看到信息更為詳細,切換上面的導航欄可以看到關於某一個維度的更為詳細的信息.
圖標中的數字大都是可以點擊的鏈接,比如頁面中顯示bugs為10我們點擊
10這個數字可以進入這10個bug的代碼詳情
