天天看點

sonarqube+sonar runner分析C#代碼

最近研究一個代碼覆寫率和代碼分析工具。遇到一些比較坑的問題,現在分享給大家。

1、Sonar介紹

Sonar是一個用于代碼品質管理的開源平台,用于管理Java源代碼的品質。通過插件機制,Sonar 可以內建不同的測試工具,代碼分析工具,以及持續內建工具,比如pmd-cpd、checkstyle、findbugs、Jenkins。通過不同的插件對這些結果進行再加工處理,通過量化的方式度量代碼品質的變化,進而可以友善地對不同規模和種類的工程進行代碼品質管理。

同時 Sonar 還對大量的持續內建工具提供了接口支援,可以很友善地在持續內建中使用 Sonar。

此外,Sonar 的插件還可以對 Java 以外的其他程式設計語言提供支援,對國際化以及報告文檔化也有良好的支援

一:先搭好環境

1.jdk 1.7的版本,我現在用的1.8的版本,盡量用最新版的: http://www.oracle.com/technetwork/java/javase/downloads/java-se-jdk-7-download-432154.html 

安裝運作JDK以後,還需要做下面的幾項配置:

-計算機屬性》進階系統設定》進階》環境變量》系統變量

sonarqube+sonar runner分析C#代碼

- 添加伺服器環境變量JAVA_HOME, 内容為Java的安裝目錄。例如我這裡的安裝目錄為C:\Java\jdk1.8.0_11

- 在伺服器環境變量Path中添加Java bin的目錄,例如C:\Java\jdk1.8.0_11\bin

2:去sonar官網下載下傳最新的版本,我用的6.3 :https://www.sonarqube.org/downloads/

sonarqube+sonar runner分析C#代碼

解壓檔案;

1.下載下傳好sonarqube後,解壓打開bin目錄,啟動相應OS目錄下的StartSonar。如本文示範使用的是win的64位系統,則打開D:\sonar\sonarqube-6.3\sonarqube-6.3\bin\windows-x86-64\StartSonar.bat

2.啟動浏覽器,通路http://localhost:9000,如出現下圖則表示安裝成功。

sonarqube+sonar runner分析C#代碼

 MySQL資料庫配置

2.1執行資料庫腳本,建立資料庫sonars及使用者:

CREATE DATABASE sonars CHARACTER SET utf8 COLLATE utf8_general_ci; 

CREATE USER 'sonars' IDENTIFIED BY 'sonars';

GRANT ALL ON sonars.* TO 'sonars'@'%' IDENTIFIED BY 'sonars';

GRANT ALL ON sonars.* TO 'sonars'@'localhost' IDENTIFIED BY 'sonars';

FLUSH PRIVILEGES;

2.2修改sonar配置檔案

在D:\sonarqube-6.3.1\sonarqube-6.3.1\conf\sonar.properties

在MySQL 5.6 or greater下載下傳添加下面這段。并且去掉#

sonar.jdbc.url=jdbc:mysql://localhost:3306/sonars?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

sonar.jdbc.username=sonars

sonar.jdbc.password=sonars

sonar.sorceEncoding=UTF-8

sonar.login=admin

sonar.password=admin

url是資料庫連接配接位址,username是資料庫使用者名,jdbc.password是資料庫密碼,login是sonarqube的登入名,sonar.password是sonarqube的密碼

 sonar預設的登陸名和密碼都是admin,預設端口是http://localhost:9000/

我們現在更改預設端口,改成自己想要的端口

sonarqube+sonar runner分析C#代碼

 重新開機服務之前,必須關閉目前服務,否則會出現如下圖所示

sonarqube+sonar runner分析C#代碼

這個時候是因為我們啟動sonar服務的同時,也啟動了jdk 的Java服務,必須關閉所有的Java服務

一、Linux下重新開機sonar

1、先進入sonar安裝bin目錄下如.\sonarqube-6.3\bin\linux-x86-64,運作如下指令:

./sonar.sh restart   重新開機服務

2、其他常用的指令如下:

./sonar.sh stop 停止服務 

./sonar.sh start 啟動服務

二、Windows下重新開機sonar:

1、首先關閉SonarQube.bat視窗

2、再Ctrl+Shift+Esc調出windows資料總管

3、在程序中關閉所有Java.exe程序

4、然後重新進入.\sonarqube-6.3\bin\windows-x86-32,運作StartSonar.bat檔案

sonarqube+sonar runner分析C#代碼

重新開機sonarqube服務,通路http://localhost:9100,會稍微有點慢,因為要初始化資料庫資訊

sonarqube+sonar runner分析C#代碼

資料庫初始化成功後,登入admin 

登陸後,進入插件安裝頁面,下載下傳自己需要的插件,我做的是C#的項目,Chinese Pack、CSS / SCSS / Less、Checkstyle、Code Smells、CodeCracker for C# 

sonarqube+sonar runner分析C#代碼

3:安裝sonar sunner

下載下傳目錄:http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip

 3.1配置環境變量

1) 計算機屬性》進階系統設定》進階》環境變量》系統變量

2) 在“系統變量(S)”下點選“建立(W)...”,在編輯系統變量對話框中添加SONAR_RUNNER_HOME變量。

3) 在“系統變量(S)”下找到“Path”,點選“編輯(I)...”,在編輯系統變量對話框中“變量值(V):”輸入框内容未尾添加、“;%SONAR_RUNNER_HOME%\bin”,點确定。

sonarqube+sonar runner分析C#代碼

4) 按wind+r 輸入 cmd  輸入 sonar-runner -v

出現如下界面,說明配置成功了

sonarqube+sonar runner分析C#代碼

3.2 配置Sonar Runner》sonar-runner.properties

路徑:D:\sonar-scanner-2.5\sonar-scanner-2.5\conf\sonar-runner.properties

添加配置資訊,我們配置的Mysql哦

sonar.jdbc.username=sonars

sonar.jdbc.password=sonars

sonar.sourceEncoding=UTF-8

sonar.host.url=http://localhost:9100

sonarqube+sonar runner分析C#代碼

4.配置C#項目sonar-project.properties檔案

4.1建立一個sonar-project.properties檔案

sonar.projectKey=TestClient

sonar.projectName=TestClient

sonar.projectVersion=1.0

# Info required for Sonar

sonar.sources=TestClient

#sonar.language=C#

sonarqube+sonar runner分析C#代碼

注意:sonar-project.properties檔案要和.sln在同一個目錄

sonarqube+sonar runner分析C#代碼

4.2 掃描代碼

在項目TestClient目錄下D:\Testwcf\TestClient> 輸入 sonar-runner

sonarqube+sonar runner分析C#代碼

等一分鐘後,尼看回到如下圖所示的成功字樣,說明你已經成功了 

sonarqube+sonar runner分析C#代碼

如果出現如下圖所示的錯誤

sonarqube+sonar runner分析C#代碼

輸入sonar-runner -X 檢視自己出現的異常資訊,

現在我們在登陸http://localhost:9100/overview?id=TestClient

出現如下圖所示,這樣就配置好了

sonarqube+sonar runner分析C#代碼

 5 插件配置

Sonar支援多種插件,插件的下載下傳位址為:http://docs.codehaus.org/display/SONAR/Plugin+Library

将下載下傳後的插件上傳到${SONAR_HOME}extensions\plugins目錄下,重新啟動sonar。

sonar預設內建了Java Ecosystem插件,該插件是一組插件的合集

  • Java [sonar-java-plugin]:java源代碼解析,計算名額等
  • Squid [sonar-squid-java-plugin]:檢查違反Sonar定義規則的代碼
  • Checkstyle [sonar-checkstyle-plugin]:使用CheckStyle檢查違反統一代碼編寫風格的代碼
  • FindBugs [sonar-findbugs-plugin]:使用FindBugs檢查違反規則的缺陷代碼
  • PMD [sonar-pmd-plugin]:使用pmd檢查違反規則的代碼
  • Surefire [sonar-surefire-plugin]:使用Surefire執行單元測試
  • Cobertura [sonar-cobertura-plugin]:使用Cobertura擷取代碼覆寫率
  • JaCoCo [sonar-jacoco-plugin]:使用JaCOCO擷取代碼覆寫率

下面列出了一些常用的插件:

  • JavaScript代碼檢查:http://docs.codehaus.org/display/SONAR/JavaScript+Plugin
  • python代碼檢查:http://docs.codehaus.org/display/SONAR/Python+Plugin
  • Web頁面檢查(HTML、JSP、JSF、Ruby、PHP等):http://docs.codehaus.org/display/SONAR/Web+Plugin
  • xml檔案檢查:http://docs.codehaus.org/display/SONAR/XML+Plugin
  • scm源碼庫統計分析:http://docs.codehaus.org/display/SONAR/SCM+Stats+Plugin
  • 檔案度量:http://docs.codehaus.org/display/SONAR/Tab+Metrics+Plugin
  • 中文語言包:http://docs.codehaus.org/display/SONAR/Chinese+Pack
  • 時間表顯示度量結果:http://docs.codehaus.org/display/SONAR/Timeline+Plugin
  • 度量結果演進圖:http://docs.codehaus.org/display/SONAR/Motion+Chart+Plugin

文章就分享到這裡了,下次繼續分享jenkins內建和sonar持續審查