Jenkins+PMD构建自动化静态代码检测

最新推荐文章于 2021-08-08 08:41:25 发布

hunterno4

最新推荐文章于 2021-08-08 08:41:25 发布

阅读量1.2w

点赞数

分类专栏：自动化测试持续集成文章标签： jenkins pmd 静态代码检测自动化测试软件测试

本文链接：https://blog.csdn.net/hunterno4/article/details/9304573

版权

本文介绍了如何结合Jenkins和PMD工具进行自动化静态代码检测，以提升软件质量。PMD作为开源的Java代码分析器，能发现代码错误。通过配置ant脚本，生成XML和HTML格式报告，方便Jenkins分析和团队成员查阅。在Jenkins中设置执行Shell命令即可实现自动化流程。

摘要由CSDN通过智能技术生成

前言：软件缺陷是不可避免的，要尽量减少错误并提高软件质量，主要有两在类技术，即缺陷预防和缺陷检测

缺陷预防包括编写更好的设计规范、实施代码审核制度、运行代码静态分析工具、运行单元测试等

PMD是一种开源分析Java代码的工具，通过静态分析获知代码错误，该工具可以做到检查Java代码中是否含有未使用的变量、是否含有空的抓取块、是否含有不必要的对象等等

因此Jenkins+PMD构建自动化静态代码检测是很有必要的

PMD下载地址：http://sourceforge.net/projects/pmd/

下载后解压即可

PMD主要可以通过ant脚本来执行，编写ant的build文件，这里新建的为如buildPMD.xml

<?xml version="1.0" encoding="UTF-8"?>

</include></pathelement></pathelement></pathelement></pathelement></path>
<target depends="pmd_html" name="pmd">
  <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" classpathref="pmd.classpath">
   
   
    
  	<pmd rulesetfiles="${basedir}/pmdrule.xml" encoding="UTF-8">
    
    <formatter type="html" tofile="pmd_report.html" toconsole="true">
    
    <fileset dir="${ExampleProject.location}/src">
        <include name="**/*.java">
    </include></fileset>
  </formatter></pmd>
</taskdef></target>

</project>

本文中定义了两个target，分别生成了XML和HTML格式的报告，因为在Jenkins中的分析插件需要用XML格式才能生成视图报告，而XML格式对于团队来说不直观，不宜发送邮件，因此生成两份报告，一份用于Jenkins分析，一份发送邮件用于团队成员直接查看

编写好buildPMD.xml，直接使用ant -f buildPMD.xml即可在CMD命令或Linux shell下执行PMD静态代码检测

在Jenkins中新建个任务，Build项Add build step中选择“Execute Shell”，输入ant -f buildPMD.xml即可

附：pmdrule.xml

<?xml version="1.0" encoding="UTF-8"?>
<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="pmdrule" xsi:schemalocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
   <description>PMD Plugin preferences rule set</description>
   <rule ref="rulesets/java/design.xml/AbstractClassWithoutAbstractMethod">
   <rule ref="rulesets/java/design.xml/AbstractClassWithoutAnyMethod">
   <rule ref="rulesets/java/naming.xml/AbstractNaming">
   <rule ref="rulesets/java/design.xml/AccessorClassGeneration">
   <rule ref="rulesets/java/optimizations.xml/AddEmptyString">
   <rule ref="rulesets/java/strings.xml/AppendCharacterWithChar">
   <rule ref="rulesets/java/sunsecure.xml/ArrayIsStoredDirectly">
   <rule ref="rulesets/ecmascript/basic.xml/AssignmentInOperand">
   <rule ref="rulesets/java/controversial.xml/AssignmentInOperand">
   <rule ref="rulesets/java/design.xml/AssignmentToNonFinalStatic">
   <rule ref="rulesets/java/controversial.xml/AtLeastOneConstructor">
   <rule ref="rulesets/java/controversial.xml/AvoidAccessibilityAlteration">
   <rule ref="rulesets/java/optimizations.xml/AvoidArrayLoops">
   <rule ref="rulesets/java/migrating.xml/AvoidAssertAsIdentifier">
   <rule ref="rulesets/xsl/xpath.xml/AvoidAxisNavigation">
   <rule ref="rulesets/java/basic.xml/AvoidBranchingStatementAsLastInLoop">
   <rule ref="rulesets/java/finalizers.xml/AvoidCallingFinalize">
   <rule ref="rulesets/java/strictexception.xml/Avoid