随着信息技术的发展,我们的软件开发项目规模变得越来越庞大,所以我们的代码质量的管理变得越来越重要。为了让我们的持续集成更智能,发挥它强大的功能,今天我们在Jenkins中加入了我们的代码质量管理。下面来具体看看它的相关配置。
首先,我们要安装以下插件:
1. Jenkins FxCop Runner plugin:该插件就是在构建的时候调用FxCop来分析代码。
2. Static Analysis Utilities
3. Jenkins Violations plugin:该插件主要用来展示各种分析工具所产生的结果。
其次,系统设置,如下图。
注意:在配置Jenkins前必须确保机器已经安装了FXCop ,然后在下图配置FXCop的安装路径。
1. 使用FxCop分析程序集
FxCop是一个代码分析工具,它依照微软.NET框架的设计规范对托管代码assembly进行检查。它使用基于规则的引擎,来检查出你代码中不合规范的部分;也可以定制自己的规则加入到这个引擎。
为了能让FxCop在构建系统时运行,还需在任务中添加配置。在构建项目,选择增加构建步骤,选择FxCop exec,如下图:
添加配置信息。程序集名称为我们需要分析的项目所生成的程序集。输入xml文件为分析所产生的结果文件,为xml格式文件
。
完成好这些配置后,系统在构建的时候将会调用配置的工具进行代码分析。
2. 使用StyleCop审查代码
StyleCop的终极目标是让所有人都能写出优雅和一致的代码,因此这些代码具有很高的可读性。
StyleCop不是代码格式化(代码美化)工具,而是代码规范检查工具(Code Review 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。
StyleCop目的是帮助项目团队执行一系列常用的源代码格式规范,这些规范是关于如何开发布局规整,易读,易维护并且文档良好的优雅代码的 。
StyleCop现在包含了 200 个左右的最佳实践规则(best practice rules),这些规则与 Visual Studio 2005 和 Visual Studio 2008 中默认的代码格式化规则是一致的。
StyleCop安装
StyleCop是微软的开源项目,可到http://stylecop.codeplex.com/下载最新的安装包。在安装该工具的时候,尽量默认安装,并且MSBuild files一定要选上,不然有可能导致不能正常使用。
为了能让系统在构建时自动运行该工具,需编辑一下项目文件,添加如下配置:
3. 展示分析结果
在任务配置页面,构建后操作,增加构建后操作,选择Report Violations。
在Report Violations配置页面,设置要展示的文件。我闪这里设置FxCop、StyleCop分析所产生的文件。值得注意的是,StyleCop所产生的文件是在obj\Debug目录下。
完成这些配置后,重新构建任务。任务构建的主页会多出配置的分析报告。
点击某一项,还可以进入该项的详细分析报表。