Issue #559: update checkstyle to 10.26.1

muhlba91 · muhlba91 · commit 5953e71c00d6 · 2025-07-09T17:22:31.000+02:00
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ Compatibility matrix from Checkstyle:
 
 | Checkstyle Plugin | Sonar min | Sonar max | Checkstyle | Jdk |
 |-------------------|-----------|-----------|------------|-----|
+| 10.26.1           | 9.9       | 10.7+     | 10.26.1    | 11  |
 | 10.23.0           | 9.9       | 10.7+     | 10.23.0    | 11  |
 | 10.21.4           | 9.9       | 10.7+     | 10.21.4    | 11  |
 | 10.21.1           | 9.9       | 10.7+     | 10.21.1    | 11  |
diff --git a/pom.xml b/pom.xml
@@ -93,13 +93,13 @@
   </ciManagement>
 
   <properties>
-    <checkstyle.version>10.23.0</checkstyle.version>
+    <checkstyle.version>10.26.1</checkstyle.version>
     <sonar.version>9.9.4.87374</sonar.version>
     <sonar.api-version>9.9.0.229</sonar.api-version>
     <maven.sevntu.checkstyle.plugin.version>1.44.1</maven.sevntu.checkstyle.plugin.version>
     <!-- it should be a version of checkstyle that is compatible/compiled with sevntu -->
     <maven.sevntu.checkstyle.plugin.checkstyle.version>
-      10.23.0
+      10.26.1
     </maven.sevntu.checkstyle.plugin.checkstyle.version>
     <antrun.plugin.version>3.1.0</antrun.plugin.version>
     <checkstyle.configLocation>https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-${checkstyle.version}/config/checkstyle-checks.xml</checkstyle.configLocation>
diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleAuditListener.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleAuditListener.java
@@ -134,17 +134,17 @@ static String getRuleKey(AuditEvent event) {
         try {
             key = event.getModuleId();
         }
-        catch (Exception ex) {
+        catch (Exception exception) {
             LOG.warn("AuditEvent is created incorrectly. Exception happen during getModuleId()",
-                    ex);
+                    exception);
         }
         if (StringUtils.isBlank(key)) {
             try {
                 key = event.getSourceName();
             }
-            catch (Exception ex) {
+            catch (Exception exception) {
                 LOG.warn("AuditEvent is created incorrectly."
-                        + "Exception happen during getSourceName()", ex);
+                        + "Exception happen during getSourceName()", exception);
             }
         }
         return key;
@@ -157,8 +157,9 @@ static String getMessage(AuditEvent event) {
             result = event.getMessage();
 
         }
-        catch (Exception ex) {
-            LOG.warn("AuditEvent is created incorrectly. Exception happen during getMessage()", ex);
+        catch (Exception exception) {
+            LOG.warn("AuditEvent is created incorrectly. Exception happen during getMessage()",
+                exception);
             result = null;
         }
         return result;
@@ -173,8 +174,9 @@ static int getLineId(AuditEvent event) {
                 result = eventLine;
             }
         }
-        catch (Exception ex) {
-            LOG.warn("AuditEvent is created incorrectly. Exception happen during getLine()", ex);
+        catch (Exception exception) {
+            LOG.warn("AuditEvent is created incorrectly. Exception happen during getLine()",
+                exception);
         }
         return result;
     }
diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleConfiguration.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleConfiguration.java
@@ -94,9 +94,9 @@ public File getXmlDefinitionFile() {
             writer.flush();
             return xmlFile;
         }
-        catch (IOException ex) {
+        catch (IOException exception) {
             throw new IllegalStateException("Fail to save the Checkstyle configuration to "
-                    + xmlFile.getPath(), ex);
+                    + xmlFile.getPath(), exception);
 
         }
     }
diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleExecutor.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleExecutor.java
@@ -108,8 +108,8 @@ private void executeWithClassLoader() {
                 .map(inputFile -> new File(inputFile.uri()))
                 .collect(Collectors.toList()));
         }
-        catch (Exception ex) {
-            throw new IllegalStateException("Can not execute Checkstyle", ex);
+        catch (Exception exception) {
+            throw new IllegalStateException("Can not execute Checkstyle", exception);
         }
         finally {
             checker.destroy();
@@ -124,8 +124,8 @@ static void close(Closeable closeable) {
         try {
             closeable.close();
         }
-        catch (IOException ex) {
-            throw new IllegalStateException("failed to close object", ex);
+        catch (IOException exception) {
+            throw new IllegalStateException("failed to close object", exception);
         }
     }
 
@@ -141,9 +141,9 @@ URL getUrl(URI uri) {
         try {
             return uri.toURL();
         }
-        catch (MalformedURLException ex) {
+        catch (MalformedURLException exception) {
             throw new IllegalStateException("Fail to create the project classloader. "
-                    + "Classpath element is invalid: " + uri, ex);
+                    + "Classpath element is invalid: " + uri, exception);
         }
     }
 }
diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleProfileExporter.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleProfileExporter.java
@@ -65,8 +65,8 @@ public void exportProfile(ActiveRules activeRules, Writer writer) {
                     .findByRepository(CheckstyleConstants.REPOSITORY_KEY));
             generateXml(writer, activeRulesByConfigKey);
         }
-        catch (IOException ex) {
-            throw new IllegalStateException("Fail to export active rules.", ex);
+        catch (IOException exception) {
+            throw new IllegalStateException("Fail to export active rules.", exception);
         }
 
     }
diff --git a/src/main/java/org/sonar/plugins/checkstyle/metadata/CheckstyleMetadata.java b/src/main/java/org/sonar/plugins/checkstyle/metadata/CheckstyleMetadata.java
@@ -159,9 +159,9 @@ private Class<?> getClass(String checkName) {
         try {
             return Class.forName(checkName, true, loader);
         }
-        catch (ClassNotFoundException ex) {
+        catch (ClassNotFoundException exception) {
             throw new IllegalStateException("exception occured during getClass for " + checkName,
-                    ex);
+                    exception);
         }
     }
 
@@ -320,8 +320,9 @@ private static String getRuleTag(String checkPackage,
         try (InputStream inputStream = CheckstyleMetadata.class.getResourceAsStream(fileName)) {
             sonarRulePropertyLoader = mapper.readValue(inputStream, SonarRulePropertyLoader.class);
         }
-        catch (IOException ex) {
-            throw new IllegalStateException("Exception during yaml loading of " + fileName, ex);
+        catch (IOException exception) {
+            throw new IllegalStateException("Exception during yaml loading of " + fileName,
+                exception);
         }
         final Map<String, SonarRulePropertyLoader.AdditionalRuleProperties> additionalDetails =
                 new HashMap<>();
diff --git a/src/main/java/org/sonar/plugins/checkstyle/metadata/ModuleFactory.java b/src/main/java/org/sonar/plugins/checkstyle/metadata/ModuleFactory.java
@@ -39,17 +39,18 @@ public static AbstractCheck getCheck(String checkName) {
                 final Set<String> packageNames = PackageNamesLoader.getPackageNames(classLoader);
                 packageObjectFactory = new PackageObjectFactory(packageNames, classLoader);
             }
-            catch (CheckstyleException ex) {
+            catch (CheckstyleException exception) {
                 throw new IllegalStateException("exception happened during initialization of"
-                        + " PackageObjectFactory while loading of " + checkName, ex);
+                        + " PackageObjectFactory while loading of " + checkName, exception);
             }
         }
 
         try {
             return (AbstractCheck) packageObjectFactory.createModule(checkName);
         }
-        catch (CheckstyleException ex) {
-            throw new IllegalStateException("exception occured during load of " + checkName, ex);
+        catch (CheckstyleException exception) {
+            throw new IllegalStateException("exception occured during load of " + checkName,
+                exception);
         }
     }
 }
diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleConfigurationTest.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleConfigurationTest.java
@@ -167,8 +167,8 @@ public void exportProfile(ActiveRules activeRules, Writer writer) {
             try {
                 writer.write("<conf/>");
             }
-            catch (IOException ex) {
-                throw new IllegalStateException(ex);
+            catch (IOException exception) {
+                throw new IllegalStateException(exception);
             }
         }
     }
diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleProfileExporterTest.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleProfileExporterTest.java
@@ -181,8 +181,8 @@ public void activeRulesThrowsException() {
                     new DefaultActiveRules(Collections.emptyList()), new IoExceptionWriter());
             Assert.fail("IOException while writing should not be ignored");
         }
-        catch (IllegalStateException ex) {
-            Assertions.assertThat(ex.getMessage()).isEqualTo("Fail to export active rules.");
+        catch (IllegalStateException exception) {
+            Assertions.assertThat(exception.getMessage()).isEqualTo("Fail to export active rules.");
         }
     }
 
diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java
@@ -76,7 +76,7 @@ public void test() {
         // such number should not change during checkstyle version upgrade
         assertThat(duplicatedRuleWithTemplate).hasSize(0);
         // all new Rules should fall in this group
-        assertThat(rulesWithDuplicateTemplate).hasSize(192);
+        assertThat(rulesWithDuplicateTemplate).hasSize(195);
 
         for (RulesDefinition.Rule rule : rules) {
             assertThat(rule.key()).isNotNull();
diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleSeverityUtilsTest.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleSeverityUtilsTest.java
@@ -44,8 +44,8 @@ public void testToSeverityWrongString() {
             CheckstyleSeverityUtils.toSeverity("nothing");
             Assert.fail("IOException while writing should not be ignored");
         }
-        catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage()).isEqualTo("Priority not supported: nothing");
+        catch (IllegalArgumentException exception) {
+            assertThat(exception.getMessage()).isEqualTo("Priority not supported: nothing");
         }
     }
 
diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleTestUtils.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleTestUtils.java
@@ -42,8 +42,8 @@ public static String getResourceContent(String path) {
             return Resources.toString(Resources.getResource(CheckstyleTestUtils.class, path),
                     Charsets.UTF_8);
         }
-        catch (IOException ex) {
-            throw new IllegalArgumentException("Could not load resource " + path, ex);
+        catch (IOException exception) {
+            throw new IllegalArgumentException("Could not load resource " + path, exception);
         }
     }
 
@@ -53,8 +53,8 @@ public static void assertSimilarXml(String expectedXml, String xml) {
         try {
             diff = XMLUnit.compareXML(xml, expectedXml);
         }
-        catch (SAXException | IOException ex) {
-            throw new IllegalArgumentException("Could not run XML comparison", ex);
+        catch (SAXException | IOException exception) {
+            throw new IllegalArgumentException("Could not run XML comparison", exception);
         }
         final String message = "Diff: " + diff + CharUtils.LF + "XML: " + xml;
         assertTrue(message, diff.similar());

Original file line number	Diff line number	Diff line change
`@@ -134,17 +134,17 @@ static String getRuleKey(AuditEvent event) {`
`134`	`134`	`try {`
`135`	`135`	`key = event.getModuleId();`
`136`	`136`	`}`
`137`		`- catch (Exception ex) {`
	`137`	`+ catch (Exception exception) {`
`138`	`138`	`LOG.warn("AuditEvent is created incorrectly. Exception happen during getModuleId()",`
`139`		`- ex);`
	`139`	`+ exception);`
`140`	`140`	`}`
`141`	`141`	`if (StringUtils.isBlank(key)) {`
`142`	`142`	`try {`
`143`	`143`	`key = event.getSourceName();`
`144`	`144`	`}`
`145`		`- catch (Exception ex) {`
	`145`	`+ catch (Exception exception) {`
`146`	`146`	`LOG.warn("AuditEvent is created incorrectly."`
`147`		`- + "Exception happen during getSourceName()", ex);`
	`147`	`+ + "Exception happen during getSourceName()", exception);`
`148`	`148`	`}`
`149`	`149`	`}`
`150`	`150`	`return key;`
`@@ -157,8 +157,9 @@ static String getMessage(AuditEvent event) {`
`157`	`157`	`result = event.getMessage();`
`158`	`158`
`159`	`159`	`}`
`160`		`- catch (Exception ex) {`
`161`		`- LOG.warn("AuditEvent is created incorrectly. Exception happen during getMessage()", ex);`
	`160`	`+ catch (Exception exception) {`
	`161`	`+ LOG.warn("AuditEvent is created incorrectly. Exception happen during getMessage()",`
	`162`	`+ exception);`
`162`	`163`	`result = null;`
`163`	`164`	`}`
`164`	`165`	`return result;`
`@@ -173,8 +174,9 @@ static int getLineId(AuditEvent event) {`
`173`	`174`	`result = eventLine;`
`174`	`175`	`}`
`175`	`176`	`}`
`176`		`- catch (Exception ex) {`
`177`		`- LOG.warn("AuditEvent is created incorrectly. Exception happen during getLine()", ex);`
	`177`	`+ catch (Exception exception) {`
	`178`	`+ LOG.warn("AuditEvent is created incorrectly. Exception happen during getLine()",`
	`179`	`+ exception);`
`178`	`180`	`}`
`179`	`181`	`return result;`
`180`	`182`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,9 +94,9 @@ public File getXmlDefinitionFile() {`
`94`	`94`	`writer.flush();`
`95`	`95`	`return xmlFile;`
`96`	`96`	`}`
`97`		`- catch (IOException ex) {`
	`97`	`+ catch (IOException exception) {`
`98`	`98`	`throw new IllegalStateException("Fail to save the Checkstyle configuration to "`
`99`		`- + xmlFile.getPath(), ex);`
	`99`	`+ + xmlFile.getPath(), exception);`
`100`	`100`
`101`	`101`	`}`
`102`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,8 +108,8 @@ private void executeWithClassLoader() {`
`108`	`108`	`.map(inputFile -> new File(inputFile.uri()))`
`109`	`109`	`.collect(Collectors.toList()));`
`110`	`110`	`}`
`111`		`- catch (Exception ex) {`
`112`		`- throw new IllegalStateException("Can not execute Checkstyle", ex);`
	`111`	`+ catch (Exception exception) {`
	`112`	`+ throw new IllegalStateException("Can not execute Checkstyle", exception);`
`113`	`113`	`}`
`114`	`114`	`finally {`
`115`	`115`	`checker.destroy();`
`@@ -124,8 +124,8 @@ static void close(Closeable closeable) {`
`124`	`124`	`try {`
`125`	`125`	`closeable.close();`
`126`	`126`	`}`
`127`		`- catch (IOException ex) {`
`128`		`- throw new IllegalStateException("failed to close object", ex);`
	`127`	`+ catch (IOException exception) {`
	`128`	`+ throw new IllegalStateException("failed to close object", exception);`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`
`@@ -141,9 +141,9 @@ URL getUrl(URI uri) {`
`141`	`141`	`try {`
`142`	`142`	`return uri.toURL();`
`143`	`143`	`}`
`144`		`- catch (MalformedURLException ex) {`
	`144`	`+ catch (MalformedURLException exception) {`
`145`	`145`	`throw new IllegalStateException("Fail to create the project classloader. "`
`146`		`- + "Classpath element is invalid: " + uri, ex);`
	`146`	`+ + "Classpath element is invalid: " + uri, exception);`
`147`	`147`	`}`
`148`	`148`	`}`
`149`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ public void exportProfile(ActiveRules activeRules, Writer writer) {`
`65`	`65`	`.findByRepository(CheckstyleConstants.REPOSITORY_KEY));`
`66`	`66`	`generateXml(writer, activeRulesByConfigKey);`
`67`	`67`	`}`
`68`		`- catch (IOException ex) {`
`69`		`- throw new IllegalStateException("Fail to export active rules.", ex);`
	`68`	`+ catch (IOException exception) {`
	`69`	`+ throw new IllegalStateException("Fail to export active rules.", exception);`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -159,9 +159,9 @@ private Class<?> getClass(String checkName) {`
`159`	`159`	`try {`
`160`	`160`	`return Class.forName(checkName, true, loader);`
`161`	`161`	`}`
`162`		`- catch (ClassNotFoundException ex) {`
	`162`	`+ catch (ClassNotFoundException exception) {`
`163`	`163`	`throw new IllegalStateException("exception occured during getClass for " + checkName,`
`164`		`- ex);`
	`164`	`+ exception);`
`165`	`165`	`}`
`166`	`166`	`}`
`167`	`167`
`@@ -320,8 +320,9 @@ private static String getRuleTag(String checkPackage,`
`320`	`320`	`try (InputStream inputStream = CheckstyleMetadata.class.getResourceAsStream(fileName)) {`
`321`	`321`	`sonarRulePropertyLoader = mapper.readValue(inputStream, SonarRulePropertyLoader.class);`
`322`	`322`	`}`
`323`		`- catch (IOException ex) {`
`324`		`- throw new IllegalStateException("Exception during yaml loading of " + fileName, ex);`
	`323`	`+ catch (IOException exception) {`
	`324`	`+ throw new IllegalStateException("Exception during yaml loading of " + fileName,`
	`325`	`+ exception);`
`325`	`326`	`}`
`326`	`327`	`final Map<String, SonarRulePropertyLoader.AdditionalRuleProperties> additionalDetails =`
`327`	`328`	`new HashMap<>();`
Original file line number	Diff line number	Diff line change
`@@ -39,17 +39,18 @@ public static AbstractCheck getCheck(String checkName) {`
`39`	`39`	`final Set<String> packageNames = PackageNamesLoader.getPackageNames(classLoader);`
`40`	`40`	`packageObjectFactory = new PackageObjectFactory(packageNames, classLoader);`
`41`	`41`	`}`
`42`		`- catch (CheckstyleException ex) {`
	`42`	`+ catch (CheckstyleException exception) {`
`43`	`43`	`throw new IllegalStateException("exception happened during initialization of"`
`44`		`- + " PackageObjectFactory while loading of " + checkName, ex);`
	`44`	`+ + " PackageObjectFactory while loading of " + checkName, exception);`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`try {`
`49`	`49`	`return (AbstractCheck) packageObjectFactory.createModule(checkName);`
`50`	`50`	`}`
`51`		`- catch (CheckstyleException ex) {`
`52`		`- throw new IllegalStateException("exception occured during load of " + checkName, ex);`
	`51`	`+ catch (CheckstyleException exception) {`
	`52`	`+ throw new IllegalStateException("exception occured during load of " + checkName,`
	`53`	`+ exception);`
`53`	`54`	`}`
`54`	`55`	`}`
`55`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -167,8 +167,8 @@ public void exportProfile(ActiveRules activeRules, Writer writer) {`
`167`	`167`	`try {`
`168`	`168`	`writer.write("<conf/>");`
`169`	`169`	`}`
`170`		`- catch (IOException ex) {`
`171`		`- throw new IllegalStateException(ex);`
	`170`	`+ catch (IOException exception) {`
	`171`	`+ throw new IllegalStateException(exception);`
`172`	`172`	`}`
`173`	`173`	`}`
`174`	`174`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,8 +181,8 @@ public void activeRulesThrowsException() {`
`181`	`181`	`new DefaultActiveRules(Collections.emptyList()), new IoExceptionWriter());`
`182`	`182`	`Assert.fail("IOException while writing should not be ignored");`
`183`	`183`	`}`
`184`		`- catch (IllegalStateException ex) {`
`185`		`- Assertions.assertThat(ex.getMessage()).isEqualTo("Fail to export active rules.");`
	`184`	`+ catch (IllegalStateException exception) {`
	`185`	`+ Assertions.assertThat(exception.getMessage()).isEqualTo("Fail to export active rules.");`
`186`	`186`	`}`
`187`	`187`	`}`
`188`	`188`