io.qameta.allure.maven

Class AllureGenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

io.qameta.allure.maven.AllureBaseMojo

io.qameta.allure.maven.AllureGenerateMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AllureAggregateMojo, AllureReportMojo, AllureServeMojo

public abstract class AllureGenerateMojo
extends AllureBaseMojo

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLURE_NEW_PROPERTIES
static java.lang.String	ALLURE_OLD_PROPERTIES
protected java.lang.String	allureDownloadUrl
protected java.lang.String	buildDirectory The project build directory.
static java.lang.String	CATEGORIES_FILE_NAME
protected org.apache.maven.settings.crypto.SettingsDecrypter	decrypter
protected org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver	dependencyResolver
protected java.util.Map<java.lang.String,java.lang.String>	executorInfo This is key-value map which defines executor.json file content.
protected java.lang.String	installDirectory
protected java.util.Map<java.lang.String,java.lang.String>	properties The additional Allure properties such as issue tracker pattern.
protected java.lang.String	propertiesFilePath The path to the allure.properties file.
protected java.lang.String	reportDirectory
protected java.lang.String	reportingOutputDirectory The project reporting output directory.
protected int	reportTimeout Report timeout parameter in seconds.
protected java.lang.String	reportVersion The version on Allure report to generate.
protected java.lang.String	resultsDirectory The path to Allure results directory.
protected org.apache.maven.execution.MavenSession	session
protected java.lang.Boolean	singleFile The report generation mode.

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

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected java.lang.ClassLoader	createProjectClassLoader() Return ClassLoader with classpath elements.
protected void	executeReport(java.util.Locale locale)
protected void	generateReport(java.util.List<java.nio.file.Path> resultsPaths)
protected abstract java.util.List<java.nio.file.Path>	getInputDirectories() Get list of Allure results directories to generate the report.
java.lang.String	getInstallDirectory()
protected abstract java.lang.String	getMojoName() Get the current mojo name.
protected java.lang.String	getOutputDirectory()
java.lang.String	getReportDirectory() The directory to generate Allure report into.
protected boolean	isAggregate() Is the current report aggregated?
protected boolean	isDirectoryExists(java.nio.file.Path path) Returns true if given path is an existed directory.
protected void	prepareProperties(java.util.Properties properties) Replaces the placeholders in properties.
protected void	readPropertiesFile(java.util.Properties properties) Read system properties from file propertiesFilePath.
protected void	readPropertiesFileFromClasspath(java.lang.String propertiesFileName, java.util.Properties properties) Read allure.properties from classpath.
protected void	readPropertiesFromMap(java.util.Properties properties) Set properties from properties.
protected void	render(org.apache.maven.doxia.sink.Sink sink, java.lang.String title) Render allure report page in project-reports.html.

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

ALLURE_OLD_PROPERTIES

public static final java.lang.String ALLURE_OLD_PROPERTIES

See Also:

Constant Field Values

ALLURE_NEW_PROPERTIES

public static final java.lang.String ALLURE_NEW_PROPERTIES

See Also:

Constant Field Values

CATEGORIES_FILE_NAME

public static final java.lang.String CATEGORIES_FILE_NAME

See Also:

Constant Field Values

buildDirectory

@Parameter(defaultValue="${project.build.directory}",
           readonly=true)
protected java.lang.String buildDirectory

The project build directory. For maven projects it is usually the target folder.

reportingOutputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}",
           readonly=true)
protected java.lang.String reportingOutputDirectory

The project reporting output directory. For maven projects it is usually the target/site folder.

resultsDirectory

@Parameter(property="allure.results.directory",
           defaultValue="allure-results/")
protected java.lang.String resultsDirectory

The path to Allure results directory. In general it is the directory created by allure adaptor and contains allure xml files and attachments. This path can be relative from build directory (for maven it is the target directory) or absolute (absolute only for report mojo). Will be ignored for bulk mojo.

reportVersion

@Parameter(property="report.version")
protected java.lang.String reportVersion

The version on Allure report to generate.

reportDirectory

@Parameter(property="allure.report.directory",
           defaultValue="${project.reporting.outputDirectory}/allure-maven-plugin")
protected java.lang.String reportDirectory

reportTimeout

@Parameter(property="allure.report.timeout",
           defaultValue="60")
protected int reportTimeout

Report timeout parameter in seconds.

executorInfo

@Parameter
protected final java.util.Map<java.lang.String,java.lang.String> executorInfo

This is key-value map which defines executor.json file content. Default content: {"buildName":"${project.name}","name":"Maven","type":"maven"}

propertiesFilePath

@Parameter(defaultValue="report.properties")
protected java.lang.String propertiesFilePath

The path to the allure.properties file.

installDirectory

@Parameter(property="allure.install.directory",
           defaultValue="${project.basedir}/.allure")
protected java.lang.String installDirectory

allureDownloadUrl

@Parameter(property="allure.download.url")
protected java.lang.String allureDownloadUrl

session

@Parameter(property="session",
           defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

decrypter

@Component(role=org.apache.maven.settings.crypto.SettingsDecrypter.class)
protected org.apache.maven.settings.crypto.SettingsDecrypter decrypter

dependencyResolver

@Component
protected org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver

properties

@Parameter
protected java.util.Map<java.lang.String,java.lang.String> properties

The additional Allure properties such as issue tracker pattern.

singleFile

@Parameter
protected java.lang.Boolean singleFile

The report generation mode.

Constructor Detail

AllureGenerateMojo

public AllureGenerateMojo()

Method Detail

getOutputDirectory

protected java.lang.String getOutputDirectory()

Overrides:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

generateReport

protected void generateReport(java.util.List<java.nio.file.Path> resultsPaths)
                       throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

readPropertiesFile

protected void readPropertiesFile(java.util.Properties properties)
                           throws java.io.IOException

Read system properties from file propertiesFilePath.

Throws:

java.io.IOException - if any occurs.

readPropertiesFileFromClasspath

protected void readPropertiesFileFromClasspath(java.lang.String propertiesFileName,
                                               java.util.Properties properties)
                                        throws java.io.IOException,
                                               org.apache.maven.artifact.DependencyResolutionRequiredException

Read allure.properties from classpath.

Throws:

java.io.IOException - if any occurs.

org.apache.maven.artifact.DependencyResolutionRequiredException

readPropertiesFromMap

protected void readPropertiesFromMap(java.util.Properties properties)

Set properties from properties.

prepareProperties

protected void prepareProperties(java.util.Properties properties)

Replaces the placeholders in properties. You can use properties like: name1=value1 name2=value2 with ${name1} You can also use system and maven properties for the placeholder.

render

protected void render(org.apache.maven.doxia.sink.Sink sink,
                      java.lang.String title)

Render allure report page in project-reports.html.

createProjectClassLoader

protected java.lang.ClassLoader createProjectClassLoader()
                                                  throws java.net.MalformedURLException,
                                                         org.apache.maven.artifact.DependencyResolutionRequiredException

Return ClassLoader with classpath elements.

Throws:

java.net.MalformedURLException

org.apache.maven.artifact.DependencyResolutionRequiredException

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

isAggregate

protected boolean isAggregate()

Is the current report aggregated?

isDirectoryExists

protected boolean isDirectoryExists(java.nio.file.Path path)

Returns true if given path is an existed directory.

getInputDirectories

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

Get list of Allure results directories to generate the report.

getMojoName

protected abstract java.lang.String getMojoName()

Get the current mojo name.

getReportDirectory

public java.lang.String getReportDirectory()

The directory to generate Allure report into.

getInstallDirectory

public java.lang.String getInstallDirectory()