jacoco:prepare-agent
Full name:
org.jacoco:jacoco-maven-plugin:0.7.1.201405082137:prepare-agent
Description:
Prepares a property pointing to the JaCoCo runtime agent that can be passed as a VM argument to the application under test. Depending on the project packaging type by default a property with the following name is set:
- tycho.testArgLine for packaging type eclipse-test-plugin and
- argLine otherwise.
Note that these properties must not be overwritten by the test configuration, otherwise the JaCoCo agent cannot be attached. If you need custom parameters please append them. For example:
<argLine>${argLine} -your -extra -arguments</argLine>
Resulting coverage information is collected during execution and by default written to a file when the process terminates.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
runtime
. - The goal is thread-safe and supports parallel builds.
- Since version:
0.5.3
. - Binds by default to the lifecycle phase:
initialize
.
Optional Parameters
Name | Type | Since | Description |
address |
String
|
0.5.3
|
IP address or hostname to bind to when the output method is
tcpserver or connect to when the output method is tcpclient. In
tcpserver mode the value "*" causes the agent to accept connections
on any local address. |
append |
Boolean
|
0.5.3
|
If set to true and the execution data file already exists, coverage
data is appended to the existing file. If set to false, an existing
execution data file will be replaced. |
classDumpDir |
File
|
0.5.3
|
If a directory is specified for this parameter the JaCoCo agent
dumps all class files it processes to the given location. This can
be useful for debugging purposes or in case of dynamically created
classes for example when scripting engines are used. |
destFile |
File
|
0.5.3
|
Path to the output file for execution data. Default value is: ${project.build.directory}/jacoco.exec . |
dumpOnExit |
Boolean
|
0.5.3
|
If set to true coverage data will be written on VM shutdown. |
exclClassLoaders |
String
|
0.5.3
|
A list of class loader names, that should be excluded from
execution analysis. The list entries are separated by a colon (:)
and may use wildcard characters (* and ?). This option might be
required in case of special frameworks that conflict with JaCoCo
code instrumentation, in particular class loaders that do not have
access to the Java runtime classes. |
excludes |
List
|
0.5.3
|
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
|
0.5.3
|
A list of class files to include in
instrumentation/analysis/reports. May use wildcard characters (*
and ?). When not specified everything will be included. |
jmx |
Boolean
|
0.5.3
|
If set to true the agent exposes functionality via JMX. |
output |
String
|
0.5.3
|
Output method to use for writing coverage data. Valid options are:
|
port |
Integer
|
0.5.3
|
Port to bind to when the output method is tcpserver or connect to
when the output method is tcpclient. In tcpserver mode the port
must be available, which means that if multiple JaCoCo agents
should run on the same machine, different ports have to be
specified. |
propertyName |
String
|
0.5.3
|
Allows to specify property which will contains settings for JaCoCo
Agent. If not specified, then "argLine" would be used for "jar"
packaging and "tycho.testArgLine" for "eclipse-test-plugin". |
sessionId |
String
|
0.5.3
|
A session identifier that is written with the execution data.
Without this parameter a random identifier is created by the agent. |
skip |
boolean
|
0.5.3
|
Flag used to suppress execution. Default value is: false . |
Parameter Details
IP address or hostname to bind to when the output method is
tcpserver or connect to when the output method is tcpclient. In
tcpserver mode the value "*" causes the agent to accept connections
on any local address.
-
Type:
java.lang.String
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.address}
If set to true and the execution data file already exists, coverage
data is appended to the existing file. If set to false, an existing
execution data file will be replaced.
-
Type:
java.lang.Boolean
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.append}
If a directory is specified for this parameter the JaCoCo agent
dumps all class files it processes to the given location. This can
be useful for debugging purposes or in case of dynamically created
classes for example when scripting engines are used.
-
Type:
java.io.File
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.classDumpDir}
Path to the output file for execution data.
-
Type:
java.io.File
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.destFile}
-
Default:
${project.build.directory}/jacoco.exec
If set to true coverage data will be written on VM shutdown.
-
Type:
java.lang.Boolean
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.dumpOnExit}
A list of class loader names, that should be excluded from
execution analysis. The list entries are separated by a colon (:)
and may use wildcard characters (* and ?). This option might be
required in case of special frameworks that conflict with JaCoCo
code instrumentation, in particular class loaders that do not have
access to the Java runtime classes.
-
Type:
java.lang.String
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.exclClassLoaders}
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
-
Since:
0.5.3
-
Required:
No
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
-
Since:
0.5.3
-
Required:
No
jmx:
If set to true the agent exposes functionality via JMX.
-
Type:
java.lang.Boolean
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.jmx}
Output method to use for writing coverage data. Valid options are:
- file: At VM termination execution data is written to a file.
- tcpserver: The agent listens for incoming connections on the
TCP port specified by the
address
andport
. Execution data is written to this TCP connection. - tcpclient: At startup the agent connects to the TCP port
specified by the
address
andport
. Execution data is written to this TCP connection. - none: Do not produce any output.
-
Type:
java.lang.String
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.output}
port:
Port to bind to when the output method is tcpserver or connect to
when the output method is tcpclient. In tcpserver mode the port
must be available, which means that if multiple JaCoCo agents
should run on the same machine, different ports have to be
specified.
-
Type:
java.lang.Integer
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.port}
Allows to specify property which will contains settings for JaCoCo
Agent. If not specified, then "argLine" would be used for "jar"
packaging and "tycho.testArgLine" for "eclipse-test-plugin".
-
Type:
java.lang.String
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.propertyName}
A session identifier that is written with the execution data.
Without this parameter a random identifier is created by the agent.
-
Type:
java.lang.String
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.sessionId}
skip:
Flag used to suppress execution.
-
Type:
boolean
-
Since:
0.5.3
-
Required:
No
-
Expression:
${jacoco.skip}
-
Default:
false