com.arakelian.docker.junit

Class Container

java.lang.Object

com.arakelian.docker.junit.Container

public class Container
extends java.lang.Object

Represents a connection to a Docker container.

Constructor Summary

Constructors

Constructor and Description
Container(java.lang.String name, com.spotify.docker.client.messages.ContainerConfig config, boolean alwaysRemoveContainer, ContainerListener listener) Construct a container.

Method Summary

Modifier and Type	Method and Description
protected com.spotify.docker.client.DockerClient	createDockerClient()
com.spotify.docker.client.DockerClient	getClient()
java.lang.String	getContainerId()
java.lang.String	getHost()
com.spotify.docker.client.messages.ContainerInfo	getInfo()
int	getPort(java.lang.String portName)
static boolean	isSocketAlive(java.net.SocketAddress socketAddress, int timeout)
void	stop()
void	waitForLog(int timeout, java.util.concurrent.TimeUnit unit, java.lang.String... messages) Wait for nth occurrence of message to appear in docker logs within the specified timeframe.
void	waitForLog(java.lang.String... messages) Wait for a sequence of messages to appear in docker logs.
void	waitForPort(int port) Wait for the specified port to accept socket connection.
void	waitForPort(int port, int timeout, java.util.concurrent.TimeUnit unit) Wait for the specified port to accept socket connection within a given timeframe.

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container(java.lang.String name,
                 com.spotify.docker.client.messages.ContainerConfig config,
                 boolean alwaysRemoveContainer,
                 ContainerListener listener)

Construct a container.

Parameters:

name - name to assign to container, or null to use default

config - the container configuration

alwaysRemoveContainer - true if we should always remove container, e.g. "docker rm" after unit tests; by default, the docker container is left around so that it can be reused again.

listener - listener for container events, may be null

Method Detail

isSocketAlive

public static boolean isSocketAlive(java.net.SocketAddress socketAddress,
                                    int timeout)

createDockerClient

protected com.spotify.docker.client.DockerClient createDockerClient()

getClient

public final com.spotify.docker.client.DockerClient getClient()

getContainerId

public final java.lang.String getContainerId()

getHost

public final java.lang.String getHost()

getInfo

public final com.spotify.docker.client.messages.ContainerInfo getInfo()

getPort

public final int getPort(java.lang.String portName)

stop

public void stop()

waitForLog

public final void waitForLog(int timeout,
                             java.util.concurrent.TimeUnit unit,
                             java.lang.String... messages)
                      throws com.spotify.docker.client.exceptions.DockerException,
                             java.lang.InterruptedException

Wait for nth occurrence of message to appear in docker logs within the specified timeframe.

Parameters:

timeout - timeout value

unit - timeout units

messages - The sequence of messages to wait for

Throws:

com.spotify.docker.client.exceptions.DockerException - if docker throws exception while tailing logs

java.lang.InterruptedException - if thread interrupted while waiting for timeout

waitForLog

public final void waitForLog(java.lang.String... messages)
                      throws com.spotify.docker.client.exceptions.DockerException,
                             java.lang.InterruptedException

Wait for a sequence of messages to appear in docker logs.

Parameters:

messages - The sequence of messages to wait for

Throws:

com.spotify.docker.client.exceptions.DockerException - if docker throws exception while tailing logs

java.lang.InterruptedException - if thread interrupted while waiting for timeout

waitForPort

public final void waitForPort(int port)

Wait for the specified port to accept socket connection.

Parameters:

port - target port number

waitForPort

public final void waitForPort(int port,
                              int timeout,
                              java.util.concurrent.TimeUnit unit)

Wait for the specified port to accept socket connection within a given timeframe.

Parameters:

port - target port number

timeout - timeout value

unit - timeout units