AgentOptions fails to parse options where destfile contains a comma

[jochenberger]

Caused by: java.lang.IllegalArgumentException: Invalid agent option syntax "destfile=build/jacoco/foo, bar.exec,append=true,dumponexit=true,output=file,jmx=false".
    at org.jacoco.agent.rt.internal_932a715.core.runtime.AgentOptions.<init>(AgentOptions.java:192)
    at org.jacoco.agent.rt.internal_932a715.PreMain.premain(PreMain.java:43)

[marchof]

@jochenberger Well, this is a limitation of the current agent options syntax. Any ideas for a syntax extension to properly handle such cases?

[jochenberger]

If your keys are always lowercase letters, I suggest a RegExp-based approach

String optionString = "destfile=build/jacoco/foo, bar.exec,append=true,dumponexit=true,output=file,jmx=false"
Pattern p = ~",(?=[a-z]+=)"
String [] items = p.split(optionString)
assert items == ["destfile=build/jacoco/foo, bar.exec", "append=true", "dumponexit=true", "output=file", "jmx=false"]

[bjkail]

I'm not convinced it's worth the effort, but you could check if the first key is escaped=true and then parse the option string "manually" (without split) so that '' or whatever can be used as an escape char.

[marchof]

The agent parameter format has its limitations. Also file names with = characters will fail to parse.

Also built-in agents fail to parse such file names, e.g.

> java -Xrunhprof:file=a,b.txt Example
HPROF ERROR: hprof option error: Unknown option: b.txt (file=a,b.txt) [hprof_init.c:495]

Therefore I tempted to close this as "wontfix". If we have a compelling use case I would rather suggest to offer an alternative way to configure the agent (e.g. property file) which does not have such syntax limitations. For offline instrumentation this is already supported.

[jochenberger]

My suggested fix also works for = in the file name.

[Godin]

I also wonder about strong use case for comma in filename.

[jochenberger]

Well, I have a directory that contains a comma. And I wonder why jacoco should explicitly forbid that.

[marchof]

Thanks for contributing this fix! I just merged #359.

[Godin]

@marchof I'm reopening this ticket, because I had hard time debugging patch for Gradle for new configuration option and this change was the root cause:

$ java -cp . -javaagent:jacocoagent-0.7.5.jar=dumponexit=true,inclNoLocationClasses=true Main
Exception in thread "main" java.lang.reflect.InvocationTargetException
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:606)
        at sun.instrument.InstrumentationImpl.loadClassAndStartAgent(InstrumentationImpl.java:382)
        at sun.instrument.InstrumentationImpl.loadClassAndCallPremain(InstrumentationImpl.java:397)
Caused by: java.lang.IllegalArgumentException: Unknown agent option "inclNoLocationClasses".
        at org.jacoco.agent.rt.internal_b0d6a23.core.runtime.AgentOptions.<init>(AgentOptions.java:210)
        at org.jacoco.agent.rt.internal_b0d6a23.PreMain.premain(PreMain.java:43)
        ... 6 more

$ java -cp . -javaagent:jacocoagent-0.7.6-SNAPSHOT.jar=dumponexit=true,inclNoLocationClasses=true Main
OK

$ java -cp . -javaagent:jacocoagent-0.7.6-SNAPSHOT.jar=dumponexit=true,inclnolocationclasses=true Main
OK

Notice incorrect spelling in second case - instead it should be lowercase inclnolocationclasses.

[Godin]

And same happens with existing options:

$ ls *.exec
zsh: no matches found: *.exec

$ java -cp . -javaagent:jacocoagent-0.7.6-SNAPSHOT.jar=dumponexit=true,destFile=dest.exec Main
OK

$ ls *.exec
jacoco.exec

$ java -cp . -javaagent:jacocoagent-0.7.5.jar=dumponexit=true,destFile=dest.exec Main
Exception in thread "main" java.lang.reflect.InvocationTargetException
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:606)
        at sun.instrument.InstrumentationImpl.loadClassAndStartAgent(InstrumentationImpl.java:382)
        at sun.instrument.InstrumentationImpl.loadClassAndCallPremain(InstrumentationImpl.java:397)
Caused by: java.lang.IllegalArgumentException: Unknown agent option "destFile".
        at org.jacoco.agent.rt.internal_b0d6a23.core.runtime.AgentOptions.<init>(AgentOptions.java:210)
        at org.jacoco.agent.rt.internal_b0d6a23.PreMain.premain(PreMain.java:43)
        ... 6 more

[marchof]

@Godin Thanks for discovering this! It's actually a bad regression.
Instead of rolling back we might fix it: see PR #376