org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport Maven / Gradle / Ivy
Show all versions of maven-checkstyle-plugin Show documentation
/*
* 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.
*/
package org.apache.maven.plugins.checkstyle;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import com.puppycrawl.tools.checkstyle.DefaultLogger;
import com.puppycrawl.tools.checkstyle.SarifLogger;
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;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginManagement;
import org.apache.maven.model.ReportPlugin;
import org.apache.maven.model.Reporting;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutor;
import org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException;
import org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest;
import org.apache.maven.plugins.checkstyle.exec.CheckstyleResults;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.i18n.I18N;
import org.codehaus.plexus.resource.ResourceManager;
import org.codehaus.plexus.resource.loader.FileResourceLoader;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.PathTool;
/**
* Base abstract class for Checkstyle reports.
*
*
*/
public abstract class AbstractCheckstyleReport extends AbstractMavenReport {
protected static final String JAVA_FILES = "**\\/*.java";
private static final String DEFAULT_CONFIG_LOCATION = "sun_checks.xml";
@Parameter(defaultValue = "${session}", readonly = true, required = true)
private MavenSession session;
/**
* Specifies the cache file used to speed up Checkstyle on successive runs.
*/
@Parameter(defaultValue = "${project.build.directory}/checkstyle-cachefile")
protected String cacheFile;
/**
*
* Specifies the location of the XML configuration to use.
*
* Potential values are a filesystem path, a URL, or a classpath resource.
* This parameter expects that the contents of the location conform to the
* xml format (Checkstyle Checker
* module) configuration of rulesets.
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}/checkstyle-configuration.xml
* file before being passed to Checkstyle as a configuration.
*
* There are 2 predefined rulesets included in Maven Checkstyle Plugin:
*
* sun_checks.xml: Sun Checks.google_checks.xml: Google Checks.
*/
@Parameter(property = "checkstyle.config.location", defaultValue = DEFAULT_CONFIG_LOCATION)
protected String configLocation;
/**
* Output errors to console.
*/
@Parameter(property = "checkstyle.consoleOutput", defaultValue = "false")
protected boolean consoleOutput;
/**
* Specifies if the build should fail upon a violation.
*/
@Parameter(defaultValue = "false")
protected boolean failsOnError;
/**
*
* Specifies the location of the License file (a.k.a. the header file) that
* can be used by Checkstyle to verify that source code has the correct
* license header.
*
* You need to use ${checkstyle.header.file} in your Checkstyle xml
* configuration to reference the name of this header file.
*
* For instance:
*
* <module name="RegexpHeader">
* <property name="headerFile" value="${checkstyle.header.file}"/>
* </module>
*
*
* @since 2.0-beta-2
*/
@Parameter(property = "checkstyle.header.file", defaultValue = "LICENSE.txt")
protected String headerLocation;
/**
* Skip entire check.
*
* @since 2.2
*/
@Parameter(property = "checkstyle.skip", defaultValue = "false")
protected boolean skip;
/**
* Specifies the path and filename to save the Checkstyle output. The format
* of the output file is determined by the outputFileFormat
* parameter.
*/
@Parameter(property = "checkstyle.output.file", defaultValue = "${project.build.directory}/checkstyle-result.xml")
private File outputFile;
/**
*
* Specifies the location of the properties file.
*
* This parameter is resolved as URL, File then resource. If successfully
* resolved, the contents of the properties location is copied into the
* ${project.build.directory}/checkstyle-checker.properties
* file before being passed to Checkstyle for loading.
*
* The contents of the propertiesLocation will be made
* available to Checkstyle for specifying values for parameters within the
* xml configuration (specified in the configLocation
* parameter).
*
* @since 2.0-beta-2
*/
@Parameter(property = "checkstyle.properties.location")
protected String propertiesLocation;
/**
* Allows for specifying raw property expansion information.
*/
@Parameter
protected String propertyExpansion;
/**
* Specifies the location of the resources to be used for Checkstyle.
*
* @since 2.10
*/
@Parameter(defaultValue = "${project.resources}", readonly = true)
protected List resources;
/**
* Specifies the location of the test resources to be used for Checkstyle.
*
* @since 2.11
*/
@Parameter(defaultValue = "${project.testResources}", readonly = true)
protected List testResources;
/**
* Specifies the names filter of the source files to be used for Checkstyle.
*/
@Parameter(property = "checkstyle.includes", defaultValue = JAVA_FILES, required = true)
protected String includes;
/**
* Specifies the names filter of the source files to be excluded for
* Checkstyle.
*/
@Parameter(property = "checkstyle.excludes")
protected String excludes;
/**
* Specifies the names filter of the resource files to be used for Checkstyle.
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceIncludes", defaultValue = "**/*.properties", required = true)
protected String resourceIncludes;
/**
* Specifies the names filter of the resource files to be excluded for
* Checkstyle.
* @since 2.11
*/
@Parameter(property = "checkstyle.resourceExcludes")
protected String resourceExcludes;
/**
* Specifies whether to include the resource directories in the check.
* @since 2.11
*/
@Parameter(property = "checkstyle.includeResources", defaultValue = "true", required = true)
protected boolean includeResources;
/**
* Specifies whether to include the test resource directories in the check.
* @since 2.11
*/
@Parameter(property = "checkstyle.includeTestResources", defaultValue = "true", required = true)
protected boolean includeTestResources;
/**
* Specifies the location of the source directory to be used for Checkstyle.
*
* @deprecated instead use {@link #sourceDirectories}. For version 3.0.0, this parameter is only defined to break
* the build if you use it!
*/
@Deprecated
@Parameter
private File sourceDirectory;
/**
* Specifies the location of the source directories to be used for Checkstyle.
* Default value is ${project.compileSourceRoots}.
* @since 2.13
*/
// Compatibility with all Maven 3: default of 'project.compileSourceRoots' is done manually because of MNG-5440
@Parameter
private List sourceDirectories;
/**
* Specifies the location of the test source directory to be used for Checkstyle.
*
* @since 2.2
* @deprecated instead use {@link #testSourceDirectories}. For version 3.0.0, this parameter is only defined to
* break the build if you use it!
*/
@Parameter
@Deprecated
private File testSourceDirectory;
/**
* Specifies the location of the test source directories to be used for Checkstyle.
* Default value is ${project.testCompileSourceRoots}.
* @since 2.13
*/
// Compatibility with all Maven 3: default of 'project.testCompileSourceRoots' is done manually because of MNG-5440
@Parameter
private List testSourceDirectories;
/**
* Include or not the test source directory/directories to be used for Checkstyle.
*
* @since 2.2
*/
@Parameter(defaultValue = "false")
protected boolean includeTestSourceDirectory;
/**
* The key to be used in the properties for the suppressions file.
*
* @since 2.1
*/
@Parameter(property = "checkstyle.suppression.expression", defaultValue = "checkstyle.suppressions.file")
protected String suppressionsFileExpression;
/**
*
* Specifies the location of the suppressions XML file to use.
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the suppressions XML is copied into the
* ${project.build.directory}/checkstyle-supressions.xml file
* before being passed to Checkstyle for loading.
*
* See suppressionsFileExpression for the property that will
* be made available to your Checkstyle configuration.
*
* @since 2.0-beta-2
*/
@Parameter(property = "checkstyle.suppressions.location")
protected String suppressionsLocation;
/**
* If null, the Checkstyle plugin will display violations on stdout.
* Otherwise, a text file will be created with the violations.
*/
@Parameter
private File useFile;
/**
* Specifies the format of the output to be used when writing to the output
* file. Valid values are "plain", "sarif" and "xml".
*/
@Parameter(property = "checkstyle.output.format", defaultValue = "xml")
private String outputFileFormat;
/**
* Specifies if the Rules summary should be enabled or not.
*/
@Parameter(property = "checkstyle.enable.rules.summary", defaultValue = "true")
private boolean enableRulesSummary;
/**
* Specifies if the Severity summary should be enabled or not.
*/
@Parameter(property = "checkstyle.enable.severity.summary", defaultValue = "true")
private boolean enableSeveritySummary;
/**
* Specifies if the Files summary should be enabled or not.
*/
@Parameter(property = "checkstyle.enable.files.summary", defaultValue = "true")
private boolean enableFilesSummary;
/**
* The Plugin Descriptor
*/
@Parameter(defaultValue = "${plugin}", readonly = true, required = true)
private PluginDescriptor plugin;
/**
* Link the violation line numbers to the (Test) Source XRef. Links will be created automatically if the JXR plugin is
* being used.
*
* @since 2.1
*/
@Parameter(property = "linkXRef", defaultValue = "true")
private boolean linkXRef;
/**
* Location where Source XRef is generated for this project.
*
* Default: {@link #getReportOutputDirectory()} + {@code /xref}
*/
@Parameter
private File xrefLocation;
/**
* Location where Test Source XRef is generated for this project.
*
* Default: {@link #getReportOutputDirectory()} + {@code /xref-test}
*/
@Parameter
private File xrefTestLocation;
/**
* When using custom treeWalkers, specify their names here so the checks
* inside the treeWalker end up the the rule-summary.
*
* @since 2.11
*/
@Parameter
private List treeWalkerNames;
/**
* Specifies whether modules with a configured severity of ignore should be omitted during Checkstyle
* invocation.
*
* @since 3.0.0
*/
@Parameter(defaultValue = "false")
private boolean omitIgnoredModules;
/**
* By using this property, you can specify the whole Checkstyle rules
* inline directly inside this pom.
*
*
* <plugin>
* ...
* <configuration>
* <checkstyleRules>
* <module name="Checker">
* <module name="FileTabCharacter">
* <property name="eachLine" value="true" />
* </module>
* <module name="TreeWalker">
* <module name="EmptyBlock"/>
* </module>
* </module>
* </checkstyleRules>
* </configuration>
* ...
*
*
* @since 2.12
*/
@Parameter
private PlexusConfiguration checkstyleRules;
/**
* Dump file for inlined Checkstyle rules.
*/
@Parameter(
property = "checkstyle.output.rules.file",
defaultValue = "${project.build.directory}/checkstyle-rules.xml")
private File rulesFiles;
/**
* The header to use for the inline configuration.
* Only used when you specify {@code checkstyleRules}.
*/
@Parameter(
defaultValue = "\n"
+ "\n")
private String checkstyleRulesHeader;
/**
* Specifies whether generated source files should be excluded from Checkstyle.
*
* @since 3.3.1
*/
@Parameter(property = "checkstyle.excludeGeneratedSources", defaultValue = "false")
private boolean excludeGeneratedSources;
/**
*/
@Component
protected ResourceManager locator;
/**
* @since 2.5
*/
@Component(role = CheckstyleExecutor.class, hint = "default")
protected CheckstyleExecutor checkstyleExecutor;
/**
* Internationalization component
*/
@Component
private I18N i18n;
protected ByteArrayOutputStream stringOutputStream;
/** {@inheritDoc} */
public String getName(Locale locale) {
return getI18nString(locale, "name");
}
/** {@inheritDoc} */
public String getDescription(Locale locale) {
return getI18nString(locale, "description");
}
/**
* @param locale The locale
* @param key The key to search for
* @return The text appropriate for the locale.
*/
protected String getI18nString(Locale locale, String key) {
return i18n.getString("checkstyle-report", locale, "report.checkstyle." + key);
}
protected MavenProject getProject() {
return project;
}
protected List getReactorProjects() {
return reactorProjects;
}
protected String constructXrefLocation(boolean test, boolean haveResults) {
String location = null;
if (linkXRef) {
File xrefLocation = getXrefLocation(test);
String relativePath = PathTool.getRelativePath(
getReportOutputDirectory().getAbsolutePath(), xrefLocation.getAbsolutePath());
if (relativePath == null || relativePath.isEmpty()) {
relativePath = ".";
}
relativePath = relativePath + "/" + xrefLocation.getName();
if (xrefLocation.exists()) {
// XRef was already generated by manual execution of a lifecycle binding
location = relativePath;
} else {
// Not yet generated - check if the report is on its way
Reporting reporting = project.getModel().getReporting();
List reportPlugins =
reporting != null ? reporting.getPlugins() : Collections.emptyList();
for (ReportPlugin plugin : reportPlugins) {
String artifactId = plugin.getArtifactId();
if ("maven-jxr-plugin".equals(artifactId) || "jxr-maven-plugin".equals(artifactId)) {
location = relativePath;
}
}
}
if (location == null && haveResults) {
getLog().warn("Unable to locate" + (test ? " Test" : "") + " Source XRef to link to - DISABLED");
}
}
return location;
}
protected File getXrefLocation(boolean test) {
File location = test ? xrefTestLocation : xrefLocation;
return location != null ? location : new File(getReportOutputDirectory(), test ? "xref-test" : "xref");
}
/** {@inheritDoc} */
public void executeReport(Locale locale) throws MavenReportException {
checkDeprecatedParameterUsage(sourceDirectory, "sourceDirectory", "sourceDirectories");
checkDeprecatedParameterUsage(testSourceDirectory, "testSourceDirectory", "testSourceDirectories");
locator.addSearchPath(
FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath());
locator.addSearchPath("url", "");
locator.setOutputDirectory(new File(project.getBuild().getDirectory()));
// for when we start using maven-shared-io and maven-shared-monitor...
// locator = new Locator( new MojoLogMonitorAdaptor( getLog() ) );
// locator = new Locator( getLog(), new File( project.getBuild().getDirectory() ) );
String effectiveConfigLocation = configLocation;
if (checkstyleRules != null) {
if (!DEFAULT_CONFIG_LOCATION.equals(configLocation)) {
throw new MavenReportException(
"If you use inline configuration for rules, don't specify " + "a configLocation");
}
if (checkstyleRules.getChildCount() > 1) {
throw new MavenReportException("Currently only one root module is supported");
}
PlexusConfiguration checkerModule = checkstyleRules.getChild(0);
try {
FileUtils.forceMkdir(rulesFiles.getParentFile());
FileUtils.fileWrite(rulesFiles, checkstyleRulesHeader + checkerModule.toString());
} catch (final IOException e) {
throw new MavenReportException(e.getMessage(), e);
}
effectiveConfigLocation = rulesFiles.getAbsolutePath();
}
ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
try {
CheckstyleExecutorRequest request = createRequest()
.setLicenseArtifacts(collectArtifacts("license"))
.setConfigurationArtifacts(collectArtifacts("configuration"))
.setOmitIgnoredModules(omitIgnoredModules)
.setConfigLocation(effectiveConfigLocation);
CheckstyleResults results = checkstyleExecutor.executeCheckstyle(request);
boolean haveResults = results.getFileCount() > 0;
CheckstyleReportRenderer r = new CheckstyleReportRenderer(
getSink(),
i18n,
locale,
project,
siteTool,
effectiveConfigLocation,
constructXrefLocation(false, haveResults),
constructXrefLocation(true, haveResults),
linkXRef ? getTestSourceDirectories() : Collections.emptyList(),
enableRulesSummary,
enableSeveritySummary,
enableFilesSummary,
results);
if (treeWalkerNames != null) {
r.setTreeWalkerNames(treeWalkerNames);
}
r.render();
} catch (CheckstyleException e) {
throw new MavenReportException("Failed during checkstyle configuration", e);
} catch (CheckstyleExecutorException e) {
throw new MavenReportException("Failed during checkstyle execution", e);
} finally {
// be sure to restore original context classloader
Thread.currentThread().setContextClassLoader(currentClassLoader);
}
}
private void checkDeprecatedParameterUsage(Object parameter, String name, String replacement)
throws MavenReportException {
if (parameter != null) {
throw new MavenReportException("You are using '" + name + "' which has been removed"
+ " from the maven-checkstyle-plugin. " + "Please use '" + replacement
+ "' and refer to the >>Major Version Upgrade to version 3.0.0<< " + "on the plugin site.");
}
}
/**
* Create the Checkstyle executor request.
*
* @return The executor request.
* @throws MavenReportException If something goes wrong during creation.
*/
protected abstract CheckstyleExecutorRequest createRequest() throws MavenReportException;
private List collectArtifacts(String hint) {
List artifacts = new ArrayList<>();
PluginManagement pluginManagement = project.getBuild().getPluginManagement();
if (pluginManagement != null) {
artifacts.addAll(getCheckstylePluginDependenciesAsArtifacts(pluginManagement.getPluginsAsMap(), hint));
}
artifacts.addAll(
getCheckstylePluginDependenciesAsArtifacts(project.getBuild().getPluginsAsMap(), hint));
return artifacts;
}
private List getCheckstylePluginDependenciesAsArtifacts(Map plugins, String hint) {
List artifacts = new ArrayList<>();
Plugin checkstylePlugin = plugins.get(plugin.getGroupId() + ":" + plugin.getArtifactId());
if (checkstylePlugin != null) {
for (Dependency dep : checkstylePlugin.getDependencies()) {
// @todo if we can filter on hints, it should be done here...
String depKey = dep.getGroupId() + ":" + dep.getArtifactId();
artifacts.add(plugin.getArtifactMap().get(depKey));
}
}
return artifacts;
}
/**
* Creates and returns the report generation listener.
*
* @return The audit listener.
* @throws MavenReportException If something goes wrong.
*/
protected AuditListener getListener() throws MavenReportException {
AuditListener listener = null;
if (outputFileFormat != null && !outputFileFormat.isEmpty()) {
File resultFile = outputFile;
OutputStream out = getOutputStream(resultFile);
if ("xml".equals(outputFileFormat)) {
listener = new XMLLogger(out, OutputStreamOptions.CLOSE);
} else if ("plain".equals(outputFileFormat)) {
listener = new DefaultLogger(out, OutputStreamOptions.CLOSE);
} else if ("sarif".equals(outputFileFormat)) {
try {
listener = new SarifLogger(out, OutputStreamOptions.CLOSE);
} catch (IOException e) {
throw new MavenReportException("Failed to create SarifLogger", e);
}
} else {
// TODO: failure if not a report
throw new MavenReportException(
"Invalid output file format: (" + outputFileFormat + "). Must be 'plain', 'sarif' or 'xml'.");
}
}
return listener;
}
private OutputStream getOutputStream(File file) throws MavenReportException {
File parentFile = file.getAbsoluteFile().getParentFile();
if (!parentFile.exists()) {
parentFile.mkdirs();
}
FileOutputStream fileOutputStream;
try {
fileOutputStream = new FileOutputStream(file);
} catch (FileNotFoundException e) {
throw new MavenReportException("Unable to create output stream: " + file, e);
}
return fileOutputStream;
}
/**
* Creates and returns the console listener.
*
* @return The console listener.
* @throws MavenReportException If something goes wrong.
*/
protected DefaultLogger getConsoleListener() throws MavenReportException {
DefaultLogger consoleListener;
if (useFile == null) {
stringOutputStream = new ByteArrayOutputStream();
consoleListener = new DefaultLogger(stringOutputStream, OutputStreamOptions.NONE);
} else {
OutputStream out = getOutputStream(useFile);
consoleListener = new DefaultLogger(out, OutputStreamOptions.CLOSE);
}
return consoleListener;
}
private String determineRelativePath(File location) {
String relativePath =
PathTool.getRelativePath(getReportOutputDirectory().getAbsolutePath(), location.getAbsolutePath());
if (relativePath == null || relativePath.trim().isEmpty()) {
relativePath = ".";
}
return relativePath + "/" + location.getName();
}
protected List getSourceDirectories() {
if (sourceDirectories == null) {
sourceDirectories = filterBuildTarget(project.getCompileSourceRoots());
}
List sourceDirs = new ArrayList<>(sourceDirectories.size());
for (String sourceDir : sourceDirectories) {
sourceDirs.add(FileUtils.resolveFile(project.getBasedir(), sourceDir));
}
return sourceDirs;
}
protected List getTestSourceDirectories() {
if (testSourceDirectories == null) {
testSourceDirectories = filterBuildTarget(project.getTestCompileSourceRoots());
}
List testSourceDirs = new ArrayList<>(testSourceDirectories.size());
for (String testSourceDir : testSourceDirectories) {
testSourceDirs.add(FileUtils.resolveFile(project.getBasedir(), testSourceDir));
}
return testSourceDirs;
}
private List filterBuildTarget(List sourceDirectories) {
if (!excludeGeneratedSources) {
return sourceDirectories;
}
List filtered = new ArrayList<>(sourceDirectories.size());
Path buildTarget = FileUtils.resolveFile(
project.getBasedir(), project.getBuild().getDirectory())
.toPath();
for (String sourceDir : sourceDirectories) {
Path src = FileUtils.resolveFile(project.getBasedir(), sourceDir).toPath();
if (!src.startsWith(buildTarget)) {
filtered.add(sourceDir);
}
}
return filtered;
}
}