net.officefloor.docker.test

Class OfficeFloorDockerUtil

java.lang.Object

net.officefloor.docker.test.OfficeFloorDockerUtil

public class OfficeFloorDockerUtil
extends Object

Docker wrapper for running third party services (typically for testing).

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
OfficeFloorDockerUtil()

Method Summary

Modifier and Type	Method and Description
static DockerContainerInstance	ensureContainerAvailable(String containerName, String imageName, Function<com.github.dockerjava.api.DockerClient,com.github.dockerjava.api.command.CreateContainerCmd> createContainer) Ensures the docker container is available.
static DockerNetworkInstance	ensureNetworkAvailable(String networkName) Ensures the docker network is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeFloorDockerUtil

public OfficeFloorDockerUtil()

Method Detail

ensureNetworkAvailable

public static DockerNetworkInstance ensureNetworkAvailable(String networkName)
                                                    throws Exception

Ensures the docker network is available.

Parameters:

networkName - Network name.

Returns:

DockerNetworkInstance of manage docker network.

Throws:

Exception - If fails to ensure docker network available.

ensureContainerAvailable

public static DockerContainerInstance ensureContainerAvailable(String containerName,
                                                               String imageName,
                                                               Function<com.github.dockerjava.api.DockerClient,com.github.dockerjava.api.command.CreateContainerCmd> createContainer)
                                                        throws Exception

Ensures the docker container is available.

Parameters:

containerName - Name of docker container.

imageName - Name of the docker image.

createContainer - Factory for the CreateContainerCmd if container not running.

Returns:

DockerContainerInstance to manage running docker container.

Throws:

Exception - If fails to ensure docker container available.