TestDesigner (citrus-java-dsl 2.7.9 API)

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware

All Known Subinterfaces:

TestBehavior

All Known Implementing Classes:

AbstractTestBehavior, DefaultTestDesigner, ExecutableTestDesigner, ExecutableTestDesignerComponent, JUnit4CitrusTestDesigner, TestDesignerComponent, TestDesignerSimulation, TestNGCitrusTestDesigner
```
public interface TestDesigner
extends org.springframework.context.ApplicationContextAware
```
Test builder interface defines builder pattern methods for creating a new Citrus test case.

Since:

2.3

Author:

Christoph Deppisch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`action(TestAction testAction)` Adds a custom test action implementation.
`AntRunBuilder`	`antrun(String buildFilePath)` Creates a new ANT run action definition for further configuration.
`ApplyTestBehaviorAction`	`applyBehavior(TestBehavior behavior)` Apply test apply with all test actions, finally actions and test variables defined in given apply.
`TemplateBuilder`	`applyTemplate(String name)` Adds template container with nested test actions.
`AssertExceptionBuilder`	`assertException()` Assert exception to happen in nested test action.
`AssertSoapFaultBuilder`	`assertSoapFault()` Assert SOAP fault during action execution.
`AsyncBuilder`	`async()` Adds async container with nested test actions.
`void`	`author(String author)` Adds author to the test case.
`CamelRouteActionBuilder`	`camel()` Creates a new Camel route action.
`CatchExceptionBuilder`	`catchException()` Action catches possible exceptions in nested test actions.
`ConditionalBuilder`	`conditional()` Adds conditional container with nested test actions.
`<T extends AbstractActionContainer> AbstractTestContainerBuilder<T>`	`container(T container)` Prepare and add a custom container implementation.
`CreateVariablesAction`	`createVariable(String variableName, String value)` Action creating a new test variable during a test.
`void`	`creationDate(Date date)` Sets the creation date.
`void`	`description(String description)` Adds description to the test case.
`DockerActionBuilder`	`docker()` Creates a new docker execute action.
`FinallySequenceBuilder`	`doFinally()` Adds sequence of test actions to finally block.
`EchoAction`	`echo(String message)` Creates a new echo action.
`FailAction`	`fail(String message)` Creates a new fail action.
`TestCase`	`getTestCase()` Builds the test case.
`GroovyActionBuilder`	`groovy(org.springframework.core.io.Resource scriptResource)` Creates a new groovy action definition with script file resource.
`GroovyActionBuilder`	`groovy(String script)` Creates a new groovy action definition with script code.
`HttpActionBuilder`	`http()`
`InputActionBuilder`	`input()` Creates a new input action.
`IterateBuilder`	`iterate()` Adds iterate container with nested test actions.
`JavaActionBuilder`	`java(Class<?> clazz)` Creates a new Java action definition from Java class.
`JavaActionBuilder`	`java(Object instance)` Creates a new Java action definition from Java object instance.
`JavaActionBuilder`	`java(String className)` Creates a new Java action definition from class name.
`KubernetesActionBuilder`	`kubernetes()` Creates a new kubernetes execute action.
`LoadPropertiesAction`	`load(String filePath)` Creates a new load properties action.
`void`	`name(String name)` Set custom test case name.
`void`	`packageName(String packageName)` Sets custom package name for this test case.
`ParallelBuilder`	`parallel()` Adds parallel container with nested test actions.
`ExecutePLSQLBuilder`	`plsql(DataSource dataSource)` Creates a new executePLSQL action definition for further configuration.
`PurgeChannelsBuilder`	`purgeChannels()` Creates a new purge message channel action definition for further configuration.
`PurgeEndpointsBuilder`	`purgeEndpoints()` Purge endpoints.
`PurgeJmsQueuesBuilder`	`purgeQueues()` Purge queues using default connection factory.
`ExecuteSQLQueryBuilder`	`query(DataSource dataSource)` Creates a new executesqlquery action definition for further configuration.
`ReceiveMessageBuilder`	`receive(Endpoint messageEndpoint)` Creates receive message action definition with message endpoint instance.
`ReceiveMessageBuilder`	`receive(String messageEndpointName)` Creates receive message action definition with messsage endpoint name.
`ReceiveTimeoutBuilder`	`receiveTimeout(Endpoint messageEndpoint)` Creates a new receive timeout action definition for further configuration.
`ReceiveTimeoutBuilder`	`receiveTimeout(String messageEndpointName)` Creates a new receive timeout action definition from message endpoint name as String.
`RepeatBuilder`	`repeat()` Adds repeat until true container with nested test actions.
`RepeatOnErrorBuilder`	`repeatOnError()` Adds repeat on error until true container with nested test actions.
`SeleniumActionBuilder`	`selenium()` Creates a new selenium action builder.
`SendMessageBuilder`	`send(Endpoint messageEndpoint)` Create send message action definition with message endpoint instance.
`SendMessageBuilder`	`send(String messageEndpointName)` Create send message action definition with message endpoint name.
`SequenceBuilder`	`sequential()` Adds sequential container with nested test actions.
`SleepAction`	`sleep()` Add sleep action with default delay time.
`SleepAction`	`sleep(double seconds)` Add sleep action with time in seconds.
`SleepAction`	`sleep(long milliseconds)` Add sleep action with time in milliseconds.
`SoapActionBuilder`	`soap()`
`ExecuteSQLBuilder`	`sql(DataSource dataSource)` Creates a new executeSQL action definition for further configuration.
`StartServerAction`	`start(Server... servers)` Creates a new start server action definition for further configuration.
`StartServerAction`	`start(Server server)` Creates a new start server action definition for further configuration.
`void`	`status(TestCaseMetaInfo.Status status)` Sets test case status.
`StopServerAction`	`stop(Server... servers)` Creates a new stop server action definition for further configuration.
`StopServerAction`	`stop(Server server)` Creates a new stop server action definition for further configuration.
`StopTimeAction`	`stopTime()` Creates a new stop time action.
`StopTimeAction`	`stopTime(String id)` Creates a new stop time action.
`StopTimeAction`	`stopTime(String id, String suffix)` Creates a new stop time action.
`StopTimerAction`	`stopTimer(String timerId)` Stops the timer matching the supplied timerId
`StopTimerAction`	`stopTimers()` Stops all timers within the current test context
`void`	`testClass(Class<?> type)` Set test class.
`TimerBuilder`	`timer()` Adds a timer container.
`TraceVariablesAction`	`traceVariables()` Creates a new trace variables action definition that prints variable values to the console/logger.
`TraceVariablesAction`	`traceVariables(String... variables)` Creates a new trace variables action definition that prints variable values to the console/logger.
`TransformActionBuilder`	`transform()` Creates a new transform action definition for further configuration.
`void`	`variable(String name, Object value)` Adds a new variable definition to the set of test variables for this test case.
`WaitBuilder`	`waitFor()` Add wait action.
`ZooActionBuilder`	`zookeeper()` Creates a new zookeeper execute action.

Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext

- Method Detail
  - getTestCase
```
TestCase getTestCase()
```
    Builds the test case.
    
    Returns:
  - testClass
```
void testClass(Class<?> type)
```
    Set test class.
    
    Parameters:
    
    type -
  - name
```
void name(String name)
```
    Set custom test case name.
    
    Parameters:
    
    name -
  - description
```
void description(String description)
```
    Adds description to the test case.
    
    Parameters:
    
    description -
  - author
```
void author(String author)
```
    Adds author to the test case.
    
    Parameters:
    
    author -
  - packageName
```
void packageName(String packageName)
```
    Sets custom package name for this test case.
    
    Parameters:
    
    packageName -
  - status
```
void status(TestCaseMetaInfo.Status status)
```
    Sets test case status.
    
    Parameters:
    
    status -
  - creationDate
```
void creationDate(Date date)
```
    Sets the creation date.
    
    Parameters:
    
    date -
  - variable
```
void variable(String name,
              Object value)
```
    Adds a new variable definition to the set of test variables for this test case.
    
    Parameters:
    
    name -
    
    value -
  - action
```
void action(TestAction testAction)
```
    Adds a custom test action implementation.
    
    Parameters:
    
    testAction -
  - applyBehavior
```
ApplyTestBehaviorAction applyBehavior(TestBehavior behavior)
```
    Apply test apply with all test actions, finally actions and test variables defined in given apply.
    
    Parameters:
    
    behavior -
  - container
```
<T extends AbstractActionContainer> AbstractTestContainerBuilder<T> container(T container)
```
    Prepare and add a custom container implementation.
    
    Parameters:
    
    container -
    
    Returns:
  - createVariable
```
CreateVariablesAction createVariable(String variableName,
                                     String value)
```
    Action creating a new test variable during a test.
    
    Parameters:
    
    variableName -
    
    value -
    
    Returns:
  - antrun
```
AntRunBuilder antrun(String buildFilePath)
```
    Creates a new ANT run action definition for further configuration.
    
    Parameters:
    
    buildFilePath -
    
    Returns:
  - echo
```
EchoAction echo(String message)
```
    Creates a new echo action.
    
    Parameters:
    
    message -
    
    Returns:
  - plsql
```
ExecutePLSQLBuilder plsql(DataSource dataSource)
```
    Creates a new executePLSQL action definition for further configuration.
    
    Parameters:
    
    dataSource -
    
    Returns:
  - sql
```
ExecuteSQLBuilder sql(DataSource dataSource)
```
    Creates a new executeSQL action definition for further configuration.
    
    Parameters:
    
    dataSource -
    
    Returns:
  - query
```
ExecuteSQLQueryBuilder query(DataSource dataSource)
```
    Creates a new executesqlquery action definition for further configuration.
    
    Parameters:
    
    dataSource -
    
    Returns:
  - receiveTimeout
```
ReceiveTimeoutBuilder receiveTimeout(Endpoint messageEndpoint)
```
    Creates a new receive timeout action definition for further configuration.
    
    Parameters:
    
    messageEndpoint -
    
    Returns:
  - receiveTimeout
```
ReceiveTimeoutBuilder receiveTimeout(String messageEndpointName)
```
    Creates a new receive timeout action definition from message endpoint name as String.
    
    Parameters:
    
    messageEndpointName -
    
    Returns:
  - fail
```
FailAction fail(String message)
```
    Creates a new fail action.
    
    Parameters:
    
    message -
    
    Returns:
  - input
```
InputActionBuilder input()
```
    Creates a new input action.
    
    Returns:
  - java
```
JavaActionBuilder java(String className)
```
    Creates a new Java action definition from class name.
    
    Parameters:
    
    className -
    
    Returns:
  - java
```
JavaActionBuilder java(Class<?> clazz)
```
    Creates a new Java action definition from Java class.
    
    Parameters:
    
    clazz -
    
    Returns:
  - java
```
JavaActionBuilder java(Object instance)
```
    Creates a new Java action definition from Java object instance.
    
    Parameters:
    
    instance -
    
    Returns:
  - load
```
LoadPropertiesAction load(String filePath)
```
    Creates a new load properties action.
    
    Parameters:
    
    filePath - path to properties file.
    
    Returns:
  - purgeQueues
```
PurgeJmsQueuesBuilder purgeQueues()
```
    Purge queues using default connection factory.
    
    Returns:
  - purgeChannels
```
PurgeChannelsBuilder purgeChannels()
```
    Creates a new purge message channel action definition for further configuration.
    
    Returns:
  - purgeEndpoints
```
PurgeEndpointsBuilder purgeEndpoints()
```
    Purge endpoints.
    
    Returns:
  - receive
```
ReceiveMessageBuilder receive(Endpoint messageEndpoint)
```
    Creates receive message action definition with message endpoint instance.
    
    Parameters:
    
    messageEndpoint -
    
    Returns:
  - receive
```
ReceiveMessageBuilder receive(String messageEndpointName)
```
    Creates receive message action definition with messsage endpoint name.
    
    Parameters:
    
    messageEndpointName -
    
    Returns:
  - send
```
SendMessageBuilder send(Endpoint messageEndpoint)
```
    Create send message action definition with message endpoint instance.
    
    Parameters:
    
    messageEndpoint -
    
    Returns:
  - send
```
SendMessageBuilder send(String messageEndpointName)
```
    Create send message action definition with message endpoint name. According to message endpoint type we can create a SOAP specific message sending action.
    
    Parameters:
    
    messageEndpointName -
    
    Returns:
  - sleep
```
SleepAction sleep()
```
    Add sleep action with default delay time.
    
    Returns:
  - sleep
```
SleepAction sleep(long milliseconds)
```
    Add sleep action with time in milliseconds.
    
    Parameters:
    
    milliseconds -
    
    Returns:
  - sleep
```
SleepAction sleep(double seconds)
```
    Add sleep action with time in seconds.
    
    Parameters:
    
    seconds -
    
    Returns:
  - waitFor
```
WaitBuilder waitFor()
```
    Add wait action.
    
    Returns:
  - start
```
StartServerAction start(Server... servers)
```
    Creates a new start server action definition for further configuration.
    
    Parameters:
    
    servers -
    
    Returns:
  - start
```
StartServerAction start(Server server)
```
    Creates a new start server action definition for further configuration.
    
    Parameters:
    
    server -
    
    Returns:
  - stop
```
StopServerAction stop(Server... servers)
```
    Creates a new stop server action definition for further configuration.
    
    Parameters:
    
    servers -
    
    Returns:
  - stop
```
StopServerAction stop(Server server)
```
    Creates a new stop server action definition for further configuration.
    
    Parameters:
    
    server -
    
    Returns:
  - stopTime
```
StopTimeAction stopTime()
```
    Creates a new stop time action.
    
    Returns:
  - stopTime
```
StopTimeAction stopTime(String id)
```
    Creates a new stop time action.
    
    Parameters:
    
    id -
    
    Returns:
  - stopTime
```
StopTimeAction stopTime(String id,
                        String suffix)
```
    Creates a new stop time action.
    
    Parameters:
    
    id -
    
    suffix -
    
    Returns:
  - traceVariables
```
TraceVariablesAction traceVariables()
```
    Creates a new trace variables action definition that prints variable values to the console/logger.
    
    Returns:
  - traceVariables
```
TraceVariablesAction traceVariables(String... variables)
```
    Creates a new trace variables action definition that prints variable values to the console/logger.
    
    Parameters:
    
    variables -
    
    Returns:
  - groovy
```
GroovyActionBuilder groovy(String script)
```
    Creates a new groovy action definition with script code.
    
    Parameters:
    
    script -
    
    Returns:
  - groovy
```
GroovyActionBuilder groovy(org.springframework.core.io.Resource scriptResource)
```
    Creates a new groovy action definition with script file resource.
    
    Parameters:
    
    scriptResource -
    
    Returns:
  - transform
```
TransformActionBuilder transform()
```
    Creates a new transform action definition for further configuration.
    
    Returns:
  - assertException
```
AssertExceptionBuilder assertException()
```
    Assert exception to happen in nested test action.
    
    Returns:
  - catchException
```
CatchExceptionBuilder catchException()
```
    Action catches possible exceptions in nested test actions.
    
    Returns:
  - assertSoapFault
```
AssertSoapFaultBuilder assertSoapFault()
```
    Assert SOAP fault during action execution.
    
    Returns:
  - conditional
```
ConditionalBuilder conditional()
```
    Adds conditional container with nested test actions.
    
    Returns:
  - iterate
```
IterateBuilder iterate()
```
    Adds iterate container with nested test actions.
    
    Returns:
  - parallel
```
ParallelBuilder parallel()
```
    Adds parallel container with nested test actions.
    
    Returns:
  - repeatOnError
```
RepeatOnErrorBuilder repeatOnError()
```
    Adds repeat on error until true container with nested test actions.
    
    Returns:
  - repeat
```
RepeatBuilder repeat()
```
    Adds repeat until true container with nested test actions.
    
    Returns:
  - sequential
```
SequenceBuilder sequential()
```
    Adds sequential container with nested test actions.
    
    Returns:
  - async
```
AsyncBuilder async()
```
    Adds async container with nested test actions.
    
    Returns:
  - timer
```
TimerBuilder timer()
```
    Adds a timer container.
    
    Returns:
  - stopTimer
```
StopTimerAction stopTimer(String timerId)
```
    Stops the timer matching the supplied timerId
    
    Parameters:
    
    timerId -
    
    Returns:
  - stopTimers
```
StopTimerAction stopTimers()
```
    Stops all timers within the current test context
    
    Returns:
  - docker
```
DockerActionBuilder docker()
```
    Creates a new docker execute action.
    
    Returns:
  - kubernetes
```
KubernetesActionBuilder kubernetes()
```
    Creates a new kubernetes execute action.
    
    Returns:
  - selenium
```
SeleniumActionBuilder selenium()
```
    Creates a new selenium action builder.
    
    Returns:
  - http
```
HttpActionBuilder http()
```
  - soap
```
SoapActionBuilder soap()
```
  - camel
```
CamelRouteActionBuilder camel()
```
    Creates a new Camel route action.
    
    Returns:
  - zookeeper
```
ZooActionBuilder zookeeper()
```
    Creates a new zookeeper execute action.
    
    Returns:
  - applyTemplate
```
TemplateBuilder applyTemplate(String name)
```
    Adds template container with nested test actions.
    
    Parameters:
    
    name -
    
    Returns:
  - doFinally
```
FinallySequenceBuilder doFinally()
```
    Adds sequence of test actions to finally block.

Interface TestDesigner

Method Summary

Methods inherited from interface org.springframework.context.ApplicationContextAware

Method Detail

getTestCase

testClass

name

description

author

packageName

status

creationDate

variable

action

applyBehavior

container

createVariable

antrun

echo

plsql

sql

query

receiveTimeout

receiveTimeout

fail

input

java

java

java

load

purgeQueues

purgeChannels

purgeEndpoints

receive

receive

send

send

sleep

sleep

sleep

waitFor

start

start

stop

stop

stopTime

stopTime

stopTime

traceVariables

traceVariables

groovy

groovy

transform

assertException

catchException

assertSoapFault

conditional

iterate

parallel

repeatOnError

repeat

sequential

async

timer

stopTimer

stopTimers

docker

kubernetes

selenium

http

soap

camel

zookeeper

applyTemplate

doFinally