Tests Flask

Les tests sont le fondement pour garantir la qualité du code.

Flask fournit un client de test intégré, qui, combiné à pytest, permet d'écrire et d'exécuter efficacement des tests.


Client de test——test_client

Letest_client() de FlaskLa méthode crée un client HTTP simulé qui peut envoyer des requêtes sans démarrer un serveur :

Exemple

# Chemin du fichier : test_demo.py (test dans l'environnement interactif Python)
from app import create_app

# Créer une instance d'application de test
app = create_app()

# Créer un client de test
with app.test_client() as client:
    # Envoyer une requête GET
    response = client.get("/")
    print(response.status_code)   # 200
    print(response.data[:100])    # Les 100 premiers octets du corps de la réponse

    # Envoyer une requête POST et envoyer les données au format JSON
    response = client.post("/api/posts",
                          json={"title": "Tutoriel d'exemple", "body": "contenu", "author_id": 1})
    print(response.status_code)   # 201
    print(response.get_json())    # Analyser la réponse JSON

Intégration de pytest

pytest est le framework de test standard dans la communauté Python et fonctionne très facilement avec Flask.

Installer pytest

(.venv) $ pip install pytest

Écriture de tests——conftest.py (Fixtures partagées)

Utilisationconftest.pyLe fichier crée des fixtures de test réutilisables :

Exemple

# Chemin du fichier : 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():
    """Créer une instance d'application de test en utilisant une base de données temporaire"""
    # Créer un fichier temporaire comme base de données de test
    db_fd, db_path = tempfile.mkstemp()

    # Créer l'application, remplacer le chemin de la base de données par le fichier temporaire
    app = create_app()
    app.config["DATABASE"] = db_path
    app.config["TESTING"] = True  # Activer le mode test

    # Initialiser les structures des tables de la base de données de test
    with app.app_context():
        init_db()

    yield app

    # Nettoyer après les tests : fermer et supprimer le fichier de base de données temporaire
    os.close(db_fd)
    os.unlink(db_path)

@pytest.fixture
def client(app):
    """Créer un client de test"""
    return app.test_client()

@pytest.fixture
def runner(app):
    """Créer un exécuteur de tests CLI"""
    return app.test_cli_runner()

Tester les routes

Exemple

# Chemin du fichier : tests/test_app.py
def test_home_page(client):
    """Tester si la page d'accueil répond normalement"""
    response = client.get("/")
    assert response.status_code == 200
    # Vérifier si la page contient les mots-clés attendus
    assert b"EXAMPLE" in response.data

def test_404_page(client):
    """Tester la visite d'une page inexistante"""
    response = client.get("/this-page-does-not-exist")
    assert response.status_code == 404

Exécuter les tests :

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

Tester l'API JSON

Exemple

# Chemin du fichier : tests/test_api.py
def test_create_post(client):
    """Test de l'API de création d'article"""
    response = client.post("/api/posts", json={
        "title": "article de test EXEMPLE",
        "body": "Ceci est le contenu de test",
        "author_id": 1
    })
    # Une création réussie doit renvoyer 201
    assert response.status_code == 201
    data = response.get_json()
    assert data["title"] == "article de test EXEMPLE"
    assert "id" in data

def test_create_post_without_title(client):
    """Teste qu'un titre vide renvoie une erreur 400"""
    response = client.post("/api/posts", json={
        "title": "",
        "body": "contenu",
        "author_id": 1
    })
    assert response.status_code == 400
    assert b"error" in response.data

def test_get_posts(client):
    """Test de récupération de la liste des articles"""
    # D'abord créer un article
    client.post("/api/posts", json={
        "title": "Article A", "body": "Contenu A", "author_id": 1
    })

    # Récupérer la liste
    response = client.get("/api/posts")
    assert response.status_code == 200
    data = response.get_json()
    assert len(data) >= 1

def test_delete_post(client):
    """Test de suppression d'article"""
    # D'abord créer
    rv = client.post("/api/posts", json={
        "title": "À supprimer", "body": "contenu", "author_id": 1
    })
    post_id = rv.get_json()["id"]

    # Puis supprimer
    rv = client.delete(f"/api/posts/{post_id}")
    assert rv.status_code == 200

    # Confirmer la suppression
    rv = client.get(f"/api/posts/{post_id}")
    assert rv.status_code == 404

Test de session

Test des fonctionnalités qui nécessitent une session, comme la connexion :

Exemple

# Chemin du fichier : tests/test_auth.py
def test_login(client):
    """Test du flux de connexion"""
    # Envoyer la requête de connexion
    response = client.post("/auth/login", data={
        "username": "testuser",
        "password": "testpass"
    }, follow_redirects=True)  # follow_redirects suit automatiquement les redirections

    assert response.status_code == 200

def test_session_transaction(client):
    """Manipuler directement la session pour les tests"""
    with client.session_transaction() as session:
        # Définir directement des valeurs dans la session pour simuler un état connecté
        session["username"] = "example"

    # Visitez maintenant la page d'accueil ; elle devrait afficher l'état connecté
    response = client.get("/")
    assert b"example" in response.data

client.session_transaction()C'est un outil de test très pratique — il vous permet de modifier directement le contenu de Session sans passer par le processus de connexion complet.


Test des commandes CLI

Exemple

# Chemin du fichier : tests/test_cli.py
def test_init_db(runner):
    """Teste la commande d'initialisation de la base de données"""
    result = runner.invoke(args=["init-db"])
    # Commande exécutée avec succès ; exit_code doit être 0
    assert result.exit_code == 0

def test_flask_routes(runner):
    """Teste la commande flask routes"""
    result = runner.invoke(args=["routes"])
    assert result.exit_code == 0
    # Vérifie si la sortie contient des routes enregistrées
    assert "/api/posts" in result.output

Bonnes pratiques de test

Pratique Description
Utilisation d'une base de données temporaire Chaque test utilise une base de données indépendante afin qu'ils n'interfèrent pas les uns avec les autres (par exemple, tempfile dans conftest.py)
Activation du mode TESTING app.config["TESTING"] = TrueLaisser les exceptions se propager normalement plutôt que d'être avalées par la gestion des erreurs
Un test ne doit tester qu'une seule chose. Chaque fonction de test ne vérifie qu'un seul comportement, ce qui facilite l'identification des problèmes
Nommage clair Les noms de fonctions sont de la formetest_<scenario>_<expected_result>
Utilisez judicieusement follow_redirects Utile lors du test du flux de redirection après un POST

Exécuter tous les tests

(.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 ====================
autres extensions