org.testcontainers.containers

Class DockerComposeContainer<SELF extends DockerComposeContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.DockerComposeContainer<SELF>

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, Startable

public class DockerComposeContainer<SELF extends DockerComposeContainer<SELF>>
extends FailureDetectingExternalResource
implements Startable

Container which launches Docker Compose, for the purposes of launching a defined set of containers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerComposeContainer.RemoveImages

Constructor Summary

Constructors

Constructor and Description
DockerComposeContainer(java.io.File... composeFiles)
DockerComposeContainer(java.io.File composeFile, java.lang.String identifier) Deprecated.
DockerComposeContainer(java.util.List<java.io.File> composeFiles)
DockerComposeContainer(java.lang.String identifier, java.io.File... composeFiles)
DockerComposeContainer(java.lang.String identifier, java.util.List<java.io.File> composeFiles)

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description) Deprecated.
protected void	failed(java.lang.Throwable e, org.junit.runner.Description description) Deprecated.
void	finished(org.junit.runner.Description description) Deprecated.
java.util.Optional<ContainerState>	getContainerByServiceName(java.lang.String serviceName)
java.lang.String	getServiceHost(java.lang.String serviceName, java.lang.Integer servicePort) Get the host (e.g.
java.lang.Integer	getServicePort(java.lang.String serviceName, java.lang.Integer servicePort) Get the port that an exposed service can be found at, from the host machine (i.e.
void	start()
void	starting(org.junit.runner.Description description) Deprecated.
void	stop()
protected void	succeeded(org.junit.runner.Description description) Deprecated.
SELF	waitingFor(java.lang.String serviceName, @NonNull WaitStrategy waitStrategy) Specify the WaitStrategy to use to determine if the container is ready.
SELF	withBuild(boolean build) Whether to always build images before starting containers.
SELF	withEnv(java.util.Map<java.lang.String,java.lang.String> env)
SELF	withEnv(java.lang.String key, java.lang.String value)
SELF	withExposedService(java.lang.String serviceName, int servicePort)
DockerComposeContainer	withExposedService(java.lang.String serviceName, int instance, int servicePort)
DockerComposeContainer	withExposedService(java.lang.String serviceName, int instance, int servicePort, WaitStrategy waitStrategy)
SELF	withExposedService(java.lang.String serviceName, int servicePort, @NonNull WaitStrategy waitStrategy)
SELF	withLocalCompose(boolean localCompose) Use a local Docker Compose binary instead of a container.
SELF	withLogConsumer(java.lang.String serviceName, java.util.function.Consumer<OutputFrame> consumer) Attach an output consumer at container startup, enabling stdout and stderr to be followed, waited on, etc.
SELF	withOptions(java.lang.String... options) Adds options to the docker-compose command, e.g.
SELF	withPull(boolean pull) Whether to pull images first.
SELF	withRemoveImages(DockerComposeContainer.RemoveImages removeImages) Remove images after containers shutdown.
SELF	withScaledService(java.lang.String serviceBaseName, int numInstances)
SELF	withServices(java.lang.String... services)
SELF	withTailChildContainers(boolean tailChildContainers) Whether to tail child container logs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.lifecycle.Startable

close, getDependencies

Constructor Detail

DockerComposeContainer

@Deprecated
public DockerComposeContainer(java.io.File composeFile,
                                          java.lang.String identifier)

Deprecated.

DockerComposeContainer

public DockerComposeContainer(java.io.File... composeFiles)

DockerComposeContainer

public DockerComposeContainer(java.util.List<java.io.File> composeFiles)

DockerComposeContainer

public DockerComposeContainer(java.lang.String identifier,
                              java.io.File... composeFiles)

DockerComposeContainer

public DockerComposeContainer(java.lang.String identifier,
                              java.util.List<java.io.File> composeFiles)

Method Detail

apply

@Deprecated
public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                                           org.junit.runner.Description description)

Deprecated.

Specified by:

apply in interface org.junit.rules.TestRule

Overrides:

apply in class FailureDetectingExternalResource

starting

@Deprecated
public void starting(org.junit.runner.Description description)

Deprecated.

Overrides:

starting in class FailureDetectingExternalResource

succeeded

@Deprecated
protected void succeeded(org.junit.runner.Description description)

Deprecated.

Overrides:

succeeded in class FailureDetectingExternalResource

failed

@Deprecated
protected void failed(java.lang.Throwable e,
                                  org.junit.runner.Description description)

Deprecated.

Overrides:

failed in class FailureDetectingExternalResource

finished

@Deprecated
public void finished(org.junit.runner.Description description)

Deprecated.

Overrides:

finished in class FailureDetectingExternalResource

start

public void start()

Specified by:

start in interface Startable

withServices

public SELF withServices(@NonNull
                         java.lang.String... services)

stop

public void stop()

Specified by:

stop in interface Startable

withExposedService

public SELF withExposedService(java.lang.String serviceName,
                               int servicePort)

withExposedService

public DockerComposeContainer withExposedService(java.lang.String serviceName,
                                                 int instance,
                                                 int servicePort)

withExposedService

public DockerComposeContainer withExposedService(java.lang.String serviceName,
                                                 int instance,
                                                 int servicePort,
                                                 WaitStrategy waitStrategy)

withExposedService

public SELF withExposedService(java.lang.String serviceName,
                               int servicePort,
                               @NonNull
                               @NonNull WaitStrategy waitStrategy)

waitingFor

public SELF waitingFor(java.lang.String serviceName,
                       @NonNull
                       @NonNull WaitStrategy waitStrategy)

Specify the WaitStrategy to use to determine if the container is ready.

Parameters:

serviceName - the name of the service to wait for

waitStrategy - the WaitStrategy to use

Returns:

this

See Also:

Wait.defaultWaitStrategy()

getServiceHost

public java.lang.String getServiceHost(java.lang.String serviceName,
                                       java.lang.Integer servicePort)

Get the host (e.g. IP address or hostname) that an exposed service can be found at, from the host machine (i.e. should be the machine that's running this Java process).

The service must have been declared using DockerComposeContainer#withExposedService.

Parameters:

serviceName - the name of the service as set in the docker-compose.yml file.

servicePort - the port exposed by the service container.

Returns:

a host IP address or hostname that can be used for accessing the service container.

getServicePort

public java.lang.Integer getServicePort(java.lang.String serviceName,
                                        java.lang.Integer servicePort)

Get the port that an exposed service can be found at, from the host machine (i.e. should be the machine that's running this Java process).

The service must have been declared using DockerComposeContainer#withExposedService.

Parameters:

serviceName - the name of the service as set in the docker-compose.yml file.

servicePort - the port exposed by the service container.

Returns:

a port that can be used for accessing the service container.

withScaledService

public SELF withScaledService(java.lang.String serviceBaseName,
                              int numInstances)

withEnv

public SELF withEnv(java.lang.String key,
                    java.lang.String value)

withEnv

public SELF withEnv(java.util.Map<java.lang.String,java.lang.String> env)

withLocalCompose

public SELF withLocalCompose(boolean localCompose)

Use a local Docker Compose binary instead of a container.

Returns:

this instance, for chaining

withPull

public SELF withPull(boolean pull)

Whether to pull images first.

Returns:

this instance, for chaining

withTailChildContainers

public SELF withTailChildContainers(boolean tailChildContainers)

Whether to tail child container logs.

Returns:

this instance, for chaining

withLogConsumer

public SELF withLogConsumer(java.lang.String serviceName,
                            java.util.function.Consumer<OutputFrame> consumer)

Attach an output consumer at container startup, enabling stdout and stderr to be followed, waited on, etc.

More than one consumer may be registered.

Parameters:

serviceName - the name of the service as set in the docker-compose.yml file

consumer - consumer that output frames should be sent to

Returns:

this instance, for chaining

withBuild

public SELF withBuild(boolean build)

Whether to always build images before starting containers.

Returns:

this instance, for chaining

withOptions

public SELF withOptions(java.lang.String... options)

Adds options to the docker-compose command, e.g. docker-compose --compatibility.

Returns:

this instance, for chaining

withRemoveImages

public SELF withRemoveImages(DockerComposeContainer.RemoveImages removeImages)

Remove images after containers shutdown.

Returns:

this instance, for chaining

getContainerByServiceName

public java.util.Optional<ContainerState> getContainerByServiceName(java.lang.String serviceName)