org.gradle.api.plugins.quality.FindBugs Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2016 the original author or authors.
*
* Licensed 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.gradle.api.plugins.quality;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
import com.google.common.collect.Iterables;
import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Incubating;
import org.gradle.api.JavaVersion;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.logging.LogLevel;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.quality.internal.FindBugsReportsImpl;
import org.gradle.api.plugins.quality.internal.FindBugsReportsInternal;
import org.gradle.api.plugins.quality.internal.findbugs.FindBugsClasspathValidator;
import org.gradle.api.plugins.quality.internal.findbugs.FindBugsResult;
import org.gradle.api.plugins.quality.internal.findbugs.FindBugsSpec;
import org.gradle.api.plugins.quality.internal.findbugs.FindBugsSpecBuilder;
import org.gradle.api.plugins.quality.internal.findbugs.FindBugsWorkerManager;
import org.gradle.api.reporting.Reporting;
import org.gradle.api.reporting.SingleFileReport;
import org.gradle.api.resources.TextResource;
import org.gradle.api.tasks.CacheableTask;
import org.gradle.api.tasks.Classpath;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SkipWhenEmpty;
import org.gradle.api.tasks.SourceTask;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.VerificationTask;
import org.gradle.internal.logging.ConsoleRenderer;
import org.gradle.process.internal.worker.WorkerProcessFactory;
import org.gradle.util.ClosureBackedAction;
import javax.annotation.Nullable;
import javax.inject.Inject;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
/**
* Analyzes code with FindBugs. See the FindBugs Manual for additional information on configuration
* options.
*
* @deprecated FindBugs is unmaintained and does not support bytecode compiled for Java 9 and above.
*/
@Deprecated
@CacheableTask
public class FindBugs extends SourceTask implements VerificationTask, Reporting {
private FileCollection classes;
private FileCollection classpath;
private FileCollection findbugsClasspath;
private FileCollection pluginClasspath;
private boolean ignoreFailures;
private String effort;
private String reportLevel;
private String maxHeapSize;
private Collection visitors = new ArrayList();
private Collection omitVisitors = new ArrayList();
private TextResource includeFilterConfig;
private TextResource excludeFilterConfig;
private TextResource excludeBugsFilterConfig;
private Collection extraArgs = new ArrayList();
private Collection jvmArgs = new ArrayList();
private boolean showProgress;
private final FindBugsReportsInternal reports;
public FindBugs() {
reports = getObjectFactory().newInstance(FindBugsReportsImpl.class, this);
}
@Inject
protected ObjectFactory getObjectFactory() {
throw new UnsupportedOperationException();
}
@Inject
public WorkerProcessFactory getWorkerProcessBuilderFactory() {
throw new UnsupportedOperationException();
}
/**
* The reports to be generated by this task.
*
* @return The reports container
*/
@Nested
public FindBugsReports getReports() {
return reports;
}
/**
* Configures the reports to be generated by this task.
*
* The contained reports can be configured by name and closures. Example:
*
*
* findbugsTask {
* reports {
* xml {
* destination "build/findbugs.xml"
* }
* }
* }
*
*
* @param closure The configuration
* @return The reports container
*/
public FindBugsReports reports(Closure closure) {
return reports(new ClosureBackedAction(closure));
}
/**
* Configures the reports to be generated by this task.
*
* The contained reports can be configured by name and closures. Example:
*
*
* findbugsTask {
* reports {
* xml {
* destination "build/findbugs.xml"
* }
* }
* }
*
*
*
* @param configureAction The configuration
* @return The reports container
*/
public FindBugsReports reports(Action configureAction) {
configureAction.execute(reports);
return reports;
}
/**
* The filename of a filter specifying which bugs are reported.
*/
@Internal
@Nullable
public File getIncludeFilter() {
TextResource config = getIncludeFilterConfig();
return config == null ? null : config.asFile();
}
/**
* The filename of a filter specifying which bugs are reported.
*/
public void setIncludeFilter(File filter) {
setIncludeFilterConfig(getProject().getResources().getText().fromFile(filter));
}
/**
* The filename of a filter specifying bugs to exclude from being reported.
*/
@Nullable
@Internal
public File getExcludeFilter() {
TextResource config = getExcludeFilterConfig();
return config == null ? null : config.asFile();
}
/**
* The filename of a filter specifying bugs to exclude from being reported.
*/
public void setExcludeFilter(File filter) {
setExcludeFilterConfig(getProject().getResources().getText().fromFile(filter));
}
/**
* The filename of a filter specifying baseline bugs to exclude from being reported.
*/
@Nullable
@Internal
public File getExcludeBugsFilter() {
TextResource config = getExcludeBugsFilterConfig();
return config == null ? null : config.asFile();
}
/**
* The filename of a filter specifying baseline bugs to exclude from being reported.
*/
public void setExcludeBugsFilter(File filter) {
setExcludeBugsFilterConfig(getProject().getResources().getText().fromFile(filter));
}
@TaskAction
public void run() throws IOException, InterruptedException {
new FindBugsClasspathValidator(JavaVersion.current()).validateClasspath(
Iterables.transform(getFindbugsClasspath(), new Function() {
@Override
public String apply(File input) {
return input.getName();
}
}));
FindBugsSpec spec = generateSpec();
FindBugsWorkerManager manager = new FindBugsWorkerManager();
getLogging().captureStandardOutput(LogLevel.DEBUG);
getLogging().captureStandardError(LogLevel.DEBUG);
FindBugsResult result = manager.runWorker(getProject().getProjectDir(), getWorkerProcessBuilderFactory(), getFindbugsClasspath(), spec);
evaluateResult(result);
}
@VisibleForTesting
FindBugsSpec generateSpec() {
FindBugsSpecBuilder specBuilder = new FindBugsSpecBuilder(getClasses())
.withPluginsList(getPluginClasspath())
.withSources(getSource())
.withClasspath(getClasspath())
.withDebugging(getLogger().isDebugEnabled())
.withEffort(getEffort())
.withReportLevel(getReportLevel())
.withMaxHeapSize(getMaxHeapSize())
.withVisitors(getVisitors())
.withOmitVisitors(getOmitVisitors())
.withExcludeFilter(getExcludeFilter())
.withIncludeFilter(getIncludeFilter())
.withExcludeBugsFilter(getExcludeBugsFilter())
.withExtraArgs(getExtraArgs())
.withJvmArgs(getJvmArgs())
.withShowProgress(getShowProgress())
.configureReports(getReports());
return specBuilder.build();
}
@VisibleForTesting
void evaluateResult(FindBugsResult result) {
if (result.getException() != null) {
throw new GradleException("FindBugs encountered an error. Run with --debug to get more information.", result.getException());
}
if (result.getErrorCount() > 0) {
throw new GradleException("FindBugs encountered an error. Run with --debug to get more information.");
}
if (result.getBugCount() > 0) {
String message = "FindBugs rule violations were found.";
SingleFileReport report = reports.getFirstEnabled();
if (report != null) {
String reportUrl = new ConsoleRenderer().asClickableFileUrl(report.getDestination());
message += " See the report at: " + reportUrl;
}
if (getIgnoreFailures()) {
getLogger().warn(message);
} else {
throw new GradleException(message);
}
}
}
/**
* Any additional arguments (not covered here more explicitly like {@code effort}) to be passed along to FindBugs. Extra arguments are passed to FindBugs after the arguments Gradle understands
* (like {@code effort} but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate
* the arguments before passing them to FindBugs.
See the FindBugs
* TextUICommandLine source for available options.
*
* @since 2.6
*/
public FindBugs extraArgs(Iterable arguments) {
for (String argument : arguments) {
extraArgs.add(argument);
}
return this;
}
/**
* Any additional arguments (not covered here more explicitly like {@code effort}) to be passed along to FindBugs. Extra arguments are passed to FindBugs after the arguments Gradle understands
* (like {@code effort} but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate
* the arguments before passing them to FindBugs.
See the FindBugs
* TextUICommandLine source for available options.
*
* @since 2.6
*/
public FindBugs extraArgs(String... arguments) {
extraArgs.addAll(Arrays.asList(arguments));
return this;
}
/**
* Any additional arguments to be passed along to FindBugs JVM process.
*
* Arguments can contain general JVM flags like {@code -Xdebug} and also FindBugs system properties like {@code -Dfindbugs.loadPropertiesFrom=...}
*
* @since 4.3
*/
@Incubating
public FindBugs jvmArgs(Iterable arguments) {
for (String argument : arguments) {
jvmArgs.add(argument);
}
return this;
}
/**
* Any additional arguments to be passed along to FindBugs JVM process.
*
* Arguments can contain general JVM flags like {@code -Xdebug} and also FindBugs system properties like {@code -Dfindbugs.loadPropertiesFrom=...}
*
* @since 4.3
*/
@Incubating
public FindBugs jvmArgs(String... arguments) {
jvmArgs.addAll(Arrays.asList(arguments));
return this;
}
/**
* {@inheritDoc}
*/
@Override
@PathSensitive(PathSensitivity.RELATIVE)
public FileTree getSource() {
return super.getSource();
}
/**
* The classes to be analyzed.
*/
@SkipWhenEmpty
@PathSensitive(PathSensitivity.RELATIVE)
@InputFiles
protected FileCollection getCandidateClassFiles() {
// We need to resolve the classes into a set of files so @SkipWhenEmpty will work
// Otherwise, a collection of empty directories is not seen as "empty"
return getClasses().getAsFileTree();
}
/**
* The class directories to be analyzed.
*/
@Internal
public FileCollection getClasses() {
return classes;
}
/**
* The class directories to be analyzed.
*/
public void setClasses(FileCollection classes) {
this.classes = classes;
}
/**
* Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves.
*/
@Classpath
public FileCollection getClasspath() {
return classpath;
}
/**
* Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves.
*/
public void setClasspath(FileCollection classpath) {
this.classpath = classpath;
}
/**
* Class path holding the FindBugs library.
*/
@Classpath
public FileCollection getFindbugsClasspath() {
return findbugsClasspath;
}
/**
* Class path holding the FindBugs library.
*/
public void setFindbugsClasspath(FileCollection findbugsClasspath) {
this.findbugsClasspath = findbugsClasspath;
}
/**
* Class path holding any additional FindBugs plugins.
*/
@Classpath
public FileCollection getPluginClasspath() {
return pluginClasspath;
}
/**
* Class path holding any additional FindBugs plugins.
*/
public void setPluginClasspath(FileCollection pluginClasspath) {
this.pluginClasspath = pluginClasspath;
}
/**
* Whether to allow the build to continue if there are warnings.
*/
@Override
public boolean getIgnoreFailures() {
return ignoreFailures;
}
/**
* Whether to allow the build to continue if there are warnings.
*/
public void setIgnoreFailures(boolean ignoreFailures) {
this.ignoreFailures = ignoreFailures;
}
/**
* The analysis effort level. The value specified should be one of {@code min}, {@code default}, or {@code max}. Higher levels increase precision and find more bugs at the expense of running time
* and memory consumption.
*/
@Nullable
@Optional
@Input
public String getEffort() {
return effort;
}
/**
* The analysis effort level. The value specified should be one of {@code min}, {@code default}, or {@code max}. Higher levels increase precision and find more bugs at the expense of running time
* and memory consumption.
*/
public void setEffort(@Nullable String effort) {
this.effort = effort;
}
/**
* The priority threshold for reporting bugs. If set to {@code low}, all bugs are reported. If set to {@code medium} (the default), medium and high priority bugs are reported. If set to {@code
* high}, only high priority bugs are reported.
*/
@Nullable
@Optional
@Input
public String getReportLevel() {
return reportLevel;
}
/**
* The priority threshold for reporting bugs. If set to {@code low}, all bugs are reported. If set to {@code medium} (the default), medium and high priority bugs are reported. If set to {@code
* high}, only high priority bugs are reported.
*/
public void setReportLevel(@Nullable String reportLevel) {
this.reportLevel = reportLevel;
}
/**
* The maximum heap size for the forked findbugs process (ex: '1g').
*/
@Nullable
@Optional
@Input
public String getMaxHeapSize() {
return maxHeapSize;
}
/**
* The maximum heap size for the forked findbugs process (ex: '1g').
*/
public void setMaxHeapSize(@Nullable String maxHeapSize) {
this.maxHeapSize = maxHeapSize;
}
/**
* The bug detectors which should be run. The bug detectors are specified by their class names, without any package qualification. By default, all detectors which are not disabled by default are
* run.
*/
@Nullable
@Optional
@Input
public Collection getVisitors() {
return visitors;
}
/**
* The bug detectors which should be run. The bug detectors are specified by their class names, without any package qualification. By default, all detectors which are not disabled by default are
* run.
*/
public void setVisitors(@Nullable Collection visitors) {
this.visitors = visitors;
}
/**
* Similar to {@code visitors} except that it specifies bug detectors which should not be run. By default, no visitors are omitted.
*/
@Nullable
@Optional
@Input
public Collection getOmitVisitors() {
return omitVisitors;
}
/**
* Similar to {@code visitors} except that it specifies bug detectors which should not be run. By default, no visitors are omitted.
*/
public void setOmitVisitors(@Nullable Collection omitVisitors) {
this.omitVisitors = omitVisitors;
}
/**
* A filter specifying which bugs are reported. Replaces the {@code includeFilter} property.
*
* @since 2.2
*/
@Nullable
@Optional
@Nested
public TextResource getIncludeFilterConfig() {
return includeFilterConfig;
}
/**
* A filter specifying which bugs are reported. Replaces the {@code includeFilter} property.
*
* @since 2.2
*/
public void setIncludeFilterConfig(@Nullable TextResource includeFilterConfig) {
this.includeFilterConfig = includeFilterConfig;
}
/**
* A filter specifying bugs to exclude from being reported. Replaces the {@code excludeFilter} property.
*
* @since 2.2
*/
@Nullable
@Optional
@Nested
public TextResource getExcludeFilterConfig() {
return excludeFilterConfig;
}
/**
* A filter specifying bugs to exclude from being reported. Replaces the {@code excludeFilter} property.
*
* @since 2.2
*/
public void setExcludeFilterConfig(@Nullable TextResource excludeFilterConfig) {
this.excludeFilterConfig = excludeFilterConfig;
}
/**
* A filter specifying baseline bugs to exclude from being reported.
*
* @since 2.4
*/
@Nullable
@Optional
@Nested
public TextResource getExcludeBugsFilterConfig() {
return excludeBugsFilterConfig;
}
/**
* A filter specifying baseline bugs to exclude from being reported.
*
* @since 2.4
*/
public void setExcludeBugsFilterConfig(@Nullable TextResource excludeBugsFilterConfig) {
this.excludeBugsFilterConfig = excludeBugsFilterConfig;
}
/**
* Any additional arguments (not covered here more explicitly like {@code effort}) to be passed along to FindBugs. Extra arguments are passed to FindBugs after the arguments Gradle understands
* (like {@code effort} but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate
* the arguments before passing them to FindBugs.
See the FindBugs
* TextUICommandLine source for available options.
*
* @since 2.6
*/
@Nullable
@Optional
@Input
public Collection getExtraArgs() {
return extraArgs;
}
/**
* Any additional arguments (not covered here more explicitly like {@code effort}) to be passed along to FindBugs. Extra arguments are passed to FindBugs after the arguments Gradle understands
* (like {@code effort} but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate
* the arguments before passing them to FindBugs.
See the FindBugs
* TextUICommandLine source for available options.
*
* @since 2.6
*/
public void setExtraArgs(@Nullable Collection extraArgs) {
this.extraArgs = extraArgs;
}
/**
* Indicates whether analysis progress should be rendered on standard output. Defaults to false.
*
* @since 4.2
*/
@Input
public boolean getShowProgress() {
return showProgress;
}
/**
* Indicates whether analysis progress should be rendered on standard output.
*
* @since 4.2
*/
public void setShowProgress(boolean showProgress) {
this.showProgress = showProgress;
}
/**
* Any additional arguments to be passed along to FindBugs JVM process.
*
* Arguments can contain general JVM flags like {@code -Xdebug} and also FindBugs system properties like {@code -Dfindbugs.loadPropertiesFrom=...}
*
* @since 4.3
*/
@Incubating
@Nullable
@Optional
@Input
public Collection getJvmArgs() {
return jvmArgs;
}
/**
* Any additional arguments to be passed along to FindBugs JVM process.
*
* Arguments can contain general JVM flags like {@code -Xdebug} and also FindBugs system properties like {@code -Dfindbugs.loadPropertiesFrom=...}
*
* @since 4.3
*/
@Incubating
public void setJvmArgs(@Nullable Collection jvmArgs) {
this.jvmArgs = jvmArgs;
}
}