Testing with database in FastAPI - Step-by-Step Execution

Concept Flow - Testing with database

Setup Test DB

↓

Create Test Client

↓

Run Test Function

↓

Perform DB Operations

↓

Assert Results

↓

Teardown Test DB

This flow shows how a test sets up a temporary database, runs API calls, checks results, and cleans up.

Execution Sample

FastAPI

from fastapi.testclient import TestClient
from main import app, get_db

def test_create_item():
    client = TestClient(app)
    response = client.post('/items/', json={'name': 'Test'})
    assert response.status_code == 200

This test creates a test client, sends a POST request to create an item, and checks the response status.

Execution Table

Step	Action	DB State	Response Status	Assertion
1	Setup test database (empty)	Empty	N/A	N/A
2	Create TestClient instance	Empty	N/A	N/A
3	Send POST /items/ with {'name': 'Test'}	Contains 1 item	200	Pass
4	Check response status code	Contains 1 item	200	Pass
5	Teardown test database	Deleted all	N/A	N/A

💡 Test ends after teardown; database reset to empty state

Variable Tracker

Variable	Start	After Step 3	After Step 5
client	None	TestClient instance	TestClient instance
response.status_code	N/A	200	N/A
database contents	Empty	Contains 1 item	Empty

Key Moments - 2 Insights

Why do we need to setup and teardown the test database?

To keep tests isolated and avoid data conflicts, the test database is created fresh and deleted after tests, as shown in steps 1 and 5 in the execution_table.

Why use TestClient instead of calling app functions directly?

TestClient simulates real HTTP requests, including routing and middleware, ensuring the test covers the full API behavior, as in step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the database state after step 3?

A Empty

B Contains 1 item

C Deleted all

D Unknown

💡 Hint

Check the 'DB State' column for step 3 in the execution_table

At which step is the response status code checked?

A Step 4

B Step 3

C Step 2

D Step 5

💡 Hint

Look at the 'Action' and 'Assertion' columns in the execution_table

If the test database was not torn down, what would happen in the next test?

A The test client would fail to create

B The database would be empty again

C The database would contain leftover data

D The response status would always be 404

💡 Hint

Refer to the importance of teardown in key_moments and execution_table step 5

Concept Snapshot

Testing with database in FastAPI:
- Setup a test database separate from production
- Use TestClient to simulate HTTP requests
- Perform API calls that read/write test DB
- Assert expected responses and DB changes
- Teardown test DB to keep tests isolated

Full Transcript

Testing with database in FastAPI involves creating a temporary database for tests to avoid affecting real data. We use FastAPI's TestClient to send HTTP requests to the app as if from a user. The test creates data in the test database, then checks the response status and database contents. After the test, the database is cleaned up to keep tests independent. This process ensures reliable, repeatable tests that simulate real API usage.

Practice

1. Why should you use a separate test database when testing FastAPI applications that interact with a database?

easy

A. To skip database setup during tests

B. To make tests run slower and more realistic

C. To avoid changing real data and keep tests isolated

D. To share data between tests and production

Solution

1. Step 1: Understand test isolation

   Tests should not affect real data to avoid accidental data loss or corruption.

2. Step 2: Use separate test database

   Using a separate database keeps test data separate and allows safe repeated testing.

3. Final Answer:

   To avoid changing real data and keep tests isolated -> Option C

4. Quick Check:

   Separate test database = safe isolated tests [OK]

Hint: Always isolate test data from real data [OK]

Common Mistakes:

• Using production database for tests
• Not cleaning test data after tests
• Assuming tests don't affect real data

2. Which of the following is the correct way to override the database dependency in FastAPI tests?

easy

A. app.replace_dependency(get_db, override_get_db)

B. app.override_dependency(get_db, override_get_db)

C. app.set_dependency(get_db, override_get_db)

D. app.dependency_overrides[get_db] = override_get_db

Solution

1. Step 1: Recall FastAPI dependency override syntax

   FastAPI uses the dictionary app.dependency_overrides to replace dependencies during tests.

2. Step 2: Match correct syntax

   Assigning override_get_db function to app.dependency_overrides[get_db] is the correct method.

3. Final Answer:

   app.dependency_overrides[get_db] = override_get_db -> Option D

4. Quick Check:

   Override dependencies via app.dependency_overrides dict [OK]

Hint: Use app.dependency_overrides dictionary to override [OK]

Common Mistakes:

• Using non-existent methods like set_dependency
• Trying to override dependencies without assignment
• Confusing syntax with other frameworks

3. Given this test code snippet, what will be the output of response.json()?

def test_create_item(client):
    response = client.post('/items/', json={'name': 'Book', 'price': 10})
    return response.json()

medium

A. {'id': 1, 'name': 'Book', 'price': 10}

B. {'name': 'Book', 'price': 10}

C. An error because POST is not allowed

D. Empty response {}

Solution

1. Step 1: Understand POST /items/ behavior

   Assuming the endpoint creates an item and returns it with an assigned id.

2. Step 2: Analyze response.json()

   The response should include the new item's id plus the sent data.

3. Final Answer:

   {'id': 1, 'name': 'Book', 'price': 10} -> Option A

4. Quick Check:

   POST creates item and returns it with id [OK]

Hint: POST usually returns created object with id [OK]

Common Mistakes:

• Expecting only sent data without id
• Assuming POST is disallowed
• Ignoring response content

4. What is the main issue with this test code snippet?

def override_get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

app.dependency_overrides[get_db] = override_get_db

def test_read_items(client):
    response = client.get('/items/')
    assert response.status_code == 200
    assert response.json() == []

medium

A. The dependency override is missing

B. The test database session is not properly created or isolated

C. The test client is not defined

D. The test expects wrong status code

Solution

1. Step 1: Check override_get_db function

   It uses SessionLocal but does not ensure a separate test database or transaction rollback.

2. Step 2: Identify test isolation problem

   Without a test database or rollback, tests may affect real data or each other.

3. Final Answer:

   The test database session is not properly created or isolated -> Option B

4. Quick Check:

   Test DB session must be isolated and separate [OK]

Hint: Ensure test DB session is isolated and rolled back [OK]

Common Mistakes:

• Not using a test database
• Not overriding dependencies correctly
• Assuming client is auto-defined

5. You want to write a test that creates an item, then reads it back from the test database in FastAPI. Which approach correctly ensures the test uses a separate database and cleans up after itself?

hard

A. Use a test database URL, override get_db to yield a session from it, and rollback after each test

B. Use the production database URL and delete created items manually after test

C. Use an in-memory list to mock database and skip actual DB calls

D. Run tests without overriding get_db and rely on default DB

Solution

1. Step 1: Use separate test database URL

   This prevents tests from affecting production data.

2. Step 2: Override get_db to yield test session and rollback

   This ensures each test runs isolated and cleans up changes automatically.

3. Final Answer:

   Use a test database URL, override get_db to yield a session from it, and rollback after each test -> Option A

4. Quick Check:

   Separate DB + override + rollback = clean isolated tests [OK]

Hint: Always isolate tests with separate DB and rollback [OK]

Common Mistakes:

• Using production DB for tests
• Not cleaning test data after tests
• Skipping dependency overrides