[MCHECKSTYLE-374] - replace deprecated method calls with newer

checkstyle version
apache · May 1, 2019 · 29ebada · 29ebada
1 parent 6704658
commit 29ebada
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 187 deletions.
diff --git a/src/it/MCHECKSTYLE-332_cache-checker/pom.xml b/src/it/MCHECKSTYLE-332_cache-checker/pom.xml
@@ -29,7 +29,7 @@
 
   <url>https://issues.apache.org/jira/browse/MCHECKSTYLE-332</url>
   <description>
-    Tests that the cache file is correctly set with Checkstyle 6.16 (https://github.com/checkstyle/checkstyle/issues/569)
+    Tests that the cache file is correctly set with Checkstyle 6.16+ (https://github.com/checkstyle/checkstyle/issues/569)
   </description>
 
   <properties>
@@ -42,14 +42,6 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
         <version>@pom.version@</version>
-        <dependencies>
-          <!-- force usage of 6.16, where the cacheFile property is in the Checker module -->
-          <dependency>
-            <groupId>com.puppycrawl.tools</groupId>
-            <artifactId>checkstyle</artifactId>
-            <version>6.16</version>
-          </dependency>
-        </dependencies>
       </plugin>
     </plugins>
   </build>

diff --git a/src/it/MCHECKSTYLE-332_cache-treewalker/invoker.properties b/src/it/MCHECKSTYLE-332_cache-treewalker/invoker.properties
diff --git a/src/it/MCHECKSTYLE-332_cache-treewalker/pom.xml b/src/it/MCHECKSTYLE-332_cache-treewalker/pom.xml
diff --git a/src/it/MCHECKSTYLE-332_cache-treewalker/src/main/java/org/MyClass.java b/src/it/MCHECKSTYLE-332_cache-treewalker/src/main/java/org/MyClass.java
diff --git a/src/it/MCHECKSTYLE-332_cache-treewalker/verify.groovy b/src/it/MCHECKSTYLE-332_cache-treewalker/verify.groovy
diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java b/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java
@@ -60,6 +60,7 @@
 import com.puppycrawl.tools.checkstyle.DefaultLogger;
 import com.puppycrawl.tools.checkstyle.XMLLogger;
 import com.puppycrawl.tools.checkstyle.api.AuditListener;
+import com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions;
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
 
 /**
@@ -628,11 +629,11 @@ protected AuditListener getListener()
 
             if ( "xml".equals( outputFileFormat ) )
             {
-                listener = new XMLLogger( out, true );
+                listener = new XMLLogger( out, OutputStreamOptions.CLOSE );
             }
             else if ( "plain".equals( outputFileFormat ) )
             {
-                listener = new DefaultLogger( out, true );
+                listener = new DefaultLogger( out, OutputStreamOptions.CLOSE );
             }
             else
             {
@@ -681,13 +682,13 @@ protected DefaultLogger getConsoleListener()
         if ( useFile == null )
         {
             stringOutputStream = new ByteArrayOutputStream();
-            consoleListener = new DefaultLogger( stringOutputStream, false );
+            consoleListener = new DefaultLogger( stringOutputStream, OutputStreamOptions.NONE );
         }
         else
         {
             OutputStream out = getOutputStream( useFile );
 
-            consoleListener = new DefaultLogger( out, true );
+            consoleListener = new DefaultLogger( out, OutputStreamOptions.CLOSE );
         }
 
         return consoleListener;

diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java b/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
@@ -62,6 +62,7 @@
 import com.puppycrawl.tools.checkstyle.DefaultLogger;
 import com.puppycrawl.tools.checkstyle.XMLLogger;
 import com.puppycrawl.tools.checkstyle.api.AuditListener;
+import com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions;
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
 
 /**
@@ -731,13 +732,13 @@ private DefaultLogger getConsoleListener()
         if ( useFile == null )
         {
             stringOutputStream = new ByteArrayOutputStream();
-            consoleListener = new DefaultLogger( stringOutputStream, false );
+            consoleListener = new DefaultLogger( stringOutputStream, OutputStreamOptions.NONE );
         }
         else
         {
             OutputStream out = getOutputStream( useFile );
 
-            consoleListener = new DefaultLogger( out, true );
+            consoleListener = new DefaultLogger( out, OutputStreamOptions.CLOSE );
         }
 
         return consoleListener;
@@ -778,7 +779,7 @@ private AuditListener getListener()
 
             if ( "xml".equals( outputFileFormat ) )
             {
-                listener = new XMLLogger( out, true );
+                listener = new XMLLogger( out, OutputStreamOptions.CLOSE );
             }
             else if ( "plain".equals( outputFileFormat ) )
             {
@@ -790,8 +791,8 @@ else if ( "plain".equals( outputFileFormat ) )
                     outputXmlFile.deleteOnExit();
                     OutputStream xmlOut = getOutputStream( outputXmlFile );
                     CompositeAuditListener compoundListener = new CompositeAuditListener();
-                    compoundListener.addListener( new XMLLogger( xmlOut, true ) );
-                    compoundListener.addListener( new DefaultLogger( out, true ) );
+                    compoundListener.addListener( new XMLLogger( xmlOut, OutputStreamOptions.CLOSE ) );
+                    compoundListener.addListener( new DefaultLogger( out, OutputStreamOptions.CLOSE ) );
                     listener = compoundListener;
                 }
                 catch ( IOException e )

diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java b/src/main/java/org/apache/maven/plugins/checkstyle/exec/DefaultCheckstyleExecutor.java
@@ -25,14 +25,12 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.lang.reflect.Method;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.security.AccessController;
 import java.security.PrivilegedAction;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.LinkedHashSet;
@@ -58,6 +56,7 @@
 
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
+import com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions;
 import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
 import com.puppycrawl.tools.checkstyle.PackageNamesLoader;
 import com.puppycrawl.tools.checkstyle.PropertiesExpander;
@@ -373,9 +372,18 @@ public Configuration getConfiguration( CheckstyleExecutorRequest request )
             Thread.currentThread().setContextClassLoader( checkstyleClassLoader );
             String configFile = getConfigFile( request );
             Properties overridingProperties = getOverridingProperties( request );
+            IgnoredModulesOptions omitIgnoredModules;
+            if ( request.isOmitIgnoredModules() )
+            {
+                omitIgnoredModules = IgnoredModulesOptions.OMIT;
+            }
+            else
+            {
+                omitIgnoredModules = IgnoredModulesOptions.EXECUTE;
+            }
             Configuration config =
                 ConfigurationLoader.loadConfiguration( configFile, new PropertiesExpander( overridingProperties ),
-                                                       request.isOmitIgnoredModules() );
+                                                       omitIgnoredModules );
             String effectiveEncoding = StringUtils.isNotEmpty( request.getEncoding() ) ? request.getEncoding() : System
                 .getProperty( "file.encoding", "UTF-8" );
 
@@ -385,55 +393,20 @@ public Configuration getConfiguration( CheckstyleExecutorRequest request )
                                       + ", i.e. build is platform dependent!" );
             }
 
-            // MCHECKSTYLE-332 Checkstyle 6.16+ (#569): the cache is moved to the Checker module instead of TreeWalker
-            boolean cacheInChecker = false;
-            for ( Method method : Checker.class.getMethods() )
-            {
-                if ( "setCacheFile".equals( method.getName() )
-                    && Arrays.equals( method.getParameterTypes(), new Class<?>[] { String.class } ) )
-                {
-                    cacheInChecker = true;
-                    break;
-                }
-            }
-
             if ( "Checker".equals( config.getName() )
                     || "com.puppycrawl.tools.checkstyle.Checker".equals( config.getName() ) )
             {
                 if ( config instanceof DefaultConfiguration )
                 {
                     // MCHECKSTYLE-173 Only add the "charset" attribute if it has not been set
                     addAttributeIfNotExists( (DefaultConfiguration) config, "charset", effectiveEncoding );
-                    if ( cacheInChecker )
-                    {
-                        addAttributeIfNotExists( (DefaultConfiguration) config, "cacheFile", request.getCacheFile() );
-                    }
+                    addAttributeIfNotExists( (DefaultConfiguration) config, "cacheFile", request.getCacheFile() );
                 }
                 else
                 {
                     getLogger().warn( "Failed to configure file encoding on module " + config );
                 }
             }
-            Configuration[] modules = config.getChildren();
-            for ( Configuration module : modules )
-            {
-                if ( "TreeWalker".equals( module.getName() )
-                    || "com.puppycrawl.tools.checkstyle.TreeWalker".equals( module.getName() ) )
-                {
-                    if ( module instanceof DefaultConfiguration )
-                    {
-                        if ( !cacheInChecker )
-                        {
-                            addAttributeIfNotExists( (DefaultConfiguration) module, "cacheFile",
-                                                     request.getCacheFile() );
-                        }
-                    }
-                    else
-                    {
-                        getLogger().warn( "Failed to configure cache file on module " + module );
-                    }
-                }
-            }
             return config;
         }
         catch ( CheckstyleException e )