org.testcontainers.containers

Class DockerComposeContainer<SELF extends DockerComposeContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.DockerComposeContainer<SELF>

All Implemented Interfaces:

org.junit.rules.TestRule

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	finished(org.junit.runner.Description description)
String	getServiceHost(String serviceName, Integer servicePort) Get the host (e.g.
Integer	getServicePort(String serviceName, Integer servicePort) Get the port that an exposed service can be found at, from the host machine (i.e.
void	starting(org.junit.runner.Description description)
SELF	withEnv(Map<String,String> env)
SELF	withEnv(String key, String value)
SELF	withExposedService(String serviceName, int servicePort)
DockerComposeContainer	withExposedService(String serviceName, int instance, int servicePort)
SELF	withLocalCompose(boolean localCompose) Use a local Docker Compose binary instead of a container.
SELF	withPull(boolean pull) Whether to pull images first.
SELF	withScaledService(String serviceBaseName, int numInstances)
SELF	withTailChildContainers(boolean tailChildContainers) Whether to tail child container logs.

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

Constructor Detail

DockerComposeContainer

@Deprecated
public DockerComposeContainer(File composeFile,
                                          String identifier)

Deprecated.

DockerComposeContainer

public DockerComposeContainer(File... composeFiles)

DockerComposeContainer

public DockerComposeContainer(List<File> composeFiles)

DockerComposeContainer

public DockerComposeContainer(String identifier,
                              File... composeFiles)

DockerComposeContainer

public DockerComposeContainer(String identifier,
                              List<File> composeFiles)

Method Detail

starting

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

Overrides:

starting in class FailureDetectingExternalResource

finished

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

Overrides:

finished in class FailureDetectingExternalResource

withExposedService

public SELF withExposedService(String serviceName,
                               int servicePort)

withExposedService

public DockerComposeContainer withExposedService(String serviceName,
                                                 int instance,
                                                 int servicePort)

getServiceHost

public String getServiceHost(String serviceName,
                             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 Integer getServicePort(String serviceName,
                              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(String serviceBaseName,
                              int numInstances)

withEnv

public SELF withEnv(String key,
                    String value)

withEnv

public SELF withEnv(Map<String,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