clover2:check

Full name:

com.atlassian.maven.plugins:maven-clover2-plugin:3.0.0-m4r3:check

Description:

Verify Test Percentage Coverage (TPC) from an existing Clover database and fail the build if it is below the defined threshold. The check is done on main Clover databases and also on merged Clover databases when they exist.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
cloverMergeDatabase String - The location of the merged clover database to create when running a report in a multimodule build. Default value is: ${project.build.directory}/clover/cloverMerge.db.
cloverOutputDirectory String - The directory where the Clover plugin will put all the files it generates during the build process. For example the Clover plugin will put instrumented sources somewhere inside this directory. Default value is: ${project.build.directory}/clover.
project MavenProject - The Maven project instance for the executing project.

Note: This is passed by Maven and must not be configured by the user.

Optional Parameters

Name Type Since Description
cloverDatabase String - The location of the Clover database.
conditionalPercentage String - The Test Percentage Conditional Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.
contextFilters String - Comma or space separated list of Clover contexts (block, statement or method filers) to exclude before performing the check.
debug boolean - If you wish to enable debug level logging in just the Clover plugin, set this to true. This is useful for integrating Clover into the build Default value is: false.
failOnViolation boolean - Do we fail the build on a violation? The default is true but there are some edge cases where you want to be able to check what would fail but without actually failing the build. For example you may want to let the build continue so that you can verify others checks that are executed after the Clover checks. Default value is: true.
flushInterval int - When the Clover Flush Policy is set to "interval" or threaded this value is the minimum period between flush operations (in milliseconds). Default value is: 500.
flushPolicy String - The Clover flush policy to use. Valid values are directed, interval and threaded. Default value is: threaded.
historyDir File - The location where historical Clover data is located.

Allows you to specify a location for historical build data, along with a configurable threshold expressed as a percentage ? used to cause the build to fail if coverage has dropped. This attribute is passed down to specified packages, then the same test is done for these at the package level. This will only be used if there is no targetPercentage parameter set.

Default value is: ${project.build.directory}/clover/history.
historyThreshold String - The percentage threshold to use if clover-check is checking coverage against historical clover data. This is the amount of leeway to use when comparing the current build's coverage with that of the last build. Default value is: 0%.
jdk String - Whether the Clover instrumentation should use the Clover jdk14, jdk15 or jdk16 flags to parse sources. Valid values are 1.4, 1.5 and 1.6 .
license String - The full Clover license String to use. If supplied, this certificate will be used over licenseLocation. NB. newline chars must be preserved. A trial Clover license can be generated here.
licenseLocation String - A Clover license file to be used by the plugin. The plugin tries to resolve this parameter first as a resource, then as a URL, and then as a file location on the filesystem. A trial Clover license can be generated here.
methodPercentage String - The Test Percentage Method Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.
singleCloverDatabase boolean - If true, then a single cloverDatabase will be used for the entire project. This flag will be ignored if a custom cloverDatabase location is specified. Default value is: false.
skip boolean - A flag to indicate not to run clover for this execution. If set to true, Clover will not be run. Default value is: false.
snapshot File - The location to store the clover snapshot file. This file needs to persist between builds to enable Clover's build optimization feature. If not specified, the snapshot will be stored next to the cloverDatabase.
statementPercentage String - The Test Percentage Statement Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.
targetPercentage String - The Test Percentage Coverage (TPC) threshold under which the plugin will report an error and fail the build.
waitForFlush boolean - If true we'll wait 2*flushInterval to ensure coverage data is flushed to the Clover database before running any query on it.

Note: The only use case where you would want to turn this off is if you're running your tests in a separate JVM. In that case the coverage data will be flushed by default upon the JVM shutdown and there would be no need to wait for the data to be flushed. As we can't control whether users want to fork their tests or not, we're offering this parameter to them.

Default value is: true.

Parameter Details

cloverDatabase:

The location of the Clover database.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.cloverDatabase}

cloverMergeDatabase:

The location of the merged clover database to create when running a report in a multimodule build.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${maven.clover.cloverMergeDatabase}
  • Default: ${project.build.directory}/clover/cloverMerge.db

cloverOutputDirectory:

The directory where the Clover plugin will put all the files it generates during the build process. For example the Clover plugin will put instrumented sources somewhere inside this directory.

  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.build.directory}/clover

conditionalPercentage:

The Test Percentage Conditional Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.conditionalPercentage}

contextFilters:

Comma or space separated list of Clover contexts (block, statement or method filers) to exclude before performing the check.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.contextFilters}

debug:

If you wish to enable debug level logging in just the Clover plugin, set this to true. This is useful for integrating Clover into the build

  • Type: boolean
  • Required: No
  • Expression: ${maven.clover.debug}
  • Default: false

failOnViolation:

Do we fail the build on a violation? The default is true but there are some edge cases where you want to be able to check what would fail but without actually failing the build. For example you may want to let the build continue so that you can verify others checks that are executed after the Clover checks.

  • Type: boolean
  • Required: No
  • Expression: ${maven.clover.failOnViolation}
  • Default: true

flushInterval:

When the Clover Flush Policy is set to "interval" or threaded this value is the minimum period between flush operations (in milliseconds).

  • Type: int
  • Required: No
  • Expression: ${maven.clover.flushInterval}
  • Default: 500

flushPolicy:

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

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.flushPolicy}
  • Default: threaded

historyDir:

The location where historical Clover data is located.

Allows you to specify a location for historical build data, along with a configurable threshold expressed as a percentage ? used to cause the build to fail if coverage has dropped. This attribute is passed down to specified packages, then the same test is done for these at the package level. This will only be used if there is no targetPercentage parameter set.

  • Type: java.io.File
  • Required: No
  • Expression: ${maven.clover.historyDir}
  • Default: ${project.build.directory}/clover/history

historyThreshold:

The percentage threshold to use if clover-check is checking coverage against historical clover data. This is the amount of leeway to use when comparing the current build's coverage with that of the last build.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.historyThreshold}
  • Default: 0%

jdk:

Whether the Clover instrumentation should use the Clover jdk14, jdk15 or jdk16 flags to parse sources. Valid values are 1.4, 1.5 and 1.6 .

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.jdk}

license:

The full Clover license String to use. If supplied, this certificate will be used over licenseLocation. NB. newline chars must be preserved. A trial Clover license can be generated here.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.license}

licenseLocation:

A Clover license file to be used by the plugin. The plugin tries to resolve this parameter first as a resource, then as a URL, and then as a file location on the filesystem. A trial Clover license can be generated here.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.licenseLocation}

methodPercentage:

The Test Percentage Method Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.methodPercentage}

project:

The Maven project instance for the executing project.

Note: This is passed by Maven and must not be configured by the user.

  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Expression: ${project}

singleCloverDatabase:

If true, then a single cloverDatabase will be used for the entire project. This flag will be ignored if a custom cloverDatabase location is specified.

  • Type: boolean
  • Required: No
  • Expression: ${maven.clover.singleCloverDatabase}
  • Default: false

skip:

A flag to indicate not to run clover for this execution. If set to true, Clover will not be run.

  • Type: boolean
  • Required: No
  • Expression: ${maven.clover.skip}
  • Default: false

snapshot:

The location to store the clover snapshot file. This file needs to persist between builds to enable Clover's build optimization feature. If not specified, the snapshot will be stored next to the cloverDatabase.

  • Type: java.io.File
  • Required: No
  • Expression: ${maven.clover.snapshot}

statementPercentage:

The Test Percentage Statement Coverage (TPC) threshold under which the plugin will report an error and fail the build. If maven.clover.targetPercentage is not specified, then this value is ignored.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.statementPercentage}

targetPercentage:

The Test Percentage Coverage (TPC) threshold under which the plugin will report an error and fail the build.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.targetPercentage}

waitForFlush:

If true we'll wait 2*flushInterval to ensure coverage data is flushed to the Clover database before running any query on it.

Note: The only use case where you would want to turn this off is if you're running your tests in a separate JVM. In that case the coverage data will be flushed by default upon the JVM shutdown and there would be no need to wait for the data to be flushed. As we can't control whether users want to fork their tests or not, we're offering this parameter to them.

  • Type: boolean
  • Required: No
  • Expression: ${maven.clover.waitForFlush}
  • Default: true