Database fixture patterns in PyTest

Introduction

Database fixture patterns help set up and clean test data before and after tests run. This keeps tests reliable and repeatable.

When you need to prepare test data in a database before running tests.

When you want to clean up database changes after tests to avoid side effects.

When multiple tests share the same database setup to save time.

When you want to isolate tests so they don't affect each other's data.

Syntax

PyTest

import pytest

@pytest.fixture(scope='function')
def db_setup():
    # Connect to database
    # Insert test data
    yield
    # Clean up test data
    # Close connection

Use @pytest.fixture to create a fixture function.

The scope controls how often the fixture runs (e.g., per function, module).

Examples

This fixture inserts user data before each test and deletes it after.

PyTest

import pytest

@pytest.fixture(scope='function')
def setup_user():
    print('Insert user data')
    yield
    print('Delete user data')

This fixture connects to the database once per module and disconnects after all tests finish.

PyTest

import pytest

@pytest.fixture(scope='module')
def setup_db():
    print('Connect to DB')
    yield
    print('Disconnect from DB')

Sample Program

This test uses the db_setup fixture to prepare and clean test data around the test.

PyTest

import pytest

@pytest.fixture(scope='function')
def db_setup():
    print('Setup: Insert test data')
    yield
    print('Teardown: Remove test data')

def test_example(db_setup):
    print('Running test')
    assert True

Important Notes

Always clean up test data to keep tests independent.

Use yield in fixtures to separate setup and teardown steps.

Choose fixture scope wisely to balance speed and isolation.

Summary

Database fixtures prepare and clean test data automatically.

Fixtures use @pytest.fixture and yield for setup and teardown.

Proper fixture use makes tests reliable and easy to maintain.

Practice

1. What is the main purpose of using database fixtures in pytest?

easy

A. To speed up the database server

B. To write SQL queries inside test functions

C. To prepare and clean test data automatically before and after tests

D. To replace the need for assertions in tests

Solution

1. Step 1: Understand what fixtures do

   Fixtures in pytest are used to set up and tear down resources needed for tests, such as database data.

2. Step 2: Identify the role of database fixtures

   Database fixtures specifically prepare test data before tests run and clean it up after tests finish, ensuring tests run reliably.

3. Final Answer:

   To prepare and clean test data automatically before and after tests -> Option C

4. Quick Check:

   Database fixtures = setup and cleanup [OK]

Hint: Fixtures handle setup and cleanup automatically [OK]

Common Mistakes:

• Thinking fixtures run SQL queries inside tests
• Believing fixtures speed up the database server
• Confusing fixtures with assertions

2. Which of the following is the correct way to write a pytest fixture that sets up a database connection and tears it down after the test using yield?

easy

A. def db():
conn = connect()
yield conn
conn.close()

B. def db():
conn = connect()
conn.close()
yield conn

C. def db():
yield connect()
conn.close()

D. def db():
conn = connect()
return conn
conn.close()

Solution

1. Step 1: Understand yield usage in fixtures

   Using yield in a fixture splits setup (before yield) and teardown (after yield).

2. Step 2: Check each option's order

   def db(): conn = connect() yield conn conn.close() sets up connection, yields it, then closes connection after test. Others close before yield or have unreachable code.

3. Final Answer:

   def db():\n conn = connect()\n yield conn\n conn.close() -> Option A

4. Quick Check:

   Setup before yield, teardown after yield [OK]

Hint: Yield separates setup and teardown in fixtures [OK]

Common Mistakes:

• Closing connection before yield
• Placing code after return (unreachable)
• Yielding before setup

3. Given the following pytest fixture and test, what will be printed when the test runs?

import pytest

@pytest.fixture
def sample_db():
    data = {'count': 0}
    yield data
    data['count'] += 1


def test_increment(sample_db):
    print(sample_db['count'])
    sample_db['count'] += 5
    print(sample_db['count'])

medium

A. 1\n6

B. 0\n5

C. 0\n0

D. 5\n10

Solution

1. Step 1: Analyze fixture setup and teardown

   The fixture yields data with 'count' 0. After test, it increments 'count' by 1 (not affecting test output).

2. Step 2: Trace test function prints

   First print shows initial 0. Then 'count' is increased by 5, so second print shows 5.

3. Final Answer:

   0\n5 -> Option B

4. Quick Check:

   Yielded data count = 0, incremented in test = 5 [OK]

Hint: Yield returns setup data; teardown runs after test [OK]

Common Mistakes:

• Thinking teardown runs before test prints
• Assuming fixture modifies data before yield
• Confusing fixture teardown with test code

4. Identify the error in this pytest fixture that is supposed to setup a test database and clean it after tests:

@pytest.fixture
def test_db():
    conn = connect_db()
    conn.execute('CREATE TABLE users')
    return conn
    conn.execute('DROP TABLE users')
    conn.close()

medium

A. The cleanup code after return is never executed

B. The fixture should use yield instead of return for cleanup

C. The table creation SQL is incorrect

D. The fixture is missing the @pytest.mark decorator

Solution

1. Step 1: Check the fixture structure

   Code after return statement is unreachable and will never run.

2. Step 2: Understand cleanup execution

   Cleanup code must run after test, so it should be placed after yield or before return, but not after return.

3. Final Answer:

   The cleanup code after return is never executed -> Option A

4. Quick Check:

   Code after return is unreachable [OK]

Hint: Code after return in fixture won't run [OK]

Common Mistakes:

• Thinking return allows cleanup after it
• Confusing yield and return usage
• Ignoring unreachable code warnings

5. You want to create a pytest fixture that sets up a test database with multiple tables and ensures all tables are dropped after tests, even if a test fails. Which pattern best achieves this?

hard

A. Create tables once globally without cleanup to speed up tests

B. Create tables inside each test and drop them at the end of each test

C. Use return in fixture to return connection, then drop tables in a separate teardown function

D. Use a fixture with yield: create tables before yield, drop tables after yield

Solution

1. Step 1: Understand reliable setup and teardown

   Using yield in fixtures allows setup before tests and guaranteed cleanup after, even if tests fail.

2. Step 2: Evaluate options for cleanup guarantee

   Use a fixture with yield: create tables before yield, drop tables after yield uses yield to create tables before tests and drop them after, ensuring cleanup always runs.

3. Final Answer:

   Use a fixture with yield: create tables before yield, drop tables after yield -> Option D

4. Quick Check:

   Yield fixture ensures setup and guaranteed teardown [OK]

Hint: Yield fixtures guarantee cleanup after tests [OK]

Common Mistakes:

• Skipping cleanup causing leftover tables
• Relying on test code for cleanup
• Avoiding yield and missing teardown