Built by Maven

jacoco-extras:xml

Full name:

de.dentrassi.maven:jacoco-extras:0.1.4:xml

Description:

Convert binary execution data to XML report including dependencies.
This mojo will convert the binary jacoco execution data into the same format as the XML report. But it will take all module dependencies into consideration. This may be helpful when tools actually require XML data, but tests in a module are responsible for testing classes in other modules.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
execFile File - The jacoco execution data
If this file doesn't exist, execution of this plugin will be skipped
Default value is: ${project.build.directory}/jacoco.exec.
User property is: jacoco.extras.execFile.
xmlFile File - The output XML file
Default value is: ${project.build.directory}/jacoco.xml.
User property is: jacoco.extras.xmlFile.

Optional Parameters

Name Type Since Description
deleteRaw boolean 0.1.2 When pretty printing, if the original file should be deleted.
Default value is: true.
User property is: jacoco.extras.deleteRaw.
excludes List - Exclude patterns. The default is to exclude nothing.
includes List - Include patterns. The default is to include everything.
pretty boolean 0.1.2 If the XML file should be pretty printed.
Default value is: true.
User property is: jacoco.extras.pretty.
scopes String[] - Scopes to consider for dependencies.
Default value is: compile,runtime,provided,test.
User property is: jacoco.extras.scopes.
skip boolean - Allows to skip the execution
Default value is: false.
User property is: jacoco.extras.skip.
sourceEncoding String - The encoding of the source files
Default value is: UTF-8.
User property is: project.build.sourceEncoding.
transientDependencies boolean - Process transient dependencies.
Default value is: true.
User property is: jacoco.extras.transientDependencies.

Parameter Details

deleteRaw:

When pretty printing, if the original file should be deleted.
  • Type: boolean
  • Since: 0.1.2
  • Required: No
  • User Property: jacoco.extras.deleteRaw
  • Default: true

excludes:

Exclude patterns. The default is to exclude nothing.
  • Type: java.util.List
  • Required: No

execFile:

The jacoco execution data
If this file doesn't exist, execution of this plugin will be skipped
  • Type: java.io.File
  • Required: Yes
  • User Property: jacoco.extras.execFile
  • Default: ${project.build.directory}/jacoco.exec

includes:

Include patterns. The default is to include everything.
  • Type: java.util.List
  • Required: No

pretty:

If the XML file should be pretty printed.
  • Type: boolean
  • Since: 0.1.2
  • Required: No
  • User Property: jacoco.extras.pretty
  • Default: true

scopes:

Scopes to consider for dependencies.
  • Type: java.lang.String[]
  • Required: No
  • User Property: jacoco.extras.scopes
  • Default: compile,runtime,provided,test

skip:

Allows to skip the execution
  • Type: boolean
  • Required: No
  • User Property: jacoco.extras.skip
  • Default: false

sourceEncoding:

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

transientDependencies:

Process transient dependencies.
  • Type: boolean
  • Required: No
  • User Property: jacoco.extras.transientDependencies
  • Default: true

xmlFile:

The output XML file
  • Type: java.io.File
  • Required: Yes
  • User Property: jacoco.extras.xmlFile
  • Default: ${project.build.directory}/jacoco.xml