package org.apache.maven.plugin.checkstyle;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.ByteArrayInputStream;
import java.io.Closeable;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import org.apache.commons.io.IOUtils;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.model.Resource;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.resource.ResourceManager;
import org.codehaus.plexus.resource.loader.FileResourceCreationException;
import org.codehaus.plexus.resource.loader.FileResourceLoader;
import org.codehaus.plexus.resource.loader.ResourceNotFoundException;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.PackageNamesLoader;
import com.puppycrawl.tools.checkstyle.PropertiesExpander;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.FilterSet;
import com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader;
/**
* @author Olivier Lamy
* @since 2.5
* @version $Id: DefaultCheckstyleExecutor.java 1575615 2014-03-08 21:54:26Z dennisl $
*/
@Component( role = CheckstyleExecutor.class, hint = "default", instantiationStrategy = "per-lookup" )
public class DefaultCheckstyleExecutor
extends AbstractLogEnabled
implements CheckstyleExecutor
{
@Requirement( hint = "default" )
private ResourceManager locator;
@Requirement( hint = "license" )
private ResourceManager licenseLocator;
private static final File[] EMPTY_FILE_ARRAY = new File[0];
public CheckstyleResults executeCheckstyle( CheckstyleExecutorRequest request )
throws CheckstyleExecutorException, CheckstyleException
{
// checkstyle will always use the context classloader in order
// to load resources (dtds),
// so we have to fix it
// olamy this hack is not anymore needed in maven 3.x
ClassLoader checkstyleClassLoader = PackageNamesLoader.class.getClassLoader();
Thread.currentThread().setContextClassLoader( checkstyleClassLoader );
if ( getLogger().isDebugEnabled() )
{
getLogger().debug( "executeCheckstyle start headerLocation : " + request.getHeaderLocation() );
}
MavenProject project = request.getProject();
configureResourceLocator( locator, request );
configureResourceLocator( licenseLocator, request );
File[] files;
try
{
files = getFilesToProcess( request );
}
catch ( IOException e )
{
throw new CheckstyleExecutorException( "Error getting files to process", e );
}
final String suppressionsFilePath = getSuppressionsFilePath( request );
FilterSet filterSet = getSuppressionsFilterSet( suppressionsFilePath );
Checker checker = new Checker();
// setup classloader, needed to avoid "Unable to get class information
// for ..." errors
List<String> classPathStrings = new ArrayList<String>();
List<String> outputDirectories = new ArrayList<String>();
File sourceDirectory = request.getSourceDirectory();
File testSourceDirectory = request.getTestSourceDirectory();
if ( request.isAggregate() )
{
for ( MavenProject childProject : request.getReactorProjects() )
{
prepareCheckstylePaths( request, childProject, classPathStrings, outputDirectories,
new File( childProject.getBuild().getSourceDirectory() ),
new File( childProject.getBuild().getTestSourceDirectory() ) );
}
}
else
{
prepareCheckstylePaths( request, project, classPathStrings, outputDirectories, sourceDirectory,
testSourceDirectory );
}
List<URL> urls = new ArrayList<URL>( classPathStrings.size() );
for ( String path : classPathStrings )
{
try
{
urls.add( new File( path ).toURL() );
}
catch ( MalformedURLException e )
{
throw new CheckstyleExecutorException( e.getMessage(), e );
}
}
for ( String outputDirectoryString : outputDirectories )
{
try
{
if ( outputDirectoryString != null )
{
File outputDirectoryFile = new File( outputDirectoryString );
if ( outputDirectoryFile.exists() )
{
URL outputDirectoryUrl = outputDirectoryFile.toURL();
request.getLog().debug(
"Adding the outputDirectory " + outputDirectoryUrl.toString()
+ " to the Checkstyle class path" );
urls.add( outputDirectoryUrl );
}
}
}
catch ( MalformedURLException e )
{
throw new CheckstyleExecutorException( e.getMessage(), e );
}
}
URLClassLoader projectClassLoader = new URLClassLoader( urls.toArray( new URL[urls.size()] ), null );
checker.setClassloader( projectClassLoader );
checker.setModuleClassLoader( Thread.currentThread().getContextClassLoader() );
if ( filterSet != null )
{
checker.addFilter( filterSet );
}
Configuration configuration = getConfiguration( request );
checker.configure( configuration );
AuditListener listener = request.getListener();
if ( listener != null )
{
checker.addListener( listener );
}
if ( request.isConsoleOutput() )
{
checker.addListener( request.getConsoleListener() );
}
CheckstyleReportListener sinkListener = new CheckstyleReportListener( configuration );
if ( request.isAggregate() )
{
for ( MavenProject childProject : request.getReactorProjects() )
{
addSourceDirectory( sinkListener, new File( childProject.getBuild().getSourceDirectory() ),
new File( childProject.getBuild().getTestSourceDirectory() ),
childProject.getResources(), request );
}
}
else
{
addSourceDirectory( sinkListener, sourceDirectory, testSourceDirectory, request.getResources(), request );
}
checker.addListener( sinkListener );
List<File> filesList = Arrays.asList( files );
int nbErrors = checker.process( filesList );
checker.destroy();
if ( projectClassLoader instanceof Closeable )
{
try
{
( ( Closeable ) projectClassLoader ).close();
}
catch ( IOException ex )
{
// Nothing we can do - and not detrimental to the build (save running out of file handles).
getLogger().info( "Failed to close custom Classloader - this indicated a bug in the code.", ex );
}
}
if ( request.getStringOutputStream() != null )
{
request.getLog().info( request.getStringOutputStream().toString() );
}
if ( request.isFailsOnError() && nbErrors > 0 )
{
// TODO: should be a failure, not an error. Report is not meant to
// throw an exception here (so site would
// work regardless of config), but should record this information
throw new CheckstyleExecutorException( "There are " + nbErrors + " checkstyle errors." );
}
else if ( nbErrors > 0 )
{
request.getLog().info( "There are " + nbErrors + " checkstyle errors." );
}
return sinkListener.getResults();
}
protected void addSourceDirectory( CheckstyleReportListener sinkListener, File sourceDirectory,
File testSourceDirectory, List<Resource> resources,
CheckstyleExecutorRequest request )
{
if ( sourceDirectory != null )
{
sinkListener.addSourceDirectory( sourceDirectory );
}
if ( request.isIncludeTestSourceDirectory() && ( testSourceDirectory != null )
&& ( testSourceDirectory.exists() ) && ( testSourceDirectory.isDirectory() ) )
{
sinkListener.addSourceDirectory( testSourceDirectory );
}
if ( resources != null )
{
for ( Resource resource : resources )
{
if ( resource.getDirectory() != null )
{
File resourcesDirectory = new File( resource.getDirectory() );
if ( resourcesDirectory.exists() && resourcesDirectory.isDirectory() )
{
sinkListener.addSourceDirectory( resourcesDirectory );
getLogger().debug( "Added '" + resourcesDirectory.getAbsolutePath()
+ "' as a source directory." );
}
}
}
}
}
public Configuration getConfiguration( CheckstyleExecutorRequest request )
throws CheckstyleExecutorException
{
try
{
// checkstyle will always use the context classloader in order
// to load resources (dtds),
// so we have to fix it
ClassLoader checkstyleClassLoader = PackageNamesLoader.class.getClassLoader();
Thread.currentThread().setContextClassLoader( checkstyleClassLoader );
String configFile = getConfigFile( request );
Properties overridingProperties = getOverridingProperties( request );
Configuration config = ConfigurationLoader
.loadConfiguration( configFile, new PropertiesExpander( overridingProperties ) );
String effectiveEncoding = StringUtils.isNotEmpty( request.getEncoding() ) ? request.getEncoding() : System
.getProperty( "file.encoding", "UTF-8" );
if ( StringUtils.isEmpty( request.getEncoding() ) )
{
request.getLog().warn(
"File encoding has not been set, using platform encoding " + effectiveEncoding
+ ", i.e. build is platform dependent!" );
}
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
try
{
if ( config.getAttribute( "charset" ) == null )
{
( (DefaultConfiguration) config ).addAttribute( "charset", effectiveEncoding );
}
}
catch ( CheckstyleException ex )
{
// Checkstyle 5.4+ throws an exception when trying to access an attribute that doesn't exist
( (DefaultConfiguration) config ).addAttribute( "charset", effectiveEncoding );
}
}
else
{
request.getLog().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 )
{
// MCHECKSTYLE-132 DefaultConfiguration addAttribute has changed in checkstyle 5.3
try
{
if ( module.getAttribute( "cacheFile" ) == null )
{
( (DefaultConfiguration) module ).addAttribute( "cacheFile", request.getCacheFile() );
}
}
catch ( CheckstyleException ex )
{
// MCHECKSTYLE-159 - checkstyle 5.4 throws an exception instead of return null if
// "cacheFile"
// doesn't exist
( (DefaultConfiguration) module ).addAttribute( "cacheFile", request.getCacheFile() );
}
}
else
{
request.getLog().warn( "Failed to configure cache file on module " + module );
}
}
}
return config;
}
catch ( CheckstyleException e )
{
throw new CheckstyleExecutorException( "Failed during checkstyle configuration", e );
}
}
private void prepareCheckstylePaths( CheckstyleExecutorRequest request, MavenProject project,
List<String> classPathStrings, List<String> outputDirectories,
File sourceDirectory, File testSourceDirectory )
throws CheckstyleExecutorException
{
try
{
outputDirectories.add( project.getBuild().getOutputDirectory() );
if ( request.isIncludeTestSourceDirectory() && ( testSourceDirectory != null )
&& ( testSourceDirectory.exists() ) && ( testSourceDirectory.isDirectory() ) )
{
classPathStrings.addAll( project.getTestClasspathElements() );
outputDirectories.add( project.getBuild().getTestOutputDirectory() );
}
else
{
classPathStrings.addAll( project.getCompileClasspathElements() );
}
}
catch ( DependencyResolutionRequiredException e )
{
throw new CheckstyleExecutorException( e.getMessage(), e );
}
}
private Properties getOverridingProperties( CheckstyleExecutorRequest request )
throws CheckstyleExecutorException
{
Properties p = new Properties();
try
{
if ( request.getPropertiesLocation() != null )
{
if ( getLogger().isDebugEnabled() )
{
getLogger().debug( "request.getPropertiesLocation() " + request.getPropertiesLocation() );
}
File propertiesFile = locator.getResourceAsFile( request.getPropertiesLocation(),
"checkstyle-checker.properties" );
FileInputStream properties = new FileInputStream( propertiesFile );
try
{
if ( propertiesFile != null )
{
p.load( properties );
}
}
finally
{
IOUtils.closeQuietly( properties );
}
}
if ( StringUtils.isNotEmpty( request.getPropertyExpansion() ) )
{
String propertyExpansion = request.getPropertyExpansion();
// Convert \ to \\, so that p.load will convert it back properly
propertyExpansion = StringUtils.replace( propertyExpansion, "\\", "\\\\" );
p.load( new ByteArrayInputStream( propertyExpansion.getBytes() ) );
}
// Workaround for MCHECKSTYLE-48
// Make sure that "config/maven-header.txt" is the default value
// for headerLocation, if configLocation="config/maven_checks.xml"
String headerLocation = request.getHeaderLocation();
if ( "config/maven_checks.xml".equals( request.getConfigLocation() ) )
{
if ( "LICENSE.txt".equals( request.getHeaderLocation() ) )
{
headerLocation = "config/maven-header.txt";
}
}
if ( getLogger().isDebugEnabled() )
{
getLogger().debug( "headerLocation " + headerLocation );
}
if ( StringUtils.isNotEmpty( headerLocation ) )
{
try
{
File headerFile = licenseLocator.getResourceAsFile( headerLocation, "checkstyle-header.txt" );
if ( headerFile != null )
{
p.setProperty( "checkstyle.header.file", headerFile.getAbsolutePath() );
}
}
catch ( FileResourceCreationException e )
{
getLogger().debug( "Unable to process header location: " + headerLocation );
getLogger().debug( "Checkstyle will throw exception if ${checkstyle.header.file} is used" );
}
catch ( ResourceNotFoundException e )
{
getLogger().debug( "Unable to process header location: " + headerLocation );
getLogger().debug( "Checkstyle will throw exception if ${checkstyle.header.file} is used" );
}
}
if ( request.getCacheFile() != null )
{
p.setProperty( "checkstyle.cache.file", request.getCacheFile() );
}
}
catch ( IOException e )
{
throw new CheckstyleExecutorException( "Failed to get overriding properties", e );
}
catch ( FileResourceCreationException e )
{
throw new CheckstyleExecutorException( "Failed to get overriding properties", e );
}
catch ( ResourceNotFoundException e )
{
throw new CheckstyleExecutorException( "Failed to get overriding properties", e );
}
if ( request.getSuppressionsFileExpression() != null )
{
String suppressionsFilePath = getSuppressionsFilePath( request );
if ( suppressionsFilePath != null )
{
p.setProperty( request.getSuppressionsFileExpression(), suppressionsFilePath );
}
}
return p;
}
private File[] getFilesToProcess( CheckstyleExecutorRequest request )
throws IOException
{
StringBuilder excludesStr = new StringBuilder();
if ( StringUtils.isNotEmpty( request.getExcludes() ) )
{
excludesStr.append( request.getExcludes() );
}
String[] defaultExcludes = FileUtils.getDefaultExcludes();
for ( String defaultExclude : defaultExcludes )
{
if ( excludesStr.length() > 0 )
{
excludesStr.append( "," );
}
excludesStr.append( defaultExclude );
}
File sourceDirectory = request.getSourceDirectory();
List<File> files = new ArrayList<File>();
if ( request.isAggregate() )
{
for ( MavenProject project : request.getReactorProjects() )
{
addFilesToProcess( request, new File( project.getBuild().getSourceDirectory() ),
project.getResources(), project.getTestResources(),
files, new File( project.getBuild().getTestSourceDirectory() )
);
}
}
else
{
addFilesToProcess( request, sourceDirectory, request.getResources(),
request.getTestResources(), files, request.getTestSourceDirectory() );
}
getLogger().debug( "Added " + files.size() + " files to process." );
return files.toArray( new File[files.size()] );
}
private void addFilesToProcess( CheckstyleExecutorRequest request, File sourceDirectory, List<Resource> resources,
List<Resource> testResources, List<File> files, File testSourceDirectory )
throws IOException
{
if ( sourceDirectory != null && sourceDirectory.exists() )
{
final List<File> sourceFiles =
FileUtils.getFiles( sourceDirectory, request.getIncludes(), request.getExcludes() );
files.addAll( sourceFiles );
getLogger().debug( "Added " + sourceFiles.size() + " source files found in '"
+ sourceDirectory.getAbsolutePath() + "'." );
}
if ( request.isIncludeTestSourceDirectory() && ( testSourceDirectory != null )
&& ( testSourceDirectory.exists() ) && ( testSourceDirectory.isDirectory() ) )
{
final List<File> testSourceFiles =
FileUtils.getFiles( testSourceDirectory, request.getIncludes(), request.getExcludes() );
files.addAll( testSourceFiles );
getLogger().debug( "Added " + testSourceFiles.size() + " test source files found in '"
+ testSourceDirectory.getAbsolutePath() + "'." );
}
if ( resources != null && request.isIncludeResources() )
{
addResourceFilesToProcess( request, resources, files );
}
else
{
getLogger().debug( "No resources found in this project." );
}
if ( testResources != null && request.isIncludeTestResources() )
{
addResourceFilesToProcess( request, testResources, files );
}
else
{
getLogger().debug( "No test resources found in this project." );
}
}
private void addResourceFilesToProcess( CheckstyleExecutorRequest request, List<Resource> resources,
List<File> files )
throws IOException
{
for ( Resource resource : resources )
{
if ( resource.getDirectory() != null )
{
File resourcesDirectory = new File( resource.getDirectory() );
if ( resourcesDirectory.exists() && resourcesDirectory.isDirectory() )
{
List<File> resourceFiles =
FileUtils.getFiles( resourcesDirectory, request.getResourceIncludes(),
request.getResourceExcludes() );
files.addAll( resourceFiles );
getLogger().debug( "Added " + resourceFiles.size() + " resource files found in '"
+ resourcesDirectory.getAbsolutePath() + "'." );
}
else
{
getLogger().debug( "The resources directory '" + resourcesDirectory.getAbsolutePath()
+ "' does not exist or is not a directory." );
}
}
}
}
private FilterSet getSuppressionsFilterSet( final String suppressionsFilePath )
throws CheckstyleExecutorException
{
if ( suppressionsFilePath == null )
{
return null;
}
try
{
return SuppressionsLoader.loadSuppressions( suppressionsFilePath );
}
catch ( CheckstyleException ce )
{
throw new CheckstyleExecutorException( "Failed to load suppressions file from: "
+ suppressionsFilePath, ce );
}
}
private String getSuppressionsFilePath( final CheckstyleExecutorRequest request ) throws CheckstyleExecutorException
{
final String suppressionsLocation = request.getSuppressionsLocation();
if ( StringUtils.isEmpty( suppressionsLocation ) )
{
return null;
}
try
{
File suppressionsFile = locator.getResourceAsFile( suppressionsLocation, "checkstyle-suppressions.xml" );
return suppressionsFile == null ? null : suppressionsFile.getAbsolutePath();
}
catch ( ResourceNotFoundException e )
{
throw new CheckstyleExecutorException( "Unable to find suppressions file at location: "
+ suppressionsLocation, e );
}
catch ( FileResourceCreationException e )
{
throw new CheckstyleExecutorException( "Unable to process suppressions file location: "
+ suppressionsLocation, e );
}
}
private String getConfigFile( CheckstyleExecutorRequest request )
throws CheckstyleExecutorException
{
try
{
if ( getLogger().isDebugEnabled() )
{
getLogger().debug( "request.getConfigLocation() " + request.getConfigLocation() );
}
File configFile = locator.getResourceAsFile( request.getConfigLocation(), "checkstyle-checker.xml" );
if ( configFile == null )
{
throw new CheckstyleExecutorException( "Unable to process config location: "
+ request.getConfigLocation() );
}
return configFile.getAbsolutePath();
}
catch ( ResourceNotFoundException e )
{
throw new CheckstyleExecutorException( "Unable to find configuration file at location: "
+ request.getConfigLocation(), e );
}
catch ( FileResourceCreationException e )
{
throw new CheckstyleExecutorException( "Unable to process configuration file at location: "
+ request.getConfigLocation(), e );
}
}
/**
* Configures search paths in the resource locator.
* This method should only be called once per execution.
*
* @param request executor request data.
*/
private void configureResourceLocator( final ResourceManager resourceManager,
final CheckstyleExecutorRequest request )
{
final MavenProject project = request.getProject();
resourceManager.setOutputDirectory( new File( project.getBuild().getDirectory() ) );
// Recurse up the parent hierarchy and add project directories to the search roots
MavenProject parent = project;
while ( parent != null && parent.getFile() != null )
{
// MCHECKSTYLE-131 ( olamy ) I don't like this hack.
// (dkulp) Me either. It really pollutes the location stuff
// by allowing searches of stuff outside the current module.
File dir = parent.getFile().getParentFile();
resourceManager.addSearchPath( FileResourceLoader.ID, dir.getAbsolutePath() );
parent = parent.getParent();
}
resourceManager.addSearchPath( "url", "" );
}
}