hudson.plugins.pmd.util.HealthAwarePublisher Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmd Show documentation
Show all versions of pmd Show documentation
This plug-in generates the trend report for PMD, an
open source static code analysis program.
package hudson.plugins.pmd.util;
import hudson.model.Result;
import hudson.tasks.Publisher;
import org.apache.commons.lang.StringUtils;
/**
* A base class for publishers with the following two characteristics:
*
* - It provides a unstable threshold, that could be enabled and set in the
* configuration screen. If the number of annotations in a build exceeds this
* value then the build is considered as {@link Result#UNSTABLE UNSTABLE}.
*
* - It provides thresholds for the build health, that could be adjusted in
* the configuration screen. These values are used by the
* {@link HealthReportBuilder} to compute the health and the health trend graph.
* - It works on files based on a user configurable file name pattern.
*
*/
public abstract class HealthAwarePublisher extends Publisher {
/** Ant file-set pattern of files to work with. */
private final String pattern;
/** Annotation threshold to be reached if a build should be considered as unstable. */
private final String threshold;
/** Determines whether to use the provided threshold to mark a build as unstable. */
private boolean thresholdEnabled;
/** Integer threshold to be reached if a build should be considered as unstable. */
private int minimumAnnotations;
/** Report health as 100% when the number of warnings is less than this value. */
private final String healthy;
/** Report health as 0% when the number of warnings is greater than this value. */
private final String unHealthy;
/** Report health as 100% when the number of warnings is less than this value. */
private int healthyAnnotations;
/** Report health as 0% when the number of warnings is greater than this value. */
private int unHealthyAnnotations;
/** Determines whether to use the provided healthy thresholds. */
private boolean healthyReportEnabled;
/**
* Creates a new instance of HealthAwarePublisher.
*
* @param pattern
* Ant file-set pattern of files to scan for open tasks in
* @param threshold
* Tasks threshold to be reached if a build should be considered
* as unstable.
* @param healthy
* Report health as 100% when the number of open tasks is less
* than this value
* @param unHealthy
* Report health as 0% when the number of open tasks is greater
* than this value
*/
public HealthAwarePublisher(final String pattern, final String threshold,
final String healthy, final String unHealthy) {
super();
this.threshold = threshold;
this.healthy = healthy;
this.unHealthy = unHealthy;
this.pattern = pattern;
if (!StringUtils.isEmpty(threshold)) {
try {
minimumAnnotations = Integer.valueOf(threshold);
if (minimumAnnotations >= 0) {
thresholdEnabled = true;
}
}
catch (NumberFormatException exception) {
// nothing to do, we use the default value
}
}
if (!StringUtils.isEmpty(healthy) && !StringUtils.isEmpty(unHealthy)) {
try {
healthyAnnotations = Integer.valueOf(healthy);
unHealthyAnnotations = Integer.valueOf(unHealthy);
if (healthyAnnotations >= 0 && unHealthyAnnotations > healthyAnnotations) {
healthyReportEnabled = true;
}
}
catch (NumberFormatException exception) {
// nothing to do, we use the default value
}
}
}
/**
* Creates a new instance of HealthReportBuilder.
*
* @param reportSingleCount
* message to be shown if there is exactly one item found
* @param reportMultipleCount
* message to be shown if there are zero or more than one items
* found
* @return the new health report builder
*/
protected HealthReportBuilder createHealthReporter(final String reportSingleCount, final String reportMultipleCount) {
return new HealthReportBuilder(thresholdEnabled, minimumAnnotations, healthyReportEnabled, healthyAnnotations, unHealthyAnnotations,
reportSingleCount, reportMultipleCount);
}
/**
* Determines whether a threshold has been defined.
*
* @return true if a threshold has been defined
*/
public boolean isThresholdEnabled() {
return thresholdEnabled;
}
/**
* Returns the annotation threshold to be reached if a build should be considered as unstable.
*
* @return the annotation threshold to be reached if a build should be considered as unstable.
*/
public String getThreshold() {
return threshold;
}
/**
* Returns the threshold to be reached if a build should be considered as unstable.
*
* @return the threshold to be reached if a build should be considered as unstable
*/
public int getMinimumAnnotations() {
return minimumAnnotations;
}
/**
* Returns the isHealthyReportEnabled.
*
* @return the isHealthyReportEnabled
*/
public boolean isHealthyReportEnabled() {
return healthyReportEnabled;
}
/**
* Returns the healthy threshold, i.e. when health is reported as 100%.
*
* @return the 100% healthiness
*/
public String getHealthy() {
return healthy;
}
/**
* Returns the healthy threshold for annotations, i.e. when health is reported as 100%.
*
* @return the 100% healthiness
*/
public int getHealthyAnnotations() {
return healthyAnnotations;
}
/**
* Returns the unhealthy threshold, i.e. when health is reported as 0%.
*
* @return the 0% unhealthiness
*/
public String getUnHealthy() {
return unHealthy;
}
/**
* Returns the unhealthy threshold of annotations, i.e. when health is reported as 0%.
*
* @return the 0% unhealthiness
*/
public int getUnHealthyAnnotations() {
return unHealthyAnnotations;
}
/**
* Returns the Ant file-set pattern of files to work with.
*
* @return Ant file-set pattern of files to work with
*/
public String getPattern() {
return pattern;
}
}