集成TFS Build生成与SonarQube获取代码分析结果

2022-11-24 18:16:07

软件项目在开发过程中，往往由于任务重、时间紧等原因忽略软件代码的质量和规范检查，只注重软件功能的开发和交付。等软件交付上线以后，由于代码质量导致的问题会耗费开发和运维人员的大量时间。研发表明，项目上线以后在生产环境中修复一个Bug，将耗费三倍于开发过程中修复该Bug所耗费的时间。由此可见，需要在开发过程中不断提高代码质量，避免潜在的问题，减少项目交付以后的技术负债。

在软件开发过程中检测代码质量，持续集成构建无疑是最好的选择。本文建介绍如何利用TFS的持续构建与代码质量分析工具SonarQube之间的集成，实现实时分析代码质量，帮助开发人员在开发过程中提高代码质量。

一、必备工具

本文中作者使用了下列软件产品：

- Microsoft Visual Studio Team Foundation Server 2015.1 https://www.visualstudio.com/en-us/products/tfs-overview-vs.aspx

- SonarQube 5.3 http://www.sonarqube.org/downloads/

- SonarQube Scanner for MSBuild 2.0 http://docs.sonarqube.org/display/SONAR/Analyzing+with+SonarQube+Scanner+for+MSBuild

- SonarQube C# Plugin http://docs.sonarqube.org/display/PLUG/C%23+Plugin

二、安装SonarQube

这里介绍如何在Windows Server 2012上，使用SQl Server 2014数据库安装和配置SnoarQube服务器。如果你已经拥有了一个SonarQube服务器，则可以忽略这一章节。

至于Team Foundation Server的安装，过程比较复杂，并不是本文关注的重点，你可以参考微软的官方文档https://msdn.microsoft.com/en-us/Library/vs/alm/TFS/setup/overview 安装和配置TFS服务器。

下载和安装Java JDK

SonarQube是一个基于Java的应用服务器，需要首先在服务器上下载和配置JDK 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

下载SonarQube安装程序

SonarQube是一个开源程序，可以从官网下载http://www.sonarqube.org/downloads/ 我这里下载的是目前的最新版本5.3。
下载以后建软件解压缩到服务器的本地文件夹中，例如我这里解压缩的目录为C:\sonarqube-5.3。然后按照下面的步骤配置SonarQube服务器：

1. 在SQL Server数据库中创建一个空的名称为sonar数据库，用于存储SonarQube的数据。

2. 在SQL Server数据库中创建一个SQL Server账户sonar，密码sonar，并将该账户赋予上述数据库的dbowner权限，用于SonarQube服务器读取数据。

3. 修改SonarQube服务器的配置文件

修改配置文件：C:\sonarqube-5.3\conf\sonar.properties

删除下面的代码行注释标志#，并填写访问数据库的账户和密码，

sonar.jdbc.username=sonar

sonar.jdbc.password=sonar

删除下面的代码行注释标志#

sonar.jdbc.url=jdbc:sqlserver://tfsdb;databaseName=sonar