Test containers with Docker in PyTest - Test Execution Trace

Test Overview

This test uses Docker containers to run a temporary PostgreSQL database. It verifies that the application can connect and query the database correctly.

Test Code - pytest

PyTest

import pytest
import psycopg2
from testcontainers.postgres import PostgresContainer

@pytest.fixture(scope="module")
def postgres_container():
    with PostgresContainer("postgres:15-alpine") as postgres:
        yield postgres


def test_postgres_connection(postgres_container):
    conn = psycopg2.connect(
        dbname=postgres_container.DBNAME,
        user=postgres_container.USER,
        password=postgres_container.PASSWORD,
        host=postgres_container.get_container_host_ip(),
        port=postgres_container.get_exposed_port(5432),
    )
    cur = conn.cursor()
    cur.execute("SELECT 1;")
    result = cur.fetchone()
    cur.close()
    conn.close()
    assert result == (1,)

Execution Trace - 5 Steps

Step	Action	System State	Assertion	Result
1	Test starts and pytest fixture postgres_container initializes a PostgreSQL Docker container using PostgresContainer.	Docker runs a temporary PostgreSQL 15-alpine container with default credentials and exposed port.	—	PASS
2	Test function test_postgres_connection connects to the PostgreSQL container using psycopg2 with container credentials and host/port.	Connection to the running PostgreSQL container is established.	—	PASS
3	Cursor executes SQL query 'SELECT 1;' on the PostgreSQL container database.	Query runs successfully inside the container database.	—	PASS
4	Fetch one row from the query result and close cursor and connection.	Result fetched is (1,). Database connection closed.	Assert that fetched result equals (1,).	PASS
5	Test ends and pytest fixture tears down the PostgreSQL Docker container.	Docker container is stopped and removed.	—	PASS

Failure Scenario

Failing Condition: The test fails if the connection to the PostgreSQL container cannot be established or the query returns an unexpected result.

Execution Trace Quiz - 3 Questions

What does the pytest fixture postgres_container do in this test?

A Mocks the database connection without using Docker.

B Runs the test inside a Docker container.

C Starts and provides a temporary PostgreSQL Docker container for the test.

D Creates a permanent PostgreSQL database on the host.

Key Result

Using test containers with Docker allows tests to run against real services in isolated environments, improving reliability and reproducibility without needing permanent infrastructure.

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