Issues #246: update to CS 8.26

Author: Daniel Muehlbachler

README.md

@@ -21,6 +21,7 @@ Compatibility matrix from checkstyle team:
 
 Checkstyle Plugin|Sonar min|Sonar max|Checkstyle|Jdk
 -----------------|---------|---------|----------|---
+4.26|6.7  |7.7+|8.26|1.8
 4.25|6.7  |7.7+|8.25|1.8
 4.24|6.7  |7.7+|8.24|1.8
 4.23|6.7  |7.7+|8.23|1.8

pom.xml

@@ -90,7 +90,7 @@
   </ciManagement>
 
   <properties>
-    <checkstyle.version>8.25</checkstyle.version>
+    <checkstyle.version>8.26</checkstyle.version>
     <sonar.version>6.7</sonar.version>
     <sonar-java.version>5.12.0.17701</sonar-java.version>
     <maven.checkstyle.plugin.version>2.17</maven.checkstyle.plugin.version>

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

@@ -26,10 +26,6 @@
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URL;
-import java.net.URLClassLoader;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
 import java.util.Locale;
 import java.util.Objects;
 import java.util.stream.Collectors;
@@ -42,7 +38,6 @@
 import org.sonar.api.batch.ScannerSide;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.sensor.SensorContext;
-import org.sonar.plugins.java.api.JavaResourceLocator;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.puppycrawl.tools.checkstyle.Checker;
@@ -59,13 +54,11 @@ public class CheckstyleExecutor {
 
     private final CheckstyleConfiguration configuration;
     private final CheckstyleAuditListener listener;
-    private final JavaResourceLocator javaResourceLocator;
 
     public CheckstyleExecutor(CheckstyleConfiguration configuration,
-            CheckstyleAuditListener listener, JavaResourceLocator javaResourceLocator) {
+            CheckstyleAuditListener listener) {
         this.configuration = configuration;
         this.listener = listener;
-        this.javaResourceLocator = javaResourceLocator;
     }
 
     /**
@@ -81,22 +74,19 @@ public void execute(SensorContext context) {
         Locale.setDefault(Locale.ENGLISH);
         final ClassLoader initialClassLoader = Thread.currentThread().getContextClassLoader();
         Thread.currentThread().setContextClassLoader(PackageNamesLoader.class.getClassLoader());
-        final URLClassLoader projectClassloader = createClassloader();
         try {
-            executeWithClassLoader(projectClassloader);
+            executeWithClassLoader();
         }
         finally {
             Thread.currentThread().setContextClassLoader(initialClassLoader);
             Locale.setDefault(initialLocale);
-            close(projectClassloader);
         }
     }
 
-    private void executeWithClassLoader(URLClassLoader projectClassloader) {
+    private void executeWithClassLoader() {
         final Checker checker = new Checker();
         OutputStream xmlOutput = null;
         try {
-            checker.setClassLoader(projectClassloader);
             checker.setModuleClassLoader(Thread.currentThread().getContextClassLoader());
             checker.addListener(listener);
 
@@ -146,14 +136,4 @@ URL getUrl(URI uri) {
                     + "Classpath element is invalid: " + uri, ex);
         }
     }
-
-    private URLClassLoader createClassloader() {
-        final Collection<File> classpathElements = javaResourceLocator.classpath();
-        final List<URL> urls = new ArrayList<>(classpathElements.size());
-        for (File file : classpathElements) {
-            urls.add(getUrl(file.toURI()));
-        }
-        return new URLClassLoader(urls.toArray(new URL[0]), null);
-    }
-
 }

src/main/resources/org/sonar/l10n/checkstyle.properties

@@ -94,10 +94,8 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodChec
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.scope=visibility scope where Javadoc comments are checked
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowUndeclaredRTE=whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.suppressLoadErrors=When set to false all problems with loading classes would be reported as violations. Default is true.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowedAnnotations=List of annotations that could allow missed documentation
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.validateThrows=Allows validating throws tags
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.logLoadErrors=If set to false a classpath configuration problem is assumed and the TreeWalker stops operating on the class completely. If set to true (the default) , checkstyle assumes a typo or refactoring problem in the javadoc and logs the problem in the normal checkstyle report
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck.name=Javadoc Block Tag Location
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck.param.tags=Specify the javadoc tags to process.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck.name=Javadoc Method

src/main/resources/org/sonar/plugins/checkstyle/rules.xml

@@ -856,16 +856,9 @@
     <param key="allowMissingReturnTag" type="BOOLEAN">
       <defaultValue>false</defaultValue>
     </param>
-    <param key="logLoadErrors" type="BOOLEAN">
-      <defaultValue>true</defaultValue>
-    </param>
     <param key="tokens" type="s[METHOD_DEF,CTOR_DEF,ANNOTATION_FIELD_DEF]">
       <defaultValue>METHOD_DEF,CTOR_DEF,ANNOTATION_FIELD_DEF</defaultValue>
     </param>
-    <param key="suppressLoadErrors" type="BOOLEAN">
-      <!-- Note that default value in Checkstyle 5.5 is false -->
-      <defaultValue>true</defaultValue>
-    </param>
     <status>READY</status>
   </rule>
 

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

@@ -47,9 +47,7 @@
 import org.sonar.api.batch.fs.internal.DefaultIndexedFile;
 import org.sonar.api.batch.fs.internal.DefaultInputFile;
 import org.sonar.api.batch.sensor.SensorContext;
-import org.sonar.plugins.java.api.JavaResourceLocator;
 
-import com.google.common.collect.ImmutableList;
 import com.puppycrawl.tools.checkstyle.api.AuditEvent;
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
 
@@ -64,8 +62,7 @@ public class CheckstyleExecutorTest {
     public void execute() throws CheckstyleException {
         final CheckstyleConfiguration conf = mockConf();
         final CheckstyleAuditListener listener = mockListener();
-        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener,
-                createJavaResourceLocator());
+        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener);
         executor.execute(context);
 
         verify(listener, times(1)).auditStarted(any(AuditEvent.class));
@@ -93,8 +90,7 @@ public void executeException() throws CheckstyleException {
         thrown.expect(IllegalStateException.class);
         thrown.expectMessage("Can not execute Checkstyle");
         final CheckstyleConfiguration conf = mockConf();
-        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, null,
-                createJavaResourceLocator());
+        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, null);
         executor.execute(context);
     }
 
@@ -103,17 +99,10 @@ public void getUrlException() throws URISyntaxException {
         thrown.expect(IllegalStateException.class);
         thrown.expectMessage("Fail to create the project classloader. "
                 + "Classpath element is invalid: htp://aa");
-        final CheckstyleExecutor executor = new CheckstyleExecutor(null, mockListener(),
-                createJavaResourceLocator());
+        final CheckstyleExecutor executor = new CheckstyleExecutor(null, mockListener());
         executor.getUrl(new URI("htp://aa"));
     }
 
-    private static JavaResourceLocator createJavaResourceLocator() {
-        final JavaResourceLocator javaResourceLocator = mock(JavaResourceLocator.class);
-        when(javaResourceLocator.classpath()).thenReturn(ImmutableList.of(new File(".")));
-        return javaResourceLocator;
-    }
-
     /**
      * We do suppression as we need to cache value initialLocale
      * @noinspection TooBroadScope
@@ -130,8 +119,7 @@ public void generateXmlReportInEnglish() throws Exception {
             report.delete();
             when(conf.getTargetXmlReport()).thenReturn(report);
             final CheckstyleAuditListener listener = mockListener();
-            final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener,
-                    createJavaResourceLocator());
+            final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener);
             executor.execute(context);
 
             Assert.assertTrue("Report should exists", report.exists());
@@ -154,8 +142,7 @@ public void generateXmlReportNull() throws CheckstyleException {
         report.delete();
         when(conf.getTargetXmlReport()).thenReturn(null);
         final CheckstyleAuditListener listener = mockListener();
-        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener,
-                createJavaResourceLocator());
+        final CheckstyleExecutor executor = new CheckstyleExecutor(conf, listener);
         executor.execute(context);
 
         Assert.assertFalse("Report should NOT exists", report.exists());