org.springframework.xd.dirt.test

Class SingleNodeIntegrationTestSupport

java.lang.Object

org.springframework.xd.dirt.test.SingleNodeIntegrationTestSupport

public class SingleNodeIntegrationTestSupport
extends java.lang.Object

A helper class that provides methods used for testing streams with SingleNodeApplication. It exposes components and methods used for stream creation, deployment, and destruction and provides access to the MessageBus. Additionally, it supports registration of modules contained in a local resource location (default: "file:./config"). Note that all operations block until the expected state is verified or the operation times out.

Author:

David Turanski, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
SingleNodeIntegrationTestSupport(SingleNodeApplication application)
SingleNodeIntegrationTestSupport(SingleNodeApplication application, java.lang.String moduleResourceLocation) Constructor useful for testing custom modules

Method Summary

Methods

Modifier and Type	Method and Description
void	addPathListener(java.lang.String path, org.apache.curator.framework.recipes.cache.PathChildrenCacheListener listener) Add a PathChildrenCacheListener for the given path.
boolean	createAndDeployStream(StreamDefinition definition) Create and deploy a stream.
void	deleteStream(java.lang.String name) Delete a stream.
boolean	deployStream(StreamDefinition definition) Deploy a stream.
boolean	deployStream(StreamDefinition definition, java.util.Map<java.lang.String,java.lang.String> properties) Deploy a stream with properties.
boolean	deployStream(StreamDefinition definition, java.util.Map<java.lang.String,java.lang.String> properties, boolean allowIncomplete) Deploy a stream with properties and allow return on incomplete deployment
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,Module>>	getDeployedModules() Get all currently deployed modules.
Module	getModule(java.lang.String streamName, java.lang.String moduleName, int index) Get a deployed module instance.
JobDefinitionRepository	jobDefinitionRepository()
JobRepository	jobRepository()
ResourceStateVerifier	jobStateVerifier()
MessageBusSupport	messageBus()
void	removePathListener(java.lang.String path, org.apache.curator.framework.recipes.cache.PathChildrenCacheListener listener) Remove a PathChildrenCacheListener for the given path.
StreamDefinitionRepository	streamDefinitionRepository()
StreamDeployer	streamDeployer()
StreamRepository	streamRepository()
ResourceStateVerifier	streamStateVerifier()
boolean	undeployAndDestroyStream(StreamDefinition definition) Undeploy and destroy a stream.
boolean	undeployStream(StreamDefinition definition) Undeploy a stream.
ZooKeeperConnection	zooKeeperConnection()

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleNodeIntegrationTestSupport

public SingleNodeIntegrationTestSupport(SingleNodeApplication application)

SingleNodeIntegrationTestSupport

public SingleNodeIntegrationTestSupport(SingleNodeApplication application,
                                java.lang.String moduleResourceLocation)

Constructor useful for testing custom modules

Parameters:

application - the SingleNodeApplication

moduleResourceLocation - an additional Spring (file: or classpath:) resource location used by the ModuleRegistry

Method Detail

getDeployedModules

public final java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,Module>> getDeployedModules()

Get all currently deployed modules.

Returns:

a map keyed by stream name. Each entry is a map of the modules by module index(stream left to right order).

streamDeployer

public final StreamDeployer streamDeployer()

streamRepository

public final StreamRepository streamRepository()

streamStateVerifier

public final ResourceStateVerifier streamStateVerifier()

jobStateVerifier

public final ResourceStateVerifier jobStateVerifier()

jobRepository

public final JobRepository jobRepository()

jobDefinitionRepository

public final JobDefinitionRepository jobDefinitionRepository()

streamDefinitionRepository

public final StreamDefinitionRepository streamDefinitionRepository()

messageBus

public final MessageBusSupport messageBus()

deployStream

public final boolean deployStream(StreamDefinition definition)

Deploy a stream.

Parameters:

definition - the stream definition

Returns:

true if the operation succeeded

deployStream

public final boolean deployStream(StreamDefinition definition,
                   java.util.Map<java.lang.String,java.lang.String> properties)

Deploy a stream with properties.

Parameters:

definition - the stream definition

properties - the deployment properties

Returns:

true if the operation succeeded

deployStream

public final boolean deployStream(StreamDefinition definition,
                   java.util.Map<java.lang.String,java.lang.String> properties,
                   boolean allowIncomplete)

Deploy a stream with properties and allow return on incomplete deployment

Parameters:

definition - the stream definition

properties - the deployment properties

allowIncomplete - allow incomplete as well as deployed state

Returns:

true if operation succeeded

createAndDeployStream

public final boolean createAndDeployStream(StreamDefinition definition)

Create and deploy a stream.

Parameters:

definition - the stream definition

Returns:

true if the operation succeeded.

undeployStream

public final boolean undeployStream(StreamDefinition definition)

Undeploy a stream.

Parameters:

definition - the stream definition

Returns:

true if the operation succeeded

undeployAndDestroyStream

public final boolean undeployAndDestroyStream(StreamDefinition definition)

Undeploy and destroy a stream.

Parameters:

definition - the stream definition

Returns:

true if the operation succeeded

deleteStream

public final void deleteStream(java.lang.String name)

Delete a stream.

Parameters:

name - the stream name

getModule

public final Module getModule(java.lang.String streamName,
               java.lang.String moduleName,
               int index)

Get a deployed module instance.

Parameters:

streamName - the stream name

moduleName - the module name

index - the index of the module in the stream, ordered left to right starting with 0.

Returns:

the module

zooKeeperConnection

public ZooKeeperConnection zooKeeperConnection()

Returns:

the zookeeperConnection

addPathListener

public void addPathListener(java.lang.String path,
                   org.apache.curator.framework.recipes.cache.PathChildrenCacheListener listener)

Add a PathChildrenCacheListener for the given path.

Parameters:

path - the path whose children to listen to

listener - the children listener

removePathListener

public void removePathListener(java.lang.String path,
                      org.apache.curator.framework.recipes.cache.PathChildrenCacheListener listener)

Remove a PathChildrenCacheListener for the given path.

Parameters:

path - the path whose children to listen to

listener - the children listener