TP Qualité de dev.
S. Salva

TP2 Tests Unitaires en PHP

1. Objectifs

Savoir développer des tests unitaires en php
Calculer la couverture de test d'une application
Dataprovider

2. Organisation et première utilisation

Dans ce TP, PHPUnit sera employé en ligne de commande (ce qui se fait souvent, mais il peut bien sûr être utilisé dans un IDE tel que PhpStorm ou Netbeans).
Pour le projet exemple "exo1", nous avons l'arborescence classique suivante:
exo1
—tests
—src

Pour chaque classe de nom "Class" nous avons un fichier ClassTest dans le répertoire tests. Merci de respecter cela à l'avenir.

Pour ce TP, il est obligatoire d'avoir la documentation de PHPUnit ouverte ! (disponible ici).

A

Récupérez les classes Personne.php et PersonneTest.php dans ce zip. Faites un répertoire exo1 et organisez le.

Phpunit diffère peu de Junit, mais on a aussi des annotations, du code, des assertions. La liste des assertions possible est ici : assertions.

Pour installer Phpunit sous linux, faites:

wget https://phar.phpunit.de/phpunit-X.phar avec X une version (ou curl -LO https://phar.phpunit.de/phpunit.phar')

chmod +x phpunit-X.phar

mv phpunit-X.phar /*compte personnel*/php/phpunit
Ajoutez /*compte personnel*/php/ à votre variable d'environnement $PATH (ajoutez en fin de fichier .bashrc, export PATH=$PATH:/*compte personnel*/php/ dans votre fichier .bashrc)

La version à télécharger dépend de votre version de PHP (PHPUnit 7.5 requires PHP 7.1, PHPUnit 9.3 requires PHP 7.3 PHPUnit 11 requires PHP 8.2 etc. )

Testez si Phpunit fonctionne avec phpunit --version

Pour lancer les tests, allez dans répertoire exo1 et:

phpunit tests/PersonneTest.php. Ca doit donner un écran de ce type:

capture

Maintenant que tout est en place, faisons des tests.

En se basant sur la méthode irradier, complétez votre fichier de test (1 méthode = cas de test) afin de couvrir l'ensemble de ses fonctionnalités. Combien avez-vous écris de méthodes?

C
Normalement, étant donné que vous êtes très fort et que ce n'est pas votre premier TP, vous avez bien sûr utilisé une fixure (méthode @before, @beforeclass) sinon il est encore temps.
voir ici
Vous pouvez également utiliser Hamcrest pour PHP (cela vous ajoute de nouvelles assertions plus lisibles mais cela va vous prendre un peu plus de temps pour l'installer, donc pour ceux qui maitrisent PHP)

D
Ajoutez des dépendances entre certaines de vos méthodes pour que si un cas de test ne passe pas, ceux qui en dépendent ne sont pas lancés. Celà se fait avec l'annotation @depends.

E
PHPunit offre l'opportunité d'utiliser un dataprovider afin de factoriser plusieurs tests identiques construits avec des données différentes.
Créez un test pour la méthode irradier avec les valeurs de pied 2,3,5. (On attend respectivement 3,4,5). En php, on utilise rarement des getter setter, pied peut ici être public (à vous de voir).

F
La méthode marche retourne une exception. Créez un test permettant de vérifier que l'exception peut être levée et que le message d'erreur retourné est 'trop de pieds'. Il y a deux possibilités: du code ou une annotation.

2. Sorties

A

Les programmes PHP produisent ("souvent") du code HTML en sortie. C'est ici le cas pour la classe Personne et sa méthode manger. Pour tester la sortie, il est possible d'utiliser la méthode de Phpunit expectOutputString('chaine attendue'). Faites un test pour la méthode manger.

Comme vous le voyez, ca fonctionne bien ici, MAIS il serait bien fastidieux de tester des sites Web de cette façon. C'est fait avec d'autres outils que nous verrons, tels que Selenium.

3. Suites de test

A

Créez une classe Etudiant en vous basant sur la classe Personne. Puis créez un fichier de test simple pour étudiant avec quelques cas de test au choix.
Vous souhaitez lancer, d'une façon simple, l'exécution de tous vos tests. Il vous ai demandé de créer une suite de test composée des 2 fichiers précédants. Pour cela, il faut créer un fichier XML déclarant les 2 cas de test. Voici un exemple (tiré de la doc):

<phpunit>
<testsuites>
    <testsuite name="money">
      <file>tests/IntlFormatterTest.php</file>
      <file>tests/MoneyTest.php</file>
      <file>tests/CurrencyTest.php</file>
    </testsuite>
</testsuites>
</phpunit>

Pour lancer l'exécution de la suite de test, il faut utiliser l'option de ligne de commande --testsuite <pattern>.

4. Couverture de code

Phpunit permet également d'obtenir un rapport sur la couverture de code. Pour créer ce rapport, il faut utiliser l'option de ligne de commande --coverage-html ./report. Le rapport en HTML sera placé dans le répertoire report. Il est possible de créer des rapports en XML CSV, etc.
Pour ce cela fonctionne, il faut aussi donner une "whitelist" qui indique les fichiers à couvrir. Voici dans la doc
Voici un exemple:
captures

A

Calculez la couverture de code que vous obtenez avec la classe Personne. Analysez ce rapport (besoin de plus ???)
Si vous obtenez un warning indiquant qu'il faut mettre un mode coverage dans php.ini, alors

soit faites export XDEBUG_MODE=coverage
soit modifiez la configuration (phpunit.xml) voir ici

B

Complétez vos tests pour obtenir une couverture de 100%.