com.atlassian.clover.ant.tasks

Class CloverPassTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.atlassian.clover.ant.tasks.AbstractCloverTask

com.atlassian.clover.ant.tasks.CloverPassTask

All Implemented Interfaces:

Cloneable

public class CloverPassTask
extends AbstractCloverTask

Clover Ant Task to report pass/fail status of a test run against given targets. Targets may be given overall and/or per package level. The build may optionally fail if targets are not met

Since:

Clover 1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloverPassTask.PackageRequirement Inner class to gather the package level pass/fail coverage targets.

Field Summary

Fields inherited from class com.atlassian.clover.ant.tasks.AbstractCloverTask

config, debug

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
CloverPassTask()

Method Summary

Modifier and Type	Method and Description
void	addPackage(CloverPassTask.PackageRequirement requirement) Add a apcage spec to the list of packages to be checked for coverage.
void	addTestResults(org.apache.tools.ant.types.FileSet fileset)
void	addTestSources(org.apache.tools.ant.types.FileSet fileset)
void	cloverExecute() Do the work - checking the overall and per-package coverage against the givenm targets.
Percentage	getConditionalTarget()
String	getFailureProperty()
File	getHistorydir()
Percentage	getMethodTarget()
Percentage	getStatementTarget()
List	getTestSources()
double	getThreshold()
void	init()
void	setCodeType(String codeTypeAsString)
void	setConditionalTarget(Percentage conditionalTarget)
void	setFailureProperty(String failureProperty)
void	setFilter(String filterSpec) set the filter which controls which items are included in the log report.
void	setHaltOnFailure(boolean haltOnFailure) Set the flag indicating whether the build will be failed for failing to meet a target coverage.
void	setHistorydir(File historydir)
void	setIncludeFailedTestCoverage(boolean include)
void	setMethodTarget(Percentage methodTarget)
void	setSpan(Interval span)
void	setStatementTarget(Percentage statementTarget)
void	setTarget(Percentage percentValue) Set the overall system coverage target
void	setThreshold(Percentage threshold)

Methods inherited from class com.atlassian.clover.ant.tasks.AbstractCloverTask

execute, getInitString, resolveInitString, setDebug, setInitString, setTmpDir, validate

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloverPassTask

public CloverPassTask()

Method Detail

setCodeType

public void setCodeType(String codeTypeAsString)

init

public void init()
          throws org.apache.tools.ant.BuildException

Overrides:

init in class AbstractCloverTask

Throws:

org.apache.tools.ant.BuildException

addPackage

public void addPackage(CloverPassTask.PackageRequirement requirement)

Add a apcage spec to the list of packages to be checked for coverage.

Parameters:

requirement - the package rquirement including the apckage name and percentage coverage required.

setHistorydir

public void setHistorydir(File historydir)

getHistorydir

public File getHistorydir()

setThreshold

public void setThreshold(Percentage threshold)

getThreshold

public double getThreshold()

setTarget

public void setTarget(Percentage percentValue)

Set the overall system coverage target

Parameters:

percentValue - the percentage coverage target for the build

getMethodTarget

public Percentage getMethodTarget()

setMethodTarget

public void setMethodTarget(Percentage methodTarget)

getStatementTarget

public Percentage getStatementTarget()

setStatementTarget

public void setStatementTarget(Percentage statementTarget)

getConditionalTarget

public Percentage getConditionalTarget()

setConditionalTarget

public void setConditionalTarget(Percentage conditionalTarget)

setFailureProperty

public void setFailureProperty(String failureProperty)

getFailureProperty

public String getFailureProperty()

setFilter

public void setFilter(String filterSpec)

set the filter which controls which items are included in the log report.

Parameters:

filterSpec - a comma separated set of values denoting the items to include in the report.

setSpan

public void setSpan(Interval span)

addTestResults

public void addTestResults(org.apache.tools.ant.types.FileSet fileset)

setIncludeFailedTestCoverage

public void setIncludeFailedTestCoverage(boolean include)

addTestSources

public void addTestSources(org.apache.tools.ant.types.FileSet fileset)

getTestSources

public List getTestSources()

setHaltOnFailure

public void setHaltOnFailure(boolean haltOnFailure)

Set the flag indicating whether the build will be failed for failing to meet a target coverage. If this is false the coverage target failures are logged

Parameters:

haltOnFailure - true if the build is to fail when targets are not met.

cloverExecute

public void cloverExecute()

Do the work - checking the overall and per-package coverage against the givenm targets.

Specified by:

cloverExecute in class AbstractCloverTask