org.jacoco.maven.AgentMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jacoco-maven-plugin Show documentation

The JaCoCo Maven Plugin provides the JaCoCo runtime agent to your tests and allows basic report creation.

There is a newer version: 0.8.12

/*******************************************************************************
 * Copyright (c) 2009, 2016 Mountainminds GmbH & Co. KG and Contributors
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Evgeny Mandrikov - initial API and implementation
 *
 *******************************************************************************/
package org.jacoco.maven;

import java.io.File;

/**
 * 
 * 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
 * the VM arguments are defined as a property, rather than as part of the plugin
 * configuration. For example in case of maven-surefire-plugin:
 * 
 * 
 *  *   <properties>
 *     <argLine>-your -extra -arguments</argLine>
 *   </properties>
 *   ...
 *   <plugin>
 *     <groupId>org.apache.maven.plugins</groupId>
 *     <artifactId>maven-surefire-plugin</artifactId>
 *     <configuration>
 *       <!-- Do not define argLine here! -->
 *     </configuration>
 *   </plugin>
 * 
 * 
 * 
 * Resulting coverage information is collected during execution and by default
 * written to a file when the process terminates.
 * 
 * 
 * @phase initialize
 * @goal prepare-agent
 * @requiresProject true
 * @requiresDependencyResolution runtime
 * @threadSafe
 * @since 0.5.3
 */
public class AgentMojo extends AbstractAgentMojo {

	/**
	 * Path to the output file for execution data.
	 * 
	 * @parameter property="jacoco.destFile"
	 *            default-value="${project.build.directory}/jacoco.exec"
	 */
	private File destFile;

	/**
	 * @return the destFile
	 */
	@Override
	File getDestFile() {
		return destFile;
	}

}