Premiers tests avec pytest
Un test automatique est un petit programme qui vérifie qu'un autre programme fait ce qu'on attend. On le lance en une commande, autant de fois qu'on veut.
Le problème
Le projet n'a aucun test. Pour vérifier qu'un changement n'a rien cassé, il faut lancer le jeu, créer une partie, déplacer un colon, fonder une ville, sauvegarder, recharger. Plusieurs minutes, à refaire après chaque modification. Dans la pratique, on ne le fait pas à chaque fois, et les bugs passent.
Le bug des voisins après chargement en est l'exemple : il n'apparaît que si l'on pense à recharger une partie puis à déplacer une unité.
Installer pytest
pytest est l'outil de test le plus utilisé en Python.
Bash
À ajouter aussi dans requirements..
Un premier test
On crée un dossier tests/ à la racine, et un fichier dont le nom commence par test_.
Python
On lance :
Bash
Code
Trois règles suffisent pour commencer :
- le fichier s'appelle
test_;quelquechose. py - la fonction s'appelle
test_;quelquechose assertsuivi d'une condition : si elle est fausse, le test échoue.
Anatomie d'un test
Un bon test se lit en trois temps.
Python
Le nom du test est une phrase qui décrit le comportement attendu. Quand il échoue, on sait ce qui est cassé sans ouvrir le fichier.
Quand un test échoue
Code
pytest montre la ligne, la valeur obtenue et la valeur attendue. C'est souvent suffisant pour trouver l'erreur.
Quoi tester en premier
Tout ne se teste pas avec la même facilité. On commence par ce qui rapporte le plus pour le moins d'effort.
| Cible | Exemple de test | Difficulté aujourd'hui |
|---|---|---|
| Mathématiques hexagonales | Une case a six voisins | Facile, une fois sorties de Map |
| Pathfinding | Le chemin contourne l'eau | Facile |
| Règles | Fonder une ville donne 7 cases | Impossible : il faut un game complet |
| Sauvegarde | Recharger rend le même état | Impossible pour la même raison |
| Interface | Le bouton START change de page | Très difficile |
Pourquoi certaines choses sont impossibles à tester
Essayons de tester le déplacement d'une unité :
Python
Unit demande un game. Game() ouvre une fenêtre, charge des images, lit des fichiers. Et Unit.move appelle l'interface.
Le test nous apprend quelque chose : un code difficile à tester est un code trop couplé. Ce n'est pas le test qui est en tort.
La solution n'est pas de ruser avec le test, mais de sortir les règles de l'interface. Voir Fonctions et effets de bord.
Des tests pour le jeu
Les voisins sont réciproques
Si B est voisine de A, alors A est voisine de B. Un bon test pour attraper une erreur dans les deux listes de find_.
Python
La distance
Python
Plusieurs cas d'un coup
parametrize lance le même test avec plusieurs jeux de valeurs.
Python
Reproduire un bug avant de le corriger
La bonne habitude : quand on trouve un bug, on écrit d'abord le test qui le montre. Il échoue. On corrige. Il passe. Et le bug ne reviendra pas sans qu'on le sache.
Python
Maîtriser le hasard
La carte est générée au hasard : deux lancements donnent deux résultats. Un test doit être reproductible. On fixe la graine du générateur :
Python
Avec la même graine, randint rend toujours la même suite.
Organiser les tests
Code
Pour que les tests trouvent le code de src/, un fichier pytest.ini à la racine :
Code
Commandes utiles :
| Commande | Effet |
|---|---|
pytest | Lance tous les tests |
pytest tests/ | Un seul fichier |
pytest - | Les tests dont le nom contient « distance » |
pytest -x | S'arrête au premier échec |
pytest -v | Affiche le nom de chaque test |
Ce qu'un test ne fait pas
- Il ne prouve pas l'absence de bug, seulement que les cas prévus fonctionnent.
- Il ne remplace pas le fait de jouer au jeu.
- Trop de tests sur des détails rendent le code pénible à modifier. On teste le comportement, pas la façon dont il est obtenu.
À retenir
- Un test : préparer, agir, vérifier.
- Commencer par les fonctions pures.
- Un code impossible à tester est un code trop couplé.
- Un bug trouvé, un test écrit.
- Fixer la graine quand il y a du hasard.
Exercices
- Installer
pytest, créertests/, et faire passer le test des six voisins. Il faudra d'abord sortirtest_ hex. py find_deneighbors Map. - Écrire le test de réciprocité des voisins.
- Écrire
hex_distanceen commençant par ses tests. Voir A* sur la grille hexagonale (documentation du jeu). - Écrire un test qui échoue à cause du bug des coordonnées après chargement, puis corriger le bug.