Async fixtures (pytest-asyncio) - Framework Patterns

Framework Mode - Async fixtures (pytest-asyncio)

Folder Structure

tests/
├── __init__.py
├── test_async_feature.py
├── conftest.py  # async fixtures here
utilities/
├── async_helpers.py
pytest.ini  # pytest config
requirements.txt

Test Framework Layers

• Test Layer: Async test functions using async def with pytest.mark.asyncio or pytest-asyncio plugin.
• Fixture Layer: Async fixtures defined with async def in conftest.py to setup async resources (e.g., database connections, web servers).
• Utility Layer: Async helper functions or classes to support tests, e.g., async HTTP clients.
• Configuration Layer: pytest.ini or pyproject.toml to enable pytest-asyncio plugin and set options.

Configuration Patterns

• Enable pytest-asyncio plugin in pytest.ini:

  [pytest]
  addopts = -p pytest_asyncio
  

• Use environment variables or pytest command line options to select async backend or environment.
• Store async resource credentials securely and inject via fixtures.
• Use conftest.py for shared async fixtures to avoid duplication.

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --tb=short for concise tracebacks.
• Integrate with CI tools (GitHub Actions, GitLab CI) to run async tests automatically.
• Generate JUnit XML reports with --junitxml=report.xml for CI dashboards.
• Use coverage tools compatible with async code (e.g., pytest-cov) to measure test coverage.

Best Practices

• Always declare async fixtures with async def and use await inside them.
• Use pytest-asyncio plugin to enable async test support seamlessly.
• Keep async fixtures scoped appropriately (function, module) to optimize resource usage.
• Isolate async resources per test to avoid side effects and flaky tests.
• Use explicit await in tests and fixtures to ensure proper async execution.

Self Check

Where would you add a new async fixture that provides a mock async database connection for multiple tests?

Key Result

Organize async tests and fixtures in tests/ and conftest.py using pytest-asyncio for clean async test automation.

Practice

1. What is the main purpose of using async def in pytest fixtures with pytest-asyncio?

easy

A. To allow the fixture to perform asynchronous setup and cleanup operations

B. To make the fixture run faster by using multiple threads

C. To automatically retry the fixture if it fails

D. To convert the fixture into a synchronous function

Solution

1. Step 1: Understand async def in pytest fixtures

   Using async def allows the fixture to run asynchronous code, which is necessary for async setup or cleanup tasks.

2. Step 2: Compare with other options

   Options A, B, and C describe unrelated behaviors: synchronous conversion, threading, retries, which are not the purpose of async def in fixtures.

3. Final Answer:

   To allow the fixture to perform asynchronous setup and cleanup operations -> Option A

4. Quick Check:

   async def in fixtures = async setup/cleanup [OK]

Hint: Async fixtures enable async setup and cleanup [OK]

Common Mistakes:

• Thinking async def makes tests run in parallel
• Confusing async with threading
• Assuming async def retries tests automatically

2. Which of the following is the correct way to define an async fixture using pytest-asyncio?

easy

A. async def my_fixture(): yield 'data'

B. def my_fixture(): yield 'data'

C. async def my_fixture(): return 'data'

D. def my_fixture(): return 'data'

Solution

1. Step 1: Identify async fixture syntax

   Async fixtures must be defined with async def and use yield to allow setup and cleanup.

2. Step 2: Evaluate options

   async def my_fixture(): yield 'data' correctly uses async def and yield. def my_fixture(): yield 'data' is synchronous. async def my_fixture(): return 'data' uses return which does not support cleanup. def my_fixture(): return 'data' is synchronous and uses return.

3. Final Answer:

   async def my_fixture(): yield 'data' -> Option A

4. Quick Check:

   Async fixture = async def + yield [OK]

Hint: Async fixtures use async def and yield, not return [OK]

Common Mistakes:

• Using return instead of yield in async fixtures
• Defining fixture without async def
• Mixing synchronous and asynchronous syntax

3. Given the following code, what will be printed when running the test?

import pytest
import asyncio

@pytest.fixture
async def async_resource():
    print('Setup')
    yield 'resource'
    print('Cleanup')

@pytest.mark.asyncio
def test_example(async_resource):
    print(f'Test using {async_resource}')

medium

A. Test using resource\nSetup\nCleanup

B. Setup\nTest using resource\nCleanup

C. Setup\nCleanup\nTest using resource

D. Test using resource only

Solution

1. Step 1: Understand async fixture execution order

   The fixture prints 'Setup' before yielding the resource, then the test runs, printing 'Test using resource', and finally the fixture prints 'Cleanup' after the test finishes.

2. Step 2: Match output sequence

   The output order is 'Setup', then 'Test using resource', then 'Cleanup', matching Setup\nTest using resource\nCleanup.

3. Final Answer:

   Setup\nTest using resource\nCleanup -> Option B

4. Quick Check:

   Fixture setup -> test -> fixture cleanup = Setup, Test, Cleanup [OK]

Hint: Fixture prints before yield, cleanup prints after yield [OK]

Common Mistakes:

• Assuming cleanup runs before test
• Confusing yield with return
• Ignoring async execution order

4. What is wrong with this async fixture code?

import pytest

@pytest.fixture
async def resource():
    data = await get_data()
    return data

Assuming get_data() is an async function.

medium

A. Fixture should not call async functions

B. Fixture must not be async if it uses await

C. Fixture must be decorated with @pytest.mark.asyncio

D. Async fixtures must use yield, not return, to allow cleanup

Solution

1. Step 1: Check async fixture structure

   Async fixtures that need cleanup must use yield to separate setup and teardown phases.

2. Step 2: Analyze the code

   This fixture uses return, so it cannot perform cleanup after the test. Using yield is required for cleanup.

3. Final Answer:

   Async fixtures must use yield, not return, to allow cleanup -> Option D

4. Quick Check:

   Async fixture cleanup requires yield, not return [OK]

Hint: Use yield in async fixtures for cleanup, not return [OK]

Common Mistakes:

• Using return instead of yield in async fixtures
• Thinking async fixtures can't await
• Adding @pytest.mark.asyncio to fixtures instead of tests

5. You want to write an async fixture that opens a database connection before tests and closes it after. Which code snippet correctly implements this using pytest-asyncio?

hard

A. @pytest.fixture
async def db_conn():
conn = open_db()
yield conn
conn.close()

B. async def db_conn():
conn = await open_db()
yield conn
await conn.close()

C. @pytest.fixture
async def db_conn():
conn = await open_db()
yield conn
await conn.close()

D. @pytest.fixture
async def db_conn():
conn = await open_db()
return conn

Solution

1. Step 1: Identify correct fixture decorator and async syntax

   The fixture must be decorated with @pytest.fixture and defined as async def to support async setup and cleanup.

2. Step 2: Check for proper use of yield and await

   @pytest.fixture async def db_conn(): conn = await open_db() yield conn await conn.close() correctly awaits open_db(), yields the connection, and awaits conn.close() after the test. async def db_conn(): conn = await open_db() yield conn await conn.close() misses the decorator. @pytest.fixture async def db_conn(): conn = open_db() yield conn conn.close() misses awaits. @pytest.fixture async def db_conn(): conn = await open_db() return conn uses return, so no cleanup.

3. Final Answer:

   @pytest.fixture async def db_conn(): conn = await open_db() yield conn await conn.close() -> Option C

4. Quick Check:

   Async fixture with @pytest.fixture + async def + yield + await cleanup [OK]

Hint: Always decorate async fixtures with @pytest.fixture and use yield [OK]

Common Mistakes:

• Forgetting @pytest.fixture decorator
• Using return instead of yield for cleanup
• Not awaiting async calls in fixture