How can we have different PMD rulesets in Maven for the main and test java code sets?

Question

In Gradle, we can specify different PMD configurations (including different rulesets) for the pmdMain and pmdTest source sets. e.g.

pmdMain {
    ruleSetFiles = files("$javaBuildSystemRoot/src-pmd-rulesets.xml")
}

pmdTest {
    ruleSetFiles = files("$javaBuildSystemRoot/test-pmd-rulesets.xml")
}

We want to be less stringent on test code than main code.

There is a separate maven based project, where we cannot use gradle currently.But for now, we would like to at least apply the 2 different rulesets based on main vs test. It is a single module single project, using the maven PMD plugin.

How do we do this in the Maven pom file?

xerx593 · Accepted Answer · 2019-02-10T19:33:18.887

It is "rather unconventional" to pmd over test sources, but that is not part of the question. :)

Using the executions tag and utilizing maven-pmd-plugin, you can do this with maven.

EDIT: In short & applied to the given input (and maybe more than you wanted/need), it enables/forces you to make both checks in every build:

<project><build><plugins>
<plugin>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>3.11.0</version> <!-- latest up-to-date -->
    <executions>
       <execution>
           <id>pmd-execution</id>
           <goals>
               <goal>check</goal>
           </goals>
           <configuration>
               <rulesets>
                   <ruleset>${javaBuildSystemRoot}/src-pmd-rulesets.xml</ruleset>
               </rulesets>
           </configuration>
      </execution>
      <execution>
           <id>pmd-test-execution</id>
           <goals>
              <goal>check</goal>
           </goals>
           <configuration>
               <rulesets>
                   <ruleset>${javaBuildSystemRoot}/test-pmd-rulesets.xml</ruleset>
               </rulesets>
           </configuration>
        </execution>
    </executions>
</plugin>
...

See also: Can I configure multiple plugin executions in pluginManagement, and choose from them in my child POM?

EDIT 2: If you indeed don't need "both executions" (in 1 build), but only "two configurations" for "different builds", then: Maven Profiles fits your needs (with profiles ... your "possibilities converge to infinity") !

You would introduce profiles like:

 <project>
 ...
 <profiles>
   <profile>
     <id>pmdMain</id>
     <properties>
         <myPmdRuleSetLocation>${javaBuildSystemRoot}/src-pmd-rulesets.xml</myPmdRuleSetLocation>
     </properties>
   </profile> 
   <profile>
     <id>pmdTest</id>
     <properties>
         <myPmdRuleSetLocation>${javaBuildSystemRoot}/test-pmd-rulesets.xml</myPmdRuleSetLocation>
     </properties>
   </profile> 
 <profiles>
 ...
 </project>

And use it in your (single) pmd-plugin configuration:

...
  <ruleset>${myPmdRuleSetLocation}</ruleset>
...

Please read further on profiles and their activation.

(additionally <profile/> can contain & override <build/> tag!)

xerx593, did you mean to add the 'phase' tags in the above answer OR a different goal? Without that, both the executions look to be the same. — Raja Nadar, Feb 10 '19 at 12:15
..."i think" `phase` is optional. of course you would have to adjust and test both configs: inside configutation - my answer is just an outline.. — xerx593, Feb 10 '19 at 14:40
If you use the plugin goal `pmd`, `true` should also be added to the second execution or profile. — eerriicc, Aug 19 '20 at 12:26

How can we have different PMD rulesets in Maven for the main and test java code sets?

1 Answers1