clover:clover

Generate a Clover report from existing Clover databases. The generated report is an external report generated by Clover itself. If the project generating the report is a top level project and if the aggregate configuration element is set to true then an aggregated report will also be created.

Note: This report mojo should be an @aggregator and the clover:aggregate mojo shouldn't exist. This is a limitation of the site plugin which doesn't support @aggregator reports...

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name Type Description
cloverDatabase String The location of the Clover database.
cloverMergeDatabase String The location of the merged clover database to create when running a report in a multimodule build.
historyDir String The location where historical Clover data will be saved.

Note: It's recommended to modify the location of this directory so that it points to a more permanent location as the ${project.build.directory} directory is erased when the project is cleaned.

Default value is ${project.build.directory}/clover/history.
outputDirectory File The directory where the Clover report will be generated.

Optional Parameters

Name Type Description
contextFilters String Comma or space separated list of Clover contexts (block, statement or method filers) to exclude when generating coverage reports.
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.
generateHistorical boolean Decide whether to generate a Clover historical report or not. Default value is false.
generateHtml boolean Decide whether to generate an HTML report or not. Default value is true.
generatePdf boolean Decide whether to generate a PDF report or not. Default value is false.
generateXml boolean Decide whether to generate a XML report or not. Default value is false.
siteRenderer Renderer

Note: This is passed by Maven and must not be configured by the user.
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: Yes
  • Expression: ${project.build.directory}/clover/clover.db
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: ${project.build.directory}/clover/cloverMerge.db
contextFilters Comma or space separated list of Clover contexts (block, statement or method filers) to exclude when generating coverage reports.
  • Type: java.lang.String
  • Required: No
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
  • Default: 500
generateHistorical Decide whether to generate a Clover historical report or not.
  • Type: boolean
  • Required: No
  • Default: false
generateHtml Decide whether to generate an HTML report or not.
  • Type: boolean
  • Required: No
  • Default: true
generatePdf Decide whether to generate a PDF report or not.
  • Type: boolean
  • Required: No
  • Default: false
generateXml Decide whether to generate a XML report or not.
  • Type: boolean
  • Required: No
  • Default: false
historyDir The location where historical Clover data will be saved. Note: It's recommended to modify the location of this directory so that it points to a more permanent location as the ${project.build.directory} directory is erased when the project is cleaned.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.build.directory}/clover/history
outputDirectory The directory where the Clover report will be generated.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}/clover
siteRenderer Note: This is passed by Maven and must not be configured by the user.
  • Type: org.apache.maven.doxia.siterenderer.Renderer
  • Required: No
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
  • Default: true