Class ReportAggregateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jacoco.maven.AbstractReportMojo

org.jacoco.maven.ReportAggregateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="report-aggregate",
      threadSafe=true)
public class ReportAggregateMojo
extends AbstractReportMojo

Creates a structured code coverage report (HTML, XML, and CSV) from multiple projects within reactor. The report is created from all modules this project depends on, and optionally this project itself. From those projects class and source files as well as JaCoCo execution data files will be collected. In addition execution data is collected from the project itself. This also allows to create coverage reports when tests are in separate projects than the code under test, for example in case of integration tests.

Using the dependency scope allows to distinguish projects which contribute execution data but should not become part of the report:

• compile, runtime, provided: Project source and execution data is included in the report.
• test: Only execution data is considered for the report.

Since:

0.7.7

Field Summary

Fields

Modifier and Type	Field	Description
(package private) List<String>	dataFileExcludes	A list of execution data files to exclude from the report.
(package private) List<String>	dataFileIncludes	A list of execution data files to include in the report from each project.
private boolean	includeCurrentProject	Include this project in the report.
private File	outputDirectory	Output directory for the reports.
private List<org.apache.maven.project.MavenProject>	reactorProjects	The projects in the reactor.

Fields inherited from class AbstractReportMojo

excludes, footer, formats, includes, outputEncoding, project, skip, sourceEncoding, title

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ReportAggregateMojo()

Method Summary

Modifier and Type	Method	Description
(package private) boolean	canGenerateReportRegardingClassesDirectory()
(package private) boolean	canGenerateReportRegardingDataFiles()
(package private) void	createReport(IReportGroupVisitor visitor, ReportSupport support)
private List<org.apache.maven.project.MavenProject>	findDependencies(String... scopes)
private org.apache.maven.project.MavenProject	findProjectFromReactor(org.apache.maven.model.Dependency d)	Note that if dependency specified using version range and reactor contains multiple modules with same artifactId and groupId but of different versions, then first dependency which matches range will be selected.
String	getName(Locale locale)
(package private) File	getOutputDirectory()
String	getOutputName()
File	getReportOutputDirectory()
(package private) void	loadExecutionData(ReportSupport support)
private void	loadExecutionData(ReportSupport support, FileFilter filter, File basedir)
private void	processProject(ReportSupport support, IReportGroupVisitor group, org.apache.maven.project.MavenProject project)
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class AbstractReportMojo

canGenerateReport, execute, generate, generate, getCategoryName, getDescription, getExcludes, getIncludes, isExternalReport

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

dataFileIncludes

@Parameter
List<String> dataFileIncludes

A list of execution data files to include in the report from each project. May use wildcard characters (* and ?). When not specified all *.exec files from the target folder will be included.

dataFileExcludes

@Parameter
List<String> dataFileExcludes

A list of execution data files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}/jacoco-aggregate")
private File outputDirectory

Output directory for the reports. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

includeCurrentProject

@Parameter(defaultValue="false")
private boolean includeCurrentProject

Include this project in the report. If true then this projects class and source files as well as JaCoCo execution data files will be collected.

Since:

0.8.9

reactorProjects

@Parameter(property="reactorProjects",
           readonly=true)
private List<org.apache.maven.project.MavenProject> reactorProjects

The projects in the reactor.

Constructor Details

ReportAggregateMojo

public ReportAggregateMojo()

Method Details

canGenerateReportRegardingDataFiles

boolean canGenerateReportRegardingDataFiles()

Specified by:

canGenerateReportRegardingDataFiles in class AbstractReportMojo

canGenerateReportRegardingClassesDirectory

boolean canGenerateReportRegardingClassesDirectory()

Specified by:

canGenerateReportRegardingClassesDirectory in class AbstractReportMojo

loadExecutionData

void loadExecutionData(ReportSupport support)
                throws IOException

Specified by:

loadExecutionData in class AbstractReportMojo

Throws:

IOException

loadExecutionData

private void loadExecutionData(ReportSupport support,
 FileFilter filter,
 File basedir)
                        throws IOException

Throws:

IOException

getOutputDirectory

File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractReportMojo

createReport

void createReport(IReportGroupVisitor visitor,
 ReportSupport support)
           throws IOException

Specified by:

createReport in class AbstractReportMojo

Throws:

IOException

processProject

private void processProject(ReportSupport support,
 IReportGroupVisitor group,
 org.apache.maven.project.MavenProject project)
                     throws IOException

Throws:

IOException

getReportOutputDirectory

public File getReportOutputDirectory()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

findDependencies

private List<org.apache.maven.project.MavenProject> findDependencies(String... scopes)

findProjectFromReactor

private org.apache.maven.project.MavenProject findProjectFromReactor(org.apache.maven.model.Dependency d)

Note that if dependency specified using version range and reactor contains multiple modules with same artifactId and groupId but of different versions, then first dependency which matches range will be selected. For example in case of range [0,2] if version 1 is before version 2 in reactor, then version 1 will be selected.