Fixtures

The scaffolded conftest.py gives you two test clients. Which one you reach for depends on whether the request needs a CSRF token.

Fixture	Use for	CSRF handling
`client`	GET requests, public endpoints	Not needed
`csrf_client`	POST, PUT, DELETE requests	Automatic

def test_public_page(client):
    """GET requests use the basic client."""
    response = client.get('/health')
    assert response.status_code == 200

def test_create_item(csrf_client):
    """POST, PUT and DELETE use csrf_client. The token is handled for you."""
    response = csrf_client.post('/api/items', json={'name': 'Test'})
    assert response.status_code == 201

Feather enables CSRF protection by default, which is why there are two clients. The csrf_client fixture fetches and includes the token so your tests don’t have to.

Adding your own

Extend conftest.py for data that several tests need.

tests/conftest.py

import pytest
from models import User, Item

from feather.testing import login_as

@pytest.fixture
def authenticated_user(app):
    """Create a test user and a client signed in as them."""
    with app.app_context():
        user = User(email='test@example.com', username='test', active=True)
        db.session.add(user)
        db.session.commit()

        client = app.test_client()
        login_as(client, user)  # never set session keys by hand: see below
        yield client

@pytest.fixture
def sample_items(app):
    """Create sample items for testing."""
    with app.app_context():
        items = [Item(name=f'Item {i}') for i in range(3)]
        db.session.add_all(items)
        db.session.commit()
        return items

A fixture holding one app.app_context() open across requests from several test clients resolves every request to the first user loaded. See Test database for why, and the shape that avoids it.

Signing a user in

login_as(client, user) from feather.testing signs a user in on a test client, and logout(client) signs them out. It works with the plain client and with csrf_client. Don’t set _user_id on the session yourself. With session protection on, Flask-Login signs out any session that lacks the request’s identifier, so a session set by hand looks signed in and is signed out on the next request. login_as sets the identifier too.

Get started

Tutorial: build a Kanban app

Building the UI

Backend

Features

Tooling

Testing

Deployment

Adding your own

Signing a user in

​Adding your own

​Signing a user in

Adding your own

Signing a user in