Невозможно использовать аргументы jacoco JVM и верные аргументы JVM вместе в maven
Я использую Maven сjacoco плагин для генерации метрик покрытия кода. У меня возникли трудности с настройкойбезошибочный плагин с параметрами Java, необходимыми дляjacoco плагин. Я уже видел некоторые ответы по этому поводу на Stack Overflow, но что-то не работает для меня.
У меня есть многомодульный проект, и один из моих модулей настраиваетбезошибочный Плагин выглядит следующим образом:
foo/pom.xml
:
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<argLine>-XX:MaxPermSize=512m</argLine>
</configuration>
</plugin>
</plugins>
Это работает как ожидалось.
Теперь я хочу включить jacoco для получения метрик покрытия кода, поэтому я добавилпокрытие кода профиль, который обрабатывает всю конфигурацию jacoco:
parent/pom.xml
:
<profile>
<id>CodeCoverage</id>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<executions>
<execution>
<id>jacoco-initialize</id>
<goals><goal>prepare-agent</goal></goals>
<configuration>
<propertyName>surefire.argLine</propertyName>
</configuration>
...
</execution>
<executions>
</plugin>
</plugins>
</pluginManagement>
</build>
</profile>
Здесь видно, что еслипокрытие кода профиль указывается, тоjacoco Плагин настроен на использованиеsurefire.argLine
свойство, и это свойство используется для настройкиargLine
длябезошибочный плагин.
Затем я обновилpom.xml файл дляFoo модуль для использованияsurefire.argLine
свойство, созданноеjacoco плагин:
foo/pom.xml
:
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<argLine>${surefire.argLine} -XX:MaxPermSize=512m</argLine>
</configuration>
</plugin>
</plugins>
Этот подход указан вjacoco документация плагина (см. [1]).
Когда я строюFoo модуль спокрытие кода В профиль я вижу следующее:
[foo] $ mvn clean install -X -PCodeCoverage
...
[INFO] --- jacoco-maven-plugin:0.7.0.201403182114:prepare-agent (jacoco-initialize) @ foo ---
[INFO] surefire.argLine set to -javaagent:...\\org.jacoco.agent\\0.7.0.201403182114\\org.jacoco.agent-0.7.0.201403182114-runtime.jar=destfile=...\foo\\\target\\coverage-reports\\jacoco-ut.exec
...
[DEBUG] Configuring mojo 'org.apache.maven.plugins:maven-surefire-plugin:2.13:test' with basic configurator -->
[DEBUG] (s) argLine = -javaagent:...\\org.jacoco.agent\\0.7.0.201403182114\\org.jacoco.agent-0.7.0.201403182114-runtime.jar=destfile=...\\foo\\target\\coverage-reports\\jacoco-ut.exec -XX:MaxPermSize=512m
...
[INFO] --- jacoco-maven-plugin:0.7.0.201403182114:report (jacoco-site) @ foo ---
[INFO] Analyzed bundle 'Foo' with 59 classes`
Итакjacoco плагин выполнен,surefire.argLine
свойство создано,argLine
длябезошибочный плагин используетsurefire.argLine
собственность и местныйMaxPermSize
аргумент иtarget\code-coverage\jacoc-ut-exec
файл генерируется, как и ожидалось.
Однако, если я не используюпокрытие кода профиль, то я получаю ошибку, потому что${surefire.argLine}
свойство (используется вfoo/pom.xml
) не создаетсяjacoco и не определен нигде:
[foo] $ mvn clean install -X
...
[DEBUG] Configuring mojo 'org.apache.maven.plugins:maven-surefire-plugin:2.13:test' with basic configurator -->
[DEBUG] (s) argLine = ${surefire.argLine} -XX:MaxPermSize=512m
...
Error: Could not find or load main class ${surefire.argLine}`
Синекjacoco плагин не был вызван, нетsurefire.argLine
свойство создано, следовательно ошибка.
Итак, я возвращаюсь кparent/pom.xml
и создайте это свойство без начального значения:
parent/pom.xml
:
<properties>
<surefire.argLine></surefire.argLine>
</properties>
Теперь, когда я строюFoo модуль без использованияпокрытие кода профиль, я не получаю ошибок:
[foo] $ mvn clean install -X
...
[DEBUG] Configuring mojo 'org.apache.maven.plugins:maven-surefire-plugin:2.13:test' with basic configurator -->
[DEBUG] (s) argLine = -XX:MaxPermSize=512m
...
[INFO] BUILD SUCCESS`
безошибочный арглайн теперь правильный (используется пустойsurefire.argLine
собственности) и нетtarget\code-coverage
каталог, как и ожидалось.
Итак, теперь я возвращаюсь к генерации метрик кода, используяпокрытие кода профиль:
[foo] $ mvn clean install -X -PCodeCoverage
...
[INFO] --- jacoco-maven-plugin:0.7.0.201403182114:prepare-agent (jacoco-initialize) @ foo ---
[INFO] surefire.argLine set to -javaagent:...\\org.jacoco.agent\\0.7.0.201403182114\\org.jacoco.agent-0.7.0.201403182114-runtime.jar=destfile=...\\foo\\target\\coverage-reports\\jacoco-ut.exec
...
[DEBUG] Configuring mojo 'org.apache.maven.plugins:maven-surefire-plugin:2.13:test' with basic configurator -->
[DEBUG] (s) argLine = -XX:MaxPermSize=512m
...
[INFO] --- jacoco-maven-plugin:0.7.0.201403182114:report (jacoco-site) @ foo ---
[INFO] Skipping JaCoCo execution due to missing execution data file:...\foo\target\coverage-reports\jacoco-ut.exec
Здесь можно наблюдать, чтоjacoco Плагин вызывается и устанавливаетsurefire.argLine
собственность, ноsurefire.argLine
свойство с пустым значением, определенным вparent/pom.xml
файл фактически используется для создания арглайна длябезошибочный плагин.
В результате нетjacoco-ut.exec
файл, а нетtarget\code-coverage
каталог, когда я используюпокрытие кода профиль.
Я не уверен, что я делаю не так здесь. Я объявляюargLine
свойство, как предлагаетсяjacoco документация, и использовать ее всякий раз, когдабезошибочный Плагину необходимо указать дополнительный аргумент. Другие ответы о переполнении стека предлагают создать свойство с тем же именем, что иjacoco свойство argLine для обработки случая, когдаjacoco не вызывается.
Какие-либо предложения?
редактировать
Может быть, одно из решений заключается в явном объявленииsurefire.argLine
недвижимость впокрытие кода профиль, и забудьте об использованииargLine
изjacoco плагин:
<profile>
<id>CodeCoverage</id>
<properties>
<surefire.argLine>-javaagent:${jacoco.agent.jar}=destfile=${jacoco.report.path}</surefire.argLine>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<executions>
<execution>
<id>jacoco-initialize</id>
<goals>
<goal>prepare-agent</goal>
</goals>
<!-- no longer specifying 'argLine' for jacoco plugin ... -->
</execution>
<executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!-- ... instead the arg line is configured explicitly for surefire plugin. -->
<argLine>${surefire.argLine}</argLine>
</configuration>
</plugin>
</plugins>
</plugin>
</build>
Это создастsurefire.argLine свойство использовать Java-агент, требуемыйjacoco плагин, и настройтебезошибочный плагин, чтобы использовать это свойство для своих аргументов JVM.jacoco Плагин теперь создастargLine свойство, но это будет игнорироваться. Это не элегантное решение (так как я делаю предположения о том, какjacoco плагин работает, и это может измениться в следующей версии).
редактировать
jacoco.agent.jar
свойство также должно быть установлено, указав на его местоположение в локальном хранилище (не уверен, что это надежно) или с помощьюзависимость плагин для копированияjacoco jar агента в локальный каталог сборки:
<profile>
<id>CodeCoverage</id>
<properties>
<jacoco.agent.jar>${project.build.directory}/jacoco-agent.jar</jacoco.agent.jar>
...
</project>
<build>
...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>download-jacoco-agent</id>
<phase>process-test-resources</phase>
<goals>
<goal>copy</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>org.jacoco</groupId>
<artifactId>org.jacoco.agent</artifactId>
<version>${jacoco.version}</version>
<classifier>runtime</classifier>
<outputDirectory>${project.build.directory}</outputDirectory>
<destFileName>jacoco-agent.jar</destFileName>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
редактировать
Не уверен, что при использованиизависимость Плагин - это правильный подход, или указание на артефакт агента jacoco в локальном хранилище:
<profile>
<id>CodeCoverage</id>
<properties>
<jacoco.agent.jar>${settings.localRepository}/org/jacoco/org.jacoco.agent/${jacoco.version}/org.jacoco.agent-${jacoco.version}-runtime.jar</jacoco.agent.jar>
</properties>
...
</profile>
Это проще и не требует копирования артефакта в локальный каталог сборки, но является хрупким: изменения в макете хранилища сломают это.
[1]http://www.eclemma.org/jacoco/trunk/doc/prepare-agent-mojo.html