Package org.citrusframework.mvn.plugin

Class GenerateDocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.citrusframework.mvn.plugin.AbstractCitrusMojo

org.citrusframework.mvn.plugin.GenerateDocsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-docs",
      defaultPhase=PROCESS_TEST_RESOURCES)
public class GenerateDocsMojo
extends AbstractCitrusMojo

Generates test overview documentation based on plugin configuration. Html documentation creates a web page that contains a list of all available tests with meta information. Excel documentation creates a table of all available tests with meta information such as name, author, status and so on.

Since:

2.7.4

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipGenerateDocs

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateDocsMojo()	Default constructor.
GenerateDocsMojo(ExcelTestDocsGenerator excelTestDocGenerator, HtmlTestDocsGenerator htmlTestDocGenerator)	Constructor using final fields.

Method Summary

Modifier and Type	Method	Description
void	doExecute()	Subclass execution logic.
ExcelTestDocsGenerator	getExcelTestDocGenerator()	Gets the excelTestDocGenerator.
HtmlTestDocsGenerator	getHtmlTestDocGenerator()	Gets the htmlTestDocGenerator.

Methods inherited from class org.citrusframework.mvn.plugin.AbstractCitrusMojo

execute, getDocs, getFramework, getTests, getTestSrcDirectory, getType, setDocs, setTests, setType

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 Details

skipGenerateDocs

@Parameter(property="citrus.skip.generate.docs",
           defaultValue="false")
protected boolean skipGenerateDocs

Constructor Details

GenerateDocsMojo

public GenerateDocsMojo()

Default constructor.

GenerateDocsMojo

public GenerateDocsMojo(ExcelTestDocsGenerator excelTestDocGenerator,
 HtmlTestDocsGenerator htmlTestDocGenerator)

Constructor using final fields.

Parameters:

excelTestDocGenerator -

htmlTestDocGenerator -

Method Details

doExecute

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

Description copied from class: AbstractCitrusMojo

Subclass execution logic.

Specified by:

doExecute in class AbstractCitrusMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getHtmlTestDocGenerator

public HtmlTestDocsGenerator getHtmlTestDocGenerator()

Gets the htmlTestDocGenerator.

Returns:

getExcelTestDocGenerator

public ExcelTestDocsGenerator getExcelTestDocGenerator()

Gets the excelTestDocGenerator.

Returns: