Issue #122: Added support for multiple instances of same check

Anmol202005 · Anmol202005 · commit e0fbc207f80e · 2026-01-25T14:32:58.000+05:30
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,5 @@
+# All files default to text with LF line endings
+* text eol=lf
+
+# Windows files always have CRLF eol
+*.cmd text eol=crlf
diff --git a/config/pitest-suppressions.xml b/config/pitest-suppressions.xml
@@ -1123,7 +1123,7 @@
     <mutatedMethod>parseErrorTag</mutatedMethod>
     <mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator>
     <description>removed call to java/util/Optional::empty</description>
-    <lineContent>Optional&lt;CheckstyleCheck&gt; source = Optional.empty();</lineContent>
+    <lineContent>Optional&lt;CheckstyleCheck&gt; check = Optional.empty();</lineContent>
   </mutation>
 
   <mutation unstable="false">
@@ -1132,7 +1132,7 @@
     <mutatedMethod>parseErrorTag</mutatedMethod>
     <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator>
     <description>removed conditional - replaced equality check with true</description>
-    <lineContent>if (source.isPresent()) {</lineContent>
+    <lineContent>if (check.isPresent()) {</lineContent>
   </mutation>
 
   <mutation unstable="false">
diff --git a/mvnw.cmd b/mvnw.cmd
diff --git a/pom.xml b/pom.xml
@@ -45,7 +45,7 @@
 
         <!-- Checkstyle properties -->
         <maven.checkstyle.plugin.version>3.6.0</maven.checkstyle.plugin.version>
-        <checkstyle.version>12.1.0</checkstyle.version>
+        <checkstyle.version>12.2.0</checkstyle.version>
 
         <!-- Pitest properties -->
         <pitest.version>1.22.0</pitest.version>
diff --git a/src/main/java/org/checkstyle/autofix/CheckstyleAutoFix.java b/src/main/java/org/checkstyle/autofix/CheckstyleAutoFix.java
@@ -88,7 +88,7 @@ public List<Recipe> getRecipeList() {
         final ReportParser reportParser = createReportParser(getViolationReportPath());
         final List<CheckstyleViolation> violations = reportParser
                 .parse(Path.of(getViolationReportPath()));
-        final Map<CheckstyleCheck,
+        final Map<CheckstyleCheckInstance,
                 CheckConfiguration> configuration = loadCheckstyleConfiguration();
 
         return CheckstyleRecipeRegistry.getRecipes(violations, configuration);
@@ -108,7 +108,7 @@ else if (path.endsWith(".sarif") || path.endsWith(".sarif.json")) {
         return result;
     }
 
-    private Map<CheckstyleCheck, CheckConfiguration> loadCheckstyleConfiguration() {
+    private Map<CheckstyleCheckInstance, CheckConfiguration> loadCheckstyleConfiguration() {
         return ConfigurationLoader.loadConfiguration(getConfigurationPath(), getPropertiesPath());
     }
 }
diff --git a/src/main/java/org/checkstyle/autofix/CheckstyleCheck.java b/src/main/java/org/checkstyle/autofix/CheckstyleCheck.java
@@ -39,7 +39,7 @@ public String getId() {
 
     public static Optional<CheckstyleCheck> fromSource(String source) {
         return Arrays.stream(values())
-                .filter(check -> check.getId().contains(source))
+                .filter(check -> check.getId().contains(source.split("#")[0]))
                 .findFirst();
     }
 }
diff --git a/src/main/java/org/checkstyle/autofix/CheckstyleCheckInstance.java b/src/main/java/org/checkstyle/autofix/CheckstyleCheckInstance.java
@@ -0,0 +1,24 @@
+///////////////////////////////////////////////////////////////////////////////////////////////
+// checkstyle-openrewrite-recipes: Automatically fix Checkstyle violations with OpenRewrite.
+// Copyright (C) 2025 The Checkstyle OpenRewrite Recipes Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+///////////////////////////////////////////////////////////////////////////////////////////////
+
+package org.checkstyle.autofix;
+
+public record CheckstyleCheckInstance(
+        CheckstyleCheck check,
+        String id
+) {
+}
diff --git a/src/main/java/org/checkstyle/autofix/CheckstyleRecipeRegistry.java b/src/main/java/org/checkstyle/autofix/CheckstyleRecipeRegistry.java
@@ -65,7 +65,7 @@ private CheckstyleRecipeRegistry() {
      * @return a list of generated Recipe objects
      */
     public static List<Recipe> getRecipes(List<CheckstyleViolation> violations,
-                                          Map<CheckstyleCheck, CheckConfiguration> config) {
+                                          Map<CheckstyleCheckInstance, CheckConfiguration> config) {
         return violations.stream()
                 .collect(Collectors.groupingBy(CheckstyleViolation::getSource))
                 .entrySet()
diff --git a/src/main/java/org/checkstyle/autofix/parser/CheckstyleViolation.java b/src/main/java/org/checkstyle/autofix/parser/CheckstyleViolation.java
@@ -19,7 +19,7 @@
 
 import java.nio.file.Path;
 
-import org.checkstyle.autofix.CheckstyleCheck;
+import org.checkstyle.autofix.CheckstyleCheckInstance;
 
 public final class CheckstyleViolation {
 
@@ -29,14 +29,14 @@ public final class CheckstyleViolation {
 
     private final String severity;
 
-    private final CheckstyleCheck source;
+    private final CheckstyleCheckInstance source;
 
     private final String message;
 
     private final Path filePath;
 
     public CheckstyleViolation(int line, int column, String severity,
-                               CheckstyleCheck source, String message, Path filePath) {
+                               CheckstyleCheckInstance source, String message, Path filePath) {
         this.line = line;
         this.column = column;
         this.severity = severity;
@@ -46,7 +46,7 @@ public CheckstyleViolation(int line, int column, String severity,
     }
 
     public CheckstyleViolation(int line, String severity,
-                               CheckstyleCheck source, String message, Path filePath) {
+                               CheckstyleCheckInstance source, String message, Path filePath) {
         this(line, -1, severity, source, message, filePath);
     }
 
@@ -58,7 +58,7 @@ public Integer getColumn() {
         return column;
     }
 
-    public CheckstyleCheck getSource() {
+    public CheckstyleCheckInstance getSource() {
         return source;
     }
 
diff --git a/src/main/java/org/checkstyle/autofix/parser/ConfigurationLoader.java b/src/main/java/org/checkstyle/autofix/parser/ConfigurationLoader.java
@@ -25,6 +25,7 @@
 import java.util.Properties;
 
 import org.checkstyle.autofix.CheckstyleCheck;
+import org.checkstyle.autofix.CheckstyleCheckInstance;
 
 import com.puppycrawl.tools.checkstyle.PropertiesExpander;
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
@@ -36,14 +37,16 @@ private ConfigurationLoader() {
         // utility class
     }
 
-    public static Map<CheckstyleCheck, CheckConfiguration> mapConfiguration(Configuration config) {
-        final Map<CheckstyleCheck, CheckConfiguration> result = new HashMap<>();
-        final Map<String, String> inherited = getProperties(config);
+    public static Map<CheckstyleCheckInstance,
+            CheckConfiguration> mapConfiguration(Configuration config) {
 
+        final Map<CheckstyleCheckInstance, CheckConfiguration> result = new HashMap<>();
+        final Map<String, String> inherited = getProperties(config);
         final Optional<CheckstyleCheck> module = CheckstyleCheck.fromSource(config.getName());
+
         module.ifPresent(checkstyleCheck -> {
-            result.put(checkstyleCheck, new CheckConfiguration(checkstyleCheck, new HashMap<>(),
-                    getProperties(config)));
+            result.put(new CheckstyleCheckInstance(checkstyleCheck, inherited.get("id")),
+                    new CheckConfiguration(checkstyleCheck, new HashMap<>(), inherited));
         });
 
         for (Configuration child : config.getChildren()) {
@@ -69,7 +72,7 @@ private static Map<String, String> getProperties(Configuration config) {
         return props;
     }
 
-    public static Map<CheckstyleCheck, CheckConfiguration> loadConfiguration(
+    public static Map<CheckstyleCheckInstance, CheckConfiguration> loadConfiguration(
             String checkstyleConfigurationPath, String propFile) {
         Properties props = new Properties();
         if (propFile == null) {
diff --git a/src/main/java/org/checkstyle/autofix/parser/SarifReportParser.java b/src/main/java/org/checkstyle/autofix/parser/SarifReportParser.java
@@ -26,6 +26,7 @@
 import java.util.Optional;
 
 import org.checkstyle.autofix.CheckstyleCheck;
+import org.checkstyle.autofix.CheckstyleCheckInstance;
 
 import de.jcup.sarif_2_1_0.SarifSchema210ImportExportSupport;
 import de.jcup.sarif_2_1_0.model.PhysicalLocation;
@@ -57,17 +58,22 @@ public List<CheckstyleViolation> parse(Path reportPath) {
         for (final Run run: report.getRuns()) {
             if (run.getResults() != null) {
                 run.getResults().forEach(resultEntry -> {
-                    CheckstyleCheck.fromSource(resultEntry.getRuleId()).ifPresent(check -> {
-                        final CheckstyleViolation violation = createViolation(check, resultEntry);
-                        result.add(violation);
-                    });
-                });
+                    CheckstyleCheck.fromSource(resultEntry.getRuleId()).ifPresent(
+                            check -> {
+                                final String id = Optional.of(resultEntry.getRuleId())
+                                        .filter(src -> src.contains("#"))
+                                        .map(src -> src.substring(src.indexOf('#') + 1))
+                                        .orElse(null);
+                                result.add(createViolation(new
+                                        CheckstyleCheckInstance(check, id), resultEntry));
+                            }); }
+                );
             }
         }
         return result;
     }
 
-    private CheckstyleViolation createViolation(CheckstyleCheck check, Result result) {
+    private CheckstyleViolation createViolation(CheckstyleCheckInstance check, Result result) {
         final String severity = result.getLevel().name();
         final String message = result.getMessage().getText();
         final PhysicalLocation location = result.getLocations().get(0).getPhysicalLocation();
diff --git a/src/main/java/org/checkstyle/autofix/parser/XmlReportParser.java b/src/main/java/org/checkstyle/autofix/parser/XmlReportParser.java
@@ -35,6 +35,7 @@
 import javax.xml.stream.events.XMLEvent;
 
 import org.checkstyle.autofix.CheckstyleCheck;
+import org.checkstyle.autofix.CheckstyleCheckInstance;
 
 public class XmlReportParser implements ReportParser {
 
@@ -118,7 +119,8 @@ private Optional<CheckstyleViolation> parseErrorTag(StartElement startElement,
         String message = null;
         String severity = null;
         CheckstyleViolation violation = null;
-        Optional<CheckstyleCheck> source = Optional.empty();
+        Optional<CheckstyleCheck> check = Optional.empty();
+        String id = null;
 
         final Iterator<Attribute> attributes = startElement.getAttributes();
         while (attributes.hasNext()) {
@@ -138,15 +140,20 @@ private Optional<CheckstyleViolation> parseErrorTag(StartElement startElement,
                     message = attribute.getValue();
                     break;
                 case SOURCE_ATTR:
-                    source = CheckstyleCheck.fromSource(attribute.getValue());
+                    final String attrValue = attribute.getValue();
+                    check = CheckstyleCheck.fromSource(attrValue);
+                    final int index = attrValue.indexOf('#');
+                    if (index >= 0) {
+                        id = attrValue.substring(index + 1);
+                    }
                     break;
                 default:
                     break;
             }
         }
-        if (source.isPresent()) {
+        if (check.isPresent()) {
             violation = new CheckstyleViolation(line, column, severity,
-                    source.get(), message, Path.of(filename));
+                    new CheckstyleCheckInstance(check.get(), id), message, Path.of(filename));
         }
         return Optional.ofNullable(violation);
 
diff --git a/src/test/java/org/checkstyle/autofix/parser/CheckstyleReportsParserTest.java b/src/test/java/org/checkstyle/autofix/parser/CheckstyleReportsParserTest.java
@@ -26,6 +26,7 @@
 import java.util.stream.Collectors;
 
 import org.checkstyle.autofix.CheckstyleCheck;
+import org.checkstyle.autofix.CheckstyleCheckInstance;
 import org.junit.jupiter.api.Test;
 
 public class CheckstyleReportsParserTest {
@@ -49,7 +50,8 @@ public void testParseFromResource() throws Exception {
         assertEquals(13, record.getColumn());
         assertEquals("error", record.getSeverity());
         assertEquals("Example message", record.getMessage());
-        assertEquals(CheckstyleCheck.UPPER_ELL, record.getSource());
+        assertEquals(new CheckstyleCheckInstance(CheckstyleCheck.UPPER_ELL, null),
+                record.getSource());
         assertEquals(Path.of("Example.java"), record.getFilePath());
     }
 
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/DiffFinalLocalVariable2One.diff b/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/DiffFinalLocalVariable2One.diff
@@ -1,6 +1,6 @@
 --- src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/InputFinalLocalVariable2One.java
 +++ src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/OutputFinalLocalVariable2One.java
-@@ -10,7 +10,7 @@
+@@ -11,7 +11,7 @@
  */
  package org.checkstyle.autofix.recipe.finallocalvariable.finallocalvariable2one;
  
@@ -9,7 +9,7 @@
      private int m_ClassVariable = 0;
      //static block
      static
-@@ -49,9 +49,7 @@
+@@ -50,9 +50,7 @@
              }
          };
      }
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/InputFinalLocalVariable2One.java b/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/InputFinalLocalVariable2One.java
@@ -2,6 +2,7 @@
 <module name="Checker">
   <module name="TreeWalker">
     <module name="com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck">
+      <property name="id" value="strict"/>
       <property name="tokens" value="PARAMETER_DEF"/>
     </module>
   </module>
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/OutputFinalLocalVariable2One.java b/src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/finallocalvariable2one/OutputFinalLocalVariable2One.java
@@ -2,6 +2,7 @@
 <module name="Checker">
   <module name="TreeWalker">
     <module name="com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck">
+      <property name="id" value="strict"/>
       <property name="tokens" value="PARAMETER_DEF"/>
     </module>
   </module>

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public List<Recipe> getRecipeList() {`
`88`	`88`	`final ReportParser reportParser = createReportParser(getViolationReportPath());`
`89`	`89`	`final List<CheckstyleViolation> violations = reportParser`
`90`	`90`	`.parse(Path.of(getViolationReportPath()));`
`91`		`- final Map<CheckstyleCheck,`
	`91`	`+ final Map<CheckstyleCheckInstance,`
`92`	`92`	`CheckConfiguration> configuration = loadCheckstyleConfiguration();`
`93`	`93`
`94`	`94`	`return CheckstyleRecipeRegistry.getRecipes(violations, configuration);`
`@@ -108,7 +108,7 @@ else if (path.endsWith(".sarif") \|\| path.endsWith(".sarif.json")) {`
`108`	`108`	`return result;`
`109`	`109`	`}`
`110`	`110`
`111`		`- private Map<CheckstyleCheck, CheckConfiguration> loadCheckstyleConfiguration() {`
	`111`	`+ private Map<CheckstyleCheckInstance, CheckConfiguration> loadCheckstyleConfiguration() {`
`112`	`112`	`return ConfigurationLoader.loadConfiguration(getConfigurationPath(), getPropertiesPath());`
`113`	`113`	`}`
`114`	`114`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public String getId() {`
`39`	`39`
`40`	`40`	`public static Optional<CheckstyleCheck> fromSource(String source) {`
`41`	`41`	`return Arrays.stream(values())`
`42`		`- .filter(check -> check.getId().contains(source))`
	`42`	`+ .filter(check -> check.getId().contains(source.split("#")[0]))`
`43`	`43`	`.findFirst();`
`44`	`44`	`}`
`45`	`45`	`}`