org.jacoco.maven.AgentMojo Maven / Gradle / Ivy
Show all versions of jacoco-maven-plugin Show documentation
/*******************************************************************************
* Copyright (c) 2009, 2022 Mountainminds GmbH & Co. KG and Contributors
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Evgeny Mandrikov - initial API and implementation
*
*******************************************************************************/
package org.jacoco.maven;
import java.io.File;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
/**
*
* 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.
*
*
*
* If your project already defines VM arguments for test execution, be sure that
* they will include property defined by JaCoCo.
*
*
*
* One of the ways to do this in case of maven-surefire-plugin - is to use
* syntax for late
* property evaluation:
*
*
*
* <plugin>
* <groupId>org.apache.maven.plugins</groupId>
* <artifactId>maven-surefire-plugin</artifactId>
* <configuration>
* <argLine>@{argLine} -your -extra -arguments</argLine>
* </configuration>
* </plugin>
*
*
*
* You can define empty property to avoid JVM startup error
* Could not find or load main class @{argLine} when using late
* property evaluation and jacoco-maven-plugin not executed.
*
*
*
* Another way is to define "argLine" as a Maven property rather than as part of
* the configuration of maven-surefire-plugin:
*
*
*
* <properties>
* <argLine>-your -extra -arguments</argLine>
* </properties>
* ...
* <plugin>
* <groupId>org.apache.maven.plugins</groupId>
* <artifactId>maven-surefire-plugin</artifactId>
* <configuration>
* <!-- no argLine here -->
* </configuration>
* </plugin>
*
*
*
* Resulting coverage information is collected during execution and by default
* written to a file when the process terminates.
*
*
* @since 0.5.3
*/
@Mojo(name = "prepare-agent", defaultPhase = LifecyclePhase.INITIALIZE, requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true)
public class AgentMojo extends AbstractAgentMojo {
/**
* Path to the output file for execution data.
*/
@Parameter(property = "jacoco.destFile", defaultValue = "${project.build.directory}/jacoco.exec")
private File destFile;
/**
* @return the destFile
*/
@Override
File getDestFile() {
return destFile;
}
}