cobertura:cobertura

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

Full name:

org.codehaus.mojo:cobertura-maven-plugin:2.7:cobertura

Description:

Instrument the compiled classes, run the unit tests and generate a Cobertura report.

Attributes:

  • Requires a Maven project to be executed.
  • Invokes the execution of the lifecycle phase test prior to executing itself.
  • Executes in its own lifecycle: cobertura.

Required Parameters

Name Type Since Description
outputDirectory File - The output directory for the report.
Default value is: ${project.reporting.outputDirectory}/cobertura.

Optional Parameters

Name Type Since Description
aggregate boolean 2.5 Generate aggregate reports in multi-module projects.
Default value is: false.
User property is: cobertura.aggregate.
encoding String 2.4 The encoding for the java source code files.
Default value is: UTF-8.
User property is: project.build.sourceEncoding.
format String - The format of the report. Supports 'html' or 'xml'. Defaults to 'html'.
User property is: cobertura.report.format.
formats String[] - The formats of the report. Can be 'html' and/or 'xml'. Defaults to 'html'.
maxmem String - Maximum memory to pass to the JVM for Cobertura processes.
User property is: cobertura.maxmem.
omitGplFiles boolean 2.5 Whether to remove GPL licensed files from the generated report. This is required to distribute the report as part of a distribution, which is licensed under the ASL, or a similar license, which is incompatible with the GPL.
Default value is: false.
User property is: cobertura.omitGplFiles.
quiet boolean 2.1 Only output Cobertura errors, avoid info messages.
Default value is: false.
User property is: quiet.

Parameter Details

aggregate:

Generate aggregate reports in multi-module projects.
  • Type: boolean
  • Since: 2.5
  • Required: No
  • User Property: cobertura.aggregate
  • Default: false

encoding:

The encoding for the java source code files.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • User Property: project.build.sourceEncoding
  • Default: UTF-8

format:

The format of the report. Supports 'html' or 'xml'. Defaults to 'html'.
  • Type: java.lang.String
  • Required: No
  • User Property: cobertura.report.format

formats:

The formats of the report. Can be 'html' and/or 'xml'. Defaults to 'html'.
  • Type: java.lang.String[]
  • Required: No

maxmem:

Maximum memory to pass to the JVM for Cobertura processes.
  • Type: java.lang.String
  • Required: No
  • User Property: cobertura.maxmem

omitGplFiles:

Whether to remove GPL licensed files from the generated report. This is required to distribute the report as part of a distribution, which is licensed under the ASL, or a similar license, which is incompatible with the GPL.
  • Type: boolean
  • Since: 2.5
  • Required: No
  • User Property: cobertura.omitGplFiles
  • Default: false

outputDirectory:

The output directory for the report.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}/cobertura

quiet:

Only output Cobertura errors, avoid info messages.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: quiet
  • Default: false