com.atlassian.maven.plugin.clover.internal

Class AbstractCloverInstrumentMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo

com.atlassian.maven.plugin.clover.internal.AbstractCloverInstrumentMojo

All Implemented Interfaces:

CloverConfiguration, CompilerConfiguration, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CloverInstrumentInternalMojo, CloverInstrumentMojo

public abstract class AbstractCloverInstrumentMojo
extends AbstractCloverMojo
implements CompilerConfiguration

Common settings for clover:instr / clover:setup MOJOs.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cloveredArtifactExpiryInMillis The difference (in milliseconds) that a -clover classified artifact can have to a non-clover classified artifact.
protected boolean	copyExcludedFiles If set, then the clover-maven-plugin will not copy files that were excluded, across to the target/clover directory.
protected DistributedCoverage	distributedCoverage The configuration for distributed coverage collection by Clover.
protected String	encoding The character encoding to use when parsing source files.
protected Set<String>	excludes The list of file to exclude from the instrumentation.
protected String	excludesFile The file containing a list of file paths, separated by new line, to exclude from the instrumentation.
protected String	excludesList The comma seperated list of file to exclude from the instrumentation.
protected String	flushPolicy The Clover flush policy to use.
protected File	groverJar By default, Clover Maven Plugin generates the ${java.io.tmpdir}/grover*.jar file during setup, which is next being added as the dependent artifact to the build.
protected Set<String>	includes The list of file to include in the instrumentation.
protected boolean	includesAllSourceRoots Till 3.1.11: whether the Clover plugin should instrument all source roots (for example src/main/java, src/main/groovy, target/generated-sources, so including the generated sources) or whether it should only instrument the main source root (usually src/main/java).
protected String	includesFile The file containing a list of file paths, separated by new line, to include in the instrumentation.
protected String	includesList The comma seperated list of files to include in the instrumentation.
protected boolean	includesTestSourceRoots Whether the Clover plugin should instrument test source roots.
protected String	instrumentation The level to instrument to.
protected String	jdk Which Java language level Clover shall use to parse sources.
protected Map<String,String>	methodContexts Specifies the custom method contexts to use for filtering specific methods from Clover reports.
protected Set<MethodWithMetricsContext>	methodWithMetricsContexts Specifies the custom method contexts to use for filtering specific methods from Clover reports.
protected boolean	repositoryPollutionProtection Try to protect your build from installing instrumented artifacts into local ~/.m2 cache or deploying them to a binaries repository.
protected String	scope When creating the clover.jar dependency, what scope to use.
protected boolean	setTestFailureIgnore If set to true, Clover will add several properties to the build configuration which disable a build failure for following plugins:
protected boolean	skipGroverJar By default, Clover Maven Plugin generates the ${java.io.tmpdir}/grover*.jar file during setup, which is next being added as the dependent artifact to the build.
protected int	staleMillis Sets the granularity in milliseconds of the last modification date for testing whether a source needs reinstrumentation.
protected Map<String,String>	statementContexts Specifies the custom statement contexts to use for filtering specific statements from Clover reports.
protected TestSources	testSources Specifies a custom test detector configuration.
protected boolean	useCloverClassifier Whether or not to include the -clover classifier on artifacts.
protected boolean	useFullyQualifiedJavaLang Use the fully qualified package name for java.lang.* classes.

Fields inherited from class com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo

cloverOutputDirectory, debug, license, licenseLocation, skip, snapshot

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCloverInstrumentMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	failIfCustomClassifierIsPresent() Check if an artifact has a custom classifier (except the 'javadoc' and 'sources' ones).
protected void	failIfDeployPhaseIsPresent(BuildLifecycleAnalyzer lifecycleAnalyzer) Check if the build life cycle contains the 'deploy' phase.
protected void	failIfInstallPhaseIsPresent(BuildLifecycleAnalyzer lifecycleAnalyzer) Check if the build life cycle contains the 'install' phase.
DistributedCoverage	getDistributedCoverage()
String	getEncoding()
Set<String>	getExcludes()
String	getFlushPolicy()
Set<String>	getIncludes()
String	getInstrumentation()
String	getInstrumentLambda()
String	getJdk()
Map<String,String>	getMethodContexts()
Set<MethodWithMetricsContext>	getMethodWithMetricsContexts()
int	getStaleMillis()
Map<String,String>	getStatementContexts()
TestSources	getTestSources()
boolean	isCopyExcludedFiles()
boolean	isIncludesAllSourceRoots()
boolean	isUseFullyQualifiedJavaLang()
protected abstract boolean	shouldRedirectArtifacts()
protected abstract boolean	shouldRedirectOutputDirectories()

Methods inherited from class com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo

areCloverDatabasesAvailable, getCloverDatabase, getCloverMergeDatabase, getDescendantModuleProjects, getFlushInterval, getModuleProjects, getProject, getReactorProjects, getResourceAsFile, getWaitForFlush, isLastProjectInReactor, isModuleOfProject, isSingleCloverDatabase, registerCloverAntTasks, resolveCloverDatabase, setLicense, setLicenseLocation, setProject, waitForFlush

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.maven.plugin.clover.internal.CompilerConfiguration

getFlushInterval

Methods inherited from interface com.atlassian.maven.plugin.clover.internal.CloverConfiguration

getCloverDatabase, getLog, getProject, getReactorProjects, isSingleCloverDatabase, resolveCloverDatabase

Field Detail

cloveredArtifactExpiryInMillis

@Parameter(property="maven.clover.cloveredArtifactExpiryInMillis",
           defaultValue="2000")
protected long cloveredArtifactExpiryInMillis

The difference (in milliseconds) that a -clover classified artifact can have to a non-clover classified artifact.

If the -clover classified artifact is more than cloveredArtifactExpiryInMillis older than the non-clover classified artifact, then the non-classified artifact will be used.

This setting defaults to 2000.

copyExcludedFiles

@Parameter(property="maven.clover.copyExcludedFiles",
           defaultValue="true")
protected boolean copyExcludedFiles

If set, then the clover-maven-plugin will not copy files that were excluded, across to the target/clover directory. This is useful if the build is also using plugins such as the maven-gwt-plugin, that scans for resources, and skips a step if none are found. Otherwise, setting this to false could well cause build failures.

distributedCoverage

@Parameter
protected DistributedCoverage distributedCoverage

The configuration for distributed coverage collection by Clover.

If present, default values will be used and coverage will be collected across JVMs.

Optional nested elements (and their defaults) of distributedCoverage are:

• host - the host name of the JVM running the tests. default: localhost
• port - the port that Clover can bind to in the host JVM. default: 1198
• numClients - the number of clients expected to attach to the Test JVM. The test JVM will wait until numClients have connected before continuing. default: 0
• timeout - the amount of time to wait for a response from a remote JVM before shunning it. default: 5000
• retryPeriod - the amount of time a client should wait between reconnect attempts. default: 1000

encoding

@Parameter(property="maven.clover.encoding")
protected String encoding

The character encoding to use when parsing source files.

excludes

@Parameter
protected Set<String> excludes

The list of file to exclude from the instrumentation. Patterns are resolved against source roots.

excludesList

@Parameter(property="maven.clover.excludesList")
protected String excludesList

The comma seperated list of file to exclude from the instrumentation. Patterns are resolved against source roots.

excludesFile

@Parameter(property="maven.clover.excludesFile")
protected String excludesFile

The file containing a list of file paths, separated by new line, to exclude from the instrumentation. Patterns are resolved against source roots. See also excludes and excludesList

flushPolicy

@Parameter(property="maven.clover.flushPolicy",
           defaultValue="threaded")
protected String flushPolicy

The Clover flush policy to use. Valid values are directed, interval and threaded.

groverJar

@Parameter(property="maven.clover.groverJar")
protected File groverJar

By default, Clover Maven Plugin generates the ${java.io.tmpdir}/grover*.jar file during setup, which is next being added as the dependent artifact to the build. As the file has generated, unique name and the jar is not being removed at the end of the build, these files can litter the temporary directory.

By setting this parameter you can:

a) specify constant file name for generated artifact,

b) choose location different than ${java.io.tmpdir}.

However, you must ensure that:

a) grover.jar will not be deleted till end of the build (for example don't put into ./target directory and next run mvn clover:setup clean)

b) grover.jar will not be shared among builds with different Clover Maven Plugin versions used (for example if ProjectA uses Clover v 3.1.8 and ProjectB uses Clover v 3.1.9 then they shall have different groverJar locations defined)

Since:

3.1.8

includes

@Parameter
protected Set<String> includes

The list of file to include in the instrumentation. Patterns are resolved against source roots. Defaults are '**/*.java, **/*.groovy' which are overwritten if <includes> is set by the user

includesList

@Parameter(property="maven.clover.includesList")
protected String includesList

The comma seperated list of files to include in the instrumentation. Patterns are resolved against source roots. Defaults are **.java which are overwritten if <includes> is set by the user

includesFile

@Parameter(property="maven.clover.includesFile")
protected String includesFile

The file containing a list of file paths, separated by new line, to include in the instrumentation. Patterns are resolved against source roots. See also includes and includesList

includesAllSourceRoots

@Parameter(property="maven.clover.includesAllSourceRoots",
           defaultValue="false")
protected boolean includesAllSourceRoots

Till 3.1.11: whether the Clover plugin should instrument all source roots (for example src/main/java, src/main/groovy, target/generated-sources, so including the generated sources) or whether it should only instrument the main source root (usually src/main/java).

Since 3.1.12: whether the Clover plugin should instrument all source roots (for example src/main/java, src/main/groovy, target/generated-sources, so including the generated sources) or whether it should instrument non-generated source roots (i.e. all roots except target/generated-sources/*)

includesTestSourceRoots

@Parameter(property="maven.clover.includesTestSourceRoots",
           defaultValue="true")
protected boolean includesTestSourceRoots

Whether the Clover plugin should instrument test source roots.

instrumentation

@Parameter(property="maven.clover.instrumentation",
           defaultValue="statement")
protected String instrumentation

The level to instrument to. Valid values are 'method' or 'statement'. Default is 'statement'.

Setting this to 'method' greatly reduces the overhead of enabling Clover, however limited or no reporting is available. The current use of setting this to method is for Test Optimization only.

jdk

@Parameter(property="maven.clover.jdk")
protected String jdk

Which Java language level Clover shall use to parse sources. Valid values are:

• 1.3
• 1.4 (introduces 'assert' keyword)
• 1.5 ('enum' keyword and generics)
• 1.6 (no language changes)
• 1.7 (String in switch, try with resources, binary literals, underscores in literals)
• 1.8 (lambda expressions, default methods in interfaces)
• 9 / 1.9 (module-info.java)

By default Clover instruments using the highest language level supported.

methodContexts

@Parameter
protected Map<String,String> methodContexts

Specifies the custom method contexts to use for filtering specific methods from Clover reports.

e.g.

<main>public static void main\(String args\[\]\).*</main>

will define the context called 'main' which will match all public static void main methods.

methodWithMetricsContexts

@Parameter
protected Set<MethodWithMetricsContext> methodWithMetricsContexts

Specifies the custom method contexts to use for filtering specific methods from Clover reports. This is more detailed format compared to methodContexts, which allows to set also code metrics to be matched. Example:

 <methodWithMetricsContexts>
     <methodWithMetricsContext>
         <name>simpleGetter</name> <!-- (mandatory) -->
         <regexp>public .* get.*\(\)</regexp> <!-- (mandatory) -->
         <maxComplexity>1</maxComplexity> <!-- at most 1 cycle (optional) -->
         <maxStatements>1</maxStatements> <!-- at most 1 statement (optional) -->
         <maxAggregatedComplexity>2</maxAggregatedComplexity> <!-- no more than 2 cycles including inline classes (optional) -->
         <maxAggregatedStatements>10</maxAggregatedStatements> <!-- no more than 10 statements including inline classes (optional) -->
     </methodWithMetricsContext>
     <!-- can add more methodWithMetricsContext -->
 </methodWithMetricsContexts>
 

will define a context called 'simpleGetter' which matches all public getXyz() methods containing at most one statement; this statement may contain more complex logic (an anonymous inline class) but not bigger than 9 statements.

repositoryPollutionProtection

@Parameter(property="maven.clover.repositoryPollutionProtection",
           defaultValue="false")
protected boolean repositoryPollutionProtection

Try to protect your build from installing instrumented artifacts into local ~/.m2 cache or deploying them to a binaries repository. If this option is enabled, Clover will fail a build whenever it detects that 'install' or 'deploy' phase is about to be called. It will also fail a build if it detects that an artifact having multiple classifiers (e.g. "-clover-tests.jar"), which are not supported by Maven, is about to be installed under original name (e.g. "-tests.jar").

Please note that this flag may not protect from all possible cases.

Since:

4.0.4

scope

@Parameter(property="maven.clover.scope")
protected String scope

When creating the clover.jar dependency, what scope to use. This may be one of: compile, test, provided etc. If not specified - provided will be used.

setTestFailureIgnore

@Parameter(property="maven.clover.setTestFailureIgnore",
           defaultValue="false")
protected boolean setTestFailureIgnore

If set to true, Clover will add several properties to the build configuration which disable a build failure for following plugins:

• maven-surefire-plugin (maven.test.failure.ignore=true)
• maven-failsafe-plugin (maven.test.failure.ignore=true)
• maven-checkstyle-plugin (checkstyle.failOnViolation=false)
• maven-pmd-plugin (pmd.failOnViolation=false)

Thanks to this, build continues despite test failures or code validation failures and thus it is possible to generate a Clover coverage report for failed tests at the end of the build.

Note: before version 3.1.9 the testFailureIgnore property was set to true for the forked Clover lifecycle ('instrument' goal) for 'test' and 'integration-test' phases. Since 3.1.9 it is no longer set.

Since:

3.1.9

skipGroverJar

@Parameter(property="maven.clover.skipGroverJar",
           defaultValue="false")
protected boolean skipGroverJar

By default, Clover Maven Plugin generates the ${java.io.tmpdir}/grover*.jar file during setup, which is next being added as the dependent artifact to the build. As the file has generated, unique name and the jar is not being removed at the end of the build, these files can litter the temporary directory.

In case when there is no Groovy code in the project, this parameter can be set to true in order to disable generation of grover.jar artifact.

Since:

3.1.8

statementContexts

@Parameter
protected Map<String,String> statementContexts

Specifies the custom statement contexts to use for filtering specific statements from Clover reports. e.g.

<log>^LOG\..*</log>

defines a statement context called "log" which matches all LOG statements.

staleMillis

@Parameter(property="maven.clover.staleMillis",
           defaultValue="0")
protected int staleMillis

Sets the granularity in milliseconds of the last modification date for testing whether a source needs reinstrumentation.

testSources

@Parameter
protected TestSources testSources

Specifies a custom test detector configuration. Useful in case your tests are not following JUnit/TestNG naming convention. Example:

 <testSources>
    <includes>
        <include>**/*</include>
        <include>*WebTest.java</include>
        <include>**/*IT.java</include>
    </includes>
    <excludes>
        <exclude>deprecated/**</exclude>
    </excludes>
    <testClasses>
        <testClass> <!-- 0..N occurrences -->
            <name>.*Test</name>
            <super>WebTest</super>
            <annotation>@Repeat</annotation>
            <package>org\.openclover\..*</package>
            <tag>@chrome</tag>
            <testMethods> <!-- 0..N occurrences -->
               <testMethod>
                   <name>check.*</name>
                   <annotation>@Test</annotation>
                   <tag>@web</tag>
                   <returnType>void</returnType>
               </testMethod>
            </testMethods>
        </testClass>
    </testClasses>
 </testSources>
 

Note: every tag is optional.

Since:

4.4.0

useCloverClassifier

@Parameter(property="maven.clover.useCloverClassifier",
           defaultValue="true")
protected boolean useCloverClassifier

Whether or not to include the -clover classifier on artifacts.

useFullyQualifiedJavaLang

@Parameter(property="maven.clover.useFullyQualifiedJavaLang",
           defaultValue="true")
protected boolean useFullyQualifiedJavaLang

Use the fully qualified package name for java.lang.* classes.

Constructor Detail

AbstractCloverInstrumentMojo

public AbstractCloverInstrumentMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractCloverMojo

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractCloverMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

Mojo.execute()

shouldRedirectArtifacts

protected abstract boolean shouldRedirectArtifacts()

shouldRedirectOutputDirectories

protected abstract boolean shouldRedirectOutputDirectories()

isCopyExcludedFiles

public boolean isCopyExcludedFiles()

Specified by:

isCopyExcludedFiles in interface CompilerConfiguration

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface CompilerConfiguration

getDistributedCoverage

public DistributedCoverage getDistributedCoverage()

Specified by:

getDistributedCoverage in interface CompilerConfiguration

getExcludes

public Set<String> getExcludes()

Specified by:

getExcludes in interface CompilerConfiguration

getFlushPolicy

public String getFlushPolicy()

Specified by:

getFlushPolicy in interface CompilerConfiguration

getIncludes

public Set<String> getIncludes()

Specified by:

getIncludes in interface CompilerConfiguration

getInstrumentation

public String getInstrumentation()

Specified by:

getInstrumentation in interface CompilerConfiguration

getInstrumentLambda

public String getInstrumentLambda()

Specified by:

getInstrumentLambda in interface CompilerConfiguration

getJdk

public String getJdk()

Specified by:

getJdk in interface CompilerConfiguration

getMethodContexts

public Map<String,String> getMethodContexts()

Specified by:

getMethodContexts in interface CompilerConfiguration

getMethodWithMetricsContexts

public Set<MethodWithMetricsContext> getMethodWithMetricsContexts()

Specified by:

getMethodWithMetricsContexts in interface CompilerConfiguration

getStatementContexts

public Map<String,String> getStatementContexts()

Specified by:

getStatementContexts in interface CompilerConfiguration

getStaleMillis

public int getStaleMillis()

Specified by:

getStaleMillis in interface CompilerConfiguration

isIncludesAllSourceRoots

public boolean isIncludesAllSourceRoots()

Specified by:

isIncludesAllSourceRoots in interface CompilerConfiguration

isUseFullyQualifiedJavaLang

public boolean isUseFullyQualifiedJavaLang()

Specified by:

isUseFullyQualifiedJavaLang in interface CompilerConfiguration

getTestSources

public TestSources getTestSources()

Specified by:

getTestSources in interface CompilerConfiguration

failIfInstallPhaseIsPresent

protected void failIfInstallPhaseIsPresent(BuildLifecycleAnalyzer lifecycleAnalyzer)
                                    throws org.apache.maven.plugin.MojoExecutionException

Check if the build life cycle contains the 'install' phase.

Parameters:

lifecycleAnalyzer - analyser

Throws:

org.apache.maven.plugin.MojoExecutionException - if 'install' phase is present

failIfDeployPhaseIsPresent

protected void failIfDeployPhaseIsPresent(BuildLifecycleAnalyzer lifecycleAnalyzer)
                                   throws org.apache.maven.plugin.MojoExecutionException

Check if the build life cycle contains the 'deploy' phase.

Parameters:

lifecycleAnalyzer - analyser

Throws:

org.apache.maven.plugin.MojoExecutionException - if 'deploy' phase is present

failIfCustomClassifierIsPresent

protected void failIfCustomClassifierIsPresent()
                                        throws org.apache.maven.plugin.MojoExecutionException

Check if an artifact has a custom classifier (except the 'javadoc' and 'sources' ones). If a custom classifier is present then adding a second 'clover' classifier may not work correctly as Maven does not support multiple classifiers.

Throws:

org.apache.maven.plugin.MojoExecutionException - if custom classifier is present