Issue #502: update to LTS 9.9; cleanup deprecations

checkstyle · Mar 1, 2024 · 7056481 · 7056481
1 parent 8462c9e
commit 7056481
Show file tree

Hide file tree

Showing 43 changed files with 285 additions and 1,092 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,7 @@ version: 2
 jobs:
   build-project:
     docker:
-      - image: cimg/openjdk:11.0.16
+      - image: cimg/openjdk:17.0.10
 
     steps:
       - checkout
@@ -15,7 +15,7 @@ jobs:
 
   execute-sonar:
     docker:
-      - image: sonarqube:9.0-community
+      - image: sonarqube:9.9-community
     working_directory: ~/repo
 
     environment:

diff --git a/.github/workflows/sonar-checkstyle-workflows.yml b/.github/workflows/sonar-checkstyle-workflows.yml
@@ -18,16 +18,17 @@ jobs:
       - name: install
         run: "./.ci/ci.sh install"
 
-  integration-tests:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up JDK 11
-        uses: actions/setup-java@v1
-        with:
-          java-version: 11
-      - name: run integration tests
-        run: "./.ci/ci.sh integration-tests"
+# depreacted for now since SQ removed the application ZIP files needed for the integration tests
+#   integration-tests:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v2
+#       - name: Set up JDK 11
+#         uses: actions/setup-java@v1
+#         with:
+#           java-version: 11
+#       - name: run integration tests
+#         run: "./.ci/ci.sh integration-tests"
 
   nondex:
     runs-on: ubuntu-latest

diff --git a/config/import-control.xml b/config/import-control.xml
@@ -15,7 +15,7 @@
 
   <allow class="com.puppycrawl.tools.checkstyle.api.AuditEvent"/>
   <allow class="com.puppycrawl.tools.checkstyle.api.AuditListener"/>
-  <allow class="com.puppycrawl.tools.checkstyle.api.AutomaticBean"/>
+  <allow class="com.puppycrawl.tools.checkstyle.AbstractAutomaticBean"/>
   <allow class="com.puppycrawl.tools.checkstyle.api.CheckstyleException"/>
   <allow class="com.puppycrawl.tools.checkstyle.api.Configuration"/>
   <allow class="com.puppycrawl.tools.checkstyle.api.SeverityLevel"/>

diff --git a/config/sevntu-suppressions.xml b/config/sevntu-suppressions.xml
@@ -13,9 +13,6 @@
     <suppress checks="AvoidModifiersForTypes" files=".*[\\/]src[\\/]main[\\/]"/>
     <!-- END of legacy code -->
 
-
-    <!-- parsing of xml imply reference attribute names, does not make sense to move all to special variables -->
-    <suppress checks="MultipleStringLiteralsExtended" files="CheckstyleProfileImporter\.java"/>
     <!-- till https://github.com/checkstyle/sonar-checkstyle/issues/135 -->
     <suppress checks="MultipleStringLiteralsExtended" files="CheckstylePlugin\.java"/>
 

diff --git a/config/suppressions.xml b/config/suppressions.xml
@@ -11,8 +11,6 @@
     <suppress checks="IllegalCatch" files=".*[\\/]src[\\/]main[\\/]"/>
     <!-- END of legacy code -->
 
-    <!-- parsing of xml imply reference attribute names, does not make sense to move all to special variables -->
-    <suppress checks="MultipleStringLiterals" files="CheckstyleProfileImporter\.java"/>
     <!-- till https://github.com/checkstyle/sonar-checkstyle/issues/135 -->
     <suppress checks="MultipleStringLiterals" files=".*[\\/]CheckstylePlugin\.java"/>
     <!-- messing test code with such optimization does not make sense , readability will decrease -->

diff --git a/pom.xml b/pom.xml
@@ -94,8 +94,8 @@
 
   <properties>
     <checkstyle.version>10.12.5</checkstyle.version>
-    <sonar.version>8.9.0.43852</sonar.version>
-    <sonar-java.version>7.2.0.26923</sonar-java.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>
@@ -158,9 +158,9 @@
       <version>32.0.0-jre</version>
     </dependency>
     <dependency>
-      <groupId>org.sonarsource.sonarqube</groupId>
+      <groupId>org.sonarsource.api.plugin</groupId>
       <artifactId>sonar-plugin-api</artifactId>
-      <version>${sonar.version}</version>
+      <version>${sonar.api-version}</version>
       <scope>provided</scope>
     </dependency>
     <dependency>
@@ -558,6 +558,13 @@
               <goal>report</goal>
             </goals>
           </execution>
+          <execution>
+            <id>report</id>
+            <phase>prepare-package</phase>
+            <goals>
+                <goal>report</goal>
+            </goals>
+        </execution>
           <execution>
             <id>default-check</id>
             <goals>
@@ -573,7 +580,6 @@
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleExecutor</exclude>
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleSeverityUtils</exclude>
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleConfiguration</exclude>
-                    <exclude>org.sonar.plugins.checkstyle.CheckstyleProfileImporter</exclude>
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleRulesDefinition</exclude>
                     <exclude>org.sonar.plugins.checkstyle.metadata.CheckstyleMetadata</exclude>
                     <exclude>org.sonar.plugins.checkstyle.metadata.CheckUtil</exclude>
@@ -682,24 +688,6 @@
                     </limit>
                   </limits>
                 </rule>
-                <rule>
-                  <element>CLASS</element>
-                  <includes>
-                    <include>org.sonar.plugins.checkstyle.CheckstyleProfileImporter</include>
-                  </includes>
-                  <limits>
-                    <limit>
-                      <counter>LINE</counter>
-                      <value>COVEREDRATIO</value>
-                      <minimum>1.0</minimum>
-                    </limit>
-                    <limit>
-                      <counter>BRANCH</counter>
-                      <value>COVEREDRATIO</value>
-                      <minimum>0.96</minimum>
-                    </limit>
-                  </limits>
-                </rule>
                 <rule>
                   <element>CLASS</element>
                   <includes>

diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleAuditListener.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleAuditListener.java
@@ -25,7 +25,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.ExtensionPoint;
-import org.sonar.api.batch.ScannerSide;
 import org.sonar.api.batch.fs.FileSystem;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.rule.ActiveRule;
@@ -34,6 +33,7 @@
 import org.sonar.api.batch.sensor.issue.NewIssue;
 import org.sonar.api.batch.sensor.issue.NewIssueLocation;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.scanner.ScannerSide;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.puppycrawl.tools.checkstyle.api.AuditEvent;

diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleConfiguration.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleConfiguration.java
@@ -33,11 +33,11 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.ExtensionPoint;
-import org.sonar.api.batch.ScannerSide;
 import org.sonar.api.batch.fs.FilePredicates;
 import org.sonar.api.batch.fs.FileSystem;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.rule.ActiveRules;
+import org.sonar.api.scanner.ScannerSide;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
@@ -59,6 +59,17 @@ public class CheckstyleConfiguration {
     private final FileSystem fileSystem;
 
     public CheckstyleConfiguration(
+            org.sonar.api.config.Configuration conf,
+            ActiveRules activeRules,
+            FileSystem fileSystem) {
+        this.conf = conf;
+        confExporter = new CheckstyleProfileExporter(conf);
+        this.activeRules = activeRules;
+        this.fileSystem = fileSystem;
+    }
+
+    // used for unit testing
+    protected CheckstyleConfiguration(
             org.sonar.api.config.Configuration conf,
             CheckstyleProfileExporter confExporter,
             ActiveRules activeRules,

diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstyleExecutor.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstyleExecutor.java
@@ -34,15 +34,14 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.ExtensionPoint;
-import org.sonar.api.batch.ScannerSide;
-import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.scanner.ScannerSide;
 
 import com.google.common.annotations.VisibleForTesting;
+import com.puppycrawl.tools.checkstyle.AbstractAutomaticBean;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.PackageNamesLoader;
 import com.puppycrawl.tools.checkstyle.XMLLogger;
-import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
 
 @ExtensionPoint
 @ScannerSide
@@ -98,16 +97,16 @@ private void executeWithClassLoader() {
                 LOG.info("Checkstyle output report: {}", xmlReport.getAbsolutePath());
                 xmlOutput = FileUtils.openOutputStream(xmlReport);
                 checker.addListener(
-                        new XMLLogger(xmlOutput, AutomaticBean.OutputStreamOptions.CLOSE));
+                        new XMLLogger(xmlOutput, AbstractAutomaticBean.OutputStreamOptions.CLOSE));
             }
 
             checker.setCharset(configuration.getCharset().name());
             checker.configure(configuration.getCheckstyleConfiguration());
             checker.process(configuration
                     .getSourceFiles()
-                    .stream()
-                    .map(InputFile::file)
-                    .collect(Collectors.toList()));
+                .stream()
+                .map(inputFile -> new File(inputFile.uri()))
+                .collect(Collectors.toList()));
         }
         catch (Exception ex) {
             throw new IllegalStateException("Can not execute Checkstyle", ex);

diff --git a/src/main/java/org/sonar/plugins/checkstyle/CheckstylePlugin.java b/src/main/java/org/sonar/plugins/checkstyle/CheckstylePlugin.java
@@ -76,22 +76,22 @@ public static List getExtensions() {
                                 .name("Checker Filters")
                                 .description(CHECKER_FILTERS_DESCRIPTION)
                                 .type(PropertyType.TEXT)
-                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE).build(),
+                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.PROJECT).build(),
                         PropertyDefinition.builder(CheckstyleConstants.TREEWALKER_FILTERS_KEY)
                                 .defaultValue(CheckstyleConstants.TREEWALKER_FILTERS_DEFAULT_VALUE)
                                 .category(CHECKSTYLE_CATEGORY_NAME)
                                 .subCategory(CHECKSTYLE_SUB_CATEGORY_NAME)
                                 .name("Treewalker Filters")
                                 .description(TREEWALKER_FILTERS_DESCRIPTION)
                                 .type(PropertyType.TEXT)
-                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE).build(),
+                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.PROJECT).build(),
                         PropertyDefinition.builder(CheckstyleConstants.CHECKER_TAB_WIDTH)
                                 .category(CHECKSTYLE_CATEGORY_NAME)
                                 .subCategory(CHECKSTYLE_SUB_CATEGORY_NAME)
                                 .name("Tab Width")
                                 .description(CHECKER_TAB_WIDTH_DESCRIPTION)
                                 .type(PropertyType.INTEGER)
-                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE)
+                                .onQualifiers(Qualifiers.PROJECT, Qualifiers.PROJECT)
                                 .build(),
                         PropertyDefinition.builder(CheckstyleConfiguration.PROPERTY_GENERATE_XML)
                                 .defaultValue("false").category(CHECKSTYLE_CATEGORY_NAME)
@@ -101,7 +101,6 @@ public static List getExtensions() {
 
                         CheckstyleSensor.class, CheckstyleConfiguration.class,
                         CheckstyleExecutor.class, CheckstyleAuditListener.class,
-                        CheckstyleProfileExporter.class, CheckstyleProfileImporter.class,
                         CheckstyleRulesDefinition.class);
     }