Fixture as function argument in PyTest

Introduction

Fixtures help prepare things your tests need. Passing them as function arguments makes tests simple and clean.

When you need to set up a database connection before running tests.

When you want to create a temporary file for testing and clean it up after.

When you want to share common test data across multiple test functions.

When you want to initialize a web browser session before testing a website.

Syntax

PyTest

def test_function(fixture_name):
    # use fixture_name inside the test
    assert something

Just add the fixture name as a parameter to your test function.

pytest will automatically run the fixture and pass its result to your test.

Examples

This test uses the sample_data fixture to get a list and checks its sum.

PyTest

import pytest

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

def test_sum(sample_data):
    assert sum(sample_data) == 6

The fixture number provides a value to the test function.

PyTest

import pytest

@pytest.fixture
def number():
    return 10

def test_double(number):
    assert number * 2 == 20

Sample Program

This test uses the greeting fixture to get a string and checks if the message is correct. It also prints the message.

PyTest

import pytest

@pytest.fixture
def greeting():
    return "Hello"

def test_greeting_message(greeting):
    message = f"{greeting}, world!"
    assert message == "Hello, world!"
    print(message)

Important Notes

Fixtures run before the test function automatically.

You can use multiple fixtures by adding more arguments to the test function.

If a fixture returns a value, you can use it directly inside your test.

Summary

Fixtures provide setup data or state for tests.

Pass fixtures as function arguments to use them in tests.

pytest handles running fixtures and passing their results automatically.

Practice

1. What is the main purpose of passing a fixture as a function argument in pytest?

easy

A. To manually call the fixture inside the test

B. To skip the test when the fixture is missing

C. To automatically receive setup data or state for the test

D. To define a new fixture inside the test function

Solution

1. Step 1: Understand pytest fixture usage

   Fixtures provide setup data or state that tests need to run properly.

2. Step 2: Recognize how pytest injects fixtures

   Passing a fixture as a function argument lets pytest automatically run the fixture and pass its result to the test.

3. Final Answer:

   To automatically receive setup data or state for the test -> Option C

4. Quick Check:

   Fixture argument = automatic setup [OK]

Hint: Fixtures as args give automatic setup data [OK]

Common Mistakes:

• Trying to call fixture functions manually inside tests
• Thinking fixtures must be called explicitly
• Confusing fixture definition with test function

2. Which of the following is the correct way to use a fixture named db_connection in a pytest test function?

easy

A. def test_example(db_connection()):

B. def test_example(): db_connection()

C. def test_example(): fixture(db_connection)

D. def test_example(db_connection):

Solution

1. Step 1: Recall pytest fixture syntax

   Fixtures are passed as plain function arguments without parentheses.

2. Step 2: Check each option's syntax

   def test_example(db_connection): correctly uses db_connection as a parameter. def test_example(): db_connection() tries to call it inside the test, which is incorrect. def test_example(): fixture(db_connection) uses a non-existent fixture() call. def test_example(db_connection()): uses parentheses in the parameter list, which is invalid syntax.

3. Final Answer:

   def test_example(db_connection): -> Option D

4. Quick Check:

   Fixture as parameter = no parentheses [OK]

Hint: Pass fixture name as parameter, no parentheses [OK]

Common Mistakes:

• Adding parentheses when passing fixture as argument
• Calling fixture inside test instead of passing as argument
• Using undefined functions like fixture()

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

import pytest

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

def test_sum(numbers):
    assert sum(numbers) == 6
    print("Sum is correct")

medium

A. Test passes and prints 'Sum is correct'

B. Test fails with AssertionError

C. SyntaxError due to fixture usage

D. Test is skipped because fixture is missing

Solution

1. Step 1: Understand fixture return value

   The fixture numbers returns the list [1, 2, 3].

2. Step 2: Analyze test function behavior

   The test receives the list as argument, sums it, and asserts the sum equals 6, which is true. Then it prints "Sum is correct".

3. Final Answer:

   Test passes and prints 'Sum is correct' -> Option A

4. Quick Check:

   Sum([1,2,3])=6, assertion passes [OK]

Hint: Fixture returns data, test uses it directly [OK]

Common Mistakes:

• Assuming fixture must be called inside test
• Expecting test failure without reason
• Confusing fixture with test function

4. Identify the error in the following pytest test code using a fixture:

import pytest

@pytest.fixture
def data():
    return 42

def test_data(data):
    result = data()
    assert result == 42

medium

A. Missing @pytest.mark.usefixtures decorator

B. Calling fixture as a function inside the test causes an error

C. Fixture name cannot be the same as test function argument

D. Fixture must return a string, not an integer

Solution

1. Step 1: Review fixture usage in test

   The fixture data is passed as an argument to the test function.

2. Step 2: Identify incorrect call

   Inside the test, data() is called as if it were a function, but pytest already passes the fixture's return value. Calling it again causes a TypeError.

3. Final Answer:

   Calling fixture as a function inside the test causes an error -> Option B

4. Quick Check:

   Fixture argument is value, not callable [OK]

Hint: Do not call fixture argument as function inside test [OK]

Common Mistakes:

• Calling fixture argument like a function
• Confusing fixture definition with usage
• Adding unnecessary decorators

5. You have two fixtures: db that returns a database connection string, and user that depends on db to create a user object. How should you write a test function that uses both fixtures correctly?

hard

A. def test_user(db, user): assert user.db == db

B. def test_user(): db = db(); user = user(); assert user.db == db

C. def test_user(user): db = db; assert user.db == db

D. def test_user(db): user = user(db); assert user.db == db

Solution

1. Step 1: Understand fixture dependencies

   Fixtures can depend on each other, and pytest injects them automatically when passed as arguments.

2. Step 2: Use fixtures as function arguments

   Passing both db and user as arguments lets pytest handle dependencies and provide correct values.

3. Step 3: Validate test logic

   The test asserts that the user fixture's db attribute matches the db fixture value, which is correct.

4. Final Answer:

   def test_user(db, user): assert user.db == db -> Option A

5. Quick Check:

   Pass all fixtures as args for dependency [OK]

Hint: List all needed fixtures as test parameters [OK]

Common Mistakes:

• Trying to call fixtures inside test manually
• Passing fixtures incorrectly or missing dependencies
• Confusing fixture names with function calls