Merge pull request #53 from jensgerdes/sonarqube-7.3+

sonar-pmd has been heavily refactored to use the current Sonar Plugin API, allowing it to be run on SonarQube 7.3+. Fixes #49, fixes #42
jborgers · Oct 17, 2018 · c88d547 · c88d547
2 parents 6998130 + 583a5ce
commit c88d547
Show file tree

Hide file tree

Showing 240 changed files with 2,947 additions and 6,496 deletions.
diff --git a/.sonarsource.properties b/.sonarsource.properties
diff --git a/.travis.yml b/.travis.yml
@@ -16,6 +16,7 @@ env:
 - TEST=ci
 - TEST=plugin SQ_VERSION=LATEST_RELEASE[6.7]
 - TEST=plugin SQ_VERSION=LATEST_RELEASE[7.2]
+- TEST=plugin SQ_VERSION=LATEST_RELEASE[7.3]
 
 cache:
   directories:

diff --git a/infinitest.args b/infinitest.args
diff --git a/infinitest.filters b/infinitest.filters
diff --git a/...s/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/MaximumMethodsCountCheck.java b/...s/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/MaximumMethodsCountCheck.java
@@ -1,7 +1,7 @@
 /*
  * Java :: IT :: Plugins :: PMD Extension Plugin
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package org.sonar.examples.pmd;
 

diff --git a/...plugins/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/PmdExtensionPlugin.java b/...plugins/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/PmdExtensionPlugin.java
@@ -1,7 +1,7 @@
 /*
  * Java :: IT :: Plugins :: PMD Extension Plugin
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package org.sonar.examples.pmd;
 

diff --git a/...ins/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/PmdExtensionRepository.java b/...ins/pmd-extension-plugin/src/main/java/org/sonar/examples/pmd/PmdExtensionRepository.java
@@ -1,7 +1,7 @@
 /*
  * Java :: IT :: Plugins :: PMD Extension Plugin
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,42 +13,46 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package org.sonar.examples.pmd;
 
-import org.apache.commons.io.IOUtils;
-import org.sonar.api.resources.Java;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
 import org.sonar.api.rules.Rule;
 import org.sonar.api.rules.RuleRepository;
 import org.sonar.api.rules.XMLRuleParser;
 
-import java.io.InputStream;
-import java.util.List;
-
 public class PmdExtensionRepository extends RuleRepository {
 
-  // Must be the same than the PMD plugin
-  private static final String REPOSITORY_KEY = "pmd";
-  private XMLRuleParser ruleParser;
-
-  public PmdExtensionRepository(XMLRuleParser ruleParser) {
-    super(REPOSITORY_KEY, Java.KEY);
-    this.ruleParser = ruleParser;
-  }
+    // Must be the same than the PMD plugin
+    private static final String REPOSITORY_KEY = "pmd";
+    private XMLRuleParser ruleParser;
 
-  @Override
-  public List<Rule> createRules() {
-    // In this example, new rules are declared in a XML file
-    InputStream input = getClass().getResourceAsStream("/org/sonar/examples/pmd/extensions.xml");
-    try {
-      return ruleParser.parse(input);
-
-    } finally {
-      IOUtils.closeQuietly(input);
+    public PmdExtensionRepository(XMLRuleParser ruleParser) {
+        // FIXME: Usage of PmdConstants possible?
+        super(REPOSITORY_KEY, "java");
+        this.ruleParser = ruleParser;
     }
-  }
 
+    @Override
+    public List<Rule> createRules() {
+        // In this example, new rules are declared in a XML file
+        InputStream input = getClass().getResourceAsStream("/org/sonar/examples/pmd/extensions.xml");
+        try {
+            return ruleParser.parse(input);
+
+        } finally {
+            // FIXME Get rid of double close
+            try {
+                input.close();
+            } catch (IOException e) {
+                throw new RuntimeException("Failed to close stream.", e);
+            }
+        }
+    }
 }
diff --git a/its/plugin/pom.xml b/its/plugin/pom.xml
@@ -5,19 +5,14 @@
  <parent>
     <groupId>org.sonarsource.parent</groupId>
     <artifactId>parent</artifactId>
-    <version>24</version>
+    <version>48</version>
   </parent>
 
   <groupId>com.sonarsource.it</groupId>
   <artifactId>it-pmd-plugin</artifactId>
   <name>PMD :: IT :: Plugin</name>
   <version>1.0-SNAPSHOT</version>
   <packaging>pom</packaging>
-  <organization>
-    <name>SonarSource</name>
-    <url>http://www.sonarsource.com</url>
-  </organization>
-
   <inceptionYear>2013</inceptionYear>
 
   <modules>

diff --git a/its/plugin/tests/pom.xml b/its/plugin/tests/pom.xml
@@ -17,9 +17,9 @@
 
   <dependencies>
     <dependency>
-      <groupId>${pom.groupId}</groupId>
+      <groupId>${project.groupId}</groupId>
       <artifactId>it-pmd-plugin-plugins</artifactId>
-      <version>${pom.version}</version>
+      <version>${project.version}</version>
       <type>pom</type>
     </dependency>
     <dependency>

diff --git a/its/plugin/tests/src/test/java/com/sonar/it/java/suite/PmdTest.java b/its/plugin/tests/src/test/java/com/sonar/it/java/suite/PmdTest.java
@@ -1,7 +1,7 @@
 /*
  * PMD :: IT :: Plugin :: Tests
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package com.sonar.it.java.suite;
 

diff --git a/its/plugin/tests/src/test/java/com/sonar/it/java/suite/PmdTestSuite.java b/its/plugin/tests/src/test/java/com/sonar/it/java/suite/PmdTestSuite.java
@@ -1,7 +1,7 @@
 /*
  * PMD :: IT :: Plugin :: Tests
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package com.sonar.it.java.suite;
 

diff --git a/its/plugin/tests/src/test/java/com/sonar/it/java/suite/TestUtils.java b/its/plugin/tests/src/test/java/com/sonar/it/java/suite/TestUtils.java
@@ -1,7 +1,7 @@
 /*
  * PMD :: IT :: Plugin :: Tests
- * Copyright (C) 2013 SonarSource
- * sonarqube@googlegroups.com
+ * Copyright (C) 2013-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -13,9 +13,9 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 package com.sonar.it.java.suite;
 

diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.sonarsource.parent</groupId>
     <artifactId>parent</artifactId>
-    <version>24</version>
+    <version>48</version>
   </parent>
 
   <groupId>org.sonarsource.pmd</groupId>
@@ -15,9 +15,7 @@
   <packaging>sonar-plugin</packaging>
 
   <name>SonarQube PMD Plugin</name>
-  <description>PMD is a tool that looks for potential problems like possible bugs, dead code, suboptimal code,
-    overcomplicated expressions or duplicate code.
-  </description>
+  <description>Sonar-PMD is a plugin that provides coding rules from PMD.</description>
   <inceptionYear>2012</inceptionYear>
 
   <licenses>
@@ -60,8 +58,8 @@
     <maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
 
     <pmd.version>5.4.2</pmd.version>
-    <sonar.version>4.5.4</sonar.version>
-    <sonar-java.version>3.6</sonar-java.version>
+    <sonar.version>6.7</sonar.version>
+    <sonar-java.version>5.5.0.14655</sonar-java.version>
 
     <!-- Configuration for sonar-packaging-maven-plugin -->
     <sonar.pluginKey>pmd</sonar.pluginKey>
@@ -73,7 +71,7 @@
 
   <dependencies>
     <dependency>
-      <groupId>org.codehaus.sonar</groupId>
+      <groupId>org.sonarsource.sonarqube</groupId>
       <artifactId>sonar-plugin-api</artifactId>
       <scope>provided</scope>
       <version>${sonar.version}</version>
@@ -84,18 +82,35 @@
         </exclusion>
       </exclusions>
     </dependency>
+    <!--<dependency>
+      <groupId>org.sonarsource.sslr-squid-bridge</groupId>
+      <artifactId>sslr-squid-bridge</artifactId>
+      <version>2.7.0.377</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.picocontainer</groupId>
+          <artifactId>picocontainer</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>commons-lang</groupId>
+          <artifactId>commons-lang</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>com.google.code.findbugs</groupId>
+          <artifactId>jsr305</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>org.slf4j</groupId>
+          <artifactId>slf4j-api</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>-->
     <dependency>
       <groupId>org.sonarsource.java</groupId>
-      <artifactId>sonar-java-plugin</artifactId>
-      <type>sonar-plugin</type>
+      <artifactId>java-frontend</artifactId>
       <version>${sonar-java.version}</version>
       <scope>provided</scope>
     </dependency>
-    <dependency>
-      <groupId>org.codehaus.sonar.sslr-squid-bridge</groupId>
-      <artifactId>sslr-squid-bridge</artifactId>
-      <version>2.6</version>
-    </dependency>
     <dependency>
       <groupId>net.sourceforge.pmd</groupId>
       <artifactId>pmd-core</artifactId>
@@ -149,20 +164,14 @@
       <version>1.0</version>
     </dependency>
 
-    <!-- TODO http://jira.codehaus.org/browse/SONAR-2011
-    We need following dependency, otherwise we will receive
-    java.lang.NoClassDefFoundError: org/apache/maven/project/MavenProject
-    during call mock(org.sonar.api.resources.Project.class)
-    -->
     <dependency>
-      <groupId>org.apache.maven</groupId>
-      <artifactId>maven-project</artifactId>
-      <version>2.0.7</version>
-      <scope>test</scope>
+      <groupId>com.google.guava</groupId>
+      <artifactId>guava</artifactId>
+      <version>19.0</version>
     </dependency>
 
     <dependency>
-      <groupId>org.codehaus.sonar</groupId>
+      <groupId>org.sonarsource.sonarqube</groupId>
       <artifactId>sonar-testing-harness</artifactId>
       <scope>test</scope>
       <version>${sonar.version}</version>
@@ -176,9 +185,23 @@
     </dependency>
 
     <dependency>
-      <groupId>commons-io</groupId>
-      <artifactId>commons-io</artifactId>
-      <version>2.4</version>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.6.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>0.9.30</version>
+      <scope>test</scope>
+    </dependency>
+
+    <!-- Only here for transition purposes. -->
+    <dependency>
+      <groupId>org.easytesting</groupId>
+      <artifactId>fest-assert</artifactId>
+      <version>1.4</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -215,7 +238,7 @@
             <configuration>
               <rules>
                 <requireFilesSize>
-                  <maxsize>5000000</maxsize>
+                  <maxsize>7000000</maxsize>
                   <minsize>4200000</minsize>
                   <files>
                     <file>${project.build.directory}/${project.build.finalName}.jar</file>