infra: upgrade verify checkstyle version to 10

Author: rnveach

config/import-control-test.xml

@@ -3,7 +3,11 @@
     "-//Checkstyle//DTD ImportControl Configuration 1.4//EN"
     "https://checkstyle.org/dtds/import_control_1_4.dtd">
 
-<import-control pkg="org.sonar.plugins.checkstyle">
+<import-control
+        pkg="(|
+        |org\.sonar\.plugins\.checkstyle|
+        |org\.checkstyle\.plugins\.sonar)"
+        regex="true">
 
   <allow pkg=".*" regex="true" />
 

pom.xml

@@ -98,10 +98,10 @@
     <sonar.version>8.9.0.43852</sonar.version>
     <sonar-java.version>7.2.0.26923</sonar-java.version>
     <maven.checkstyle.plugin.version>3.1.2</maven.checkstyle.plugin.version>
-    <maven.sevntu.checkstyle.plugin.version>1.40.0</maven.sevntu.checkstyle.plugin.version>
+    <maven.sevntu.checkstyle.plugin.version>1.42.0</maven.sevntu.checkstyle.plugin.version>
     <!-- it should be a version of checkstyle that is compatible/compiled with sevntu -->
     <maven.sevntu.checkstyle.plugin.checkstyle.version>
-      8.35
+      10.0
     </maven.sevntu.checkstyle.plugin.checkstyle.version>
     <maven.jacoco.plugin.version>0.8.5</maven.jacoco.plugin.version>
     <java.version>11</java.version>

src/main/java/org/sonar/plugins/checkstyle/CheckstyleExecutor.java

@@ -63,6 +63,7 @@ public CheckstyleExecutor(CheckstyleConfiguration configuration,
 
     /**
      * Execute Checkstyle and return the generated XML report.
+     *
      * @noinspection TooBroadScope
      */
     public void execute(SensorContext context) {

src/main/java/org/sonar/plugins/checkstyle/metadata/CheckstyleMetadata.java

@@ -34,6 +34,7 @@
 import org.sonar.api.server.debt.internal.DefaultDebtRemediationFunction;
 import org.sonar.api.server.rule.RuleParamType;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.plugins.checkstyle.metadata.SonarRulePropertyLoader.AdditionalRuleProperties;
 
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -95,44 +96,55 @@ public void createRulesWithMetadata() {
 
         metadataRepo.entrySet().stream()
                 .filter(entry -> entry.getValue().getModuleType() == ModuleType.CHECK)
-                .forEach(check -> {
-                    final ModuleDetails moduleDetails = check.getValue();
-                    final boolean isTemplate = isTemplateRule(moduleDetails);
-                    final String fullCheckName = getFullCheckName(moduleDetails.getName());
-                    final String fullQualifiedName = moduleDetails.getFullQualifiedName();
-                    final RulesDefinition.NewRule rule;
-                    if (isTemplate) {
-                        rule = repository
-                                .createRule(fullQualifiedName + "template")
-                                .setName(fullCheckName + " Template");
-                    }
-                    else {
-                        rule = repository
-                                .createRule(fullQualifiedName)
-                                .setName(fullCheckName);
-                    }
-                    rule.setHtmlDescription(moduleDetails.getDescription())
-                            .setInternalKey(getInternalKey(moduleDetails))
-                            .setSeverity("MINOR")
-                            .setStatus(RuleStatus.READY);
-                    if (!NO_SQALE.contains(rule.key())) {
-                        rule.setDebtRemediationFunction(debtRemediationFunction);
-                    }
-                    final String tag = getRuleTag(moduleDetails.getFullQualifiedName(),
-                            additionalRuleData.get(check.getKey()));
-                    if (tag != null) {
-                        rule.setTags(tag);
-                    }
-                    if (isTemplate) {
-                        rule.setTemplate(true);
-                    }
+                .forEach(check -> forEachCheck(check, additionalRuleData, debtRemediationFunction));
+    }
 
-                    for (ModulePropertyDetails property : moduleDetails.getProperties()) {
-                        constructParams(moduleDetails.getName(),
-                                rule.createParam(property.getName()),
-                                property);
-                    }
-                });
+    /**
+     * Processing to do when examining each check found.
+     *
+     * @param check The check to do processing on.
+     * @param additionalRuleData The additional rule data to save.
+     * @param debtRemediationFunction The remediation function to use.
+     */
+    private void forEachCheck(Map.Entry<String, ModuleDetails> check,
+            Map<String, AdditionalRuleProperties> additionalRuleData,
+            DebtRemediationFunction debtRemediationFunction) {
+        final ModuleDetails moduleDetails = check.getValue();
+        final boolean isTemplate = isTemplateRule(moduleDetails);
+        final String fullCheckName = getFullCheckName(moduleDetails.getName());
+        final String fullQualifiedName = moduleDetails.getFullQualifiedName();
+        final RulesDefinition.NewRule rule;
+        if (isTemplate) {
+            rule = repository
+                    .createRule(fullQualifiedName + "template")
+                    .setName(fullCheckName + " Template");
+        }
+        else {
+            rule = repository
+                    .createRule(fullQualifiedName)
+                    .setName(fullCheckName);
+        }
+        rule.setHtmlDescription(moduleDetails.getDescription())
+                .setInternalKey(getInternalKey(moduleDetails))
+                .setSeverity("MINOR")
+                .setStatus(RuleStatus.READY);
+        if (!NO_SQALE.contains(rule.key())) {
+            rule.setDebtRemediationFunction(debtRemediationFunction);
+        }
+        final String tag = getRuleTag(moduleDetails.getFullQualifiedName(),
+                additionalRuleData.get(check.getKey()));
+        if (tag != null) {
+            rule.setTags(tag);
+        }
+        if (isTemplate) {
+            rule.setTemplate(true);
+        }
+
+        for (ModulePropertyDetails property : moduleDetails.getProperties()) {
+            constructParams(moduleDetails.getName(),
+                    rule.createParam(property.getName()),
+                    property);
+        }
     }
 
     /**
@@ -222,6 +234,7 @@ else if ("anyTokenTypesSet".equals(paramType)) {
     /**
      * This check is required since the PARAM_TYPE column has size 512, and exceeding it
      * will result in an error in DB updates
+     *
      * @param values array of values
      * @return true if the size has exceeded the limit
      */

src/test/java/org/sonar/plugins/checkstyle/CheckstyleAuditListenerTest.java

@@ -78,6 +78,7 @@ public void before() {
 
     /**
      * We do suppression to keep code the same in view
+     *
      * @noinspection TooBroadScope
      */
     @Test

src/test/java/org/sonar/plugins/checkstyle/CheckstyleExecutorTest.java

@@ -105,6 +105,7 @@ public void getUrlException() throws URISyntaxException {
 
     /**
      * We do suppression as we need to cache value initialLocale
+     *
      * @noinspection TooBroadScope
      */
     @Test