Documentation sur le groupement des tests

Grouper des tests

Il existe beaucoup de moyens pour grouper des tests dans des suites de tests. Le premier d'entre eux est tout simplement ajouter tous les scénarios de test au fur et à mesure d'un unique fichier...

<?php
require_once(dirname(__FILE__) . '/simpletest/autorun.php');
require_once(dirname(__FILE__) . '/../classes/io.php');

class FileTester extends UnitTestCase {
    ...
}

class SocketTester extends UnitTestCase {
    ...
}
?>

Autant de scénarios que nécessaires peuvent être mis dans cet unique fichier. Ils doivent contenir tout le code nécessaire, entre autres la bibliothèque testée, mais aucune des bibliothèques de SimpleTest.

Occasionnellement des sous-classes spéciales sont créés pour ajouter des méthodes nécessaires à certains tests spécifiques au sein de l'application. Ces nouvelles classes de base sont ensuite utilisées à la place de UnitTestCase ou de WebTestCase. Bien sûr vous ne souhaitez pas les lancer en tant que scénario de tests : il suffit alors de les identifier comme "abstraites"...

abstract class MyFileTestCase extends UnitTestCase {
    ...
}

class FileTester extends MyFileTestCase { ... }

class SocketTester extends UnitTestCase { ... }

La classe FileTester ne contient aucun test véritable, il s'agit d'une classe de base pour d'autres scénarios de test.

Nous appelons ce fichier file_test.php. Pour l'instant les scénarios de tests sont simplement groupés dans le même fichier. Nous pouvons mettre en place des structures plus importantes en incluant d'autres fichiers de tests.

<?php
require_once('simpletest/autorun.php');
require_once('file_test.php');
?>

Ceci fontionnera, tout en créant une hiérarchie tout à fait plate. A la place, nous créons un fichier de suite de tests. Notre suite des tests de premier niveau devient...

<?php
require_once('simpletest/autorun.php');

class AllFileTests extends TestSuite {
    function __construct() {
        parent::__construct();
        $this->addFile('file_test.php');
    }
}
?>

Voici ce qui arrive : la class TestSuite effecturera le require_once() pour nous. Ensuite elle vérifie si de nouvelles classes de test ont été créées par ce nouveau fichier et les inclut automatiquement dans la suite de tests. Cette méthode nous donne un maximum de contrôle tout comme le ferait des ajouts manuels de fichiers de tests au fur et à mesure où notre suite grandit.

Si c'est trop de boulot pour vos petits doigts et qu'en plus vous avez envie de grouper vos suites de tests par répertoire ou par un tag dans le nom des fichiers, alors il y a un moyen encore plus automatique...

<?php
require_once('simpletest/autorun.php');

class AllFileTests extends TestSuite {
    function __construct() {
        parent::__construct();
        $this->collect(dirname(__FILE__) . '/unit',
                       new SimplePatternCollector('/_test.php/'));
    }
}
?>

Cette fonctionnalités va scanner un répertoire appelé "unit", y détecter tous les fichiers finissant par "_test.php" et les charger. Vous n'avez pas besoin d'utiliser SimplePatternCollector pour filtrer en fonction d'un motif dans le nom de fichier, mais c'est son usage le plus courant.

Ce morceau de code est très courant. Désormais la seule chose qu'il vous reste à faire, c'est de déposer un fichier avec des scénarios de tests dans ce répertoire et il sera lancé directement par le script de la suite de tests.

Juste un bémol : vous ne pouvez pas contrôler l'ordre de lancement des tests. Si vous souhaitez voir des composants de bas niveau renvoyer leurs erreurs dès le début de la suite de tests - en particulier pour se facilier le travail de diagnostic - alors vous devriez plutôt passer par addFile() pour ces cas spécifiques. Les scénarios de tests ne sont chargés qu'une fois, pas d'inquiétude donc lors du scan de votre répertoire avec tous les tests.

Les tests chargés avec la méthode addFile ont certaines propriétés qui peuvent s'avérer intéressantes. Elle vous assure que le constructeur est lancé avant la première méthode de test et que le destructeur est lancé après la dernière méthode de test. Cela vous permet de placer une initialisation (setUp et tearDown) globale au sein de ce destructeur et desctructeur, comme dans n'importe quelle classe.

Groupements de plus haut niveau

La technique ci-dessus place tous les scénarios de test dans un unique et grand groupe. Sauf que pour des projets plus conséquents, ce n'est probablement pas assez souple; vous voudriez peut-être grouper les tests tout à fait différemment.

Tout ce que nous avons décrit avec des scripts de tests s'applique pareillement avec des TestSuites...

<?php
require_once('simpletest/autorun.php');

class BigTestSuite extends TestSuite {
    function __construct() {
        parent::__construct();
        $this->addFile('file_tests.php');
    }
}
?>

Cette opération additionne nos scénarios de tests et une unique suite sous la première. Quand un test échoue, nous voyons le fil d'ariane avec l'enchainement. Nous pouvons même mélanger groupes et tests librement en prenant quand même soin d'éviter les inclusions en boucle.

<?php
require_once('simpletest/autorun.php');

class BigTestSuite extends TestSuite {
    function __construct() {
        parent::__construct();
        $this->addFile('file_tests.php');
        $this->addFile('some_other_test.php');
    }
}
?>

Petite précision, en cas de double inclusion, seule la première instance sera lancée.