org.testcontainers.containers

Class GenericContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer

All Implemented Interfaces:

org.junit.rules.TestRule, LinkableContainer

Direct Known Subclasses:

VncRecordingSidekickContainer

public class GenericContainer
extends FailureDetectingExternalResource
implements LinkableContainer

Base class for that allows a container to be launched and controlled.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	containerId
protected String	containerName
protected com.github.dockerjava.api.DockerClient	dockerClient

Constructor Summary

Constructors

Constructor and Description
GenericContainer()
GenericContainer(String dockerImageName)

Method Summary

Modifier and Type	Method and Description
void	addEnv(String key, String value) Add an environment variable to be passed to the container.
void	addExposedPort(Integer port)
void	addExposedPorts(int... ports)
void	addFileSystemBind(String hostPath, String containerPath, BindMode mode)
void	addLink(LinkableContainer otherContainer, String alias)
protected void	configure()
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
protected void	containerIsStarting(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
protected Path	createVolumeDirectory(boolean temporary) Creates a directory on the local filesystem which will be mounted as a volume for the container.
protected void	finished(org.junit.runner.Description description)
String	getHostIpAddress() Get the IP address that containers (e.g.
String	getIpAddress() Get the IP address that this container may be reached on (may not be the local machine).
protected Integer	getLivenessCheckPort()
Integer	getMappedPort(int originalPort) Get the actual mapped port for a given port exposed by the container.
Boolean	isRunning()
protected org.slf4j.Logger	logger() Provide a logger that references the docker image name.
void	setCommand(String... commandParts) Set the command that should be run in the container
void	setCommand(String command) Set the command that should be run in the container
void	setDockerImageName(String dockerImageName)
void	start() Starts the container using docker, pulling an image if necessary.
protected void	starting(org.junit.runner.Description description)
void	stop() Stops the container.
protected void	waitForListeningPort(String ipAddress, Integer port) Waits for a port to start listening for incoming connections.
protected void	waitUntilContainerStarted() Wait until the container has started.
GenericContainer	withClasspathResourceMapping(String resourcePath, String containerPath, BindMode mode) Map a resource (file or directory) on the classpath to a path inside the container
GenericContainer	withCommand(String... commandParts) Set the command that should be run in the container
GenericContainer	withCommand(String cmd) Set the command that should be run in the container
GenericContainer	withEnv(String key, String value) Add an environment variable to be passed to the container.
GenericContainer	withExposedPorts(Integer... ports) Set the ports that this container listens on

Methods inherited from class org.testcontainers.containers.FailureDetectingExternalResource

apply, failed, succeeded

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.containers.traits.LinkableContainer

getContainerName

Field Detail

dockerClient

protected com.github.dockerjava.api.DockerClient dockerClient

containerId

protected String containerId

containerName

protected String containerName

Constructor Detail

GenericContainer

public GenericContainer()

GenericContainer

public GenericContainer(@NonNull
                        String dockerImageName)

Method Detail

start

public void start()

Starts the container using docker, pulling an image if necessary.

stop

public void stop()

Stops the container.

logger

protected org.slf4j.Logger logger()

Provide a logger that references the docker image name.

Returns:

a logger that references the docker image name

createVolumeDirectory

protected Path createVolumeDirectory(boolean temporary)
                              throws IOException

Creates a directory on the local filesystem which will be mounted as a volume for the container.

Parameters:

temporary - is the volume directory temporary? If true, the directory will be deleted on JVM shutdown.

Returns:

path to the volume directory

Throws:

IOException

configure

protected void configure()

containerIsStarting

protected void containerIsStarting(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

containerIsStarted

protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

getLivenessCheckPort

protected Integer getLivenessCheckPort()

waitUntilContainerStarted

protected void waitUntilContainerStarted()

Wait until the container has started. The default implementation simply waits for a port to start listening; subclasses may override if more sophisticated behaviour is required.

waitForListeningPort

protected void waitForListeningPort(String ipAddress,
                                    Integer port)

Waits for a port to start listening for incoming connections.

Parameters:

ipAddress - the IP address to attempt to connect to

port - the port which will start accepting connections

setCommand

public void setCommand(@NonNull
                       String command)

Set the command that should be run in the container

Parameters:

command - a command in single string format (will automatically be split on spaces)

setCommand

public void setCommand(@NonNull
                       String... commandParts)

Set the command that should be run in the container

Parameters:

commandParts - a command as an array of string parts

addEnv

public void addEnv(String key,
                   String value)

Add an environment variable to be passed to the container.

Parameters:

key - environment variable key

value - environment variable value

addFileSystemBind

public void addFileSystemBind(String hostPath,
                              String containerPath,
                              BindMode mode)

addLink

public void addLink(LinkableContainer otherContainer,
                    String alias)

addExposedPort

public void addExposedPort(Integer port)

addExposedPorts

public void addExposedPorts(int... ports)

starting

protected void starting(org.junit.runner.Description description)

Overrides:

starting in class FailureDetectingExternalResource

finished

protected void finished(org.junit.runner.Description description)

Overrides:

finished in class FailureDetectingExternalResource

withExposedPorts

public GenericContainer withExposedPorts(Integer... ports)

Set the ports that this container listens on

Parameters:

ports - an array of TCP ports

Returns:

this

withEnv

public GenericContainer withEnv(String key,
                                String value)

Add an environment variable to be passed to the container.

Parameters:

key - environment variable key

value - environment variable value

Returns:

this

withCommand

public GenericContainer withCommand(String cmd)

Set the command that should be run in the container

Parameters:

cmd - a command in single string format (will automatically be split on spaces)

Returns:

this

withCommand

public GenericContainer withCommand(String... commandParts)

Set the command that should be run in the container

Parameters:

commandParts - a command as an array of string parts

Returns:

this

withClasspathResourceMapping

public GenericContainer withClasspathResourceMapping(String resourcePath,
                                                     String containerPath,
                                                     BindMode mode)

Map a resource (file or directory) on the classpath to a path inside the container

Parameters:

resourcePath - path to the resource on the classpath (relative to the classpath root; should not start with a leading slash)

containerPath - path this should be mapped to inside the container

mode - access mode for the file

Returns:

this

getIpAddress

public String getIpAddress()

Get the IP address that this container may be reached on (may not be the local machine).

Returns:

an IP address

isRunning

public Boolean isRunning()

Returns:

is the container currently running?

getMappedPort

public Integer getMappedPort(int originalPort)

Get the actual mapped port for a given port exposed by the container.

Parameters:

originalPort - the original TCP port that is exposed

Returns:

the port that the exposed port is mapped to, or null if it is not exposed

setDockerImageName

public void setDockerImageName(@NonNull
                               String dockerImageName)

getHostIpAddress

public String getHostIpAddress()

Get the IP address that containers (e.g. browsers) can use to reference a service running on the local machine, i.e. the machine on which this test is running.

For example, if a web server is running on port 8080 on this local machine, the containerized web driver needs to be pointed at "http://" + getHostIpAddress() + ":8080" in order to access it. Trying to hit localhost from inside the container is not going to work, since the container has its own IP address.

Returns:

the IP address of the host machine