Dynamically calculate xrefDir/xrefTestDir

@kriegaex
apache · Nov 16, 2023 · 922d072 · 922d072
1 parent 1bffca5
commit 922d072
Show file tree

Hide file tree

Showing 22 changed files with 44 additions and 37 deletions.
diff --git a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java
@@ -78,23 +78,25 @@ public abstract class AbstractPmdReport extends AbstractMavenReport {
     protected String format = "xml";
 
     /**
-     * Link the violation line numbers to the source xref. Links will be created automatically if the jxr plugin is
+     * Link the violation line numbers to the source XRef. Links will be created automatically if the JXR plugin is
      * being used.
      */
     @Parameter(property = "linkXRef", defaultValue = "true")
     private boolean linkXRef;
 
     /**
-     * Location of the Xrefs to link to.
+     * Directory where XRef is generated for this project. The default value is calculated from
+     * {@link #getReportOutputDirectory()} and concatenated with {@code xref}.
      */
-    @Parameter(defaultValue = "${project.reporting.outputDirectory}/xref")
-    private File xrefLocation;
+    @Parameter
+    private File xrefDir;
 
     /**
-     * Location of the Test Xrefs to link to.
+     * Directory where Test XRef is generated for this project. The default value is calculated from
+     * {@link #getReportOutputDirectory()} and concatenated with {@code xref-test}.
      */
-    @Parameter(defaultValue = "${project.reporting.outputDirectory}/xref-test")
-    private File xrefTestLocation;
+    @Parameter
+    private File xrefTestDir;
 
     /**
      * A list of files to exclude from checking. Can contain Ant-style wildcards and double wildcards. Note that these
@@ -268,18 +270,18 @@ protected MojoExecution getMojoExecution() {
         return mojoExecution;
     }
 
-    protected String constructXRefLocation(boolean test) {
+    protected String constructXrefLocation(boolean test) {
         String location = null;
         if (linkXRef) {
-            File xrefLoc = test ? xrefTestLocation : xrefLocation;
+            File xrefDir = getXrefDir(test);
 
             String relativePath =
-                    PathTool.getRelativePath(getReportOutputDirectory().getAbsolutePath(), xrefLoc.getAbsolutePath());
+                    PathTool.getRelativePath(getReportOutputDirectory().getAbsolutePath(), xrefDir.getAbsolutePath());
             if (relativePath == null || relativePath.isEmpty()) {
                 relativePath = ".";
             }
-            relativePath = relativePath + "/" + xrefLoc.getName();
-            if (xrefLoc.exists()) {
+            relativePath = relativePath + "/" + xrefDir.getName();
+            if (xrefDir.exists()) {
                 // XRef was already generated by manual execution of a lifecycle binding
                 location = relativePath;
             } else {
@@ -302,6 +304,11 @@ protected String constructXRefLocation(boolean test) {
         return location;
     }
 
+    protected File getXrefDir(boolean test) {
+        File dir = test ? xrefTestDir : xrefDir;
+        return dir != null ? dir : new File(getReportOutputDirectory(), test ?  "xref-test" : "xref");
+    }
+
     /**
      * Convenience method to get the list of files where the PMD tool will be executed
      *
@@ -335,7 +342,7 @@ protected Map<File, PmdFileInfo> getFilesToProcess() throws IOException {
             for (String root : compileSourceRoots) {
                 File sroot = new File(root);
                 if (sroot.exists()) {
-                    String sourceXref = constructXRefLocation(false);
+                    String sourceXref = constructXrefLocation(false);
                     directories.add(new PmdFileInfo(project, sroot, sourceXref));
                 }
             }
@@ -348,7 +355,7 @@ protected Map<File, PmdFileInfo> getFilesToProcess() throws IOException {
             for (String root : testSourceRoots) {
                 File sroot = new File(root);
                 if (sroot.exists()) {
-                    String testXref = constructXRefLocation(true);
+                    String testXref = constructXrefLocation(true);
                     directories.add(new PmdFileInfo(project, sroot, testXref));
                 }
             }
@@ -359,7 +366,7 @@ protected Map<File, PmdFileInfo> getFilesToProcess() throws IOException {
                 for (String root : localCompileSourceRoots) {
                     File sroot = new File(root);
                     if (sroot.exists()) {
-                        String sourceXref = constructXRefLocation(false);
+                        String sourceXref = constructXrefLocation(false);
                         directories.add(new PmdFileInfo(localProject, sroot, sourceXref));
                     }
                 }
@@ -368,7 +375,7 @@ protected Map<File, PmdFileInfo> getFilesToProcess() throws IOException {
                     for (String root : localTestCompileSourceRoots) {
                         File sroot = new File(root);
                         if (sroot.exists()) {
-                            String testXref = constructXRefLocation(true);
+                            String testXref = constructXrefLocation(true);
                             directories.add(new PmdFileInfo(localProject, sroot, testXref));
                         }
                     }

diff --git a/src/test/resources/unit/custom-configuration/cpd-custom-configuration-plugin-config.xml b/src/test/resources/unit/custom-configuration/cpd-custom-configuration-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/custom-configuration/target</targetDirectory>
           <format>csv</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/custom-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/custom-configuration/target/site/xref</xrefDir>
           <minimumTokens>25</minimumTokens>
           <excludes>
             <exclude>**/Sample.java</exclude>

diff --git a/src/test/resources/unit/custom-configuration/custom-configuration-plugin-config.xml b/src/test/resources/unit/custom-configuration/custom-configuration-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/custom-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>csv</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/custom-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/custom-configuration/target/site/xref</xrefDir>
           <inputEncoding>ISO-8859-1</inputEncoding>
           <rulesets>
             <ruleset>rulesets/java/maven-pmd-plugin-default.xml</ruleset>

diff --git a/src/test/resources/unit/custom-configuration/skip-plugin-config.xml b/src/test/resources/unit/custom-configuration/skip-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/skip-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>csv</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/skip-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/skip-configuration/target/site/xref</xrefDir>
           <inputEncoding>ISO-8859-1</inputEncoding>
           <targetJdk>1.4</targetJdk>
           <minimumPriority>4</minimumPriority>

diff --git a/src/test/resources/unit/default-configuration/cpd-default-configuration-plugin-config.xml b/src/test/resources/unit/default-configuration/cpd-default-configuration-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>100</minimumTokens>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/cpd-encoding-configuration-plugin-config.xml b/src/test/resources/unit/default-configuration/cpd-encoding-configuration-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>100</minimumTokens>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/cpd-javascript-plugin-config.xml b/src/test/resources/unit/default-configuration/cpd-javascript-plugin-config.xml
@@ -37,7 +37,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>10</minimumTokens>
           <language>javascript</language>
           <includes>

diff --git a/src/test/resources/unit/default-configuration/cpd-jsp-plugin-config.xml b/src/test/resources/unit/default-configuration/cpd-jsp-plugin-config.xml
@@ -37,7 +37,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>5</minimumTokens>
           <language>jsp</language>
           <includes>

diff --git a/...rces/unit/default-configuration/cpd-report-cpd-exclusions-configuration-plugin-config.xml b/...rces/unit/default-configuration/cpd-report-cpd-exclusions-configuration-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>100</minimumTokens>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/...est/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml b/...est/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory>
           <format>xml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <minimumTokens>100</minimumTokens>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml b/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/pmd-report-custom-rules.xml b/src/test/resources/unit/default-configuration/pmd-report-custom-rules.xml
@@ -42,7 +42,7 @@ under the License.
           </rulesets>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/...test/resources/unit/default-configuration/pmd-report-no-render-violations-by-priority.xml b/...test/resources/unit/default-configuration/pmd-report-no-render-violations-by-priority.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/...esources/unit/default-configuration/pmd-report-not-render-rule-priority-plugin-config.xml b/...esources/unit/default-configuration/pmd-report-not-render-rule-priority-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/...rces/unit/default-configuration/pmd-report-pmd-exclusions-configuration-plugin-config.xml b/...rces/unit/default-configuration/pmd-report-pmd-exclusions-configuration-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/pmd-report-resolve-rulesets.xml b/src/test/resources/unit/default-configuration/pmd-report-resolve-rulesets.xml
@@ -48,7 +48,7 @@ under the License.
           </rulesets>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>

diff --git a/src/test/resources/unit/default-configuration/pmd-with-analysis-cache-plugin-config.xml b/src/test/resources/unit/default-configuration/pmd-with-analysis-cache-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/pmd-with-analysis-cache-plugin-config/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/pmd-with-analysis-cache-plugin-config/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/pmd-with-analysis-cache-plugin-config/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <analysisCache>true</analysisCache>
           <analysisCacheLocation>${basedir}/target/test/unit/pmd-with-analysis-cache-plugin-config/target/pmd/pmd.cache</analysisCacheLocation>

diff --git a/.../resources/unit/default-configuration/pmd-with-suppressMarker-no-render-plugin-config.xml b/.../resources/unit/default-configuration/pmd-with-suppressMarker-no-render-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <suppressMarker>SUPPRESSME</suppressMarker>
           <renderSuppressedViolations>false</renderSuppressedViolations>

diff --git a/src/test/resources/unit/default-configuration/pmd-with-suppressMarker-plugin-config.xml b/src/test/resources/unit/default-configuration/pmd-with-suppressMarker-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/default-configuration/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xml</format>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>UTF-8</inputEncoding>
           <suppressMarker>SUPPRESSME</suppressMarker>
           <compileSourceRoots>

diff --git a/src/test/resources/unit/invalid-format/cpd-invalid-format-plugin-config.xml b/src/test/resources/unit/invalid-format/cpd-invalid-format-plugin-config.xml
@@ -38,7 +38,7 @@ under the License.
           <targetDirectory>${basedir}/target/test/unit/invalid-format/target</targetDirectory>
           <format>xhtml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/invalid-format/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/invalid-format/target/site/xref</xrefDir>
           <minimumTokens>25</minimumTokens>
         </configuration>
       </plugin>

diff --git a/src/test/resources/unit/invalid-format/invalid-format-plugin-config.xml b/src/test/resources/unit/invalid-format/invalid-format-plugin-config.xml
@@ -39,7 +39,7 @@ under the License.
           <rulesetsTargetDirectory>${basedir}/target/test/unit/invalid-format/target/pmd/rulesets</rulesetsTargetDirectory>
           <format>xhtml</format>
           <linkXRef>false</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/invalid-format/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/invalid-format/target/site/xref</xrefDir>
           <inputEncoding>ISO-8859-1</inputEncoding>
         </configuration>
       </plugin>

diff --git a/src/test/resources/unit/invalid-format/invalid-target-jdk-plugin-config.xml b/src/test/resources/unit/invalid-format/invalid-target-jdk-plugin-config.xml
@@ -40,7 +40,7 @@ under the License.
           <format>xml</format>
           <targetJdk>1.x</targetJdk>
           <linkXRef>true</linkXRef>
-          <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation>
+          <xrefDir>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefDir>
           <inputEncoding>ISO-8859-1</inputEncoding>
           <compileSourceRoots>
             <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot>