Tests d'API simules

En entreprise, une API sans tests c'est du code jetable. A chaque modification, tu risques de casser quelque chose sans t'en rendre compte. Les tests d'API automatises te permettent de verifier en quelques secondes que tout fonctionne encore apres un changement.

Un bon test d'API verifie trois choses : le status code (200, 201, 404...), le contenu de la reponse, et les effets de bord (un POST a bien cree l'objet, un DELETE l'a bien supprime). On va construire un client de test qui simule des requetes HTTP.

Tu vas créer une classe APITestClient qui :

__init__(viewset) : prend un ViewSet (avec dispatch) et l'associe au client

get(path) : simule une requête GET. path est '/' pour la liste ou '/<id>/' pour un detail. Retourne le résultat de dispatch.

post(path, data) : simule une requête POST avec des données

put(path, data) : simule une requête PUT avec des données

delete(path) : simule une requête DELETE

Le client doit extraire le pk depuis le path quand il est present (ex: '/1/' -> pk=1).

Tu vas aussi écrire une fonction run_api_tests(client) qui exécute une série de tests et retourne un dictionnaire avec 'passed' (nombre de tests reussis) et 'failed' (nombre de tests echoues) et 'details' (liste des résultats). Les tests a exécuter :
1. GET sur liste vide retourne status 200 et data vide
2. POST crée un article et retourne status 201
3. GET sur la liste retourne 1 article
4. GET sur l'article crée retourne ses données
5. PUT modifie l'article
6. DELETE supprime l'article et retourne 204

Exemple :

vs = ArticleViewSet()
client = APITestClient(vs)
client.post('/', {'title': 'Hello'})
renvoie {'status': 201, 'data': {'id': 1, 'title': 'Hello'}}

Tests (4/5)

Client GET vide

vs = ArticleViewSet()
client = APITestClient(vs)
r = client.get('/')
assert r['status'] == 200 and r['data'] == []

Client POST

vs = ArticleViewSet()
client = APITestClient(vs)
r = client.post('/', {'title': 'Hello'})
assert r['status'] == 201 and r['data']['id'] == 1

Client GET detail

vs = ArticleViewSet()
client = APITestClient(vs)
client.post('/', {'title': 'Test'})
r = client.get('/1/')
assert r['status'] == 200 and r['data']['title'] == 'Test'

run_api_tests complet

vs = ArticleViewSet()
client = APITestClient(vs)
r = run_api_tests(client)
assert r['passed'] == 6 and r['failed'] == 0

+ 0 tests cachés

Indices (3 disponibles)

Solution officielle

class ArticleViewSet:
    def __init__(self):
        self.db = {}
        self.next_id = 1

    def list(self):
        return {'status': 200, 'data': list(self.db.values())}

    def create(self, data):
        article = dict(data)
        article['id'] = self.next_id
        self.db[self.next_id] = article
        self.next_id += 1
        return {'status': 201, 'data': article}

    def retrieve(self, pk):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        return {'status': 200, 'data': self.db[pk]}

    def update(self, pk, data):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        self.db[pk].update(data)
        self.db[pk]['id'] = pk
        return {'status': 200, 'data': self.db[pk]}

    def destroy(self, pk):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        del self.db[pk]
        return {'status': 204, 'data': None}

    def dispatch(self, method, data=None, pk=None):
        if method == 'GET' and pk is None:
            return self.list()
        elif method == 'POST' and pk is None:
            return self.create(data)
        elif method == 'GET' and pk is not None:
            return self.retrieve(pk)
        elif method == 'PUT' and pk is not None:
            return self.update(pk, data)
        elif method == 'DELETE' and pk is not None:
            return self.destroy(pk)
        return {'status': 405, 'error': 'Méthode non autorisee'}


class APITestClient:
    def __init__(self, viewset):
        self.viewset = viewset

    def _extract_pk(self, path):
        parts = path.strip('/').split('/')
        if parts and parts[-1].isdigit():
            return int(parts[-1])
        return None

    def get(self, path):
        pk = self._extract_pk(path)
        return self.viewset.dispatch('GET', pk=pk)

    def post(self, path, data=None):
        pk = self._extract_pk(path)
        return self.viewset.dispatch('POST', data=data, pk=pk)

    def put(self, path, data=None):
        pk = self._extract_pk(path)
        return self.viewset.dispatch('PUT', data=data, pk=pk)

    def delete(self, path):
        pk = self._extract_pk(path)
        return self.viewset.dispatch('DELETE', pk=pk)


def run_api_tests(client):
    results = []
    passed = 0
    failed = 0

    tests = [
        ('GET liste vide', lambda: client.get('/'), lambda r: r['status'] == 200 and r['data'] == []),
        ('POST crée article', lambda: client.post('/', {'title': 'Test', 'content': 'Body'}), lambda r: r['status'] == 201 and r['data']['title'] == 'Test'),
        ('GET liste avec 1 article', lambda: client.get('/'), lambda r: r['status'] == 200 and len(r['data']) == 1),
        ('GET detail article', lambda: client.get('/1/'), lambda r: r['status'] == 200 and r['data']['title'] == 'Test'),
        ('PUT modifie article', lambda: client.put('/1/', {'title': 'Updated'}), lambda r: r['status'] == 200 and r['data']['title'] == 'Updated'),
        ('DELETE supprime article', lambda: client.delete('/1/'), lambda r: r['status'] == 204),
    ]

    for name, action, check in tests:
        try:
            result = action()
            success = check(result)
            if success:
                passed += 1
                results.append({'name': name, 'passed': True})
            else:
                failed += 1
                results.append({'name': name, 'passed': False, 'result': result})
        except Exception as e:
            failed += 1
            results.append({'name': name, 'passed': False, 'error': str(e)})

    return {'passed': passed, 'failed': failed, 'details': results}

← Paginateur Middleware CORS simule →

solution.py

class ArticleViewSet:
    def __init__(self):
        self.db = {}
        self.next_id = 1

def list(self):
        return {'status': 200, 'data': list(self.db.values())}

def create(self, data):
        article = dict(data)
        article['id'] = self.next_id
        self.db[self.next_id] = article
        self.next_id += 1
        return {'status': 201, 'data': article}

def retrieve(self, pk):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        return {'status': 200, 'data': self.db[pk]}

def update(self, pk, data):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        self.db[pk].update(data)
        self.db[pk]['id'] = pk
        return {'status': 200, 'data': self.db[pk]}

def destroy(self, pk):
        if pk not in self.db:
            return {'status': 404, 'error': 'Non trouve'}
        del self.db[pk]
        return {'status': 204, 'data': None}

def dispatch(self, method, data=None, pk=None):
        if method == 'GET' and pk is None:
            return self.list()
        elif method == 'POST' and pk is None:
            return self.create(data)
        elif method == 'GET' and pk is not None:
            return self.retrieve(pk)
        elif method == 'PUT' and pk is not None:
            return self.update(pk, data)
        elif method == 'DELETE' and pk is not None:
            return self.destroy(pk)
        return {'status': 405, 'error': 'Méthode non autorisee'}

class APITestClient:
    def __init__(self, viewset):
        self.viewset = viewset

def _extract_pk(self, path):
        # Extrait le pk du path (ex: '/1/' -> 1, '/' -> None)
        pass

def get(self, path):
        pass

def post(self, path, data=None):
        pass

def put(self, path, data=None):
        pass

def delete(self, path):
        pass

def run_api_tests(client):
    pass

Bravo!

Tests d'API simules

Tests (4/5)

Indices (3 disponibles)

Solution officielle