org.gradle.api.plugins.quality.Pmd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2011 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 groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.internal.project.IsolatedAntBuilder;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.quality.internal.PmdInvoker;
import org.gradle.api.plugins.quality.internal.PmdReportsImpl;
import org.gradle.api.provider.Property;
import org.gradle.api.reporting.Reporting;
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.LocalState;
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.SourceTask;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.VerificationTask;
import org.gradle.internal.nativeintegration.console.ConsoleDetector;
import org.gradle.internal.nativeintegration.console.ConsoleMetaData;
import org.gradle.internal.nativeintegration.services.NativeServices;
import org.gradle.util.internal.ClosureBackedAction;
import javax.annotation.Nullable;
import javax.inject.Inject;
import java.io.File;
import java.util.List;
/**
* Runs a set of static code analysis rules on Java source code files and generates a report of problems found.
*
* @see PmdPlugin
* @see PmdExtension
*/
@CacheableTask
public class Pmd extends SourceTask implements VerificationTask, Reporting {
private FileCollection pmdClasspath;
private List ruleSets;
private TargetJdk targetJdk;
private TextResource ruleSetConfig;
private FileCollection ruleSetFiles;
private final PmdReports reports;
private boolean ignoreFailures;
private boolean consoleOutput;
private FileCollection classpath;
private final Property rulesMinimumPriority;
private final Property maxFailures;
private final Property incrementalAnalysis;
private final Property threads;
public Pmd() {
ObjectFactory objects = getObjectFactory();
reports = objects.newInstance(PmdReportsImpl.class, this);
this.rulesMinimumPriority = objects.property(Integer.class);
this.incrementalAnalysis = objects.property(Boolean.class);
this.maxFailures = objects.property(Integer.class);
this.threads = objects.property(Integer.class);
}
@Inject
protected ObjectFactory getObjectFactory() {
throw new UnsupportedOperationException();
}
@Inject
public IsolatedAntBuilder getAntBuilder() {
throw new UnsupportedOperationException();
}
@TaskAction
public void run() {
validate(rulesMinimumPriority.get());
validateThreads(threads.get());
PmdInvoker.invoke(this);
}
public boolean stdOutIsAttachedToTerminal() {
try {
ConsoleDetector consoleDetector = NativeServices.getInstance().get(ConsoleDetector.class);
ConsoleMetaData consoleMetaData = consoleDetector.getConsole();
return consoleMetaData != null && consoleMetaData.isStdOut();
} catch (RuntimeException e) {
return false;
}
}
/**
* Configures the reports to be generated by this task.
*/
@Override
@SuppressWarnings("rawtypes")
public PmdReports reports(@DelegatesTo(value = PmdReports.class, strategy = Closure.DELEGATE_FIRST) Closure closure) {
return reports(new ClosureBackedAction<>(closure));
}
/**
* Configures the reports to be generated by this task.
*
* @since 3.0
*/
@Override
public PmdReports reports(Action configureAction) {
configureAction.execute(reports);
return reports;
}
/**
* Validates the value is a valid PMD rules minimum priority (1-5)
*
* @param value rules minimum priority threshold
*/
public static void validate(int value) {
if (value > 5 || value < 1) {
throw new InvalidUserDataException(String.format("Invalid rulesMinimumPriority '%d'. Valid range 1 (highest) to 5 (lowest).", value));
}
}
/**
* Validates the number of threads used by PMD.
*
* @param value the number of threads used by PMD
*/
private void validateThreads(int value) {
if (value < 0) {
throw new InvalidUserDataException(String.format("Invalid number of threads '%d'. Number should not be negative.", value));
}
}
/**
* {@inheritDoc}
*/
@Override
@PathSensitive(PathSensitivity.RELATIVE)
public FileTree getSource() {
return super.getSource();
}
/**
* The class path containing the PMD library to be used.
*/
@Classpath
public FileCollection getPmdClasspath() {
return pmdClasspath;
}
/**
* The class path containing the PMD library to be used.
*/
public void setPmdClasspath(FileCollection pmdClasspath) {
this.pmdClasspath = pmdClasspath;
}
/**
* The built-in rule sets to be used. See the official list of built-in rule sets.
*
*
* ruleSets = ["basic", "braces"]
*
*/
@Input
public List getRuleSets() {
return ruleSets;
}
/**
* The built-in rule sets to be used. See the official list of built-in rule sets.
*
*
* ruleSets = ["basic", "braces"]
*
*/
public void setRuleSets(List ruleSets) {
this.ruleSets = ruleSets;
}
/**
* The target JDK to use with PMD.
*/
@Input
public TargetJdk getTargetJdk() {
return targetJdk;
}
/**
* The target JDK to use with PMD.
*/
public void setTargetJdk(TargetJdk targetJdk) {
this.targetJdk = targetJdk;
}
/**
* The custom rule set to be used (if any). Replaces {@code ruleSetFiles}, except that it does not currently support multiple rule sets.
*
* See the official documentation for how to author a rule set.
*
*
* ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))
*
*
* @since 2.2
*/
@Nullable
@Optional
@Nested
public TextResource getRuleSetConfig() {
return ruleSetConfig;
}
/**
* The custom rule set to be used (if any). Replaces {@code ruleSetFiles}, except that it does not currently support multiple rule sets.
*
* See the official documentation for how to author a rule set.
*
*
* ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))
*
*
* @since 2.2
*/
public void setRuleSetConfig(@Nullable TextResource ruleSetConfig) {
this.ruleSetConfig = ruleSetConfig;
}
/**
* The custom rule set files to be used. See the official documentation for how to author a rule set file.
* If you want to only use custom rule sets, you must clear {@code ruleSets}.
*
*
* ruleSetFiles = files("config/pmd/myRuleSet.xml")
*
*/
@InputFiles
@PathSensitive(PathSensitivity.NONE)
public FileCollection getRuleSetFiles() {
return ruleSetFiles;
}
/**
* The custom rule set files to be used. See the official documentation for how to author a rule set file.
* This adds to the default rule sets defined by {@link #getRuleSets()}.
*
*
* ruleSetFiles = files("config/pmd/myRuleSets.xml")
*
*/
public void setRuleSetFiles(FileCollection ruleSetFiles) {
this.ruleSetFiles = ruleSetFiles;
}
/**
* The reports to be generated by this task.
*/
@Override
@Nested
public final PmdReports getReports() {
return reports;
}
/**
* Whether or not to allow the build to continue if there are warnings.
*
*
* ignoreFailures = true
*
*/
@Override
public boolean getIgnoreFailures() {
return ignoreFailures;
}
/**
* Whether or not to allow the build to continue if there are warnings.
*
*
* ignoreFailures = true
*
*/
@Override
public void setIgnoreFailures(boolean ignoreFailures) {
this.ignoreFailures = ignoreFailures;
}
/**
* The maximum number of failures to allow before stopping the build.
*
* Defaults to 0, which will stop the build on any failure. Values 0 and
* above are valid. If ignoreFailures
is set, this is ignored
* and the build will continue (infinite failures allowed).
*
* @since 6.4
*/
@Input
public Property getMaxFailures() {
return maxFailures;
}
/**
* Specifies the rule priority threshold.
*
* @see PmdExtension#getRulesMinimumPriority()
* @since 6.8
*/
@Input
public Property getRulesMinimumPriority() {
return rulesMinimumPriority;
}
/**
* Whether or not to write PMD results to {@code System.out}.
*
* @since 2.1
*/
@Input
public boolean isConsoleOutput() {
return consoleOutput;
}
/**
* Whether or not to write PMD results to {@code System.out}.
*
* @since 2.1
*/
public void setConsoleOutput(boolean consoleOutput) {
this.consoleOutput = consoleOutput;
}
/**
* Compile class path for the classes to be analyzed.
*
* The classes on this class path are used during analysis but aren't analyzed themselves.
*
* This is only well supported for PMD 5.2.1 or better.
*
* @since 2.8
*/
@Nullable
@Optional
@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.
*
* This is only well supported for PMD 5.2.1 or better.
*
* @since 2.8
*/
public void setClasspath(@Nullable FileCollection classpath) {
this.classpath = classpath;
}
/**
* Controls whether to use incremental analysis or not.
*
* This is only supported for PMD 6.0.0 or better. See for more details.
*
* @since 5.6
*/
@Internal
public Property getIncrementalAnalysis() {
return incrementalAnalysis;
}
/**
* Path to the incremental cache file, if incremental analysis is used.
*
* @since 5.6
*/
@LocalState
public File getIncrementalCacheFile() {
return new File(getTemporaryDir(), "incremental.cache");
}
/**
* Specifies the number of threads used by PMD.
*
* @see PmdExtension#getThreads()
* @since 7.5
*/
@Input
@Incubating
public Property getThreads() {
return threads;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy