ory/dockertest
Dockertest
dockertest is a Docker integration testing library and programmatic Go client used to boot and manage ephemeral containers. It functions as a containerized test orchestrator that provides isolated environments for integration tests by managing the lifecycle of dependent services.
The library handles ephemeral environment orchestration by provisioning temporary containers and networks. It ensures environment consistency through service readiness checks and automated resource cleanup to prevent leaks after test execution completes.
The project covers containerized service validation, including the ability to retrieve dynamic connection details and manage container networks. It also supports capturing container logs and executing commands within running containers.
Features
- Ephemeral Container Orchestrators - Orchestrates the rapid creation and destruction of isolated containers for integration tests.
- Docker Integration Testing Libraries - A Go library for booting and managing ephemeral Docker containers to provide isolated environments for integration tests.
- Integration Testing Utilities - Provides a framework for managing temporary Docker containers within Go tests to verify system behavior.
- Ephemeral Container Cleanup - Automatically removes temporary Docker containers and networks after test execution to prevent resource leaks.
- Containerized Service Integrations - Integrates containerized services by verifying readiness and retrieving dynamic connection details for tests.
- Docker Engine API Clients - Implements a programmatic Go client to interact directly with the Docker Engine API for container management.
- Service Readiness Checks - Verifies that containers are ready to accept connections using a polling probe with a backoff strategy.
- Containerized Test Libraries - Provides a programmatic API for controlling containerized dependencies during integration testing.
- Container Command Executors - Executes shell commands inside running containers and captures the output and exit status.
- Cloud Resource Cleanups - Automatically releases containers and networks via hooks to prevent resource leaks.
- Runtime Environment Variable Injections - Injects runtime environment variables into containers via the Docker API to customize service behavior.
- Container Image Runs - Compiles local configuration into images and starts them as containers.
- Container Reuse Strategies - Allows attaching to existing containers using image tags to reduce test startup time.
- Programmatic Docker Clients - Provides a programmatic Go interface for controlling Docker containers, networks, and images.
- Container Networking Configurations - Creates isolated networks to connect or disconnect containers for inter-service communication.
- Container Port Mapping - Retrieves dynamically assigned host ports to establish connections between the test suite and internal services.
- Dynamic Connection Detail Extraction - Extracts mapped host IPs and ports for internal services to establish successful client connections.
- Deferred Cleanup Registration - Provides automated hooks to register container deletion, ensuring environment teardown after tests.
- Container Log Retrieval - Retrieves historical logs or streams real-time output from running containers for debugging.
