org.springframework.xd.integration.util

Class StreamUtils

java.lang.Object

org.springframework.xd.integration.util.StreamUtils

public class StreamUtils
extends java.lang.Object

Utilities for creating and monitoring streams and the JMX hooks for those strings.

Author:

Glenn Renfro

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TMP_DIR

Constructor Summary

Constructors

Constructor and Description
StreamUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendToRemoteFile(java.lang.String privateKey, java.lang.String host, java.lang.String dir, java.lang.String fileName, java.lang.String payload) Appends the payload to an existing file on a remote EC2 Instance.
static void	copyFileToRemote(java.lang.String privateKey, java.lang.String host, java.net.URI uri, java.io.File file, long waitTime) Copy a file from test machine to remote machine.
static boolean	createDataFileOnRemote(java.lang.String privateKey, java.lang.String host, java.lang.String dir, java.lang.String fileName, java.lang.String payload, int retryTime) Creates a file on a remote EC2 machine with the payload as its contents.
static boolean	createRemoteDirectory(java.lang.String path, java.lang.String host, java.lang.String privateKey, int waitTime) Creates a directory on a remote machine.
static void	destroyAllStreams(java.net.URL adminServer) Removes all the streams from the cluster.
static boolean	fileExists(java.lang.String host, java.lang.String privateKey, java.lang.String path) Verifies the specified path exists on remote machine.
static java.util.Map<java.lang.String,java.lang.String>	getAvailableContainers(java.net.URL adminServer) Creates a map of container Id's and the associated host.
static java.lang.Integer[]	getContainerPidsFromURL(java.net.URL url, java.lang.String privateKey, java.lang.String jpsCommand) Retrieves the container pids for a remote machine.
static long	getCount(java.net.URL adminServer, java.lang.String name) Retrieves the value for the counter
static java.util.List<org.jclouds.ec2.domain.RunningInstance>	getEC2RunningInstances(java.lang.String awsAccessKey, java.lang.String awsSecretKey, java.lang.String awsRegion) Returns a list of active instances from the specified ec2 region.
static java.lang.Integer[]	getLocalContainerPids(java.lang.String jpsCommand) Retrieves the container pids on the local machine.
static org.springframework.hateoas.PagedResources<ModuleMetadataResource>	getRuntimeModules(java.net.URL adminServer) Return a list of container id's where the module is deployed
static java.lang.String	httpGet(java.net.URL url) Executes a http get for the client and returns the results as a string
static boolean	isStreamDeployed(java.lang.String streamName, java.net.URL adminServer) Checks to see if the specified stream is deployed on the XD cluster.
static java.net.URL	replacePort(java.net.URL url, int port) Substitutes the port associated with the URL with another port.
static void	stream(java.lang.String streamName, java.lang.String streamDefinition, java.net.URL adminServer) Creates the stream definition and deploys it to the cluster being tested.
static java.lang.String	transferResultsToLocal(java.lang.String privateKey, java.net.URL url, java.lang.String fileName) Copies the specified file from a remote machine to local machine.
static void	undeployStream(java.net.URL adminServer, java.lang.String streamName) Undeploys the specified stream name
static boolean	waitForMetric(java.lang.String name, java.net.URL adminServer, int waitTime) Waits up to the wait time for a metric to be created.
static boolean	waitForStreamDeployment(java.lang.String streamName, java.net.URL adminServer, int waitTime) Waits up to the wait time for a stream to be deployed.

Methods inherited from class java.lang.Object

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

Field Detail

TMP_DIR

public static final java.lang.String TMP_DIR

See Also:

Constant Field Values

Constructor Detail

StreamUtils

public StreamUtils()

Method Detail

stream

public static void stream(java.lang.String streamName,
          java.lang.String streamDefinition,
          java.net.URL adminServer)

Creates the stream definition and deploys it to the cluster being tested.

Parameters:

streamName - The name of the stream

streamDefinition - The definition that needs to be deployed for this stream.

adminServer - The admin server that this stream will be deployed against.

httpGet

public static java.lang.String httpGet(java.net.URL url)

Executes a http get for the client and returns the results as a string

Parameters:

url - The location to execute the get against.

Returns:

the string result of the get

destroyAllStreams

public static void destroyAllStreams(java.net.URL adminServer)

Removes all the streams from the cluster. Used to guarantee a clean acceptance test.

Parameters:

adminServer - The admin server that the command will be executed against.

undeployStream

public static void undeployStream(java.net.URL adminServer,
                  java.lang.String streamName)

Undeploys the specified stream name

Parameters:

adminServer - The admin server that the command will be executed against.

streamName - The name of the stream to undeploy

getCount

public static long getCount(java.net.URL adminServer,
            java.lang.String name)

Retrieves the value for the counter

Parameters:

adminServer - the admin server for the cluster being tested.

name - the name of the counter in the metric repo.

Returns:

the count associated with the name.

transferResultsToLocal

public static java.lang.String transferResultsToLocal(java.lang.String privateKey,
                                      java.net.URL url,
                                      java.lang.String fileName)

Copies the specified file from a remote machine to local machine.

Parameters:

privateKey - the ssh private key to the remote machine

url - The remote machine's url.

fileName - The fully qualified file name of the file to be transferred.

Returns:

The location to the fully qualified file name where the remote file was copied.

createDataFileOnRemote

public static boolean createDataFileOnRemote(java.lang.String privateKey,
                             java.lang.String host,
                             java.lang.String dir,
                             java.lang.String fileName,
                             java.lang.String payload,
                             int retryTime)

Creates a file on a remote EC2 machine with the payload as its contents.

Parameters:

privateKey - The ssh private key for the remote container

host - The remote machine's ip.

dir - The directory to write the file

fileName - The fully qualified file name of the file to be created.

payload - the data to write to the file

retryTime - the time in millis to retry to push data file to remote system.

copyFileToRemote

public static void copyFileToRemote(java.lang.String privateKey,
                    java.lang.String host,
                    java.net.URI uri,
                    java.io.File file,
                    long waitTime)

Copy a file from test machine to remote machine.

Parameters:

privateKey - The ssh private key for the remote container

host - The remote machine's ip.

uri - to the location where the file will be copied to remote machine.

file - The file to migrate to remote machine.

createRemoteDirectory

public static boolean createRemoteDirectory(java.lang.String path,
                            java.lang.String host,
                            java.lang.String privateKey,
                            int waitTime)

Creates a directory on a remote machine. It a failure occurs it will retry until waitTime is exhausted.

Parameters:

path - the directory that will be created

host - the IP where the directory will be created

privateKey - Private key to be used for signing onto remote machine.

waitTime - The max time to try creating the directory

Returns:

true if the directory was successfully created else false.

appendToRemoteFile

public static void appendToRemoteFile(java.lang.String privateKey,
                      java.lang.String host,
                      java.lang.String dir,
                      java.lang.String fileName,
                      java.lang.String payload)

Appends the payload to an existing file on a remote EC2 Instance.

Parameters:

privateKey - The ssh private key for the remote container

host - The remote machine's ip.

dir - The directory to write the file

fileName - The fully qualified file name of the file to be created.

payload - the data to append to the file

getEC2RunningInstances

public static java.util.List<org.jclouds.ec2.domain.RunningInstance> getEC2RunningInstances(java.lang.String awsAccessKey,
                                                                            java.lang.String awsSecretKey,
                                                                            java.lang.String awsRegion)

Returns a list of active instances from the specified ec2 region.

Parameters:

awsAccessKey - the unique id of the ec2 user.

awsSecretKey - the password of ec2 user.

awsRegion - The aws region to inspect for acceptance test instances.

Returns:

a list of active instances in the account and region specified.

replacePort

public static java.net.URL replacePort(java.net.URL url,
                       int port)

Substitutes the port associated with the URL with another port.

Parameters:

url - The URL that needs a port replaced.

port - The new port number

Returns:

A new URL with the host from the URL passed in and the new port.

getAvailableContainers

public static java.util.Map<java.lang.String,java.lang.String> getAvailableContainers(java.net.URL adminServer)

Creates a map of container Id's and the associated host.

Parameters:

adminServer - The admin server to be queried.

Returns:

Map where the key is the container id and the value is the host ip.

getRuntimeModules

public static org.springframework.hateoas.PagedResources<ModuleMetadataResource> getRuntimeModules(java.net.URL adminServer)

Return a list of container id's where the module is deployed

Parameters:

adminServer - The admin server that will be queried.

Returns:

A list of containers where the module is deployed.

waitForStreamDeployment

public static boolean waitForStreamDeployment(java.lang.String streamName,
                              java.net.URL adminServer,
                              int waitTime)

Waits up to the wait time for a stream to be deployed.

Parameters:

streamName - The name of the stream to be evaluated.

adminServer - The admin server URL that will be queried.

waitTime - the amount of time in millis to wait.

Returns:

true if the stream is deployed else false.

isStreamDeployed

public static boolean isStreamDeployed(java.lang.String streamName,
                       java.net.URL adminServer)

Checks to see if the specified stream is deployed on the XD cluster.

Parameters:

streamName - The name of the stream to be evaluated.

adminServer - The admin server URL that will be queried.

Returns:

true if the stream is deployed else false

waitForMetric

public static boolean waitForMetric(java.lang.String name,
                    java.net.URL adminServer,
                    int waitTime)

Waits up to the wait time for a metric to be created.

Parameters:

name - The name of the metric to be evaluated.

adminServer - The admin server URL that will be queried.

waitTime - the amount of time in millis to wait.

Returns:

true if the metric is created else false.

getLocalContainerPids

public static java.lang.Integer[] getLocalContainerPids(java.lang.String jpsCommand)

Retrieves the container pids on the local machine.

Parameters:

jpsCommand - jps command that will reveal the pids.

Returns:

An Integer array that contains the pids.

getContainerPidsFromURL

public static java.lang.Integer[] getContainerPidsFromURL(java.net.URL url,
                                          java.lang.String privateKey,
                                          java.lang.String jpsCommand)

Retrieves the container pids for a remote machine.

Parameters:

url - The URL where the containers are deployed.

privateKey - ssh private key credential

jpsCommand - The command to retrieve java processes on container machine.

Returns:

An Integer array that contains the pids.

fileExists

public static boolean fileExists(java.lang.String host,
                 java.lang.String privateKey,
                 java.lang.String path)

Verifies the specified path exists on remote machine.

Parameters:

host - The host where the file exists.

privateKey - ssh private key credential

path - path to file or directory

Returns:

true if file exists else false.