org.testcontainers

Class DockerClientFactory

java.lang.Object

org.testcontainers.DockerClientFactory

public class DockerClientFactory
extends java.lang.Object

Singleton class that provides initialized Docker clients.

The correct client configuration to use will be determined on first use, and cached thereafter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	DEFAULT_LABELS
static java.lang.String	SESSION_ID
static java.lang.String	TESTCONTAINERS_LABEL
static java.lang.String	TESTCONTAINERS_SESSION_ID_LABEL
static java.lang.ThreadGroup	TESTCONTAINERS_THREAD_GROUP

Method Summary

Modifier and Type	Method and Description
void	checkAndPullImage(com.github.dockerjava.api.DockerClient client, java.lang.String image) Check whether the image is available locally and pull it otherwise
com.github.dockerjava.api.DockerClient	client()
java.lang.String	dockerHostIpAddress()
java.lang.String	getActiveApiVersion()
java.lang.String	getActiveExecutionDriver()
java.lang.String	getRemoteDockerUnixSocketPath()
TransportConfig	getTransportConfig()
static DockerClientFactory	instance() Obtain an instance of the DockerClientFactory.
boolean	isDockerAvailable() Checks whether Docker is accessible and client() is able to produce a client.
boolean	isFileMountingSupported()
boolean	isUsing(java.lang.Class<? extends DockerClientProviderStrategy> providerStrategyClass)
static com.github.dockerjava.api.DockerClient	lazyClient()
<T> T	runInsideDocker(java.util.function.Consumer<com.github.dockerjava.api.command.CreateContainerCmd> createContainerCmdConsumer, java.util.function.BiFunction<com.github.dockerjava.api.DockerClient,java.lang.String,T> block)

Methods inherited from class java.lang.Object

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

Field Detail

TESTCONTAINERS_THREAD_GROUP

public static final java.lang.ThreadGroup TESTCONTAINERS_THREAD_GROUP

TESTCONTAINERS_LABEL

public static final java.lang.String TESTCONTAINERS_LABEL

TESTCONTAINERS_SESSION_ID_LABEL

public static final java.lang.String TESTCONTAINERS_SESSION_ID_LABEL

SESSION_ID

public static final java.lang.String SESSION_ID

DEFAULT_LABELS

public static final java.util.Map<java.lang.String,java.lang.String> DEFAULT_LABELS

Method Detail

lazyClient

public static com.github.dockerjava.api.DockerClient lazyClient()

instance

public static DockerClientFactory instance()

Obtain an instance of the DockerClientFactory.

Returns:

the singleton instance of DockerClientFactory

isDockerAvailable

public boolean isDockerAvailable()

Checks whether Docker is accessible and client() is able to produce a client.

Returns:

true if Docker is available, false if not.

getTransportConfig

@UnstableAPI
public TransportConfig getTransportConfig()

getRemoteDockerUnixSocketPath

@UnstableAPI
public java.lang.String getRemoteDockerUnixSocketPath()

client

public com.github.dockerjava.api.DockerClient client()

Returns:

a new initialized Docker client

checkAndPullImage

public void checkAndPullImage(com.github.dockerjava.api.DockerClient client,
                              java.lang.String image)

Check whether the image is available locally and pull it otherwise

dockerHostIpAddress

public java.lang.String dockerHostIpAddress()

Returns:

the IP address of the host running Docker

runInsideDocker

public <T> T runInsideDocker(java.util.function.Consumer<com.github.dockerjava.api.command.CreateContainerCmd> createContainerCmdConsumer,
                             java.util.function.BiFunction<com.github.dockerjava.api.DockerClient,java.lang.String,T> block)

getActiveApiVersion

public java.lang.String getActiveApiVersion()

Returns:

the docker API version of the daemon that we have connected to

getActiveExecutionDriver

public java.lang.String getActiveExecutionDriver()

Returns:

the docker execution driver of the daemon that we have connected to

isUsing

public boolean isUsing(java.lang.Class<? extends DockerClientProviderStrategy> providerStrategyClass)

Parameters:

providerStrategyClass - a class that extends DockerMachineClientProviderStrategy

Returns:

whether or not the currently active strategy is of the provided type

isFileMountingSupported

public boolean isFileMountingSupported()