Method Detail

• static boolean allRunning(java.util.ArrayList<java.lang.String> names)

  Test if all of a list of containers are running.

  This method takes a list of the names of containers and checks to see if they are all running. Most underlying docker commands use the container ID, but those are essentially random. The name can be set in the docker-compose.yaml file to something that is stable.

  Parameters:

  names - The list of names of containers.

  Returns:

  True if all the named containers are running

• static boolean anyRunning(java.util.ArrayList<java.lang.String> names)

  Test if any of a list of containers are running.

  This method takes a list of the names of containers and checks to see if any of them are running. Most underlying docker commands use the container ID, but those are essentially random. The name can be set in the docker-compose.yaml file to something that is stable.

  Parameters:

  names - The list of names of containers.

  Returns:

  True if none of the named containers are running

• static void assertDockerAvailable()

  Assert that docker is available.

  This method raises an exception if docker could not be found on the user's path. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if Docker is unavailable.

• static void assertDockerComposeAvailable()

  Assert that docker-compose is available.

  This method raises an exception if docker-compose could not be found on the user's path. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if Docker Compose is unavailable.

• static void assertNotRunning(java.lang.String name)

  Assert that the container named name is not running.

  This method raises an exception if the named container is running. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if the container is running.

• static void assertNotRunning(java.util.ArrayList<java.lang.String> names)

  Assert that none of the named container are running.

  This method raises an exception if any of the named containers are running. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if the container is running.

• static void assertRunning(java.lang.String name)

  Assert that the container named name running.

  This method raises an exception if the named container is not running. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if the container is not running.

• static void assertRunning(java.util.ArrayList<java.lang.String> names)

  Assert that the named containers are (all) running.

  This method raises an exception if any of the named containers is not running. It's just a convenience to avoid having to write the test and raise the exception yourself in the build script.

  throws:

  GradleException if the container is not running.

• static void compose(groovy.lang.Closure cl)

  Evaluate a docker compose command.

  Parameters:

  cl - The closure containing the environment

• static java.util.HashMap<java.lang.String, java.lang.String> containers()

  Get the running containers and their IDs.

  This method returns a map where the keys are all the names of running containers. The value associated with each key is the ID of the corresponding container.

  Returns:

  A map of container name/ID pairs.

• static java.lang.String docker()

  Where is docker?

  Returns:

  The absolute path of the docker executable, or null if it could not be found on the user's PATH.

• static void docker(groovy.lang.Closure cl)

  Evaluate a docker command.

  Parameters:

  cl - The closure containing the environment

• static java.lang.String dockerCompose()

  Where is docker-compose?

  Returns:

  The absolute path of the docker-compose executable or the word "docker" if the compose command is a subcommand of docker. Returns null if it could not be found on the user's PATH.

• static java.lang.String id(java.lang.String name)

  Find the ID of a running container.

  This method takes the name of a container and checks to see if that container is running. If it is, it returns the ID of the container. In most cases, this ID will be needed to interact with the container using the docker command.

  Parameters:

  name - The name of a container.

  Returns:

  The ID of the container, or null if it isn't running

• static boolean running(java.lang.String name)

  Test if a container is running.

  This method takes the name of a container and checks to see if that container is running. Most underlying docker commands use the container ID, but those are essentially random. The name can be set in the docker-compose.yaml file to something that is stable.

  Parameters:

  name - The name of a container.

  Returns:

  True if a container with that name is currently running.

• protected static void setProject(org.gradle.api.Project proj)