Autouse fixtures in PyTest - Build an Automation Script

Verify autouse fixture runs automatically before each test

Preconditions (2)

Step 1: Create a fixture with autouse=True that prints 'Setup running' before each test

Step 2: Write two test functions that each assert True is True

Step 3: Run the tests using pytest

Step 4: Observe the output to confirm the fixture runs before each test automatically

✅ Expected Result: The fixture's print statement 'Setup running' appears before each test output without explicitly calling the fixture

Automation Requirements - pytest

Assertions Needed:

Verify both tests pass

Verify the fixture runs automatically before each test (can be confirmed by capturing output)

Best Practices:

Use autouse=True in fixture decorator

Use capsys fixture to capture printed output for assertion

Keep fixtures simple and reusable

Automated Solution

PyTest

import pytest

@pytest.fixture(autouse=True)
def setup_fixture():
    print('Setup running')


def test_one():
    assert True


def test_two():
    assert True


def test_autouse_runs(capsys):
    # Run test_one and capture output
    test_one()
    captured = capsys.readouterr()
    assert 'Setup running' in captured.out

    # Run test_two and capture output
    test_two()
    captured = capsys.readouterr()
    assert 'Setup running' in captured.out

This code defines a fixture setup_fixture with autouse=True. This means pytest runs it automatically before each test without needing to mention it.

The fixture prints 'Setup running' before each test.

Two simple tests test_one and test_two just assert True.

The test_autouse_runs function uses pytest's capsys to capture printed output when calling the tests manually. It asserts that 'Setup running' appears in the output, confirming the fixture ran automatically.

This approach shows how autouse fixtures work and how to verify their execution.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not setting autouse=True in the fixture decorator', 'why_bad': "The fixture will not run automatically before tests, so the setup code won't execute unless explicitly used.", 'correct_approach': 'Always add autouse=True in @pytest.fixture decorator to make the fixture run automatically.'}

{'mistake': 'Trying to assert fixture output without capturing it', 'why_bad': "Print statements won't be captured by default, so assertions on output will fail.", 'correct_approach': "Use pytest's capsys fixture to capture printed output for assertions."}

{'mistake': 'Calling test functions directly without pytest runner', 'why_bad': "Calling test functions directly bypasses pytest's fixture management and hooks.", 'correct_approach': 'Use pytest runner or parametrize tests properly; for demonstration, use capsys carefully.'}

Bonus Challenge

Now add a data-driven test that uses the autouse fixture and runs with three different input values

Show Hint

Practice

1. What is the main purpose of an autouse fixture in pytest?

easy

A. To run the fixture automatically for all tests without explicitly adding it as a parameter

B. To skip the fixture during test execution

C. To run the fixture only when explicitly requested in the test

D. To disable all fixtures in the test file

Solution

1. Step 1: Understand what autouse means in pytest

   An autouse fixture runs automatically for every test in its scope without needing to be listed as a parameter.

2. Step 2: Compare options with this behavior

   Only To run the fixture automatically for all tests without explicitly adding it as a parameter describes this automatic running behavior correctly.

3. Final Answer:

   To run the fixture automatically for all tests without explicitly adding it as a parameter -> Option A

4. Quick Check:

   Autouse = automatic run without listing [OK]

Hint: Autouse means automatic use without listing in test [OK]

Common Mistakes:

• Thinking autouse disables the fixture
• Believing autouse requires explicit test parameters
• Confusing autouse with skipping tests

2. Which of the following is the correct way to declare an autouse fixture in pytest?

easy

A. @pytest.fixture(auto=True)
def setup():
pass

B. @pytest.fixture(autouse=True)
def setup():
pass

C. @pytest.autouse()
def setup():
pass

D. @pytest.usefixture(autouse=True)
def setup():
pass

Solution

1. Step 1: Recall correct syntax for autouse fixture

   The correct decorator is @pytest.fixture with the argument autouse=True.

2. Step 2: Check each option's syntax

   Only @pytest.fixture(autouse=True) def setup(): pass uses @pytest.fixture(autouse=True) correctly. Others use invalid decorators or wrong argument names.

3. Final Answer:

   @pytest.fixture(autouse=True) def setup(): pass -> Option B

4. Quick Check:

   Use @pytest.fixture(autouse=True) for autouse [OK]

Hint: Remember: autouse is a parameter in @pytest.fixture [OK]

Common Mistakes:

• Using @pytest.autouse decorator which does not exist
• Writing autouse as auto=True
• Using @pytest.usefixture instead of @pytest.fixture

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

import pytest

@pytest.fixture(autouse=True)
def setup():
    print('Setup runs')


def test_one():
    print('Test one running')


def test_two():
    print('Test two running')

medium

A. Test one running\nTest two running

B. Setup runs\nSetup runs\nTest one running\nTest two running

C. Setup runs\nTest one running\nSetup runs\nTest two running

D. Setup runs\nTest one running\nTest two running

Solution

1. Step 1: Understand autouse fixture behavior

   The autouse fixture runs automatically before each test function in the module.

2. Step 2: Trace the print statements during test runs

   For test_one: 'Setup runs' then 'Test one running'. For test_two: 'Setup runs' then 'Test two running'.

3. Final Answer:

   Setup runs\nTest one running\nSetup runs\nTest two running -> Option C

4. Quick Check:

   Autouse runs before each test = output B [OK]

Hint: Autouse fixture runs before every test automatically [OK]

Common Mistakes:

• Assuming fixture runs only once
• Ignoring print inside fixture
• Thinking tests run without setup prints

4. What is wrong with the following autouse fixture code?

import pytest

@pytest.fixture(autouse=True)
def setup():
    print('Setup')

@pytest.fixture
def test_data():
    return 42


def test_example(test_data):
    assert test_data == 42

medium

A. There is no error; the code works correctly

B. The test_data fixture cannot be used with autouse fixtures

C. The autouse fixture setup() does not yield or return, so cleanup is impossible

D. The autouse fixture setup() must accept a parameter

Solution

1. Step 1: Review fixture definitions and usage

   setup() is an autouse fixture that runs automatically and prints 'Setup'. test_data() is a normal fixture returning 42.

2. Step 2: Check if any syntax or usage errors exist

   Both fixtures are valid. Autouse fixtures do not need parameters or yield unless cleanup is needed. test_example uses test_data correctly.

3. Final Answer:

   There is no error; the code works correctly -> Option A

4. Quick Check:

   Autouse fixture without yield is valid [OK]

Hint: Autouse fixtures can be simple setup without yield [OK]

Common Mistakes:

• Expecting autouse fixtures must yield for cleanup
• Thinking autouse conflicts with other fixtures
• Assuming autouse fixtures need parameters

5. You want an autouse fixture to run once per test class, not before every test method. Which scope value should you use with @pytest.fixture(autouse=True)?

hard

A. "session"

B. "module"

C. "function"

D. "class"

Solution

1. Step 1: Understand pytest fixture scopes

   Scope "function" runs before each test function, "class" runs once per test class, "module" once per module, "session" once per test session.

2. Step 2: Match desired behavior to scope

   To run once per test class, use scope="class" with autouse=True.

3. Final Answer:

   "class" -> Option D

4. Quick Check:

   Scope "class" runs once per test class [OK]

Hint: Use scope='class' for autouse fixture once per test class [OK]

Common Mistakes:

• Using default scope 'function' which runs before every test
• Confusing 'module' with 'class' scope
• Using 'session' which runs too broadly