org.mule.munit

Class MUnitCoverageReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.munit.MUnitCoverageReportMojo

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="coverage-report",
      defaultPhase=TEST)
 @Execute(lifecycle="munit",
         phase=TEST)
public class MUnitCoverageReportMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenMultiPageReport

A mojo to generate reports regarding the MUnit test run

Author:

Mulesoft Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	coverageConfigDataFile
protected File	coverageReportDataFile
protected File	outputDirectory Output directory for the reports.

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 and Description
MUnitCoverageReportMojo()

Method Summary

Modifier and Type	Method and Description
protected Set<org.mule.munit.plugins.coverage.report.printer.CoverageReportPrinter>	buildPrinters(Coverage coverageConfiguration)
boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.mule.munit.plugins.coverage.report.model.ApplicationCoverageReport coverageReport, Coverage coverageConfiguration)
void	execute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
void	generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale) Generates the coverage report when executing the site lifecycle
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
protected Coverage	readCoverageConfigurationData()
protected org.mule.munit.plugins.coverage.report.model.ApplicationCoverageReport	readCoverageReportData()
void	setReportOutputDirectory(File reportOutputDirectory)

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputDirectory

@Parameter(defaultValue="${project.build.directory}/site/munit/coverage/")
protected 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.

coverageConfigDataFile

@Parameter(property="munit.coverageConfigData",
           defaultValue="${project.build.directory}/munit-reports/coverage-config.data")
protected File coverageConfigDataFile

coverageReportDataFile

@Parameter(property="munit.coverageReportData",
           defaultValue="${project.build.directory}/munit-reports/coverage-report.data")
protected File coverageReportDataFile

Constructor Detail

MUnitCoverageReportMojo

public MUnitCoverageReportMojo()

Method Detail

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
                     org.apache.maven.doxia.sink.SinkFactory sinkFactory,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Generates the coverage report when executing the site lifecycle

Specified by:

generate in interface org.apache.maven.reporting.MavenMultiPageReport

Throws:

org.apache.maven.reporting.MavenReportException

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

buildPrinters

protected Set<org.mule.munit.plugins.coverage.report.printer.CoverageReportPrinter> buildPrinters(Coverage coverageConfiguration)

doGenerateReport

protected void doGenerateReport(Locale locale,
                                org.mule.munit.plugins.coverage.report.model.ApplicationCoverageReport coverageReport,
                                Coverage coverageConfiguration)
                         throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

readCoverageConfigurationData

protected Coverage readCoverageConfigurationData()
                                          throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

readCoverageReportData

protected org.mule.munit.plugins.coverage.report.model.ApplicationCoverageReport readCoverageReportData()
                                                                                                 throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException