com.atlassian.maven.plugin.clover

Class CloverInstrumentMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

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

com.atlassian.maven.plugin.clover.CloverInstrumentMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CloverInstrumentTestMojo

@Execute(phase=INSTALL,
         goal="instrument",
         lifecycle="clover")
 @Mojo(name="instrument")
public class CloverInstrumentMojo
extends AbstractCloverInstrumentMojo

Fork a custom build lifecycle in which all sources will be instrumented by Clover and next execute this lifecycle till the install phase. All instrumented classes will be stored in a separate directory. Similarly, artifacts produced will have the 'clover' classifier.

This goal is forking a lifecycle because we don't want the Clover instrumentation to affect the main lifecycle build. This will prevent instrumented sources to be put in production by error. Thus running mvn install on a project where this instrument goal has been specified will run the build twice: once for building the project as usual and another time for instrumenting the sources with Clover and generating the Clover database.

Attention: Maven does not support multiple classifiers for an artifact. In case your project creates artifacts with classifiers, it may happen that the 'clover' classifier will be lost and an instrumented artifact will be installed as non-instrumented one.

Example: clover:instrument + jar:test-jar + install:install

     [INFO] --- maven-jar-plugin:2.6:test-jar (default) @ moneybags ---
     [INFO] Building jar: .../moneybags-1.0-SNAPSHOT-clover-tests.jar <<< file with double classifier was created
     [INFO] --- maven-install-plugin:2.5.2:install (default-install) @ moneybags ---
     [INFO] Installing .../moneybags-1.0-SNAPSHOT-clover-tests.jar to
            ~/.m2/.../moneybags-1.0-SNAPSHOT-tests.jar <<< but 'clover' classifier was lost
 

In order to avoid this, you can use the instrument-test goal, which runs a forked lifecycle till the test phase.

Field Summary

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

cloveredArtifactExpiryInMillis, copyExcludedFiles, distributedCoverage, encoding, excludes, excludesFile, excludesList, flushPolicy, groverJar, includes, includesAllSourceRoots, includesFile, includesList, includesTestSourceRoots, instrumentation, jdk, methodContexts, methodWithMetricsContexts, repositoryPollutionProtection, scope, setTestFailureIgnore, skipGroverJar, staleMillis, statementContexts, testSources, useCloverClassifier, useFullyQualifiedJavaLang

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
CloverInstrumentMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected boolean	shouldRedirectArtifacts()
protected boolean	shouldRedirectOutputDirectories()

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

failIfCustomClassifierIsPresent, failIfDeployPhaseIsPresent, failIfInstallPhaseIsPresent, getDistributedCoverage, getEncoding, getExcludes, getFlushPolicy, getIncludes, getInstrumentation, getInstrumentLambda, getJdk, getMethodContexts, getMethodWithMetricsContexts, getStaleMillis, getStatementContexts, getTestSources, isCopyExcludedFiles, isIncludesAllSourceRoots, isUseFullyQualifiedJavaLang

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

Constructor Detail

CloverInstrumentMojo

public CloverInstrumentMojo()

Method Detail

execute

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

Specified by:

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

Overrides:

execute in class AbstractCloverInstrumentMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

AbstractCloverMojo.execute()

shouldRedirectArtifacts

protected boolean shouldRedirectArtifacts()

Specified by:

shouldRedirectArtifacts in class AbstractCloverInstrumentMojo

shouldRedirectOutputDirectories

protected boolean shouldRedirectOutputDirectories()

Specified by:

shouldRedirectOutputDirectories in class AbstractCloverInstrumentMojo