Package org.citrusframework.mvn.plugin

Class CreateTestMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.citrusframework.mvn.plugin.AbstractCitrusMojo

org.citrusframework.mvn.plugin.CreateTestMojo

All Implemented Interfaces:

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

@Mojo(name="create-test")
public class CreateTestMojo
extends AbstractCitrusMojo

Creates new Citrus test cases with empty XML test file and executable Java class. Mojo offers an interactive mode, where the plugin prompts for parameters during execution.

Since:

2.7.4

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipCreateTest

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CreateTestMojo()	Default constructor.
CreateTestMojo(XmlTestGenerator xmlTestGenerator, XsdXmlTestGenerator xsdXmlTestGenerator, WsdlXmlTestGenerator wsdlXmlTestGenerator, SwaggerXmlTestGenerator swaggerXmlTestGenerator, JavaDslTestGenerator javaTestGenerator, XsdJavaTestGenerator xsdJavaTestGenerator, WsdlJavaTestGenerator wsdlJavaTestGenerator, SwaggerJavaTestGenerator swaggerJavaTestGenerator)	Constructor using final fields.

Method Summary

Modifier and Type	Method	Description
void	createWithSwagger(SwaggerTestGenerator generator)	Creates test case with request and response messages from Swagger API.
void	createWithWsdl(WsdlTestGenerator generator)	Creates test case with request and response messages from WSDL definition.
void	createWithXsd(XsdTestGenerator generator)	Creates test case with request and response messages from XML schema.
void	doExecute()	Subclass execution logic.
JavaDslTestGenerator	getJavaTestGenerator()	Method provides test generator instance.
SwaggerTestGenerator	getSwaggerTestGenerator()	Method provides test generator instance.
WsdlTestGenerator	getWsdlTestGenerator()	Method provides test generator instance.
XmlTestGenerator	getXmlTestGenerator()	Method provides test generator instance.
XsdTestGenerator	getXsdTestGenerator()	Method provides test generator instance.
void	setPrompter(org.codehaus.plexus.components.interactivity.Prompter prompter)	Sets the prompter.

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

skipCreateTest

@Parameter(property="citrus.skip.create.test",
           defaultValue="false")
protected boolean skipCreateTest

Constructor Details

CreateTestMojo

public CreateTestMojo()

Default constructor.

CreateTestMojo

public CreateTestMojo(XmlTestGenerator xmlTestGenerator,
 XsdXmlTestGenerator xsdXmlTestGenerator,
 WsdlXmlTestGenerator wsdlXmlTestGenerator,
 SwaggerXmlTestGenerator swaggerXmlTestGenerator,
 JavaDslTestGenerator javaTestGenerator,
 XsdJavaTestGenerator xsdJavaTestGenerator,
 WsdlJavaTestGenerator wsdlJavaTestGenerator,
 SwaggerJavaTestGenerator swaggerJavaTestGenerator)

Constructor using final fields.

Parameters:

xmlTestGenerator -

xsdXmlTestGenerator -

wsdlXmlTestGenerator -

swaggerXmlTestGenerator -

javaTestGenerator -

xsdJavaTestGenerator -

wsdlJavaTestGenerator -

swaggerJavaTestGenerator -

Method Details

doExecute

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

Description copied from class: AbstractCitrusMojo

Subclass execution logic.

Specified by:

doExecute in class AbstractCitrusMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

createWithXsd

public void createWithXsd(XsdTestGenerator generator)
                   throws org.apache.maven.plugin.MojoExecutionException

Creates test case with request and response messages from XML schema.

Parameters:

generator -

Throws:

org.apache.maven.plugin.MojoExecutionException

createWithWsdl

public void createWithWsdl(WsdlTestGenerator generator)
                    throws org.apache.maven.plugin.MojoExecutionException

Creates test case with request and response messages from WSDL definition.

Parameters:

generator -

Throws:

org.apache.maven.plugin.MojoExecutionException

createWithSwagger

public void createWithSwagger(SwaggerTestGenerator generator)
                       throws org.apache.maven.plugin.MojoExecutionException

Creates test case with request and response messages from Swagger API.

Parameters:

generator -

Throws:

org.apache.maven.plugin.MojoExecutionException

getXmlTestGenerator

public XmlTestGenerator getXmlTestGenerator()

Method provides test generator instance. Basically introduced for better mocking capabilities in unit tests but also useful for subclasses to provide customized generator instance. .

Returns:

test generator.

getJavaTestGenerator

public JavaDslTestGenerator getJavaTestGenerator()

Method provides test generator instance. Basically introduced for better mocking capabilities in unit tests but also useful for subclasses to provide customized generator instance. .

Returns:

test generator.

getSwaggerTestGenerator

public SwaggerTestGenerator getSwaggerTestGenerator()

Method provides test generator instance. Basically introduced for better mocking capabilities in unit tests but also useful for subclasses to provide customized generator instance. .

Returns:

test generator.

getWsdlTestGenerator

public WsdlTestGenerator getWsdlTestGenerator()

Method provides test generator instance. Basically introduced for better mocking capabilities in unit tests but also useful for subclasses to provide customized generator instance. .

Returns:

test generator.

getXsdTestGenerator

public XsdTestGenerator getXsdTestGenerator()

Method provides test generator instance. Basically introduced for better mocking capabilities in unit tests but also useful for subclasses to provide customized generator instance. .

Returns:

test generator.

setPrompter

public void setPrompter(org.codehaus.plexus.components.interactivity.Prompter prompter)

Sets the prompter.

Parameters:

prompter - the prompter to set