Flask-Tests

Testen ist die Grundlage für die Sicherung der Codequalität.

Flask bietet einen integrierten Test-Client, der in Kombination mit pytest ein effizientes Schreiben und Ausführen von Tests ermöglicht.


Test-Client——test_client

Dietest_client()-Methode von Flask erstellt einen simulierten HTTP-Client, der Anfragen senden kann, ohne einen Server zu starten:

Beispiel

# Dateipfad: test_demo.py (Test in der interaktiven Python-Umgebung)
from app import create_app

# Test-App-Instanz erstellen
app = create_app()

# Testclient erstellen
with app.test_client() as client:
    # GET-Anfrage senden
    response = client.get("/")
    print(response.status_code)   # 200
    print(response.data[:100])    # Die ersten 100 Bytes des Antwortkörpers

    # POST-Anfrage senden und Daten als JSON senden
    response = client.post("/api/posts",
                          json={"title": "BEISPIEL Tutorial", "body": "Inhalt", "author_id": 1})
    print(response.status_code)   # 201
    print(response.get_json())    # JSON-Antwort parsen

pytest-Integration

pytest ist das Standard-Testframework in der Python-Community und funktioniert sehr bequem mit Flask.

pytest installieren

(.venv) $ pip install pytest

Tests schreiben——conftest.py (Gemeinsame Fixtures)

Verwendungconftest.pyDie Datei erstellt wiederverwendbare Test-Fixtures:

Beispiel

# Dateipfad: tests/conftest.py
import os
import tempfile
import pytest
from app import create_app
from db import init_db, get_db

@pytest.fixture
def app():
    """Erstellt eine Test-App-Instanz mit einer temporären Datenbank"""
    # Erstelle eine temporäre Datei als Testdatenbank
    db_fd, db_path = tempfile.mkstemp()

    # App erstellen, Datenbankpfad auf temporäre Datei überschreiben
    app = create_app()
    app.config["DATABASE"] = db_path
    app.config["TESTING"] = True  # Testmodus aktivieren

    # Tabellenstrukturen der Testdatenbank initialisieren
    with app.app_context():
        init_db()

    yield app

    # Nach Tests aufräumen: temporäre Datenbankdatei schließen und löschen
    os.close(db_fd)
    os.unlink(db_path)

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

@pytest.fixture
def runner(app):
    """CLI-Testrunner erstellen"""
    return app.test_cli_runner()

Test-Routen

Beispiel

# Dateipfad: tests/test_app.py
def test_home_page(client):
    """Testet, ob die Startseite normal zurückgegeben wird"""
    response = client.get("/")
    assert response.status_code == 200
    # Prüfen, ob die Seite die erwarteten Schlüsselwörter enthält
    assert b"EXAMPLE" in response.data

def test_404_page(client):
    """Testet den Besuch einer nicht existierenden Seite"""
    response = client.get("/this-page-does-not-exist")
    assert response.status_code == 404

Tests ausführen:

(.venv) $ pytest tests/test_app.py -v
====================================
tests/test_app.py::test_home_page PASSED
tests/test_app.py::test_404_page PASSED
====================================

JSON-API-Test

Beispiel

# Dateipfad: tests/test_api.py
def test_create_post(client):
    """Teste die API zum Erstellen von Artikeln"""
    response = client.post("/api/posts", json={
        "title": "BEISPIEL Testartikel",
        "body": "Dies ist Testinhalt",
        "author_id": 1
    })
    # Erfolgreiche Erstellung sollte 201 zurückgeben
    assert response.status_code == 201
    data = response.get_json()
    assert data["title"] == "BEISPIEL Testartikel"
    assert "id" in data

def test_create_post_without_title(client):
    """Teste, dass ein leerer Titel einen 400-Fehler zurückgibt"""
    response = client.post("/api/posts", json={
        "title": "",
        "body": "Inhalt",
        "author_id": 1
    })
    assert response.status_code == 400
    assert b"error" in response.data

def test_get_posts(client):
    """Testet das Abrufen der Artikelliste"""
    # Zuerst einen Artikel erstellen
    client.post("/api/posts", json={
        "title": "Article A", "body": "Content A", "author_id": 1
    })

    # Liste abrufen
    response = client.get("/api/posts")
    assert response.status_code == 200
    data = response.get_json()
    assert len(data) >= 1

def test_delete_post(client):
    """Testet das Löschen eines Artikels"""
    # Zuerst erstellen
    rv = client.post("/api/posts", json={
        "title": "Zu löschen", "body": "content", "author_id": 1
    })
    post_id = rv.get_json()["id"]

    # Dann löschen
    rv = client.delete(f"/api/posts/{post_id}")
    assert rv.status_code == 200

    # Löschung bestätigen
    rv = client.get(f"/api/posts/{post_id}")
    assert rv.status_code == 404

Test-Session

Testen von Funktionen, die eine Session erfordern, wie z. B. Login:

Beispiel

# Dateipfad: tests/test_auth.py
def test_login(client):
    """Teste den Login-Ablauf"""
    # Sende Login-Anfrage
    response = client.post("/auth/login", data={
        "username": "testuser",
        "password": "testpass"
    }, follow_redirects=True)  # follow_redirects folgt automatisch Weiterleitungen

    assert response.status_code == 200

def test_session_transaction(client):
    """Sitzung zum Testen direkt manipulieren"""
    with client.session_transaction() as session:
        # Werte direkt in der Sitzung setzen, um den angemeldeten Zustand zu simulieren
        session["username"] = "example"

    # Nun die Startseite besuchen; sie sollte den angemeldeten Status anzeigen
    response = client.get("/")
    assert b"example" in response.data

client.session_transaction()Es ist ein sehr praktisches Testwerkzeug — es ermöglicht Ihnen, den Inhalt der Session direkt zu ändern, ohne den vollständigen Anmeldeprozess durchlaufen zu müssen.


Testen von CLI-Befehlen

Beispiel

# Dateipfad: tests/test_cli.py
def test_init_db(runner):
    """Testet den Befehl zur Datenbankinitialisierung"""
    result = runner.invoke(args=["init-db"])
    # Befehl erfolgreich ausgeführt; exit_code sollte 0 sein
    assert result.exit_code == 0

def test_flask_routes(runner):
    """Testet den Befehl flask routes"""
    result = runner.invoke(args=["routes"])
    assert result.exit_code == 0
    # Prüfen, ob die Ausgabe registrierte Routen enthält
    assert "/api/posts" in result.output

Best Practices für das Testen

Übung Beschreibung
Verwenden einer temporären Datenbank Jeder Test verwendet eine unabhängige Datenbank, sodass sie sich nicht gegenseitig beeinflussen (z. B. tempfile in conftest.py)
TESTING-Modus aktivieren app.config["TESTING"] = TrueAusnahmen normal propagieren lassen, anstatt von der Fehlerbehandlung verschluckt zu werden
Ein Test sollte nur eine Sache testen. Jede Testfunktion prüft nur ein Verhalten, was das Auffinden von Problemen erleichtert
Klare Benennung Funktionsnamen sehen aus wietest_<scenario>_<expected_result>
Nutze follow_redirects sinnvoll Nützlich beim Testen des Redirect-Ablaufs nach einem POST

Alle Tests ausführen

(.venv) $ pytest tests/ -v

tests/test_app.py::test_home_page PASSED
tests/test_app.py::test_404_page PASSED
tests/test_api.py::test_create_post PASSED
tests/test_api.py::test_create_post_without_title PASSED
tests/test_api.py::test_get_posts PASSED
tests/test_api.py::test_delete_post PASSED
tests/test_auth.py::test_login PASSED
tests/test_auth.py::test_session_transaction PASSED
tests/test_cli.py::test_init_db PASSED
tests/test_cli.py::test_flask_routes PASSED

==================== 10 passed in 0.45s ====================
Weitere Erweiterungen