org.glassfish.tyrus.test.tools

Class TestContainer

java.lang.Object

org.glassfish.tyrus.test.tools.TestContainer

public class TestContainer
extends Object

Utilities for creating automated tests easily.

Author:

Stepan Kopriva (stepan.kopriva at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestContainer.MyServiceClientEndpoint

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NEGATIVE
protected static String	POSITIVE

Constructor Summary

Constructors

Constructor and Description
TestContainer()

Method Summary

Modifier and Type	Method and Description
protected ClientManager	createClient() Get the ClientManager instance.
protected String	getHost()
protected int	getPort() Get port used for creating remote endpoint URI.
Map<String,Object>	getServerProperties() Get server properties.
protected URI	getURI(Class<?> serverClass) Get the URI for the ServerEndpoint annotated class.
protected URI	getURI(Class<?> serverClass, String scheme) Get the URI for the ServerEndpoint annotated class.
protected URI	getURI(String endpointPath) Get the URI for the given String path.
protected URI	getURI(String endpointPath, String scheme) Get the URI for the given String path.
void	setContextPath(String contextPath) Sets the context path.
void	setDefaultHost(String defaultHost) Sets the default host.
void	setDefaultPort(int defaultPort) Sets the default port.
void	setServerProperties(Map<String,Object> properties) Set properties.
protected Server	startServer(Class<?>... endpointClasses) Start embedded server unless "tyrus.test.host" system property is specified.
protected void	stopServer(Server server) Stop the server.
protected void	testViaServiceEndpoint(ClientManager client, Class<?> serviceEndpoint, String expectedResult, String message) Send message to the service endpoint and compare the received result with the specified one.

Methods inherited from class java.lang.Object

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

Field Detail

POSITIVE

protected static final String POSITIVE

See Also:

Constant Field Values

NEGATIVE

protected static final String NEGATIVE

See Also:

Constant Field Values

Constructor Detail

TestContainer

public TestContainer()

Method Detail

startServer

protected Server startServer(Class<?>... endpointClasses)
                      throws javax.websocket.DeploymentException

Start embedded server unless "tyrus.test.host" system property is specified.

Returns:

new Server instance or null if "tyrus.test.host" system property is set.

Throws:

javax.websocket.DeploymentException

stopServer

protected void stopServer(Server server)

Stop the server.

Parameters:

server - to be stopped.

getHost

protected String getHost()

getPort

protected int getPort()

Get port used for creating remote endpoint URI.

Can be overridden by TestContainer descendants.

Returns:

port used for creating remote endpoint URI.

getURI

protected URI getURI(Class<?> serverClass)

Get the URI for the ServerEndpoint annotated class.

Parameters:

serverClass - the annotated class the URI is computed for.

Returns:

URI which is used to connect to the given endpoint.

getURI

protected URI getURI(Class<?> serverClass,
                     String scheme)

Get the URI for the ServerEndpoint annotated class.

Parameters:

serverClass - the annotated class the URI is computed for.

scheme - scheme of newly created URI. If null, "ws" will be used.

Returns:

URI which is used to connect to the given endpoint.

getURI

protected URI getURI(String endpointPath)

Get the URI for the given String path.

Parameters:

endpointPath - the path the URI is computed for.

Returns:

URI which is used to connect to the given path.

getURI

protected URI getURI(String endpointPath,
                     String scheme)

Get the URI for the given String path.

Parameters:

endpointPath - the path the URI is computed for.

scheme - scheme of newly created URI. If null, "ws" will be used.

Returns:

URI which is used to connect to the given path.

createClient

protected ClientManager createClient()

Get the ClientManager instance.

Returns:

ClientManager which can be used to connect to a server

getServerProperties

public Map<String,Object> getServerProperties()

Get server properties.

Returns:

server properties.

setServerProperties

public void setServerProperties(Map<String,Object> properties)

Set properties.

Parameters:

properties - server properties.

testViaServiceEndpoint

protected void testViaServiceEndpoint(ClientManager client,
                                      Class<?> serviceEndpoint,
                                      String expectedResult,
                                      String message)
                               throws javax.websocket.DeploymentException,
                                      IOException,
                                      InterruptedException

Send message to the service endpoint and compare the received result with the specified one.

Parameters:

client - client used to send the message.

serviceEndpoint - endpoint to which the message will be sent.

expectedResult - expected reply.

message - message to be sent.

Throws:

javax.websocket.DeploymentException

IOException

InterruptedException

setContextPath

public void setContextPath(String contextPath)

Sets the context path.

Parameters:

contextPath - the path to be set.

setDefaultHost

public void setDefaultHost(String defaultHost)

Sets the default host.

Parameters:

defaultHost - the host to be set.

setDefaultPort

public void setDefaultPort(int defaultPort)

Sets the default port.

Parameters:

defaultPort - default port number.