Linux環境SonarQube部署

SonarQube安裝

預置條件

下載之後上傳到linux伺服器，解壓安裝：

部署路徑：/srv/www/app/sonar

 unzip sonarqube-5.1.2.zip

MySQL建庫

CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;

CREATE USER 'sonar' IDENTIFIED BY 'sonar';

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

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

FLUSH PRIVILEGES;

編輯conf目錄下sonar.properties配置：

vi /srv/www/app/sonar/sonarqube-5.1.2/conf/sonar.properties

新增以下內容：

#資料庫連線配置
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance

#根據需求修改預設配置（預設9000埠）
 

#sonar.web.host=0.0.0.0
#sonar.web.context=

SonarQube會自動下載MySQL驅動包

啟動 SonarQube Web Server

/srv/www/app/sonar/sonarqube-5.1.2/bin/linux-x86-64/sonar.sh start
/* 初次啟動會自動建表和做相應的初始化 */

初始語言是英文

新增中文語言包

1. 將下載好的sonar-l10n-zh-plugin-1.6.jar複製到${SONAR_HOME}/extensions/plugins

2. 重啟SonarQube專案：/srv/www/app/sonar/sonarqube-5.1.2/bin/linux-x86-64/sonar.sh restart

SonarQube安裝完畢

sonar-runner-dist-2.4安裝

安裝目錄：/srv/www/app/sonar/sonar-runner-dist-2.4

配置PATH路徑

vi /etc/profile
在檔案最後加入如下內容，儲存並退出。

PATH=$PATH:/srv/www/app/sonar/sonar-runner-dist-2.4/bin
export PATH

source /etc/profile

配置sonar-runner啟動配置檔案

vi /srv/www/app/sonar/sonar-runner-dist-2.4/conf/sonar-runner.properties

把下面內容前#號去掉或增加後，儲存並退出

sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.username=thinkxdt
sonar.jdbc.password=testpwd
sonar.login=admin
sonar.password=admin

安裝成功後重啟伺服器，在命令列執行以上命令並回顯，表示執行成功。
[[email protected] root]# sonar-runner -h
INFO:
INFO: usage: sonar-runner [options]
INFO:
INFO: Options:
INFO: -D,–define Define property
INFO: -e,–errors Produce execution error messages
INFO: -h,–help Display help information
INFO: -v,–version Display version information
INFO: -X,–debug Produce execution debug output

sonar-scanner2.6安裝

cd /srv/www/app/sonar

下載

unzip sonar-scanner-2.6.zip

mv sonar-scanner-2.6/ /srv/www/app/sonar/

配置PATH路徑

vi /etc/profile

在檔案最後加入如下內容，儲存並退出。

PATH=$PATH:/srv/www/app/sonar/sonar-runner-2.4/bin:/srv/www/app/sonar/sonar-scanner-2.6/bin
export PATH

配置sonar-scanner啟動配置檔案

vi /srv/www/app/sonar/sonar-scanner-2.6/conf/sonar-scanner.properties

把下面內容前#號去掉或增加後，儲存並退出

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

安裝成功後重啟伺服器，在命令列執行以上命令並回顯，表示執行成功。

[[email protected] root]# sonar-scanner -h
INFO:
INFO: usage: sonar-scanner [options]
INFO:
INFO: Options:
INFO: -D,–define Define property
INFO: -h,–help Display help information
INFO: -v,–version Display version information
INFO: -X,–debug Produce execution debug output
INFO: -i,–interactive Run interactively

SonarQube使用

把開發程式的原始碼打包成zip檔案上傳到安裝有Runner或Scanner的伺服器上

解壓上傳的原始碼：

cd /srv/www/app/sonar/project/

unzip prodectName.zip

使用sonar-scanner進行程式碼質量分析

1、在伺服器上建立一個準備用Scanner執行的配置檔案

cd prodectName/

vim sonar-project.properties

2、建立檔案內容如下：

#must be unique in a given SonarQube instance   
sonar.projectKey=ifc-handheld-webapp:scanner         
#this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 5.1.2
sonar.projectName=ifc-handheld-webapp-scanner    
sonar.projectVersion=1.0

#Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.   
#Since SonarQube 4.2, this property is optional if sonar.modules is set.     
#If not set, SonarQube starts looking for source code from the directory containing     
#the sonar-project.properties file.    
sonar.sources=.

#Encoding of the source code. Default is default system encoding   
#sonar.sourceEncoding=UTF-8

3、儲存並退出後執行命令進行分析（分析中不能執行Findbugs3.4.3分析，在web端解除安裝這個規則後可以正常分析）：

sonar-scanner
注意：必須在檢測專案根路徑下執行命令

在web中檢視Scanner程式碼質量分析的結果

登入賬戶：admin
登入密碼：admin

Home –> projects

使用sonar-Runner進行程式碼質量分析

1、修改下Scanner執行時的配置檔案

cd /srv/www/app/sonar/project/

vim sonar-project.properties

2、修改檔案內容如下：

#must be unique in a given SonarQube instance   
sonar.projectKey=ifc-handheld-webapp:runner    
#this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 5.1.2
sonar.projectName=ifc-handheld-webapp-runner    
sonar.projectVersion=1.0

#Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.   
#Since SonarQube 4.2, this property is optional if sonar.modules is set.     
#If not set, SonarQube starts looking for source code from the directory containing     
#the sonar-project.properties file.    
sonar.sources=.

#Encoding of the source code. Default is default system encoding   
#sonar.sourceEncoding=UTF-8

3、儲存並退出後執行命令進行分析（分析中不能執行Findbugs3.4.3分析，在web端解除安裝這個規則後可以正常分析）：

sonar-runner
注意：必須在檢測專案根路徑下執行命令

在web中檢視Runnner程式碼質量分析的結果

基於Maven配置

<!-- 首先在 Maven 的 settings.xml 檔案中新增如下標籤，內容需與sonar.properties中設定的一致。 -->
<profile>
      <id>sonar</id>
      <activation>
          <activeByDefault>true</activeByDefault>
      </activation>
      <properties>
          <sonar.jdbc.url>jdbc:mysql://localhost:3306/sona</sonar.jdbc.url>
          <sonar.jdbc.driver>oracle.jdbc.OracleDriver</sonar.jdbc.driver>
          <sonar.jdbc.username>sonar</sonar.jdbc.username>
          <sonar.jdbc.password>sonar</sonar.jdbc.password>
          <sonar.host.url>http://ip:9000</sonar.host.url>
      </properties>   
</profile>

<!-- 修改Maven工程的pom.xml，新增sonar外掛：-->
<plugin>
       <groupId>org.codehaus.mojo</groupId>
       <artifactId>sonar-maven-plugin</artifactId>
       <version>2.6</version>
</plugin>

在maven中執行clean sonar:sonar，訪問sonar，即可看到分析結果。