Simple pytest fixtures that help you write integration
tests with Docker and Docker Compose.
Specify all necessary containers in a docker-compose.yml file and and
pytest-docker will spin them up for the duration of your tests.
pytest-docker was originally created by André Caron.
Install pytest-docker with pip or add it to your test requirements.
By default, it uses the docker compose command, so it relies on the Compose plugin for Docker (also called Docker Compose V2).
If you want to use the old docker-compose command (deprecated since July 2023, not receiving updates since 2021)
then you can do it using the docker-compose-command fixture:
@pytest.fixture(scope="session")
def docker_compose_command() -> str:
return "docker-compose"If you want to use the pip-distributed version of docker-compose command, you can install it using
pip install pytest-docker[docker-compose-v1]
Another option could be usage of compose-switch.
Here is an example of a test that depends on a HTTP service.
With a docker-compose.yml file like this (using the
httpbin service):
version: '2'
services:
httpbin:
image: "kennethreitz/httpbin"
ports:
- "8000:80"You can write a test like this:
import pytest
import requests
from requests.exceptions import ConnectionError
def is_responsive(url):
try:
response = requests.get(url)
if response.status_code == 200:
return True
except ConnectionError:
return False
@pytest.fixture(scope="session")
def http_service(docker_ip, docker_services):
"""Ensure that HTTP service is up and responsive."""
# `port_for` takes a container port and returns the corresponding host port
port = docker_services.port_for("httpbin", 80)
url = "http://{}:{}".format(docker_ip, port)
docker_services.wait_until_responsive(
timeout=30.0, pause=0.1, check=lambda: is_responsive(url)
)
return url
def test_status_code(http_service):
status = 418
response = requests.get(http_service + "/status/{}".format(status))
assert response.status_code == statusBy default this plugin will try to open docker-compose.yml in your
tests directory. If you need to use a custom location, override the
docker_compose_file fixture inside your conftest.py file:
import os
import pytest
@pytest.fixture(scope="session")
def docker_compose_file(pytestconfig):
return os.path.join(str(pytestconfig.rootdir), "mycustomdir", "docker-compose.yml")By default the scope of the fixtures are session but can be changed with
pytest command line option --container-scope <scope>:
pytest --container-scope <scope> <test_directory>For available scopes and descriptions see https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes
Determine the IP address for TCP connections to Docker containers.
Get an absolute path to the docker-compose.yml file. Override this fixture in
your tests if you need a custom location.
Generate a project name using the current process PID. Override this fixture in your tests if you need a particular project name.
Start all services from the docker compose file (docker-compose up).
After test are finished, shutdown all services (docker-compose down).
Docker Compose command to use to execute Dockers. Default is to use
Docker Compose V2 (command is docker compose). If you want to use
Docker Compose V1, change this fixture to return docker-compose.
Get the list of docker_compose commands to be executed for test spawn actions. Override this fixture in your tests if you need to change spawn actions. Returning anything that would evaluate to False will skip this command.
Get the list of docker_compose commands to be executed for test clean-up actions. Override this fixture in your tests if you need to change clean-up actions. Returning anything that would evaluate to False will skip this command.
Use of a virtual environment is recommended. See the venv package for more information.
First, install pytest-docker and its test dependencies:
pip install -e ".[tests]"Run tests with
pytest -c setup.cfgto make sure that the correct configuration is used. This is also how tests are run in CI.
Use black with default settings for
formatting. You can also use pylint with setup.cfg as the configuration
file as well as mypy for type checking.
This pytest plug-in and its source code are made available to you under a MIT
license. It is safe to use in commercial and closed-source applications. Read
the license for details!
Found a bug? Think a new feature would make this plug-in more practical? We welcome issues and pull requests!
When creating a pull request, be sure to follow this projects conventions (see above).
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent