Test containers with Docker in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of using test containers with Docker in testing?

Test containers provide isolated, real environment instances (like databases or services) inside Docker containers for reliable and consistent testing.

intermediate

How does pytest integrate with Docker test containers?

Pytest can use fixtures to start and stop Docker containers before and after tests, ensuring tests run against real services in containers.

intermediate

Why is it better to use test containers instead of mocking external services?

Test containers run actual service instances, catching integration issues early, unlike mocks which only simulate behavior and may miss real problems.

beginner

What is a common Python library to manage Docker test containers in pytest?

The 'testcontainers' Python library helps manage Docker containers lifecycle easily within pytest tests.

advanced

Describe a simple pytest fixture to start a PostgreSQL test container using testcontainers.

A pytest fixture can create a PostgreSQLContainer instance, start it before tests, yield connection info, and stop it after tests.

What does a test container provide in software testing?

A A mock object to simulate service behavior

B A cloud-based testing platform

C A virtual machine for running tests

D A real service instance running inside a Docker container

Test containers run real service instances inside Docker containers for accurate integration testing.

Which pytest feature is commonly used to manage test container lifecycle?

A Fixtures

B Markers

C Parametrize

D Hooks

Fixtures in pytest setup and teardown resources like test containers before and after tests.

Why might test containers catch bugs that mocks miss?

A Because they require no setup

B Because they run faster than mocks

C Because they run actual services, not just simulations

D Because they use less memory

Running real services in containers exposes integration issues that mocks might not reveal.

Which Python library helps manage Docker containers in pytest tests?

A unittest

B testcontainers

C requests

D selenium

'testcontainers' library simplifies starting and stopping Docker containers in tests.

What is the correct order of actions in a pytest fixture using testcontainers?

A Start container, yield resource, stop container

B Yield resource, start container, stop container

C Stop container, start container, yield resource

D Yield resource, stop container, start container

Fixture starts the container, yields resource to test, then stops container after test.

Explain how test containers improve integration testing compared to mocks.

Think about running actual services versus simulating them.

Describe how you would use pytest fixtures with the testcontainers library to test a database service.

Focus on setup, usage, and teardown steps.

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