WaitForDocker

This project will execute your docker-compose.yml file and will wait until all of services will be ready to use. This could be useful in e.g. integration tests in CI/CD pipeline. After finished work, you can easily remove your services by killing them. This was tested on Windows and Ubuntu.

Installation

Install-Package WaitForDocker

Prerequisites

docker-compose.yml which contains your infrastructure setup

Usage

await WaitFor.DockerCompose();

Above code will execute following command: docker-compose -p waitfordocker up -d --no-color --renew-anon-volumes

Configuration

WaitForDocker will look for docker-compose.yml in current directory so marking this compose file as copy always is required. If you want to use different directory or compose file name you can use config builder.

var config = new WaitForDockerConfigurationBuilder()
                 .SetComposeDirectoryPath("path")
                 .SetCustomComposeFileName("filename")
                 .Build();

Health checking

By default WaitForDocker will read services tag and they ports from docker-compose.yml and check that port is open.

services:
  redis:
    image: redis
    ports:
      - '6379:6379'

If this is not enough you can specify your services health checks. At this moment there are 3 types of health checks. HTTP,TCP and CMD but you can create custom ones.

 var config = new WaitForDockerConfigurationBuilder()
                  .AddHealthCheck(check => check.WithHttp("rabbitmq", new Uri("http://localhost:15672")))
                  .AddHealthCheck(check => check.WithCmd("rabbitmq", "rabbitmqctl status"))
                  .AddHealthCheck(check => check.WithCustom(logger => new SomeHealthCheck("sqlserver", 100, null, logger)))
                  .Build();

For create custom health check you have to inherit from DockerHealthChecker class and pass it to WithCustom method. Each health check have a default timeout is set to 10 seconds, but you can specify any value you want.

Logging

For setup custom logger you have to implement ILogger interface and pass it to config. By default logs will be printed to the console.

var config = new WaitForDockerConfigurationBuilder()
                .SetCustomLogger(new FileOutputLogger())
                .Build();

Cleanup

For kill all compose services you can use kill command

await WaitFor.DockerKill();

Examples

You can find example of usage in test folder of this repository

Test folder

DanielDziubecki / WaitForDocker