clover2:clover

Note: This Mojo should be used as a Maven report.

Full name:

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

Description:

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...

Attributes:

  • Requires a Maven 2.0 project to be executed.

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.
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. Default value is: ${project.reporting.outputDirectory}/clover.

Optional Parameters

Name Type Since Description
alwaysReport boolean - If set to true, a report will be generated even in the absence of coverage data. Default value is: true.
charset String - The charset to use in the html reports. Default value is: UTF-8.
cloverDatabase String - The location of the Clover database.
contextFilters String - Comma or space separated list of Clover somesrcexcluded (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.
generateJson boolean - Decide whether to generate a JSON report or not. Default value is: false.
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: true.
license String - (no description)
licenseLocation String - (no description)
localRepository ArtifactRepository - The local repository.
orderBy String - How to order coverage tables. Default value is: PcCoveredAsc.
reportDescriptor File - Use a custom report descriptor for generating your Clover Reports. The format for the configuration file is identical to an Ant build file which uses the <clover-report/> task. For a complete reference, please consult the clover-report documentation
repositories List - Remote repositories used for the project.
resolveReportDescriptor boolean - If set to true, the clover-report configuration file will be resolved as a versioned artifact by looking for it in your configured maven repositories - both remote and local. Default value is: false.
singleCloverDatabase boolean - If true, then a single database will be saved for the entire project, in the target directory of the execution root. If a custom location for the cloverDatabase is specified, this flag is ignored. Default value is: false.
span String - A span specifies the age of the coverage data that should be used when creating a report.
title String - Title of the report Default value is: ${project.name} ${project.version}.
titleAnchor String - Title anchor of the report Default value is: ${project.url}.
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

alwaysReport:

If set to true, a report will be generated even in the absence of coverage data.

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

charset:

The charset to use in the html reports.

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.charset}
  • Default: UTF-8

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

contextFilters:

Comma or space separated list of Clover somesrcexcluded (block, statement or method filers) to exclude when generating coverage reports.

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

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

generateHistorical:

Decide whether to generate a Clover historical report or not.

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

generateHtml:

Decide whether to generate an HTML report or not.

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

generateJson:

Decide whether to generate a JSON report or not.

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

generatePdf:

Decide whether to generate a PDF report or not.

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

generateXml:

Decide whether to generate a XML report or not.

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

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
  • Expression: ${maven.clover.historyDir}
  • Default: ${project.build.directory}/clover/history

license:

(no description)

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

licenseLocation:

(no description)

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

localRepository:

The local repository.

  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

orderBy:

How to order coverage tables.

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

outputDirectory:

The directory where the Clover report will be generated.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${maven.clover.outputDirectory}
  • Default: ${project.reporting.outputDirectory}/clover

reportDescriptor:

Use a custom report descriptor for generating your Clover Reports. The format for the configuration file is identical to an Ant build file which uses the <clover-report/> task. For a complete reference, please consult the clover-report documentation

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

repositories:

Remote repositories used for the project.

  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

resolveReportDescriptor:

If set to true, the clover-report configuration file will be resolved as a versioned artifact by looking for it in your configured maven repositories - both remote and local.

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

singleCloverDatabase:

If true, then a single database will be saved for the entire project, in the target directory of the execution root. If a custom location for the cloverDatabase is specified, this flag is ignored.

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

span:

A span specifies the age of the coverage data that should be used when creating a report.

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

title:

Title of the report

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.title}
  • Default: ${project.name} ${project.version}

titleAnchor:

Title anchor of the report

  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.clover.titleAnchor}
  • Default: ${project.url}

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