Fix sonarqube 10

Author: 陆小睿

CHANGELOG.md

@@ -1,14 +1,43 @@
 # Changelog
 
-## [3.4.1-SNAPSHOT](https://github.com/jborgers/sonar-pmd/tree/master) (tbd)
-[Full Changelog](https://github.com/jborgers/sonar-pmd/compare/3.4.0...master)
 
-- nothing yet
+## [3.5.2-SNAPSHOT](https://github.com/jborgers/sonar-pmd/tree/3.5.2-SNAPSHOT) (2024-xx-xx)
+[Full Changelog](https://github.com/jborgers/sonar-pmd/compare/3.5.1..master)
+
+**Implemented highlights:**
+
+
+## [3.5.1](https://github.com/jborgers/sonar-pmd/tree/3.5.1) (2024-05-07)
+[Full Changelog](https://github.com/jborgers/sonar-pmd/compare/3.5.0..3.5.1)
+
+**Implemented highlights:**
+- Supports latest SonarQube [9.9.4 - 10.5+]
+- Supports running on Java 11 on analysis side for SQ 9.9.4 - 10.2.x
+- Supports running on Java 17 for all supported versions
+- Updated Sonar Plugin API+impl for SonarQube 9.9.4+
+- Upgraded various dependencies
+
+- ## [3.5.0](https://github.com/jborgers/sonar-pmd/tree/3.5.0) (2024-04-23)
+[Full Changelog](https://github.com/jborgers/sonar-pmd/compare/3.4.0...3.5.0)
+
+**Contributors:**
+- [jborgers](https://github.com/jborgers) 
+- [renewolfert](https://github.com/renewolfert)
+
+**Implemented highlights:**
+- Updated PMD (6.55.0) (last PMD-6) #422
+- Support analyzing up to Java 20-preview (close to 21) #422
+- Java 21+ falls back to 20-preview with warning (no error) #422
+- Updated Sonar Plugin API+impl (9.8.0.63668) (SonarQube 9.8+) 
+- Upgraded various dependencies
+- Needs Java 17, the class file version is 61 
 
 ## [3.4.0](https://github.com/jborgers/sonar-pmd/tree/3.4.0) (2022-05-11)
 [Full Changelog](https://github.com/jborgers/sonar-pmd/compare/3.3.1...3.4.0)
 
 **Contributors:**
+- [jborgers](https://github.com/jborgers)
+- [stokpop](https://github.com/stokpop)
 - [jensgerdes](https://github.com/jensgerdes) (Many thanks for his great maintenance and decision to transfer)
 
 **Implemented highlights:**

README.md

@@ -1,4 +1,8 @@
-# SonarQube PMD Plugin [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.sonarsource.pmd/sonar-pmd-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.sonarsource.pmd/sonar-pmd-plugin) [![Build Status](https://api.travis-ci.org/jborgers/sonar-pmd.svg?branch=master)](https://travis-ci.org/jborgers/sonar-pmd) [![SonarStatus](https://sonarcloud.io/api/project_badges/measure?project=org.sonarsource.pmd%3Asonar-pmd&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.sonarsource.pmd%3Asonar-pmd) [![SonarStatus](https://sonarcloud.io/api/project_badges/measure?project=org.sonarsource.pmd%3Asonar-pmd&metric=coverage)](https://sonarcloud.io/dashboard?id=org.sonarsource.pmd%3Asonar-pmd)
+# SonarQube PMD Plugin 
+
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.sonarsource.pmd/sonar-pmd-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.sonarsource.pmd/sonar-pmd-plugin)
+![Build Status](https://github.com/jborgers/sonar-pmd/actions/workflows/build.yml/badge.svg)
+
 Sonar-PMD is a plugin that provides coding rules from [PMD](https://pmd.github.io/) for use in SonarQube.
 
 Starting April 2022, the project has found a new home. We, [jborgers](https://github.com/jborgers) and [stokpop](https://github.com/stokpop), 
@@ -9,8 +13,7 @@ For a list of all rules and their status, see: [RULES.md](https://github.com/jbo
 ## Installation
 The plugin should be available in the SonarQube marketplace and is preferably installed from within SonarQube (Administration -->  Marketplace --> Search _pmd_).
 
-Because of changed integration of the Java-plugin in SonarQube and our dependency on it, this plugin is temporarily not available from the Marketplace. 
-Hopefully this will be fixed quickly with the release of version 3.4.0.
+This plugin is available again from the Marketplace with the release of version 3.4.0.
 Alternatively, download the [latest JAR file](https://github.com/jborgers/sonar-pmd/releases/latest), put it into the plugin directory (`./extensions/plugins`) and restart SonarQube.
 
 ## Usage
@@ -22,18 +25,20 @@ Usage should be straight forward:
 Sonar-PMD analyzes the given source code with the Java source version defined in your Gradle or Maven project.
 In case you are not using one of these build tools, or if that does not match the version you are using, set the `sonar.java.source` property to tell PMD which version of Java your source code complies to. 
 
-Possible values : 1.4 to 1.8/8 to 18
+Possible values : 1.6 to 1.8/8 to 20-preview
 
 ## Table of supported versions
-| PMD Plugin                  |2.5|2.6|3.0.0|3.1.x|3.2.x|3.3.x| 3.4.0          |
-|-----------------------------|---|---|---|---|---|---|----------------|
-| PMD                         |5.4.0|5.4.2|5.4.2|6.9.0|6.10.0|6.30.0| 6.45.0         |
-| Max. supported Java Version | 1.7 | 1.8 | 1.8 | 11 | | 15| 18             |
-|  Min. SonarQube Version     | 4.5.4 | 4.5.4 | 6.6 | | | 6.7| _8.9(*)_ / 9.3 |
+| Sonar-PMD Plugin       | 3.1.x | 3.3.x  | 3.4.0           | 3.5.0         | 3.5.1         | 4.0.0 (planned) |
+|------------------------|-------|--------|-----------------|---------------|---------------|-----------------|
+| PMD                    | 6.9.0 | 6.30.0 | 6.45.0          | 6.55.0        | 6.55.0        | 7.1.0           |
+| Max. Java Version      | 11    | 15     | 18              | 20-preview *2 | 20-preview *2 | 22              |
+| Min. SonarQube Version | 6.6   | 6.7    | _8.9(*1)_ / 9.3 | 9.8           | 9.9.4         | 10.0            |
+| Max. SonarQube Version |       |        | 9.9             | 10.4          | 10.5+         | 10.5+           |
 
-(*) Note: Plugin version 3.4.x runs in SonarQube 8.9, however, Java 17+ is only fully supported in SonarQube 9.3+.
+(*1) Note: Plugin version 3.4.x runs in SonarQube 8.9, however, Java 17+ is only fully supported in SonarQube 9.3+.   
+(*2) Note: Supports all tested Java 21 features; on parsing errors, warns instead of breaks 
 
-A majority of the PMD rules have been rewritten in the Java plugin. Rewritten rules are marked "Deprecated" in the PMD plugin, but a [concise summary of replaced rules](http://dist.sonarsource.com/reports/coverage/pmd.html) is available.
+A majority of the PMD rules have been rewritten in the Sonar Java plugin. Rewritten rules are marked "Deprecated" in the PMD plugin, but a [concise summary of replaced rules](http://dist.sonarsource.com/reports/coverage/pmd.html) is available.
 
 ## Rules on test
 PMD tool provides some rules that can check the code of JUnit tests. Please note that these rules (and only these rules) will be applied only on the test files of your project.
@@ -48,33 +53,3 @@ To build the plugin and run the integration tests:
 
     ./mvnw clean verify
 
-## 关于Alibaba P3c
-
-本repo在sonar-pmd基础上增加了alibaba-p3c规则，详细的修改包括：
-
-1. sonar-pmd-plugin 增加依赖
-
-   ```xml
-       <dependency>
-         <groupId>com.alibaba.p3c</groupId>
-         <artifactId>p3c-pmd</artifactId>
-         <!-- 请保持最新 -->
-         <version>2.1.1</version>
-       </dependency>
-       <dependency>
-         <groupId>com.google.code.gson</groupId>
-         <artifactId>gson</artifactId>
-         <version>2.9.0</version>
-       </dependency>
-   ```
-
-2. 修改 `/resources/org/sonar/l10n/pmd/rules/pmd.properties` ，增加 p3c 的规则。同时修改 `org.sonar.plugins.pmd.PmdRulesDefinitionTest.test` 里面对规则条数的断言，从268改实际的324。
-3. 增加 `/resources/org/sonar/plugins/pmd/rules-p3c.xml`
-4. 增加规则描述 html `/resources/org/sonar/l10n/pmd-p3c`
-5. 修改 `/resources/com/sonar/sqale/pmd-model.xml` 增加P3c相关
-6. 修改 PmdRulesDefinition.java，加入p3c规则：
-
-    ```java
-    //org.sonar.plugins.pmd.rule.PmdRulesDefinition#define 
-    extractRulesData(repository, "/org/sonar/plugins/pmd/rules-p3c.xml", "/org/sonar/l10n/pmd/rules/pmd-p3c");
-    ```

RELEASE.md

@@ -1,29 +1,36 @@
-To release a build
+# Create release
 
-- change all `x.y.z-SNAPSHOT` to `x.y.z` in all poms
-- change tag `HEAD` to `x.y.z` in scm tag in parent pom
-- finish and update `CHANGELOG.md`, update `..master` to `..x.y.z`
-- commit and push with comment "Release x.y.z"
+To create a new release, set git tag with new version number and push the tag.
+The Github Actions `release.yml` will build and release to Github actions and Maven Central.
+
+Make sure that all commits have been pushed and build 
+with `build.yml` workflow before setting and pushing the tag.
+
+Steps:
+- create release notes in `CHANGELOG.md`, update `..master` to `..x.y.z`; and update `README.md`
+- commit both
 - `git tag x.y.z`
 - `git push --tags`
-- use github action `release` to deploy to maven central
-- release staging repo in Sonatype ui
-- change all `x.y.z` in all poms to `x.y.z+1-SNAPSHOT`
-- change tag `x.y.z` in scm tag in parent pom to `HEAD`
+
+The release workflow will be triggered, using the git tag for `-Drevision=<tag>`. 
+
+- manually release staging repo in [Sonatype](https://oss.sonatype.org/#welcome) for Maven Central
+- manually change Github actions release from draft to final and limit the changelog here: [releases](https://github.com/jborgers/sonar-pmd/releases) 
+
+Next prepare for next SNAPSHOT:
+
+- change `revision` property in `x.y.z+1-SNAPSHOT` in parent pom
 - prepare `CHANGELOG.md` for `x.y.z+1-SNAPSHOT`
-- commit and push with comment "Prepare for release x.y.z+1-SNAPSHOT"
+- commit and push with comment "Prepare release x.y.z+1-SNAPSHOT"
 
-When release fails before "release staging in Sonatype ui"
+When release fails before "release staging in Sonatype"
 - drop staging repo
-- `git tag -d x.y.z`
-- `git push origin :refs/tags/x.y.z`
+- `git tag -d x.y.z` or delete tag in IntelliJ
+- `git push origin :refs/tags/x.y.z` or delete tag in context menu, delete remotes
 - fix-commit-push and start release again with tagging steps above
 
 In GitHub:
 
-- create release from tag via Actions
-- update release notes with `CHANGELOG.md` contents
-- download `sonar-pmd-plugin-x.y.z.jar` and upload in release notes
 - close milestone `x.y.z`
 - create new milestone `x.y.z+1`
 

integration-test/pom.xml

@@ -25,7 +25,7 @@
   <parent>
     <groupId>org.sonarsource.pmd</groupId>
     <artifactId>sonar-pmd</artifactId>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>${revision}</version>
   </parent>
 
   <artifactId>integration-test</artifactId>
@@ -42,13 +42,18 @@
       <groupId>org.sonarsource.orchestrator</groupId>
       <artifactId>sonar-orchestrator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.sonarsource.orchestrator</groupId>
+      <artifactId>sonar-orchestrator-junit4</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.codehaus.sonar</groupId>
       <artifactId>sonar-ws-client</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.sonarsource.sonarqube</groupId>
+      <groupId>org.sonarsource.api.plugin</groupId>
       <artifactId>sonar-plugin-api</artifactId>
+      <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>net.sourceforge.pmd</groupId>
@@ -58,54 +63,8 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
-      <version>3.14.0</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>commons-io</groupId>
-      <artifactId>commons-io</artifactId>
-      <version>2.15.1</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>commons-lang</groupId>
-      <artifactId>commons-lang</artifactId>
-      <version>2.6</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>commons-codec</groupId>
-      <artifactId>commons-codec</artifactId>
-      <version>1.16.0</version>
-    </dependency>
-    <dependency>
-      <groupId>org.apache.commons</groupId>
-      <artifactId>commons-exec</artifactId>
-      <version>1.4.0</version>
-    </dependency>
-    <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-api</artifactId>
-      <version>2.0.11</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>com.h2database</groupId>
-      <artifactId>h2</artifactId>
-      <version>2.2.224</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.squareup.okhttp3</groupId>
-      <artifactId>okhttp</artifactId>
-      <version>4.12.0</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.eclipsesource.minimal-json</groupId>
-      <artifactId>minimal-json</artifactId>
-      <version>0.9.5</version>
-    </dependency>
   </dependencies>
 
   <build>

integration-test/projects/pmd-junit-rules/pom.xml

@@ -10,7 +10,7 @@
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
-      <version>3.8</version>
+      <version>4.13.2</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

integration-test/src/main/java/org/sonar/examples/pmd/MaximumMethodsCountCheck.java

@@ -61,7 +61,7 @@ public void end(RuleContext ctx) {
     public Object visit(ASTClassOrInterfaceBody node, Object data) {
         List<ASTMethodDeclaration> methods = node.findDescendantsOfType(ASTMethodDeclaration.class);
         if (methods.size() > getProperty(propertyDescriptor)) {
-            addViolation(data, node);
+            asCtx(data).addViolation(node);
         }
         return super.visit(node, data);
     }

integration-test/src/test/java/com/sonar/it/java/suite/PmdIT.java

@@ -19,15 +19,9 @@
  */
 package com.sonar.it.java.suite;
 
-import static com.sonar.it.java.suite.TestUtils.keyFor;
-import static com.sonar.it.java.suite.TestUtils.keyForTest;
-import static org.assertj.core.api.Assertions.assertThat;
-
 import com.sonar.it.java.suite.orchestrator.PmdTestOrchestrator;
 import com.sonar.orchestrator.build.BuildResult;
 import com.sonar.orchestrator.build.MavenBuild;
-import java.util.List;
-import java.util.stream.Collectors;
 import org.apache.commons.lang3.JavaVersion;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -36,6 +30,13 @@
 import org.sonar.wsclient.issue.Issue;
 import org.sonar.wsclient.issue.IssueQuery;
 
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static com.sonar.it.java.suite.TestUtils.keyFor;
+import static com.sonar.it.java.suite.TestUtils.keyForTest;
+import static org.assertj.core.api.Assertions.assertThat;
+
 class PmdIT {
 
     private static final PmdTestOrchestrator ORCHESTRATOR = PmdTestOrchestrator.init();
@@ -46,7 +47,7 @@ static void startSonar() {
     }
 
     @ParameterizedTest
-    @EnumSource(value = JavaVersion.class, mode = EnumSource.Mode.INCLUDE, names = {"JAVA_1_8", "JAVA_11", "JAVA_16"})
+    @EnumSource(value = JavaVersion.class, mode = EnumSource.Mode.INCLUDE, names = {"JAVA_1_8", "JAVA_11", "JAVA_17", "JAVA_20"})
     void testPmdExtensionsWithDifferentJavaVersions(JavaVersion version) {
 
         // given
@@ -144,7 +145,7 @@ void testJunitRules() {
         // then
         final List<Issue> testIssues = retrieveIssues(keyForTest());
         assertThat(testIssues).hasSize(1);
-        assertThat(testIssues.get(0).message()).matches("The class '.+?Test' might be a test class, but it contains no test cases.");
+        assertThat(testIssues.get(0).message()).matches("The class 'ProductionCodeTest' might be a test class, but it contains no test cases.");
         assertThat(testIssues.get(0).ruleKey()).isEqualTo("pmd-unit-tests:TestClassWithoutTestCases");
 
         final List<Issue> prodIssues = retrieveIssues(keyFor(projectName, "", "ProductionCode"));