Testing with database in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

Why do we use a separate test database when testing FastAPI applications?

Using a separate test database keeps test data isolated from real data. This prevents accidental data loss or corruption and allows tests to run safely without affecting the live system.

intermediate

What is the purpose of using SQLAlchemy's session rollback in tests?

Session rollback resets the database state after each test. This ensures tests do not affect each other by leaving data behind, keeping tests independent and reliable.

beginner

How does the TestClient in FastAPI help with testing endpoints?

TestClient simulates HTTP requests to your FastAPI app without running a real server. It lets you test routes and responses quickly and easily in your test code.

intermediate

What is a fixture in testing with pytest and why is it useful for database tests?

A fixture sets up and tears down resources needed for tests, like a test database session. It helps keep tests clean and avoids repeating setup code.

advanced

Explain the role of dependency overrides in FastAPI testing with databases.

Dependency overrides let you replace real dependencies (like the database session) with test versions. This allows tests to use a test database instead of the real one.

What is the main reason to use a test database in FastAPI testing?

A To keep test data separate from production data

B To speed up the application in production

C To avoid writing tests

D To make the database bigger

Using a test database keeps test data isolated, preventing interference with real data.

Which FastAPI tool allows you to simulate HTTP requests in tests?

A DependencyInjector

B SessionRollback

C TestClient

D DatabaseFixture

TestClient lets you send fake HTTP requests to your FastAPI app during tests.

What does a pytest fixture typically do in database testing?

A Runs the production server

B Sets up and cleans the test database session

C Deletes the database permanently

D Creates user interface elements

Fixtures prepare and clean resources like database sessions for tests.

Why is session rollback important after each test?

A To speed up the database

B To close the database connection

C To save data permanently

D To reset database changes and keep tests independent

Rollback undoes changes made during a test so other tests start fresh.

How do dependency overrides help in FastAPI database testing?

A They replace real database sessions with test sessions

B They speed up the database queries

C They disable the database

D They create new API routes

Dependency overrides let tests use a test database instead of the real one.

Describe the steps to set up a test database session in FastAPI tests.

Think about how to isolate tests and keep them independent.

Explain why dependency overrides are crucial when testing FastAPI apps with databases.

Consider how FastAPI injects dependencies and how tests can change that.

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