Context manager fixtures in PyTest - Framework Patterns

Framework Mode - Context manager fixtures

Folder Structure

tests/
├── test_example.py          # Test files using fixtures
├── conftest.py              # Shared fixtures including context manager fixtures
utils/
├── resource_manager.py      # Helper modules for resource setup/teardown
configs/
├── config.yaml              # Environment and test configuration files
reports/
├── latest_report.html       # Generated test reports

Test Framework Layers

• Fixtures Layer:
  Defined in conftest.py, includes context manager fixtures that setup and teardown resources automatically using yield.
• Test Layer:
  Test functions in tests/ that use fixtures by declaring them as parameters.
• Utility Layer:
  Helper modules like resource_manager.py that provide context managers or resource handling logic.
• Configuration Layer:
  Files like config.yaml to manage environment variables, credentials, and test settings.

Configuration Patterns

• Use pytest.ini or config.yaml to store environment-specific settings.
• Pass configuration data to fixtures via pytest_addoption or environment variables.
• Context manager fixtures handle setup and teardown cleanly with yield, ensuring resources are released even if tests fail.
• Credentials and secrets should be stored securely and injected into fixtures at runtime, not hardcoded.

Test Reporting and CI/CD Integration

• Use pytest --junitxml=reports/results.xml to generate XML reports for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins) to run tests automatically on commits.
• Generate HTML reports with plugins like pytest-html for easy viewing.
• Context manager fixtures ensure reliable resource cleanup, preventing flaky tests in CI environments.

Best Practices

1. Use yield in fixtures to implement context managers for clear setup and teardown.
2. Keep fixtures small and focused on a single resource or responsibility.
3. Reuse fixtures across tests by placing them in conftest.py for easy sharing.
4. Use autouse=True sparingly to avoid hidden dependencies.
5. Ensure fixtures clean up resources even if tests fail or raise exceptions.

Self Check

Where in this framework structure would you add a new context manager fixture that manages a temporary database connection?

Key Result

Use pytest fixtures with yield to create context managers that setup and teardown test resources cleanly.

Practice

1. What is the main purpose of using a context manager fixture in pytest?

easy

A. To speed up test execution by skipping setup

B. To automatically handle setup and cleanup around a test

C. To replace assertions with print statements

D. To run tests in parallel automatically

Solution

1. Step 1: Understand context manager role

   Context managers in pytest use yield to run setup code before the test and cleanup code after the test finishes.

2. Step 2: Identify purpose in testing

   This automatic setup and cleanup makes tests safer and cleaner by managing resources like files or connections.

3. Final Answer:

   To automatically handle setup and cleanup around a test -> Option B

4. Quick Check:

   Context manager fixture = automatic setup and cleanup [OK]

Hint: Context managers wrap setup and cleanup automatically [OK]

Common Mistakes:

• Thinking context managers speed up tests by skipping setup
• Confusing context managers with parallel test execution
• Using print statements instead of assertions

2. Which of the following is the correct way to define a context manager fixture in pytest?

easy

A. @pytest.fixture
def resource():
setup()
yield
cleanup()

B. @pytest.fixture
def resource():
yield
setup()
cleanup()

C. @pytest.fixture
def resource():
setup()
cleanup()
yield

D. @pytest.fixture
def resource():
cleanup()
yield
setup()

Solution

1. Step 1: Recall context manager fixture syntax

   In pytest, the code before yield runs as setup, and the code after yield runs as cleanup.

2. Step 2: Check each option

   @pytest.fixture def resource(): setup() yield cleanup() correctly places setup() before yield and cleanup() after. Others have wrong order.

3. Final Answer:

   @pytest.fixture def resource(): setup() yield cleanup() -> Option A

4. Quick Check:

   Setup before yield, cleanup after yield [OK]

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

Common Mistakes:

• Placing cleanup before yield
• Calling setup after yield
• Putting yield at the end after cleanup

3. Given this fixture and test, what will be printed when running pytest?

@pytest.fixture
def file_resource():
    print('Setup file')
    yield
    print('Cleanup file')

def test_example(file_resource):
    print('Running test')

medium

A. Running test\nSetup file\nCleanup file

B. Cleanup file\nSetup file\nRunning test

C. Setup file\nCleanup file\nRunning test

D. Setup file\nRunning test\nCleanup file

Solution

1. Step 1: Understand fixture execution order

   Before the test runs, the fixture prints 'Setup file'. Then the test prints 'Running test'. After the test finishes, the fixture prints 'Cleanup file'.

2. Step 2: Match output sequence

   The output order is: 'Setup file', 'Running test', 'Cleanup file'.

3. Final Answer:

   Setup file\nRunning test\nCleanup file -> Option D

4. Quick Check:

   Setup -> Test -> Cleanup order [OK]

Hint: Fixture setup prints before test, cleanup prints after [OK]

Common Mistakes:

• Assuming cleanup runs before test
• Thinking test runs before setup
• Mixing order of prints

4. What is wrong with this context manager fixture?

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

medium

A. Nothing is wrong; it is correct

B. The fixture should not yield a value

C. The cleanup code after yield will never run

D. The connection should be closed before yield

Solution

1. Step 1: Analyze fixture structure

   The fixture creates a connection, yields it for the test, then closes it after the test finishes.

2. Step 2: Confirm cleanup runs after yield

   Code after yield runs as cleanup, so conn.close() will run properly after the test.

3. Final Answer:

   Nothing is wrong; it is correct -> Option A

4. Quick Check:

   Yield passes resource, cleanup runs after yield [OK]

Hint: Cleanup code after yield always runs after test [OK]

Common Mistakes:

• Thinking cleanup code never runs
• Closing connection before yield
• Not yielding the resource

5. You want to write a context manager fixture that creates a temporary file, yields its path, and deletes the file after the test. Which code correctly implements this?

hard

A. @pytest.fixture
def temp_file():
path = '/tmp/testfile.txt'
os.remove(path)
yield path

B. @pytest.fixture
def temp_file():
path = '/tmp/testfile.txt'
yield path
open(path, 'w').close()
os.remove(path)

C. @pytest.fixture
def temp_file():
path = '/tmp/testfile.txt'
open(path, 'w').close()
yield path
os.remove(path)

D. @pytest.fixture
def temp_file():
path = '/tmp/testfile.txt'
os.remove(path)
yield
open(path, 'w').close()

Solution

1. Step 1: Setup temporary file before yield

   The file must be created before yielding its path so the test can use it.

2. Step 2: Cleanup file after yield

   After the test, the file should be deleted to clean up resources.

3. Final Answer:

   @pytest.fixture def temp_file(): path = '/tmp/testfile.txt' open(path, 'w').close() yield path os.remove(path) -> Option C

4. Quick Check:

   Create file before yield, delete after yield [OK]

Hint: Create resource before yield, clean up after yield [OK]

Common Mistakes:

• Deleting file before test runs
• Creating file after yield
• Not yielding the file path