[MENFORCER-454] Log warning only if the '-Drules' is actually used

* the method gets called with empty list if there is no configuration, resulting in WARNing being printed every single time
apache · Dec 29, 2022 · db7fbd2 · db7fbd2
1 parent 495818f
commit db7fbd2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java b/maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/EnforceMojo.java
@@ -173,7 +173,10 @@ public void setRulesToExecute(List<String> rulesToExecute) throws MojoExecutionE
     @Parameter(required = false, property = "rules")
     @Deprecated
     public void setCommandLineRules(List<String> rulesToExecute) throws MojoExecutionException {
-        getLog().warn("Detected the usage of property '-Drules' which is deprecated. Use '-Denforcer.rules' instead.");
+        if (rulesToExecute != null && !rulesToExecute.isEmpty()) {
+            getLog().warn(
+                            "Detected the usage of property '-Drules' which is deprecated. Use '-Denforcer.rules' instead.");
+        }
         setRulesToExecute(rulesToExecute);
     }
 

diff --git a/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/TestEnforceMojo.java b/maven-enforcer-plugin/src/test/java/org/apache/maven/plugins/enforcer/TestEnforceMojo.java
@@ -319,6 +319,17 @@ void testShouldPrintWarnWhenUsingDeprecatedRulesProperty() throws MojoExecutionE
                 .warn("Detected the usage of property '-Drules' which is deprecated. Use '-Denforcer.rules' instead.");
     }
 
+    @Test
+    void testShouldNotPrintWarnWhenDeprecatedRulesPropertyIsEmpty() throws MojoExecutionException {
+        setupBasics(false);
+
+        Log logSpy = setupLogSpy();
+
+        mojo.setCommandLineRules(Collections.emptyList());
+
+        Mockito.verifyNoInteractions(logSpy);
+    }
+
     private void setupBasics(boolean fail) {
         mojo.setFail(fail);
         mojo.setSession(EnforcerTestUtils.getMavenSession());