Avoiding test interdependence in PyTest - Framework Patterns

Framework Mode - Avoiding test interdependence

Folder Structure

tests/
├── test_login.py
├── test_shopping_cart.py
├── test_checkout.py
├── conftest.py
utilities/
├── helpers.py
├── data_loader.py
configs/
├── config.yaml
reports/
├── latest_report.html
pytest.ini

Test Framework Layers

• Test Cases: Individual test files in tests/ folder, each test is independent and self-contained.
• Fixtures: Defined in conftest.py to setup and teardown test data or environment, ensuring fresh state for each test.
• Utilities: Helper functions and data loaders in utilities/ to avoid duplication and keep tests clean.
• Configuration: Environment settings and credentials stored in configs/config.yaml and accessed via utility functions.

Configuration Patterns

• Use pytest.ini to configure pytest options like markers and test paths.
• Store environment-specific data (URLs, credentials) in configs/config.yaml.
• Load configuration in fixtures or utilities to inject into tests.
• Use fixtures with scope="function" to ensure each test runs with a clean setup.

Test Reporting and CI/CD Integration

• Generate HTML reports using pytest --html=reports/latest_report.html.
• Integrate pytest runs in CI pipelines (GitHub Actions, Jenkins) to run tests on each commit.
• Fail fast option to stop on first failure to quickly identify interdependent test issues.
• Use tags/markers to run subsets of tests independently.

Framework Design Principles

1. Isolate Tests: Each test should setup and cleanup its own data to avoid sharing state.
2. Use Fixtures: Use pytest fixtures to prepare fresh environments for every test function.
3. No Test Order Dependency: Tests must pass regardless of execution order.
4. Clear Naming: Name tests clearly to reflect their independent purpose.
5. Data Reset: Reset or mock external resources between tests to prevent side effects.

Self Check

Where in this framework structure would you add a fixture that resets the database before each test?

Key Result

Use pytest fixtures to ensure each test runs independently with fresh setup and no shared state.

Practice

1. Why is it important to avoid test interdependence in pytest?

easy

A. To ensure each test runs independently and results are reliable

B. To make tests run faster by sharing data

C. To reduce the number of test functions needed

D. To allow tests to modify global variables freely

Solution

1. Step 1: Understand test independence

   Tests should not rely on each other to avoid hidden bugs and unclear results.

2. Step 2: Identify the benefit of independence

   Independent tests ensure that a failure in one test does not affect others, making debugging easier.

3. Final Answer:

   To ensure each test runs independently and results are reliable -> Option A

4. Quick Check:

   Test independence = Reliable results [OK]

Hint: Tests must run alone to keep results clear and reliable [OK]

Common Mistakes:

• Thinking tests should share data to run faster
• Believing test order does not matter
• Allowing tests to modify shared global state

2. Which pytest feature helps to avoid test interdependence by preparing fresh data for each test?

easy

A. Using print statements for debugging

B. Using global variables

C. Using fixtures with scope='function'

D. Using assert statements inside tests

Solution

1. Step 1: Identify pytest features for setup

   Fixtures with scope='function' run before each test, providing fresh data.

2. Step 2: Understand why this avoids interdependence

   Fresh data per test prevents tests from affecting each other through shared state.

3. Final Answer:

   Using fixtures with scope='function' -> Option C

4. Quick Check:

   Fixtures with function scope = Fresh data each test [OK]

Hint: Use function-scoped fixtures to reset data per test [OK]

Common Mistakes:

• Using global variables which cause shared state
• Confusing print statements with setup tools
• Thinking assert statements control test independence

3. Given the following pytest code, what will be the output when running both tests?

shared_list = []

def test_add_one():
    shared_list.append(1)
    assert shared_list == [1]

def test_add_two():
    shared_list.append(2)
    assert shared_list == [2]

medium

A. Both tests pass

B. Both tests fail

C. test_add_one fails, test_add_two passes

D. test_add_one passes, test_add_two fails

Solution

1. Step 1: Analyze shared_list state across tests

   shared_list is global and not reset, so after test_add_one it contains [1].

2. Step 2: Check assertions in each test

   test_add_one expects [1] and passes; test_add_two appends 2 making list [1,2], but asserts [2], so it fails.

3. Final Answer:

   test_add_one passes, test_add_two fails -> Option D

4. Quick Check:

   Shared state causes second test failure [OK]

Hint: Global mutable state causes test failures due to leftover data [OK]

Common Mistakes:

• Assuming shared_list resets automatically
• Ignoring order of test execution
• Expecting both tests to pass with shared state

4. Identify the problem in this pytest code that causes test interdependence:

data = {}

def test_set_value():
    data['key'] = 'value'
    assert data['key'] == 'value'

def test_check_empty():
    assert data == {}

medium

A. Using dict instead of list causes errors

B. data dictionary is not reset between tests

C. Tests are missing return statements

D. Assertions are incorrect syntax

Solution

1. Step 1: Examine shared data usage

   data is a global dictionary modified in test_set_value and not cleared before test_check_empty.

2. Step 2: Understand test impact

   test_check_empty expects data to be empty, but it contains {'key': 'value'}, causing failure and interdependence.

3. Final Answer:

   data dictionary is not reset between tests -> Option B

4. Quick Check:

   Shared mutable dict causes test dependency [OK]

Hint: Reset shared data to avoid tests affecting each other [OK]

Common Mistakes:

• Thinking assertions syntax is wrong
• Believing return statements are needed in tests
• Confusing data types with test independence

5. You want to avoid test interdependence in pytest when multiple tests modify a shared database. Which approach is best?

hard

A. Use a fixture that creates a fresh database for each test and cleans up after

B. Share one database instance and reset it manually in one test only

C. Run tests in a specific order so dependencies are met

D. Use global variables to track database state across tests

Solution

1. Step 1: Understand best practice for shared resources

   Creating a fresh database per test ensures no leftover data affects other tests.

2. Step 2: Evaluate other options

   Sharing one instance with manual reset or relying on test order causes hidden dependencies and fragile tests.

3. Final Answer:

   Use a fixture that creates a fresh database for each test and cleans up after -> Option A

4. Quick Check:

   Fresh resource per test = No interdependence [OK]

Hint: Fresh setup and cleanup per test avoids hidden dependencies [OK]

Common Mistakes:

• Relying on test order which is unreliable
• Using global variables causing shared state bugs
• Resetting shared state in only one test