Database rollback fixtures in PyTest - Framework Patterns

Framework Mode - Database rollback fixtures

Folder Structure

tests/
├── test_users.py
├── test_orders.py
├── conftest.py

src/
├── app.py
├── db.py

utils/
├── db_helpers.py

Test Framework Layers

• Fixtures Layer:
  Contains pytest fixtures like db_session that manage database transactions and rollback after each test.
• Test Layer:
  Test files in tests/ use fixtures to run tests isolated from each other.
• Application Layer:
  Application code that interacts with the database, e.g., src/db.py.
• Utilities Layer:
  Helper functions for database setup, teardown, or common queries.

Configuration Patterns

• Database URL: Use environment variables to configure database connection strings for different environments (test, dev, prod).
• Fixture Scope: Use function scope for rollback fixtures to isolate tests.
• Credentials: Store sensitive info securely outside code, e.g., in .env files or CI secrets.
• Transaction Management: Start a transaction at fixture setup and rollback at teardown to keep DB clean.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --junitxml=report.xml for CI systems.
• Integrate with CI tools like GitHub Actions, GitLab CI, or Jenkins to run tests on each commit.
• Fail tests if database rollback does not work, ensuring no side effects remain.
• Use coverage tools to ensure database-related code is tested.

Best Practices

1. Use Transaction Rollback: Wrap each test in a transaction and rollback to keep tests isolated.
2. Fixture Reuse: Define reusable fixtures in conftest.py for easy sharing across tests.
3. Keep Tests Independent: Never rely on data created by other tests; use fixtures to set up needed data.
4. Secure Configurations: Avoid hardcoding credentials; use environment variables or secret managers.
5. Clear Naming: Name fixtures clearly to indicate their purpose, e.g., db_session, rollback_transaction.

Self Check

Where in this folder structure would you add a new fixture that starts a database transaction and rolls it back after each test?

Key Result

Use pytest fixtures to start a database transaction before each test and rollback after to keep tests isolated and the database clean.

Practice

1. What is the main purpose of a database rollback fixture in pytest?

easy

A. To permanently save test data for later use

B. To speed up database queries during tests

C. To create new database tables before tests

D. To undo database changes after each test to keep tests independent

Solution

1. Step 1: Understand the role of rollback fixtures

   Rollback fixtures undo any changes made to the database during a test to keep tests isolated.

2. Step 2: Compare options with rollback purpose

   Only To undo database changes after each test to keep tests independent describes undoing changes after tests, which matches rollback behavior.

3. Final Answer:

   To undo database changes after each test to keep tests independent -> Option D

4. Quick Check:

   Rollback fixture purpose = undo changes [OK]

Hint: Rollback means undo changes after test [OK]

Common Mistakes:

• Confusing rollback with speeding up queries
• Thinking rollback creates tables
• Assuming rollback saves data permanently

2. Which of the following is the correct way to define a pytest fixture that rolls back database changes after a test?

easy

A. @pytest.fixture
def db_fixture():
setup_db()
yield
rollback_db()

B. @pytest.fixture
def db_fixture():
rollback_db()
yield
setup_db()

C. @pytest.fixture
def db_fixture():
yield
setup_db()
rollback_db()

D. @pytest.fixture
def db_fixture():
setup_db()
rollback_db()
yield

Solution

1. Step 1: Understand yield usage in fixtures

   Yield separates setup (before yield) and teardown (after yield) in pytest fixtures.

2. Step 2: Identify correct order for rollback

   Setup happens before yield, rollback (cleanup) after yield. @pytest.fixture def db_fixture(): setup_db() yield rollback_db() follows this order.

3. Final Answer:

   @pytest.fixture\ndef db_fixture():\n setup_db()\n yield\n rollback_db() -> Option A

4. Quick Check:

   Setup before yield, rollback after yield [OK]

Hint: Setup before yield, cleanup after yield [OK]

Common Mistakes:

• Placing rollback before yield
• Calling setup after yield
• Not using yield at all

3. Given this pytest fixture and test, what will be the final count of records in the database after the test runs?

@pytest.fixture
def db_fixture():
    connect_db()
    yield
    rollback_db()


def test_add_record(db_fixture):
    add_record_to_db('test')
    assert count_records() == 1

medium

A. 0

B. Raises an error

C. 1

D. Depends on previous tests

Solution

1. Step 1: Understand fixture behavior with yield

   The fixture sets up connection, yields control to test, then rolls back changes after test finishes.

2. Step 2: Analyze test effect on database

   The test adds one record and asserts count is 1 during test, but rollback removes it after test.

3. Final Answer:

   0 -> Option A

4. Quick Check:

   Rollback clears changes after test [OK]

Hint: Rollback clears test changes after test ends [OK]

Common Mistakes:

• Assuming record stays after test
• Confusing assert inside test with final state
• Thinking rollback happens before test

4. You wrote this fixture but your database changes are not rolling back after tests:

@pytest.fixture
def db_fixture():
    setup_db()
    rollback_db()
    yield

What is the main problem?

medium

A. Yield is missing, so fixture never runs

B. Setup_db should be called after yield

C. Rollback is called before yield, so changes are undone before test runs

D. Rollback_db should be called twice for safety

Solution

1. Step 1: Check order of setup, yield, and rollback

   Rollback must happen after yield to undo changes after test runs.

2. Step 2: Identify error in fixture code

   Rollback is called before yield, so changes are undone before test, not after.

3. Final Answer:

   Rollback is called before yield, so changes are undone before test runs -> Option C

4. Quick Check:

   Rollback after yield for cleanup [OK]

Hint: Rollback must be after yield to undo test changes [OK]

Common Mistakes:

• Calling rollback before yield
• Forgetting yield entirely
• Calling setup after yield

5. You want to write a pytest fixture that starts a database transaction before each test and rolls it back after, ensuring tests run fast and isolated. Which fixture code correctly achieves this behavior?

hard

A. @pytest.fixture
def db_transaction():
yield
start_transaction()
rollback_transaction()

B. @pytest.fixture
def db_transaction():
start_transaction()
yield
rollback_transaction()

C. @pytest.fixture
def db_transaction():
start_transaction()
rollback_transaction()
yield

D. @pytest.fixture
def db_transaction():
rollback_transaction()
start_transaction()
yield

Solution

1. Step 1: Understand transaction lifecycle in fixtures

   Start transaction before yield to begin test with transaction active.

2. Step 2: Rollback after yield to undo changes after test

   Rollback must happen after yield to clean up changes made during test.

3. Final Answer:

   @pytest.fixture\ndef db_transaction():\n start_transaction()\n yield\n rollback_transaction() -> Option B

4. Quick Check:

   Start before yield, rollback after yield [OK]

Hint: Start transaction before yield, rollback after yield [OK]

Common Mistakes:

• Calling rollback before yield
• Calling start_transaction after yield
• Not using yield to separate setup and cleanup