jacoco:check
Full name:
org.jacoco:jacoco-maven-plugin:0.6.2.201302030002:check
Description:
Checks that the code coverage metrics are being met.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
verify
.
Required Parameters
Name | Type | Since | Description |
check |
CheckConfiguration
|
-
|
Check configuration. Used to specify minimum coverage percentages that must be met. Defaults to 0% if a percentage ratio is not specified. Example requiring 100% coverage for class, instruction, method, branch, complexity, and line:
|
haltOnFailure |
boolean
|
-
|
Halt the build if any of the checks fail. Default value is: true . |
Optional Parameters
Name | Type | Since | Description |
dataFile |
File
|
-
|
File with execution data. Default value is: ${project.build.directory}/jacoco.exec . |
excludes |
List
|
-
|
A list of class files to exclude from
instrumentation/analysis/reports. May use wildcard characters (*
and ?). When not specified nothing will be excluded. |
includes |
List
|
-
|
A list of class files to include in
instrumentation/analysis/reports. May use wildcard characters (*
and ?). When not specified everything will be included. |
skip |
boolean
|
-
|
Flag used to suppress execution. Default value is: false . |
Parameter Details
Check configuration. Used to specify minimum coverage percentages that must be met. Defaults to 0% if a percentage ratio is not specified.
Example requiring 100% coverage for class, instruction, method, branch, complexity, and line:
<check>
<classRatio>100</classRatio>
<instructionRatio>100</instructionRatio>
<methodRatio>100</methodRatio>
<branchRatio>100</branchRatio>
<complexityRatio>100</complexityRatio>
<lineRatio>100</lineRatio>
</check>
-
Type:
org.jacoco.maven.CheckConfiguration
-
Required:
Yes
File with execution data.
-
Type:
java.io.File
-
Required:
No
-
Default:
${project.build.directory}/jacoco.exec
A list of class files to exclude from
instrumentation/analysis/reports. May use wildcard characters (*
and ?). When not specified nothing will be excluded.
-
Type:
java.util.List
-
Required:
No
Halt the build if any of the checks fail.
-
Type:
boolean
-
Required:
Yes
-
Expression:
${jacoco.haltOnFailure}
-
Default:
true
A list of class files to include in
instrumentation/analysis/reports. May use wildcard characters (*
and ?). When not specified everything will be included.
-
Type:
java.util.List
-
Required:
No
skip:
Flag used to suppress execution.
-
Type:
boolean
-
Required:
No
-
Expression:
${jacoco.skip}
-
Default:
false