org.springframework.xd.distributed.util

Class DefaultDistributedTestSupport

java.lang.Object

org.springframework.xd.distributed.util.DefaultDistributedTestSupport

All Implemented Interfaces:

DistributedTestSupport

public class DefaultDistributedTestSupport
extends java.lang.Object
implements DistributedTestSupport

Author:

Patrick Peralta

Constructor Summary

Constructors

Constructor and Description
DefaultDistributedTestSupport()

Method Summary

Methods

Modifier and Type	Method and Description
SpringXDTemplate	ensureTemplate() Return an instance of SpringXDTemplate based on the port configured for the admin server started by DistributedTestSupport.startup().
void	shutdownAll() Shut down all servers started, including those started via DistributedTestSupport.startup() and all containers started via DistributedTestSupport.startContainer(java.util.Properties).
void	shutdownContainer(long pid) Shut down the container JVM with the given process id.
void	shutdownContainers() Shut down all containers started via DistributedTestSupport.startContainer(java.util.Properties).
com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startContainer() Start a container in a new JVM.
com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startContainer(java.util.Properties properties) Start a container in a new JVM, using the provided properties as system properties for the container JVM process.
void	startup() Start the minimum required servers for a distributed XD system: ZooKeeper HSQL Admin server (for serving REST endpoints)
java.util.Map<java.lang.Long,java.lang.String>	waitForContainers() Block the executing thread until all of the container JVMs requested have started.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDistributedTestSupport

public DefaultDistributedTestSupport()

Method Detail

startup

public void startup()

Start the minimum required servers for a distributed XD system:

• ZooKeeper
• HSQL
• Admin server (for serving REST endpoints)

Also populates the following for use in testing:

• containerSystemProperties for use in creating new container processes via ServerProcessUtils.startContainer(java.util.Properties)
• adminUrl for connecting to the admin server

This implementation may only be invoked once for a test suite execution. This restriction is intended to ensure that tests execute as quickly as possible. Starting up the test infrastructure is expensive and multiple invocations will slow test execution down.

Specified by:

startup in interface DistributedTestSupport

ensureTemplate

public SpringXDTemplate ensureTemplate()

Return an instance of SpringXDTemplate based on the port configured for the admin server started by DistributedTestSupport.startup().

Specified by:

ensureTemplate in interface DistributedTestSupport

Returns:

REST template for executing commands against the admin server

startContainer

public com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startContainer(java.util.Properties properties)

Start a container in a new JVM, using the provided properties as system properties for the container JVM process.

Specified by:

startContainer in interface DistributedTestSupport

Parameters:

properties - properties to provide to the container process

Returns:

JVM process for new container

startContainer

public com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startContainer()

Start a container in a new JVM.

Specified by:

startContainer in interface DistributedTestSupport

Returns:

JVM process for new container

waitForContainers

public java.util.Map<java.lang.Long,java.lang.String> waitForContainers()
                                                                 throws java.lang.InterruptedException

Block the executing thread until all of the container JVMs requested have started. This may also be used to ensure that a shut down container JVM process is no longer running.

Specified by:

waitForContainers in interface DistributedTestSupport

Returns:

map of process ID to container UUId for currently running container processes

Throws:

java.lang.InterruptedException

See Also:

ServerProcessUtils.waitForContainers(org.springframework.xd.rest.client.impl.SpringXDTemplate, java.util.Set<java.lang.Long>)

shutdownContainer

public void shutdownContainer(long pid)

Shut down the container JVM with the given process id.

Specified by:

shutdownContainer in interface DistributedTestSupport

Parameters:

pid - process id of container JVM to shut down

shutdownContainers

public void shutdownContainers()
                        throws java.lang.InterruptedException

Shut down all containers started via DistributedTestSupport.startContainer(java.util.Properties). This method will block the executing thread until the admin server indicates that there are no containers running.

Specified by:

shutdownContainers in interface DistributedTestSupport

Throws:

java.lang.InterruptedException

shutdownAll

public void shutdownAll()
                 throws java.lang.InterruptedException

Shut down all servers started, including those started via DistributedTestSupport.startup() and all containers started via DistributedTestSupport.startContainer(java.util.Properties).

Specified by:

shutdownAll in interface DistributedTestSupport

Throws:

java.lang.InterruptedException