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以后,还需要做下面的几项配置:

-计算机属性》高级系统设置》高级》环境变量》系统变量

 

– 添加服务器环境变量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/

解压文件;

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,如出现下图则表示安装成功。

 

 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/

我们现在更改默认端口,改成自己想要的端口

 重启服务之前,必须关闭当前服务,否则会出现如下图所示

这个时候是因为我们启动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服务,访问http://localhost:9100,会稍微有点慢,因为要初始化数据库信息

 

数据库初始化成功后,登录admin 

登陆后,进入插件安装页面,下载自己需要的插件,我做的是C#的项目,Chinese Pack、CSS / SCSS / Less、Checkstyle、Code Smells、CodeCracker for 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”,点确定。

 

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

出现如下界面,说明配置成功了

3.2 配置Sonar Runner》sonar-runner.properties

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

添加配置信息,我们配置的Mysql哦

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.sourceEncoding=UTF-8

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

 

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#
sonar.sourceEncoding=UTF-8

注意:sonar-project.properties文件要和.sln在同一个目录

 

4.2 扫描代码

在项目TestClient目录下D:\Testwcf\TestClient> 输入 sonar-runner

 

等一分钟后,尼看回到如下图所示的成功字样,说明你已经成功了 

 

如果出现如下图所示的错误

输入sonar-runner -X 查看自己出现的异常信息,

现在我们在登陆http://localhost:9100/overview?id=TestClient

出现如下图所示,这样就配置好了

 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获取代码覆盖率

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

文章就分享到这里了,下次继续分享jenkins集成和sonar持续审查

Posted in 介绍及安装说明, 使用说明.