Extension for tasks that should run with a Jacoco agent to generate coverage execution data.
Modifiers | Name | Description |
---|---|---|
enum |
JacocoTaskExtension.Output |
The types of output that the agent can use for execution data. |
Type | Name and description |
---|---|
String |
address IP address or hostname to use with Output#TCP_SERVER#TCP_SERVER or Output#TCP_CLIENT#TCP_CLIENT. |
JacocoAgentJar |
agent |
boolean |
append Whether or not data should be appended if the destinationFile
already exists. |
File |
classDumpFile Path to dump all class files the agent sees are dumped to. |
File |
destinationFile The path for the execution data to be written to. |
boolean |
dumpOnExit Whether or not to dump the coverage data at VM shutdown. |
boolean |
enabled Whether or not the task should generate execution data. |
List<String> |
excludeClassLoaders List of classloader names that should be excluded from analysis. |
List<String> |
excludes List of class names that should be excluded from analysis. |
List<String> |
includes List of class names that should be included in analysis. |
boolean |
jmx Whether or not to expose functionality via JMX under org.jacoco:type=Runtime .
|
JacocoTaskExtension.Output |
output THe type of output to generate. |
int |
port Port to bind to for Output#TCP_SERVER#TCP_SERVER or Output#TCP_CLIENT#TCP_CLIENT. |
String |
sessionId An identifier for the session written to the execution data. |
Constructor and description |
---|
JacocoTaskExtension
(JacocoAgentJar agent, JavaForkOptions task) Creates a Jacoco task extension. |
Type | Name and description |
---|---|
String |
getAsJvmArg() Gets all properties in the format expected of the agent JVM argument. |
IP address or hostname to use with Output#TCP_SERVER#TCP_SERVER or Output#TCP_CLIENT#TCP_CLIENT. Defaults to localhost.
Whether or not data should be appended if the destinationFile
already exists. Defaults to true
.
Path to dump all class files the agent sees are dumped to. Defaults to no dumps.
The path for the execution data to be written to.
Whether or not to dump the coverage data at VM shutdown. Defaults to true
.
Whether or not the task should generate execution data.
Defaults to true
.
List of classloader names that should be excluded from analysis. Names can use wildcards (* and ?). Defaults to an empty list.
List of class names that should be excluded from analysis. Names can use wildcard (* and ?). Defaults to an empty list.
List of class names that should be included in analysis. Names can use wildcards (* and ?). If left empty, all classes will be included. Defaults to an empty list.
Whether or not to expose functionality via JMX under org.jacoco:type=Runtime
.
Defaults to false
.
The configuration of the jmx property is only taken into account if the used JaCoCo version
supports this option (JaCoCo version >= 0.6.2)
THe type of output to generate. Defaults to Output#FILE#FILE.
Port to bind to for Output#TCP_SERVER#TCP_SERVER or Output#TCP_CLIENT#TCP_CLIENT. Defaults to 6300.
An identifier for the session written to the execution data. Defaults to an auto-generated identifier.
Creates a Jacoco task extension.
project
- the project the task is attached toagent
- the agent JAR to use for analysisGets all properties in the format expected of the agent JVM argument.
Gradle API 2.0