Introduction

Johann is a simple Java library that communicates with docker-compose CLI.

Getting started

Just add Johann as a maven/gradle dependency and start using it. See Example usage for more information.

Maven dependency:

<dependency>
    <groupId>io.brachu</groupId>
    <artifactId>johann</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle dependency:

compile 'io.brachu:johann:1.1.0'

Requirements

• JDK8+ environment
• Docker Engine 17.06+
• Docker Compose 1.18+

Example usage

Local docker engine

Running docker-compose.yml file placed in one of the root directories of classpath

DockerCompose compose = DockerCompose.builder().classpath().build();

Running docker-compose.yml file with custom name in one of the root directories of classpath

DockerCompose compose = DockerCompose.builder().classpath("/custom-compose-file.yml").build();

Running docker-compose.yml file in one of the subdirectories of the classpath

DockerCompose compose = DockerCompose.builder().classpath("/path/to/docker-compose.yml").build();

Running docker-compose.yml file outside of classpath

DockerCompose compose = DockerCompose.builder().absolute("/path/to/docker-compose.yml").build();

Starting and waiting for compose cluster to be up

compose.up();
compose.waitForCluster(1, TimeUnit.MINUTES);

Calling up method is equivalent to executing docker-compose up -d command.

waitForCluster method waits for all containers within a cluster to be either healthy or, if they have no health check, running. For most consistent results in integration tests, all your containers should implement health checks.

You can read more about container health checks here.

Shutting compose cluster down gracefully

compose.down();

Calling down method is equivalent to executing docker-compose down -v command.

Customizing cluster shutdown

You can customize behaviour of down method by supplying it with a DownConfig object.

DownConfig object has following properties:

Property	CLI equivalent	default value
removeImages	--rmi	NONE
removeVolumes	-v	true
removeOrphans	--remove-orphans	false
timeoutSeconds	-t	10

Example usage:

DownConfig config = DownConfig.defaults().withRemoveVolumes(false);
compose.down(config);

Killing compose cluster (may leave garbage containers)

compose.kill();

Calling kill method is equivalent to executing docker-compose kill command.

Stopping a single service within compose cluster

compose.stop("postgresql");

Starting previously stopped service

compose.start("postgresql");
compose.waitForService("postgresql", 1, TimeUnit.MINUTES);

Stopping and starting multiple services at once

You can stop and start multiple services at once by using varargs-flavoured stop & start methods. There are also stopAll & startAll methods available that can stop and start all services defined in your docker-compose file.

// The order of services matters. Rabbitmq service will be stopped before postgresql.
compose.stop("rabbitmq", "postgresql");
// Postgresql will start before rabbitmq
compose.start("postgresql", "rabbitmq");

compose.stopAll()
compose.startAll()

Passing environment variables to docker-compose

DockerCompose compose = DockerCompose.builder()
    .classpath()
    .env("MY_ENV_VAR", "my value")
    .env("ANOTHER_VAR", "another value")
    .build();

Assigning project name to your compose cluster

By default, Johann uses implicitly generated project name and passes it to docker-compose command via -p switch. You can override this behaviour by passing your own project name to the builder:

DockerCompose compose = DockerCompose.builder()
    .classpath()
    .projectName("customProjectName")
    .build();

Implicit project name generation

When running docker-compose up without -p switch, your compose cluster will be assigned a project name equal to the name of directory containing your docker-compose.yml file. This may lead to problems when running multiple clusters at once. Johann tries to handle this case by always passing a project name to docker-compose CLI. This project name can be given explicitly via builder pattern or can be generated implicitly.

The sources of implicit project name are given below, ordered by priority:

1. System.getProperty("maven.dockerCompose.project") (will be used if returned value is not blank)
2. System.getenv("COMPOSE_PROJECT_NAME") (will be used if returned value is not blank)
3. Random ASCII string generator

Retrieving container's IP address

Assuming following docker-compose.yml file:

version: '2.3'

services:
  rabbitmq:
    image: rabbitmq:3.6.10-alpine
    ports:
      - "5672"

You can easily retrieve container's IP address for rabbitmq service:

String ip = compose.containerIp("rabbitmq");

If a container is bound to multiple networks, you can pass the network name as a second argument to the ip method:

String ip = compose.containerIp("rabbitmq", "my_custom_network");

Retrieving host port of a container

Assuming following docker-compose.yml file:

version: '2.3'

services:
  rabbitmq:
    image: rabbitmq:3.6.10-alpine
    ports:
      - "5672"

You can retrieve a host port bound to container's 5672 port by invoking Johann's port method:

ContainerPort containerPort = compose.port("rabbitmq", 5672);
int port = containerPort.getPort();

You can even use ContainerPort::format method to create proper URL address with one-liner:

String url = compose.port("rabbitmq", 5672).format("tcp://$HOST:$PORT");

Remote docker engine

Johann can connect to a remote Docker Engine if DOCKER_HOST environment variable is passed to the Java process that runs Johann. DOCKER_TLS_VERIFY and DOCKER_CERT_PATH variables are also supported.

You can read more about these variables here.

Running test suite

Running tests located in this repository requires you to install docker and docker-compose on your local machine. Also, assuming you are running Linux distro, user running the tests must be added to the docker group. Version requirements are posted at the top of this README.