io.qameta.allure.maven

Class AllureReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

io.qameta.allure.maven.AllureBaseMojo

io.qameta.allure.maven.AllureGenerateMojo

io.qameta.allure.maven.AllureReportMojo

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",
      defaultPhase=SITE)
public class AllureReportMojo
extends AllureGenerateMojo

Author:

Dmitry Baev dmitry.baev@qameta.io Date: 30.07.15

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	inputDirectories The comma-separated list of additional input directories.

Fields inherited from class io.qameta.allure.maven.AllureGenerateMojo

ALLURE_NEW_PROPERTIES, ALLURE_OLD_PROPERTIES, allureDownloadUrl, buildDirectory, CATEGORIES_FILE_NAME, decrypter, dependencyResolver, executorInfo, installDirectory, properties, propertiesFilePath, reportDirectory, reportingOutputDirectory, reportTimeout, reportVersion, resultsDirectory, session, singleFile

Fields inherited from class io.qameta.allure.maven.AllureBaseMojo

pluginDescriptor

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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
AllureReportMojo()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.nio.file.Path>	getInputDirectories() Get list of Allure results directories to generate the report.
protected java.lang.String	getMojoName() Get the current mojo name.

Methods inherited from class io.qameta.allure.maven.AllureGenerateMojo

canGenerateReport, createProjectClassLoader, executeReport, generateReport, getInstallDirectory, getOutputDirectory, getReportDirectory, isAggregate, isDirectoryExists, prepareProperties, readPropertiesFile, readPropertiesFileFromClasspath, readPropertiesFromMap, render

Methods inherited from class io.qameta.allure.maven.AllureBaseMojo

getDescription, getName, getOutputName, getProject, getSiteRenderer

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getXrefLocation, isExternalReport, setReportOutputDirectory

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

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

getOutputPath

Field Detail

inputDirectories

@Parameter(property="allure.results.inputDirectories")
protected java.lang.String inputDirectories

The comma-separated list of additional input directories. As long as unix path can contains commas it is bad way to specify few input directories. The main usage of this parameter is some scripts to generate aggregated report. This parameter will be used only in "bulk" mojo.

Constructor Detail

AllureReportMojo

public AllureReportMojo()

Method Detail

getInputDirectories

protected java.util.List<java.nio.file.Path> getInputDirectories()

Get list of Allure results directories to generate the report.

Specified by:

getInputDirectories in class AllureGenerateMojo

getMojoName

protected java.lang.String getMojoName()

Description copied from class: AllureGenerateMojo

Get the current mojo name.

Specified by:

getMojoName in class AllureGenerateMojo