clover:save-history

Full name:

org.openclover:clover-maven-plugin:4.5.2:save-history

Description:

Save a Clover history point.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

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: ${project.build.directory}/clover/cloverMerge.db
User Property: maven.clover.cloverMergeDatabase
<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: ${project.build.directory}/clover
<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: ${project.build.directory}/clover/history
User Property: maven.clover.historyDir
<project> MavenProject -

The Maven project instance for the executing project.

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


Default: ${project}

Optional Parameters

Name Type Since Description
<cloverDatabase> String - The location of the Clover database.
User Property: maven.clover.cloverDatabase
<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: false
User Property: maven.clover.debug
<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: 500
User Property: maven.clover.flushInterval
<license> String - The full Clover license String to use. If supplied, this certificate will be used over com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.licenseLocation. NB. newline chars must be preserved. If not provided, Clover will use a bundled license key.
See also: com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.licenseLocation
User Property: maven.clover.license
<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. If not provided, Clover will use a bundled license key.
See also: com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.license
User Property: maven.clover.licenseLocation
<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: false
User Property: maven.clover.singleCloverDatabase
<skip> boolean - A flag to indicate not to run clover for this execution. If set to true, Clover will not be run.
Default: false
User Property: maven.clover.skip
<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.
User Property: maven.clover.snapshot
<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: true
User Property: maven.clover.waitForFlush

Parameter Details

<cloverDatabase>

The location of the Clover database.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: 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: report.plugin.goal.yes
  • User Property: 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: report.plugin.goal.yes
  • Default: ${project.build.directory}/clover

<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: report.plugin.goal.no
  • User Property: maven.clover.debug
  • Default: false

<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: report.plugin.goal.no
  • User Property: maven.clover.flushInterval
  • Default: 500

<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: report.plugin.goal.yes
  • User Property: maven.clover.historyDir
  • Default: ${project.build.directory}/clover/history

<license>

The full Clover license String to use. If supplied, this certificate will be used over com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.licenseLocation. NB. newline chars must be preserved. If not provided, Clover will use a bundled license key.
See also: com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.licenseLocation
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: 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. If not provided, Clover will use a bundled license key.
See also: com.atlassian.maven.plugin.clover.internal.AbstractCloverMojo.license
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: maven.clover.licenseLocation

<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: report.plugin.goal.yes
  • Default: ${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: report.plugin.goal.no
  • User Property: 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: report.plugin.goal.no
  • User Property: 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: report.plugin.goal.no
  • User Property: maven.clover.snapshot

<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: report.plugin.goal.no
  • User Property: maven.clover.waitForFlush
  • Default: true