Introduce ruleName for rules configuration

We can define the same rule multiple times with different configuration
Each execution has the same default name, with ruleName we can differentiate them

Author: slawekjaranowski

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/AbstractEnforcerRule.java

@@ -34,6 +34,11 @@ public abstract class AbstractEnforcerRule extends AbstractEnforcerRuleBase {
      */
     private EnforcerLevel level = EnforcerLevel.ERROR;
 
+    /**
+     * Rule name for current rule instance.
+     */
+    private String ruleName;
+
     /**
      * Current Enforcer execution level
      *
@@ -44,6 +49,17 @@ public EnforcerLevel getLevel() {
         return level;
     }
 
+    /**
+     * Rule name for current rule instance.
+     *
+     * @return a rule name.
+     * @since 3.6.0
+     */
+    @Override
+    public String getRuleName() {
+        return ruleName;
+    }
+
     /**
      * If the rule is to be cached during session scope, whole executing of Maven build,
      * this id is used as part of the key.
@@ -64,7 +80,7 @@ public String getCacheId() {
      * message as a warning.
      *
      * @throws EnforcerRuleException the enforcer rule exception
-     * @throws EnforcerRuleError     in order to brake a build immediately
+     * @throws EnforcerRuleError in order to brake a build immediately
      */
     public abstract void execute() throws EnforcerRuleException;
 }

enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleBase.java

@@ -43,4 +43,14 @@ default EnforcerLevel getLevel() {
      * @param log an {@link EnforcerLogger} instance
      */
     default void setLog(EnforcerLogger log) {}
+
+    /**
+     * Rule name for current rule instance.
+     *
+     * @return a rule name.
+     * @since 3.6.0
+     */
+    default String getRuleName() {
+        return null;
+    }
 }

enforcer-rules/src/site/apt/alwaysPass.apt.vm

@@ -47,7 +47,7 @@ Always Pass
             </goals>
             <configuration>
               <rules>
-                <AlwaysPass/>
+                <alwaysPass/>
               </rules>
               <fail>true</fail>
             </configuration>

enforcer-rules/src/site/apt/index.apt

@@ -103,4 +103,16 @@ Built-In Rules
 
   []
 
+Common parameters
+
+  The following parameters are supported by all rules:
+
+  * <<level>> - steering whether a rule should fail a build or just display a warning, allowed values: <<ERROR>>, <<WARN>>. Default is <<ERROR>>
+
+  * <<ruleName>> - optional name of rule configuration
+
+  []
+
+Custom rules
+
   You may also create and inject your own custom rules by following the {{{https://maven.apache.org/enforcer/enforcer-api/writing-a-custom-rule.html}maven-enforcer-rule-api}} instructions.

maven-enforcer-plugin/src/it/projects/always-fail-warn/pom.xml

@@ -42,10 +42,25 @@ under the License.
               <goal>enforce</goal>
             </goals>
             <configuration>
+              <rulesToSkip>
+                <rule>fail2</rule>
+              </rulesToSkip>
               <rules>
-                <AlwaysFail>
+                <alwaysFail>
                   <level>WARN</level>
-                </AlwaysFail>
+                </alwaysFail>
+                <alwaysFail>
+                  <ruleName>fail1</ruleName>
+                  <level>WARN</level>
+                </alwaysFail>
+                <alwaysFail>
+                  <ruleName>fail2</ruleName>
+                  <level>WARN</level>
+                </alwaysFail>
+                <alwaysFail>
+                  <ruleName>fail3</ruleName>
+                  <level>WARN</level>
+                </alwaysFail>
               </rules>
             </configuration>
           </execution>

maven-enforcer-plugin/src/it/projects/always-fail-warn/verify.groovy

@@ -18,6 +18,8 @@
  */
 File buildLog = new File( basedir, 'build.log' )
 assert buildLog.text.contains( '[WARNING] Rule 0: org.apache.maven.enforcer.rules.AlwaysFail warned with message:' )
+assert buildLog.text.contains( '[WARNING] Rule 1: org.apache.maven.enforcer.rules.AlwaysFail(fail1) warned with message:' )
+assert buildLog.text.contains( '[WARNING] Rule 2: org.apache.maven.enforcer.rules.AlwaysFail(fail3) warned with message:' )
 
 
 

maven-enforcer-plugin/src/main/java/org/apache/maven/plugins/enforcer/internal/EnforcerRuleDesc.java

@@ -45,7 +45,8 @@ public EnforcerRuleDesc(String name, EnforcerRuleBase rule) {
     }
 
     public String getName() {
-        return name;
+        String ruleName = rule.getRuleName();
+        return ruleName == null || ruleName.isEmpty() ? name : ruleName;
     }
 
     public EnforcerRuleBase getRule() {