Use system properties in Jacoco agent configuration

[debugger-zz]

New Feature enables Jacoco agent to output "exec" results to a platform dependent directory. Examples java.io.tempdir or user.home.

Example setting the agent's destfile in jacoco-agent.properties:

replaceproperties=true
destfile=${user.home}/coverage-data/coverage.exec

The replacement feature is disabled by default. It can be enabled by
adding replaceproperties=true in agent's
jacoco-agent.properties. Alternatively the file's
configuration can be overridden by the system property
-Djacoco-agent.replaceproperties=true on java command
line.

The initial escaping mechanism was removed due to conflicts with Windows paths and anonymous classes (for more details see documentation). Documentation has been updated and explains the effects of enabling replaceproperties.

[marchof]

Why should JaCoCo implement its own variable substitution? Ant, Maven, Shell, CMD Scripts all support this already.

[debugger-zz]

For an offline instrumented build you cannot specify a dest file that is in a writable platform independent location. Adding the variable replacement allows to perform instrumented integration tests on different platforms and always outputting to the home directory.

[buildhive]

Java Code Coverage Tools » jacoco #321 SUCCESS
This pull request looks good
(what's this?)

[marchof]

Valid point. What configuration mechanism do you have in mind?

http://www.eclemma.org/jacoco/trunk/doc/offline.html

[debugger-zz]

I want to deploy a jacoco-agent.properties file as described in my initial comment.
The integration builds are run outside of maven and possibly on different platforms so I need a way to guarantee the output goes to the systems temp directory or the users home directory.
For Java applet's running in the browser the default working directory ("user.dir") is "C:\Program Files\Firefox" so I need a way to change it to something user writable.

[debugger-zz]

I did not update the documentation in offline instrumentation as it should also work for online instrumentation. Except if I did overlook something.

[buildhive]

Java Code Coverage Tools » jacoco #322 SUCCESS
This pull request looks good
(what's this?)

[marchof]

You implementation only works for offline parameters (properties files and system properties) which I think is ok. So documentation only applies to offline.html. As this is limited to offline instrumentation I don't think you need replaceproperties. Replacement could be allways active.

[debugger-zz]

Oh, I did not realize this only works in Offline-instrumentation. I wasn't aware of the class AgentOptions in org.jacoco.core. I fear overtime a use case for Online-instrumentation with such a mechanism might come up. I don't mind removing "replaceproperties". Anything else you want me to change?

[marchof]

Finally I found some time to bring this feature into master. I created a new single commit 0092055 with the following modifications:

• simplified replacement implementation
• documentation for offline configuration only
• change log (including attribution)