Test containers with Docker in PyTest - Framework Patterns

Framework Mode - Test containers with Docker

Folder Structure

project-root/
├── tests/
│   ├── test_service.py          # Test files using pytest
│   └── conftest.py              # Fixtures for test containers setup
├── docker/
│   ├── Dockerfile               # Dockerfile for service under test
│   └── docker-compose.yml       # Optional: Compose for multi-container setup
├── src/
│   └── app.py                   # Application source code
├── requirements.txt             # Python dependencies including testcontainers
└── pytest.ini                   # pytest configuration
    

Test Framework Layers

• Test Layer: pytest test functions in tests/ that use fixtures to start/stop Docker containers.
• Fixture Layer: conftest.py defines reusable pytest fixtures that manage lifecycle of Docker containers using testcontainers Python library.
• Application Layer: Source code under src/ which is tested by the tests.
• Docker Layer: Dockerfiles and optional docker-compose files to build container images for services under test.
• Utilities Layer: Helper functions or modules to interact with containers or test data setup.
• Configuration Layer: pytest.ini and requirements.txt to configure pytest and dependencies.

Configuration Patterns

• Environment Variables: Use environment variables to configure container images, ports, and credentials dynamically.
• pytest.ini: Central place to configure pytest options like markers and test paths.
• Docker Compose: Optional for multi-container orchestration during tests.
• Fixture Parameters: Pass parameters to fixtures to customize container setup per test or environment.
• Secrets Management: Use environment variables or .env files to securely pass credentials to containers.

Test Reporting and CI/CD Integration

• Use pytest built-in reporting with --junitxml=report.xml for CI systems to parse test results.
• Integrate with CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests inside containers or with Docker daemon access.
• Use pytest plugins like pytest-html for human-readable reports.
• Ensure Docker environment is available in CI agents for container lifecycle management.
• Fail fast on container startup errors to save CI resources.

Best Practices

1. Isolate Tests: Each test should start fresh containers to avoid state leakage.
2. Use Fixtures: Manage container lifecycle with pytest fixtures for clean setup and teardown.
3. Explicit Waits: Wait for container services to be ready before running tests to avoid flaky failures.
4. Parameterize Containers: Allow easy switching of container images or versions via config or environment variables.
5. Keep Containers Lightweight: Use minimal images to speed up test execution.

Self Check

Where in this folder structure would you add a new pytest fixture to start a Redis container for tests?

Key Result

Use pytest fixtures with testcontainers library to manage Docker containers lifecycle for isolated, repeatable tests.

Practice

1. What is the main benefit of using test containers with Docker in pytest?

easy

A. They make tests run faster by skipping setup steps.

B. They replace the need for writing any test code.

C. They automatically fix bugs in the application code.

D. They provide real service environments during tests for better reliability.

Solution

1. Step 1: Understand test containers purpose

   Test containers run real services like databases inside Docker during tests.

2. Step 2: Identify benefit in pytest context

   This makes tests more reliable and realistic by using actual service environments.

3. Final Answer:

   They provide real service environments during tests for better reliability. -> Option D

4. Quick Check:

   Real service environment = Better test reliability [OK]

Hint: Remember: test containers run real services inside Docker [OK]

Common Mistakes:

• Thinking test containers replace writing tests
• Believing they fix code bugs automatically
• Assuming tests run faster by skipping setup

2. Which pytest fixture code correctly starts a Docker container for testing?

easy

A. def container():
container = docker.run('redis')
yield container
container.stop()

B. def container():
client = docker.from_env()
container = client.run('redis')
yield container
container.stop()

C. def container():
client = docker.from_env()
container = client.containers.run('redis', detach=True)
yield container
container.stop()

D. def container():
client = docker.from_env()
container = client.containers.run('redis')
container.start()
yield container
container.stop()

Solution

1. Step 1: Check correct Docker client usage

   Use docker.from_env() to get client, then client.containers.run() with detach=True to start container.

2. Step 2: Verify fixture lifecycle management

   Yield container for test, then stop container after test finishes.

3. Final Answer:

   def container(): client = docker.from_env() container = client.containers.run('redis', detach=True) yield container container.stop() -> Option C

4. Quick Check:

   Use client.containers.run with detach=True [OK]

Hint: Use client.containers.run with detach=True to start container [OK]

Common Mistakes:

• Calling client.run instead of client.containers.run
• Missing detach=True causing blocking call
• Not stopping container after test

3. Given this pytest fixture, what will be printed when running the test?

import pytest
import docker

@pytest.fixture
 def redis_container():
    client = docker.from_env()
    container = client.containers.run('redis:alpine', detach=True)
    yield container
    container.stop()

def test_redis_running(redis_container):
    print(redis_container.status)

medium

A. running

B. created

C. exited

D. paused

Solution

1. Step 1: Understand container lifecycle in fixture

   Container is started with detach=True, so status should be 'running' during test.

2. Step 2: Check printed status in test

   redis_container.status returns current container status, expected 'running' while test runs.

3. Final Answer:

   running -> Option A

4. Quick Check:

   Container started = status 'running' [OK]

Hint: Container status is 'running' while test uses it [OK]

Common Mistakes:

• Expecting 'created' before container starts
• Assuming container is 'exited' during test
• Confusing status with container image tag

4. Identify the error in this pytest fixture that manages a Docker container:

@pytest.fixture
def redis_container():
    client = docker.from_env()
    container = client.containers.run('redis', detach=True)
    yield container
    container.remove()

medium

A. Missing container.stop() before container.remove() to stop container properly.

B. Using container.remove() instead of container.delete() which is invalid.

C. Not specifying environment variables for Redis container causes failure.

D. Yielding container before starting it causes runtime error.

Solution

1. Step 1: Check container cleanup steps

   Container must be stopped before removal to avoid errors.

2. Step 2: Identify missing stop call

   Fixture calls container.remove() but misses container.stop() before it.

3. Final Answer:

   Missing container.stop() before container.remove() to stop container properly. -> Option A

4. Quick Check:

   Stop container before remove to clean up [OK]

Hint: Always stop container before removing it [OK]

Common Mistakes:

• Calling remove without stopping container
• Confusing remove() with non-existent delete()
• Assuming environment vars are mandatory for container start

5. You want to write a pytest fixture that starts a PostgreSQL container with Docker, waits until it is ready to accept connections, and then yields it for tests. Which approach correctly combines container management and readiness check?

hard

A. Start container without detach, yield immediately, and rely on test to wait for readiness.

B. Start container with detach=True, then poll container logs until 'database system is ready' appears before yielding.

C. Start container with detach=True and yield immediately without any readiness check.

D. Start container with detach=True, sleep fixed 1 second, then yield container.

Solution

1. Step 1: Manage container lifecycle properly

   Start PostgreSQL container detached to run in background during tests.

2. Step 2: Implement readiness check before yielding

   Poll container logs for 'database system is ready' message to ensure service is ready.

3. Step 3: Yield container after readiness confirmed

   This ensures tests run only after PostgreSQL is ready to accept connections.

4. Final Answer:

   Start container with detach=True, then poll container logs until 'database system is ready' appears before yielding. -> Option B

5. Quick Check:

   Wait for readiness log before yielding container [OK]

Hint: Wait for readiness log, don't guess with sleep [OK]

Common Mistakes:

• Yielding container before it is ready
• Using fixed sleep instead of log polling
• Starting container without detach causing blocking