org.testcontainers.containers

Interface ContainerState

All Known Subinterfaces:

Container<SELF>, WaitStrategyTarget

All Known Implementing Classes:

FixedHostPortGenericContainer, GenericContainer, SocatContainer, VncRecordingContainer

public interface ContainerState

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
default void	copyFileFromContainer(java.lang.String containerPath, java.lang.String destinationPath) Copies a file which resides inside the container to user defined directory
default <T> T	copyFileFromContainer(java.lang.String containerPath, ThrowingFunction<java.io.InputStream,T> function) Streams a file which resides inside the container
default void	copyFileToContainer(MountableFile mountableFile, java.lang.String containerPath) Copies a file or directory to the container.
default void	copyFileToContainer(Transferable transferable, java.lang.String containerPath) Copies a file to the container.
default Container.ExecResult	execInContainer(java.nio.charset.Charset outputCharset, ExecConfig execConfig) Run a command inside a running container, as though using "docker exec".
default Container.ExecResult	execInContainer(java.nio.charset.Charset outputCharset, java.lang.String... command) Run a command inside a running container, as though using "docker exec".
default Container.ExecResult	execInContainer(ExecConfig execConfig) Run a command inside a running container, as though using "docker exec".
default Container.ExecResult	execInContainer(java.lang.String... command) Run a command inside a running container, as though using "docker exec", and interpreting the output as UTF8.
default Container.ExecResult	execInContainerWithUser(java.nio.charset.Charset outputCharset, java.lang.String user, java.lang.String... command) Deprecated. use execInContainer(Charset, ExecConfig)
default Container.ExecResult	execInContainerWithUser(java.lang.String user, java.lang.String... command) Deprecated. use execInContainer(ExecConfig)
default java.util.List<java.lang.Integer>	getBoundPortNumbers()
default java.lang.String	getContainerId()
com.github.dockerjava.api.command.InspectContainerResponse	getContainerInfo() Returns the container inspect response.
default java.lang.String	getContainerIpAddress() Deprecated. use getHost()
default com.github.dockerjava.api.command.InspectContainerResponse	getCurrentContainerInfo() Inspects the container and returns up-to-date inspection response.
default com.github.dockerjava.api.DockerClient	getDockerClient()
java.util.List<java.lang.Integer>	getExposedPorts()
default java.lang.Integer	getFirstMappedPort() Get the actual mapped port for a first port exposed by the container.
default java.lang.String	getHost() Get the host that this container may be reached on (may not be the local machine).
default java.lang.String	getLogs()
default java.lang.String	getLogs(OutputFrame.OutputType... types)
default java.lang.Integer	getMappedPort(int originalPort) Get the actual mapped port for a given port exposed by the container.
default java.util.List<java.lang.String>	getPortBindings()
default boolean	isCreated()
default boolean	isHealthy()
default boolean	isRunning()

Field Detail

STATE_HEALTHY

static final java.lang.String STATE_HEALTHY

See Also:

Constant Field Values

Method Detail

getContainerIpAddress

@Deprecated
default java.lang.String getContainerIpAddress()

Deprecated. use getHost()

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

Returns:

an IP address

See Also:

getHost()

getDockerClient

default com.github.dockerjava.api.DockerClient getDockerClient()

getHost

default java.lang.String getHost()

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

Returns:

a host

isRunning

default boolean isRunning()

Returns:

is the container currently running?

isCreated

default boolean isCreated()

Returns:

is the container created?

isHealthy

default boolean isHealthy()

Returns:

has the container health state 'healthy'?

getCurrentContainerInfo

default com.github.dockerjava.api.command.InspectContainerResponse getCurrentContainerInfo()

Inspects the container and returns up-to-date inspection response.

Returns:

up-to-date container inspect response

See Also:

getContainerInfo()

getFirstMappedPort

default java.lang.Integer getFirstMappedPort()

Get the actual mapped port for a first port exposed by the container. Should be used in conjunction with getHost().

Returns:

the port that the exposed port is mapped to

Throws:

java.lang.IllegalStateException - if there are no exposed ports

getMappedPort

default java.lang.Integer getMappedPort(int originalPort)

Get the actual mapped port for a given port exposed by the container. It should be used in conjunction with getHost().

Note: The returned port number might be outdated (for instance, after disconnecting from a network and reconnecting again). If you always need up-to-date value, override the getContainerInfo() to return the getCurrentContainerInfo().

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

See Also:

getContainerInfo(), getCurrentContainerInfo()

getExposedPorts

java.util.List<java.lang.Integer> getExposedPorts()

Returns:

the exposed ports

getPortBindings

default java.util.List<java.lang.String> getPortBindings()

Returns:

the port bindings

getBoundPortNumbers

default java.util.List<java.lang.Integer> getBoundPortNumbers()

Returns:

the bound port numbers

getLogs

default java.lang.String getLogs()

Returns:

all log output from the container from start until the current instant (both stdout and stderr)

getLogs

default java.lang.String getLogs(OutputFrame.OutputType... types)

Parameters:

types - log types to return

Returns:

all log output from the container from start until the current instant

getContainerId

default java.lang.String getContainerId()

Returns:

the id of the container

getContainerInfo

com.github.dockerjava.api.command.InspectContainerResponse getContainerInfo()

Returns the container inspect response. The response might be cached/outdated.

Returns:

the container info

See Also:

getCurrentContainerInfo()

execInContainer

default Container.ExecResult execInContainer(java.lang.String... command)
                                      throws java.lang.UnsupportedOperationException,
                                             java.io.IOException,
                                             java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec", and interpreting the output as UTF8.

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

execInContainer(Charset, String...)

execInContainer

default Container.ExecResult execInContainer(java.nio.charset.Charset outputCharset,
                                             java.lang.String... command)
                                      throws java.lang.UnsupportedOperationException,
                                             java.io.IOException,
                                             java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec".

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

ExecInContainerPattern.execInContainer(DockerClient, InspectContainerResponse, Charset, String...)

execInContainerWithUser

@Deprecated
default Container.ExecResult execInContainerWithUser(java.lang.String user,
                                                                 java.lang.String... command)
                                                          throws java.lang.UnsupportedOperationException,
                                                                 java.io.IOException,
                                                                 java.lang.InterruptedException

Deprecated. use execInContainer(ExecConfig)

Run a command inside a running container as a given user, as using "docker exec -u user".

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

ExecInContainerPattern.execInContainerWithUser(DockerClient, InspectContainerResponse, String, String...)

execInContainerWithUser

@Deprecated
default Container.ExecResult execInContainerWithUser(java.nio.charset.Charset outputCharset,
                                                                 java.lang.String user,
                                                                 java.lang.String... command)
                                                          throws java.lang.UnsupportedOperationException,
                                                                 java.io.IOException,
                                                                 java.lang.InterruptedException

Deprecated. use execInContainer(Charset, ExecConfig)

Run a command inside a running container as a given user, as using "docker exec -u user".

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

ExecInContainerPattern.execInContainerWithUser(DockerClient, InspectContainerResponse, Charset, String, String...)

execInContainer

default Container.ExecResult execInContainer(ExecConfig execConfig)
                                      throws java.lang.UnsupportedOperationException,
                                             java.io.IOException,
                                             java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec".

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

execInContainer

default Container.ExecResult execInContainer(java.nio.charset.Charset outputCharset,
                                             ExecConfig execConfig)
                                      throws java.lang.UnsupportedOperationException,
                                             java.io.IOException,
                                             java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec".

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

copyFileToContainer

default void copyFileToContainer(MountableFile mountableFile,
                                 java.lang.String containerPath)

Copies a file or directory to the container.

Parameters:

mountableFile - file or directory which is copied into the container

containerPath - destination path inside the container

copyFileToContainer

default void copyFileToContainer(Transferable transferable,
                                 java.lang.String containerPath)

Copies a file to the container.

Parameters:

transferable - file which is copied into the container

containerPath - destination path inside the container

copyFileFromContainer

default void copyFileFromContainer(java.lang.String containerPath,
                                   java.lang.String destinationPath)
                            throws java.io.IOException,
                                   java.lang.InterruptedException

Copies a file which resides inside the container to user defined directory

Parameters:

containerPath - path to file which is copied from container

destinationPath - destination path to which file is copied with file name

Throws:

java.io.IOException - if there's an issue communicating with Docker or receiving entry from TarArchiveInputStream

java.lang.InterruptedException - if the thread waiting for the response is interrupted

copyFileFromContainer

default <T> T copyFileFromContainer(java.lang.String containerPath,
                                    ThrowingFunction<java.io.InputStream,T> function)

Streams a file which resides inside the container

Parameters:

containerPath - path to file which is copied from container

function - function that takes InputStream of the copied file