自定义XPath规则在pmd中引发违规,但在声纳中不引发

时间:2012-06-27 07:48:33

标签: sonarqube pmd

我有一种非常奇怪的行为。

我在名为pmd-extensions.xml的文件中为PMD 4.2.6创建了一个XPath规则:

...
<rule name="AvoidPrintStackTrace-XPath"
  message="Avoid to use printStackTrace - XPath"
  class="net.sourceforge.pmd.rules.XPathRule">
  <description>Avoid to use printStackTrace - XPath</description>
  <properties>
    <property name="xpath">
     <value>
<![CDATA[
//Name[contains (@Image, "printStackTrace")]
]]>
     </value>
    </property>
  </properties>
  <example>
  <![CDATA[
    // don't do this! 
    myException.printStackTrace() 
   ]]>
   </example>
</rule>
...

我有一个单元测试验证此规则并且正常工作:

 ...
 @Before
 public void setUp() {
     addRule("rulesets/pmd-extensions.xml", "AvoidPrintStackTrace-XPath");
 }
 ...

但是当我在Sonar中嵌入此规则时,规则并没有在我预期的情况下触发任何违规行为:

 ...
 <rule key="AvoidPrintStackStrace-XPath" >
  <name>AvoidPrintStackStrace-XPath</name>
  <configKey>rulesets/pmd-extensions.xml/AvoidPrintStackTrace-XPath</configKey>
  <category name="Usability"/>
  <description>Avoid to use printStackTrace - XPath</description>
 </rule>
 ...

如果我直接在Sonar中声明此规则(具有相同的XPath表达式),则该规则会按预期触发违规:

...
<rule key="AvoidPrintStackStrace-XPath-Sonar" priority="MAJOR">
 <name><![CDATA[AvoidPrintStackStrace-XPath-Sonar]]></name>
 <configKey><![CDATA[net.sourceforge.pmd.rules.XPathRule]]></configKey>
 <category name="Maintainability"/>
 <description>Avoid to use printStackTrace - XPath-Sonar</description>
 <param key="xpath" type="s">
  <description><![CDATA[XPath expressions.]]></description>
  <defaultValue>//Name[contains (@Image, "printStackTrace")]</defaultValue>
 </param>
 <param key="message" type="s">
  <description><![CDATA[Message to display when a violation occurs.]]></description>
  <defaultValue>Prevent use of printStackTrace</defaultValue>
 </param>
</rule>
...

怎么了?

感谢。

1 个答案:

答案 0 :(得分:1)

您可能尚未将此新规则添加到您用于项目的配置文件中。

您提供“pmd-extensions.xml”文件只是意味着您已将此规则添加到规则存储库。但是,如果您不在单个配置文件上激活此规则,它将保持不活动状态,永远不会执行。