[MPMD-379] Deprecate parameter "showPmdLog"

apache · Apr 5, 2024 · ed944d5 · ed944d5
1 parent 00b9f13
commit ed944d5
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 23 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
@@ -196,10 +196,20 @@ public abstract class AbstractPmdReport extends AbstractMavenReport {
      * the PMD logger is also configured for debug.
      *
      * @since 3.9.0
+     * @deprecated With 3.22.0 and the upgrade to PMD 7, this parameter has no effect anymore. The PMD log
+     * is now always redirected into the maven log and this can't be disabled by this parameter anymore.
+     * In order to disable the logging, see <a href="https://maven.apache.org/maven-logging.html">Maven Logging</a>.
+     * You'd need to start maven with <code>MAVEN_OPTS=-Dorg.slf4j.simpleLogger.log.net.sourceforge.pmd=off mvn &lt;goals&gt;</code>.
      */
     @Parameter(defaultValue = "true", property = "pmd.showPmdLog")
+    @Deprecated(since = "3.22.0", forRemoval = true)
     protected boolean showPmdLog = true;
 
+    /**
+     * Used to avoid showing the deprecation warning for "showPmdLog" multiple times.
+     */
+    private boolean warnedAboutShowPmdLog = false;
+
     /**
      * <p>
      * Allow for configuration of the jvm used to run PMD via maven toolchains.
@@ -454,6 +464,12 @@ protected boolean isXml() {
      */
     @Override
     public boolean canGenerateReport() {
+        if (!showPmdLog && !warnedAboutShowPmdLog) {
+            getLog().warn("The parameter \"showPmdLog\" has been deprecated and will be removed."
+                    + "Setting it to \"false\" has no effect.");
+            warnedAboutShowPmdLog = true;
+        }
+
         if (aggregate && !project.isExecutionRoot()) {
             return false;
         }

diff --git a/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java b/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java
@@ -185,10 +185,7 @@ private void executeCpd() throws MavenReportException {
             request.setIgnoreLiterals(ignoreLiterals);
             request.setSourceEncoding(getInputEncoding());
             request.addFiles(filesToProcess.keySet());
-
-            request.setShowPmdLog(showPmdLog);
             request.setLogLevel(determineCurrentRootLogLevel());
-
             request.setExcludeFromFailureFile(excludeFromFailureFile);
             request.setTargetDirectory(targetDirectory.getAbsolutePath());
             request.setOutputEncoding(getOutputEncoding());

diff --git a/src/main/java/org/apache/maven/plugins/pmd/PmdReport.java b/src/main/java/org/apache/maven/plugins/pmd/PmdReport.java
@@ -366,11 +366,9 @@ private void executePmd() throws MavenReportException {
         request.setBenchmarkOutputLocation(benchmark ? benchmarkOutputFilename : null);
         request.setAnalysisCacheLocation(analysisCache ? analysisCacheLocation : null);
         request.setExcludeFromFailureFile(excludeFromFailureFile);
-
         request.setTargetDirectory(targetDirectory.getAbsolutePath());
         request.setOutputEncoding(getOutputEncoding());
         request.setFormat(format);
-        request.setShowPmdLog(showPmdLog);
         request.setSkipPmdError(skipPmdError);
         request.setIncludeXmlInSite(includeXmlInSite);
         request.setReportOutputDirectory(getReportOutputDirectory().getAbsolutePath());

diff --git a/src/main/java/org/apache/maven/plugins/pmd/exec/CpdRequest.java b/src/main/java/org/apache/maven/plugins/pmd/exec/CpdRequest.java
@@ -44,7 +44,6 @@ public class CpdRequest implements Serializable {
     private String sourceEncoding;
     private List<File> files = new ArrayList<>();
 
-    private boolean showPmdLog;
     private String logLevel;
 
     private String excludeFromFailureFile;
@@ -105,10 +104,6 @@ public void setReportOutputDirectory(String reportOutputDirectory) {
         this.reportOutputDirectory = reportOutputDirectory;
     }
 
-    public void setShowPmdLog(boolean showPmdLog) {
-        this.showPmdLog = showPmdLog;
-    }
-
     public void setLogLevel(String logLevel) {
         this.logLevel = logLevel;
     }
@@ -161,10 +156,6 @@ public String getReportOutputDirectory() {
         return reportOutputDirectory;
     }
 
-    public boolean isShowPmdLog() {
-        return showPmdLog;
-    }
-
     public String getLogLevel() {
         return logLevel;
     }

diff --git a/src/main/java/org/apache/maven/plugins/pmd/exec/PmdRequest.java b/src/main/java/org/apache/maven/plugins/pmd/exec/PmdRequest.java
@@ -47,7 +47,6 @@ public class PmdRequest implements Serializable {
     private String sourceEncoding;
     private List<File> files = new ArrayList<>();
 
-    private boolean showPmdLog;
     private String logLevel;
     private boolean skipPmdError;
 
@@ -126,10 +125,6 @@ public void setFormat(String format) {
         this.format = format;
     }
 
-    public void setShowPmdLog(boolean showPmdLog) {
-        this.showPmdLog = showPmdLog;
-    }
-
     public void setLogLevel(String logLevel) {
         this.logLevel = logLevel;
     }
@@ -206,10 +201,6 @@ public String getFormat() {
         return format;
     }
 
-    public boolean isShowPmdLog() {
-        return showPmdLog;
-    }
-
     public String getLogLevel() {
         return logLevel;
     }