TestRunner (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, DefaultTestRunner, ExecutableTestRunner, ExecutableTestRunnerComponent, JUnit4CitrusTestRunner, TestNGCitrusTestRunner, TestRunnerComponent, TestRunnerSimulation
```
public interface TestRunner
extends org.springframework.context.ApplicationContextAware
```
Since:

2.3

Author:

Christoph Deppisch

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AntRunAction`	`antrun(BuilderSupport<AntRunBuilder> configurer)` Creates and executes 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.
`Template`	`applyTemplate(BuilderSupport<TemplateBuilder> configurer)` 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.
`TestAction`	`camel(BuilderSupport<CamelRouteActionBuilder> configurer)` Run Camel route actions.
`CatchExceptionBuilder`	`catchException()` Catch exception when thrown in nested test action.
`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.
`TestAction`	`docker(BuilderSupport<DockerActionBuilder> configurer)` Run docker command action.
`FinallySequenceBuilder`	`doFinally()` Adds sequence of test actions to finally block.
`EchoAction`	`echo(String message)` Creates and executes a new echo action.
`FailAction`	`fail(String message)` Creates a new fail action.
`TestCase`	`getTestCase()` Builds the test case.
`GroovyAction`	`groovy(BuilderSupport<GroovyActionBuilder> configurer)` Creates a new groovy action definition for further configuration.
`TestAction`	`http(BuilderSupport<HttpActionBuilder> configurer)` Run http command action.
`InputAction`	`input(BuilderSupport<InputActionBuilder> configurer)` Creates a new input action.
`IterateBuilder`	`iterate()` Run nested test actions in iteration.
`TestAction`	`kubernetes(BuilderSupport<KubernetesActionBuilder> configurer)` Run kubernetes command 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()` Run nested test actions in parallel to each other using multiple threads.
`ExecutePLSQLAction`	`plsql(BuilderSupport<ExecutePLSQLBuilder> configurer)` Creates a new executePLSQL action definition for further configuration.
`PurgeMessageChannelAction`	`purgeChannels(BuilderSupport<PurgeChannelsBuilder> configurer)` Creates a new purge message channel action definition for further configuration.
`PurgeEndpointAction`	`purgeEndpoints(BuilderSupport<PurgeEndpointsBuilder> configurer)` Creates a new purge message endpoint action definition for further configuration.
`TestAction`	`purgeQueues(BuilderSupport<PurgeJmsQueuesBuilder> configurer)` Creates a new purge jms queues action definition for further configuration.
`ExecuteSQLQueryAction`	`query(BuilderSupport<ExecuteSQLQueryBuilder> configurer)` Creates a new executesqlquery action definition for further configuration.
`ReceiveMessageAction`	`receive(BuilderSupport<ReceiveMessageBuilder> configurer)` Creates receive message action definition with message endpoint instance.
`ReceiveTimeoutAction`	`receiveTimeout(BuilderSupport<ReceiveTimeoutBuilder> configurer)` Creates a new receive timeout action definition for further configuration.
`RepeatBuilder`	`repeat()` Adds repeat until true container with nested test actions.
`RepeatOnErrorBuilder`	`repeatOnError()` Adds repeat on error until true container with nested test actions.
`<T extends TestAction> T`	`run(T testAction)` Runs test action and returns same action after execution.
`TestAction`	`selenium(BuilderSupport<SeleniumActionBuilder> configurer)` Run selenium command action.
`SendMessageAction`	`send(BuilderSupport<SendMessageBuilder> configurer)` Create send message action definition with message endpoint instance.
`SequenceBuilder`	`sequential()` Run nested test actions in sequence.
`SleepAction`	`sleep()` Add sleep action with default delay time.
`SleepAction`	`sleep(long milliseconds)` Add sleep action with time in milliseconds.
`TestAction`	`soap(BuilderSupport<SoapActionBuilder> configurer)` Run soap command action.
`ExecuteSQLAction`	`sql(BuilderSupport<ExecuteSQLBuilder> configurer)` Creates a new executeSQL action definition for further configuration.
`void`	`start()` Starts the test case execution.
`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.
`void`	`stop()` Stops test case execution.
`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 timer matching the supplied timerId
`StopTimerAction`	`stopTimers()` Stops all timers
`void`	`testClass(Class<?> type)` Set test class.
`TimerBuilder`	`timer()` Repeat nested test actions based on a timer interval.
`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.
`TransformAction`	`transform(BuilderSupport<TransformActionBuilder> configurer)` Creates a new transform action definition for further configuration.
`<T> T`	`variable(String name, T value)` Adds a new variable definition to the set of test variables for this test case and return its value.
`WaitBuilder`	`waitFor()` Creates a wait action that waits for a condition to be satisfied before continuing.
`Wait`	`waitFor(BuilderSupport<WaitBuilder> configurer)` Deprecated. in favor of `waitFor()`
`TestAction`	`zookeeper(BuilderSupport<ZooActionBuilder> configurer)` Run zookeeper command 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 -
  - start
```
void start()
```
    Starts the test case execution.
  - stop
```
void stop()
```
    Stops test case execution.
  - variable
```
<T> T variable(String name,
               T value)
```
    Adds a new variable definition to the set of test variables for this test case and return its value.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
  - run
```
<T extends TestAction> T run(T testAction)
```
    Runs test action and returns same action after execution.
    
    Parameters:
    
    testAction -
    
    Returns:
  - 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
```
AntRunAction antrun(BuilderSupport<AntRunBuilder> configurer)
```
    Creates and executes a new ANT run action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - echo
```
EchoAction echo(String message)
```
    Creates and executes a new echo action.
    
    Parameters:
    
    message -
    
    Returns:
  - plsql
```
ExecutePLSQLAction plsql(BuilderSupport<ExecutePLSQLBuilder> configurer)
```
    Creates a new executePLSQL action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - sql
```
ExecuteSQLAction sql(BuilderSupport<ExecuteSQLBuilder> configurer)
```
    Creates a new executeSQL action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - query
```
ExecuteSQLQueryAction query(BuilderSupport<ExecuteSQLQueryBuilder> configurer)
```
    Creates a new executesqlquery action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - receiveTimeout
```
ReceiveTimeoutAction receiveTimeout(BuilderSupport<ReceiveTimeoutBuilder> configurer)
```
    Creates a new receive timeout action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - fail
```
FailAction fail(String message)
```
    Creates a new fail action.
    
    Parameters:
    
    message -
    
    Returns:
  - input
```
InputAction input(BuilderSupport<InputActionBuilder> configurer)
```
    Creates a new input action.
    
    Parameters:
    
    configurer -
    
    Returns:
  - load
```
LoadPropertiesAction load(String filePath)
```
    Creates a new load properties action.
    
    Parameters:
    
    filePath - path to properties file.
    
    Returns:
  - purgeQueues
```
TestAction purgeQueues(BuilderSupport<PurgeJmsQueuesBuilder> configurer)
```
    Creates a new purge jms queues action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - purgeChannels
```
PurgeMessageChannelAction purgeChannels(BuilderSupport<PurgeChannelsBuilder> configurer)
```
    Creates a new purge message channel action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - purgeEndpoints
```
PurgeEndpointAction purgeEndpoints(BuilderSupport<PurgeEndpointsBuilder> configurer)
```
    Creates a new purge message endpoint action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - receive
```
ReceiveMessageAction receive(BuilderSupport<ReceiveMessageBuilder> configurer)
```
    Creates receive message action definition with message endpoint instance.
    
    Parameters:
    
    configurer -
    
    Returns:
  - send
```
SendMessageAction send(BuilderSupport<SendMessageBuilder> configurer)
```
    Create send message action definition with message endpoint instance.
    
    Parameters:
    
    configurer -
    
    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:
  - waitFor
```
@Deprecated
Wait waitFor(BuilderSupport<WaitBuilder> configurer)
```
    Deprecated. in favor of waitFor()
    
    Creates a wait action that waits for a condition to be satisfied before continuing.
    
    Parameters:
    
    configurer -
    
    Returns:
  - waitFor
```
WaitBuilder waitFor()
```
    Creates a wait action that waits for a condition to be satisfied before continuing.
    
    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
```
GroovyAction groovy(BuilderSupport<GroovyActionBuilder> configurer)
```
    Creates a new groovy action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - transform
```
TransformAction transform(BuilderSupport<TransformActionBuilder> configurer)
```
    Creates a new transform action definition for further configuration.
    
    Parameters:
    
    configurer -
    
    Returns:
  - assertException
```
AssertExceptionBuilder assertException()
```
    Assert exception to happen in nested test action.
    
    Returns:
  - catchException
```
CatchExceptionBuilder catchException()
```
    Catch exception when thrown in nested test action.
    
    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()
```
    Run nested test actions in iteration.
    
    Returns:
  - parallel
```
ParallelBuilder parallel()
```
    Run nested test actions in parallel to each other using multiple threads.
    
    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()
```
    Run nested test actions in sequence.
    
    Returns:
  - async
```
AsyncBuilder async()
```
    Adds async container with nested test actions.
    
    Returns:
  - timer
```
TimerBuilder timer()
```
    Repeat nested test actions based on a timer interval.
    
    Returns:
  - stopTimer
```
StopTimerAction stopTimer(String timerId)
```
    Stops timer matching the supplied timerId
    
    Parameters:
    
    timerId -
    
    Returns:
  - stopTimers
```
StopTimerAction stopTimers()
```
    Stops all timers
    
    Returns:
  - docker
```
TestAction docker(BuilderSupport<DockerActionBuilder> configurer)
```
    Run docker command action.
    
    Returns:
  - kubernetes
```
TestAction kubernetes(BuilderSupport<KubernetesActionBuilder> configurer)
```
    Run kubernetes command action.
    
    Returns:
  - selenium
```
TestAction selenium(BuilderSupport<SeleniumActionBuilder> configurer)
```
    Run selenium command action.
    
    Returns:
  - http
```
TestAction http(BuilderSupport<HttpActionBuilder> configurer)
```
    Run http command action.
    
    Returns:
  - soap
```
TestAction soap(BuilderSupport<SoapActionBuilder> configurer)
```
    Run soap command action.
    
    Returns:
  - camel
```
TestAction camel(BuilderSupport<CamelRouteActionBuilder> configurer)
```
    Run Camel route actions.
    
    Returns:
  - zookeeper
```
TestAction zookeeper(BuilderSupport<ZooActionBuilder> configurer)
```
    Run zookeeper command action.
    
    Returns:
  - applyTemplate
```
Template applyTemplate(BuilderSupport<TemplateBuilder> configurer)
```
    Adds template container with nested test actions.
    
    Parameters:
    
    configurer -
    
    Returns:
  - doFinally
```
FinallySequenceBuilder doFinally()
```
    Adds sequence of test actions to finally block.
    
    Returns:

Interface TestRunner

Method Summary

Methods inherited from interface org.springframework.context.ApplicationContextAware

Method Detail

getTestCase

testClass

name

description

author

packageName

status

creationDate

start

stop

variable

run

applyBehavior

container

createVariable

antrun

echo

plsql

sql

query

receiveTimeout

fail

input

load

purgeQueues

purgeChannels

purgeEndpoints

receive

send

sleep

sleep

waitFor

waitFor

start

start

stop

stop

stopTime

stopTime

stopTime

traceVariables

traceVariables

groovy

transform

assertException

catchException

assertSoapFault

conditional

iterate

parallel

repeatOnError

repeat

sequential

async

timer

stopTimer

stopTimers

docker

kubernetes

selenium

http

soap

camel

zookeeper

applyTemplate

doFinally