Why fixtures provide reusable test setup in PyTest - Automation Benefits in Action

Automate reusable test setup using pytest fixture

Preconditions (2)

Step 1: Create a pytest fixture named 'sample_data' that returns a dictionary with keys 'name' and 'age'

Step 2: Write two test functions that use the 'sample_data' fixture as a parameter

Step 3: In the first test, assert that 'name' is a string

Step 4: In the second test, assert that 'age' is an integer

✅ Expected Result: Both tests pass using the same reusable 'sample_data' fixture setup

Automation Requirements - pytest

Assertions Needed:

Assert 'name' is instance of str

Assert 'age' is instance of int

Best Practices:

Use @pytest.fixture decorator for reusable setup

Use fixture as function parameter for dependency injection

Keep fixture scope default (function) for isolation

Automated Solution

PyTest

import pytest

@pytest.fixture
def sample_data():
    return {"name": "Alice", "age": 30}

def test_name_is_string(sample_data):
    assert isinstance(sample_data["name"], str), "Name should be a string"

def test_age_is_integer(sample_data):
    assert isinstance(sample_data["age"], int), "Age should be an integer"

The @pytest.fixture decorator defines a reusable setup function sample_data that returns a dictionary. This fixture can be used by any test function by adding it as a parameter. This way, the setup code is written once and reused, making tests cleaner and easier to maintain.

Each test function receives the fixture data automatically. The assertions check the data types as required. This demonstrates how fixtures provide reusable test setup in pytest.

Common Mistakes - 3 Pitfalls

Defining setup code inside each test instead of using fixtures

{'mistake': 'Not adding the fixture as a parameter to test functions', 'why_bad': "Fixture code will not run and tests won't get the setup data", 'correct_approach': 'Include fixture name as a parameter in test functions'}

Using global variables instead of fixtures for setup

Bonus Challenge

Now add a fixture that provides different user data sets and write tests that run with each data set

Show Hint

Practice

1. Why do pytest fixtures help keep test code clean and simple?

easy

A. They run tests in parallel to speed up execution

B. They provide reusable setup code that multiple tests can share

C. They replace the need for assertions in tests

D. They automatically generate test data without user input

Solution

1. Step 1: Understand the purpose of fixtures in pytest

   Fixtures are designed to prepare setup code that can be reused by many tests, avoiding repetition.

2. Step 2: Compare options with fixture purpose

   Only They provide reusable setup code that multiple tests can share correctly states that fixtures provide reusable setup code. Other options describe unrelated features.

3. Final Answer:

   They provide reusable setup code that multiple tests can share -> Option B

4. Quick Check:

   Reusable setup = fixtures help keep tests clean [OK]

Hint: Fixtures share setup code to avoid repetition [OK]

Common Mistakes:

• Thinking fixtures generate test data automatically
• Confusing fixtures with test runners
• Believing fixtures replace assertions

2. Which of the following is the correct way to define a simple pytest fixture?

easy

A. @pytest.test
def setup_data():
return {'key': 'value'}

B. def setup_data():
return {'key': 'value'}

C. @pytest.fixture
def setup_data():
return {'key': 'value'}

D. @fixture
def setup_data():
return {'key': 'value'}

Solution

1. Step 1: Identify correct fixture decorator syntax

   Pytest fixtures require the decorator @pytest.fixture above the function.

2. Step 2: Check each option's decorator

   @pytest.fixture def setup_data(): return {'key': 'value'} uses @pytest.fixture correctly. def setup_data(): return {'key': 'value'} misses decorator, A uses wrong decorator @pytest.test, D uses incomplete decorator @fixture without pytest prefix.

3. Final Answer:

   @pytest.fixture\ndef setup_data():\n return {'key': 'value'} -> Option C

4. Quick Check:

   @pytest.fixture decorator is required [OK]

Hint: Always use @pytest.fixture decorator for fixtures [OK]

Common Mistakes:

• Omitting the @pytest.fixture decorator
• Using incorrect decorators like @pytest.test
• Using @fixture without pytest prefix

3. Given this pytest code, what will be the output when running test_example?

import pytest

@pytest.fixture
def sample_data():
    return [1, 2, 3]

def test_example(sample_data):
    assert sum(sample_data) == 6
    print('Test passed')

medium

A. No output because print is ignored

B. Test fails due to wrong sum

C. SyntaxError because fixture is missing

D. Test passed printed and test passes

Solution

1. Step 1: Understand fixture usage in test

   The fixture sample_data returns [1, 2, 3]. The test asserts sum is 6, which is correct.

2. Step 2: Check test behavior

   Since assertion passes, test passes. Pytest captures stdout by default and does not show print output for passing tests (use -s to show). Thus, no 'Test passed' is printed.

3. Final Answer:

   No output because print is ignored -> Option A

4. Quick Check:

   Fixture provides data, assertion correct, test passes [OK]

Hint: pytest captures stdout by default for passing tests [OK]

Common Mistakes:

• Thinking print output is shown by default
• Thinking fixture is missing causing error
• Believing sum is incorrect

4. Identify the error in this pytest fixture usage:

import pytest

@pytest.fixture
def resource():
    return open('file.txt', 'r')

def test_read(resource):
    data = resource.read()
    assert data != ''
    resource.close()

medium

A. The fixture should close the file after test automatically

B. The fixture is missing the @pytest.fixture decorator

C. The test should not use the fixture as a parameter

D. The assert statement is invalid syntax

Solution

1. Step 1: Analyze resource fixture and test

   The fixture opens a file but does not close it. The test closes it manually.

2. Step 2: Understand best practice for cleanup

   Fixtures should handle cleanup automatically using yield or finalizers to avoid resource leaks if test fails before close.

3. Final Answer:

   The fixture should close the file after test automatically -> Option A

4. Quick Check:

   Fixtures manage setup and cleanup [OK]

Hint: Use fixture finalizers or yield for cleanup [OK]

Common Mistakes:

• Not closing resources in fixtures
• Closing resources only in tests
• Ignoring cleanup causing leaks

5. How can you modify this fixture to ensure the resource is properly cleaned up after each test?

@pytest.fixture
def db_connection():
    conn = connect_to_db()
    return conn

hard

A. Remove the fixture and open connection inside each test

B. Add a try-except block inside the fixture to catch errors

C. Call conn.close() before returning conn

D. Use yield in fixture and close connection after yield

@pytest.fixture
def db_connection():
conn = connect_to_db()
yield conn
conn.close()

Solution

1. Step 1: Understand fixture cleanup with yield

   Using yield in a fixture allows setup before yield and cleanup after yield, ensuring resource is closed after test.

2. Step 2: Evaluate options for proper cleanup

   Use yield in fixture and close connection after yield

   @pytest.fixture
   def db_connection():
       conn = connect_to_db()
       yield conn
       conn.close()

   correctly uses yield and closes connection after test. Add a try-except block inside the fixture to catch errors does not guarantee cleanup. Call conn.close() before returning conn closes before returning, breaking connection. Remove the fixture and open connection inside each test removes fixture benefits.

3. Final Answer:

   Use yield in fixture and close connection after yield -> Option D

4. Quick Check:

   Yield fixtures handle setup and cleanup [OK]

Hint: Use yield in fixtures for setup and cleanup [OK]

Common Mistakes:

• Closing resource before returning it
• Not cleaning up resources after tests
• Avoiding fixtures and duplicating code