Test fixtures with pytest in Flask - Mini Project: Build & Apply

Test fixtures with pytest in Flask

📖 Scenario: You are building a small Flask web app that has a single route returning a greeting message. You want to write tests for this app using pytest. To make your tests clean and reusable, you will use pytest fixtures to set up the Flask test client.

🎯 Goal: Create a Flask app and write a pytest fixture that provides a test client. Then write a test function that uses this fixture to check the greeting route returns the expected message.

📋 What You'll Learn

Create a Flask app with a route /hello that returns 'Hello, Flask!'

Write a pytest fixture named client that sets up the Flask test client

Write a test function named test_hello that uses the client fixture

In the test function, send a GET request to /hello and assert the response data is 'Hello, Flask!'

💡 Why This Matters

🌍 Real World

Using pytest fixtures to set up test clients is common in web development to write clean, reusable tests for Flask apps.

💼 Career

Understanding how to write tests with fixtures is important for backend developers to ensure code quality and maintainability.

1

Create the Flask app with a /hello route

Create a Flask app named app and add a route /hello that returns the string 'Hello, Flask!'.

Flask

# Your code here

Hint

Use Flask(__name__) to create the app. Use @app.route('/hello') to define the route.

2

Add a pytest fixture named client for the test client

Import pytest and create a fixture named client that returns app.test_client(). Use the @pytest.fixture decorator.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

# Your code here

Hint

Use @pytest.fixture above the client function. Return app.test_client() inside it.

3

Write a test function using the client fixture

Write a test function named test_hello that takes client as a parameter. Inside, send a GET request to /hello using client.get and store the response in response.

Flask

from flask import Flask
import pytest

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

@pytest.fixture
def client():
    return app.test_client()

# Your code here

Hint

Define test_hello with client as argument. Use client.get('/hello') to get the response.

4

Assert the response data is 'Hello, Flask!'

In the test_hello function, add an assertion that response.data equals b'Hello, Flask!' (bytes literal).

Flask

from flask import Flask
import pytest

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

@pytest.fixture
def client():
    return app.test_client()

def test_hello(client):
    response = client.get('/hello')
    # Your code here

Hint

Use assert response.data == b'Hello, Flask!' to check the response content.

Practice

1. What is the main purpose of a fixture in pytest when testing a Flask app?

easy

A. To write the main application logic

B. To handle user input in the Flask app

C. To set up and tear down resources needed for tests automatically

D. To deploy the Flask app to a server

Solution

1. Step 1: Understand what fixtures do in pytest

   Fixtures prepare the environment for tests by setting up resources before tests run and cleaning them after.

2. Step 2: Identify the role of fixtures in Flask testing

   Fixtures help create test clients, databases, or other resources needed for Flask tests automatically.

3. Final Answer:

   To set up and tear down resources needed for tests automatically -> Option C

4. Quick Check:

   Fixtures = setup and cleanup [OK]

Hint: Fixtures prepare test resources automatically [OK]

Common Mistakes:

• Confusing fixtures with application code
• Thinking fixtures handle user input
• Assuming fixtures deploy the app

2. Which of the following is the correct way to define a pytest fixture for a Flask test client?

easy

A. @pytest.fixture
def client():
app = Flask(__name__)
yield app.test_client()

B. @pytest.fixture
def client():
app = Flask(__name__)
app.test_client()

C. def client():
app = Flask(__name__)
yield app.test_client()

D. @pytest.fixture
def client():
app = Flask(__name__)
return app

Solution

1. Step 1: Check the use of @pytest.fixture decorator

   The @pytest.fixture decorator is required to mark a fixture. One option lacks it.

2. Step 2: Identify correct use of yield for setup and teardown

   @pytest.fixture def client(): app = Flask(__name__) yield app.test_client() uses yield to provide the test client and allows cleanup after tests, which is best practice.

3. Final Answer:

   @pytest.fixture\ndef client():\n app = Flask(__name__)\n yield app.test_client() -> Option A

4. Quick Check:

   Use @pytest.fixture and yield for fixtures [OK]

Hint: Use @pytest.fixture and yield to define fixtures [OK]

Common Mistakes:

• Omitting @pytest.fixture decorator
• Returning instead of yielding
• Not yielding or returning the test client

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

@pytest.fixture
def sample():
    print('Setup')
    yield 'data'
    print('Teardown')

def test_example(sample):
    print(f'Test received: {sample}')

medium

A. Setup\nTest received: data\nTeardown

B. Test received: data\nSetup\nTeardown

C. Setup\nTeardown\nTest received: data

D. Test received: data

Solution

1. Step 1: Understand fixture execution order

   Before the test runs, the fixture prints 'Setup', then yields 'data' to the test.

2. Step 2: Analyze test function output and fixture teardown

   The test prints 'Test received: data'. After test finishes, fixture resumes and prints 'Teardown'.

3. Final Answer:

   Setup\nTest received: data\nTeardown -> Option A

4. Quick Check:

   Fixture setup -> test -> fixture teardown [OK]

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

Common Mistakes:

• Assuming teardown runs before test
• Ignoring yield pauses fixture
• Thinking test runs before setup

4. Identify the error in this pytest fixture code for a Flask app:

@pytest.fixture
def client():
    app = Flask(__name__)
    client = app.test_client()
    return client
    print('Cleanup done')

medium

A. Fixture must use 'yield' instead of 'return' always

B. Missing '@pytest.fixture' decorator

C. 'app.test_client()' is not a valid method

D. The 'print' statement after 'return' will never execute

Solution

1. Step 1: Check code after return statement

   Code after 'return' is unreachable, so 'print' will never run.

2. Step 2: Confirm other parts are correct

   The decorator is present, 'app.test_client()' is valid, and 'return' is allowed but limits cleanup.

3. Final Answer:

   The 'print' statement after 'return' will never execute -> Option D

4. Quick Check:

   Code after return is unreachable [OK]

Hint: Code after return is ignored; use yield for cleanup [OK]

Common Mistakes:

• Thinking print runs after return
• Assuming return disallows fixture
• Confusing method names

5. You want to create a fixture that sets up a temporary database for Flask tests and ensures it is cleaned up after all tests in the module run. Which fixture scope and structure is best?

hard

A. @pytest.fixture(scope='function')
def temp_db():
db = setup_temp_db()
yield db
teardown_temp_db(db)

B. @pytest.fixture(scope='module')
def temp_db():
db = setup_temp_db()
yield db
teardown_temp_db(db)

C. @pytest.fixture(scope='session')
def temp_db():
db = setup_temp_db()
return db

D. @pytest.fixture(scope='module')
def temp_db():
db = setup_temp_db()
return db
teardown_temp_db(db)

Solution

1. Step 1: Choose fixture scope for module-wide setup

   Scope 'module' runs once per module, ideal for shared DB setup across tests.

2. Step 2: Use yield to allow teardown after all tests

   Yield pauses fixture to run tests, then runs teardown after all tests complete.

3. Final Answer:

   @pytest.fixture(scope='module')\ndef temp_db():\n db = setup_temp_db()\n yield db\n teardown_temp_db(db) -> Option B

4. Quick Check:

   Module scope + yield for setup and cleanup [OK]

Hint: Use scope='module' and yield for setup/cleanup [OK]

Common Mistakes:

• Using function scope causes repeated setup
• Returning without yield skips cleanup
• Placing cleanup code after return