com.consol.citrus

Class Citrus

java.lang.Object

com.consol.citrus.Citrus

public final class Citrus
extends Object

Citrus main class initializes a new Citrus runtime environment with a Spring application context. Provides before/after suite action execution and test execution methods.

Since:

2.1

Author:

Christoph Deppisch

Method Summary

Modifier and Type	Method and Description
void	afterSuite(String suiteName, String... testGroups) Performs after suite test actions.
void	beforeSuite(String suiteName, String... testGroups) Performs before suite test actions.
TestContext	createTestContext() Creates a new test context.
org.springframework.context.ApplicationContext	getApplicationContext() Gets the basic Citrus Spring bean application context.
<T extends Endpoint> T	getEndpoint(Class<T> requiredType) Gets the endpoint from Spring application context with given type.
Endpoint	getEndpoint(String name) Gets the endpoint from Spring application context.
<T extends Endpoint> T	getEndpoint(String name, Class<T> requiredType) Gets the endpoint from Spring application context with given type.
static String	getVersion() Gets the Citrus version from classpath resource properties.
static Citrus	newInstance() Initializing method loads Spring application context and reads bean definitions such as test listeners and test context factory.
static Citrus	newInstance(org.springframework.context.ApplicationContext applicationContext) Create new Citrus instance with given Spring bean application context.
static Citrus	newInstance(Class<? extends CitrusBaseConfig> configClass) Initializing method with Spring application context Java configuration class that gets loaded as application context.
void	run(TestAction action) Runs a test action which can also be a whole test case.
void	run(TestAction action, TestContext testContext) Runs test action with given test context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static Citrus newInstance()

Initializing method loads Spring application context and reads bean definitions such as test listeners and test context factory.

Returns:

newInstance

public static Citrus newInstance(Class<? extends CitrusBaseConfig> configClass)

Initializing method with Spring application context Java configuration class that gets loaded as application context.

Returns:

newInstance

public static Citrus newInstance(org.springframework.context.ApplicationContext applicationContext)

Create new Citrus instance with given Spring bean application context.

Parameters:

applicationContext -

Returns:

beforeSuite

public void beforeSuite(String suiteName,
                        String... testGroups)

Performs before suite test actions.

Parameters:

suiteName -

testGroups -

afterSuite

public void afterSuite(String suiteName,
                       String... testGroups)

Performs after suite test actions.

Parameters:

suiteName -

testGroups -

getEndpoint

public Endpoint getEndpoint(String name)

Gets the endpoint from Spring application context.

Parameters:

name -

Returns:

getEndpoint

public <T extends Endpoint> T getEndpoint(Class<T> requiredType)

Gets the endpoint from Spring application context with given type.

Parameters:

requiredType -

Returns:

getEndpoint

public <T extends Endpoint> T getEndpoint(String name,
                                          Class<T> requiredType)

Gets the endpoint from Spring application context with given type.

Parameters:

name -

requiredType -

Returns:

run

public void run(TestAction action)

Runs a test action which can also be a whole test case.

run

public void run(TestAction action,
                TestContext testContext)

Runs test action with given test context. Test action can also be a whole test case.

Parameters:

action -

testContext -

createTestContext

public TestContext createTestContext()

Creates a new test context.

Returns:

the new citrus test context.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Gets the basic Citrus Spring bean application context.

Returns:

getVersion

public static String getVersion()

Gets the Citrus version from classpath resource properties.

Returns: