Documentation sur les tests unitaires en PHP

Scénarios de tests unitaires

Le coeur du système est un framework de tests de régression construit autour des scénarios de test. Un exemple de scénario de test ressemble à...

class FileTestCase extends UnitTestCase {
}

Si aucun nom de test n'est fourni au moment de la liaison avec le constructeur alors le nom de la classe sera utilisé. Il s'agit du nom qui sera affiché dans les résultats du test.

Les véritables tests sont ajoutés en tant que méthode dans le scénario de test dont le nom par défaut commence par la chaîne "test" et quand le scénario de test est appelé toutes les méthodes de ce type sont exécutées dans l'ordre utilisé par l'introspection de PHP pour les trouver. Peuvent être ajoutées autant de méthodes de test que nécessaires. Par exemple...

require_once('simpletest/autorun.php');
require_once('../classes/writer.php');

class FileTestCase extends UnitTestCase {
    function FileTestCase() {
        $this->UnitTestCase('File test');
    }

    function setUp() {
        @unlink('../temp/test.txt');
    }

    function tearDown() {
        @unlink('../temp/test.txt');
    }

    function testCreation() {
        $writer = &new FileWriter('../temp/test.txt');
        $writer->write('Hello');
        $this->assertTrue(file_exists('../temp/test.txt'), 'File created');
    }
}

Le constructeur est optionnel et souvent omis. Sans nom, le nom de la classe est utilisé comme nom pour le scénario de test.

Notre unique méthode de test pour le moment est testCreation() où nous vérifions qu'un fichier a bien été créé par notre objet Writer. Nous pourrions avoir mis le code unlink() dans cette méthode, mais en la plaçant dans setUp() et tearDown() nous pouvons l'utiliser pour nos autres méthodes de test que nous ajouterons.

La méthode setUp() est lancé juste avant chaque méthode de test. tearDown() est lancé après chaque méthode de test.

Vous pouvez placer une initialisation de scénario de test dans le constructeur afin qu'elle soit lancée pour toutes les méthodes dans le scénario de test mais dans un tel cas vous vous exposeriez à des interférences. Cette façon de faire est légèrement moins rapide, mais elle est plus sûre. Notez que si vous arrivez avec des notions de JUnit, il ne s'agit pas du comportement auquel vous êtes habitués. Bizarrement JUnit re-instancie le scénario de test pour chaque méthode de test pour se prévenir d'une telle interférence. SimpleTest demande à l'utilisateur final d'utiliser setUp(), mais fournit aux codeurs de bibliothèque d'autres crochets.

Pour rapporter les résultats de test, le passage par une classe d'affichage - notifiée par les différentes méthodes de type assert...() - est utilisée. En voici la liste complète pour la classe UnitTestCase, celle par défaut dans SimpleTest...

assertTrue($x)	Echoue si $x est faux
assertFalse($x)	Echoue si $x est vrai
assertNull($x)	Echoue si $x est initialisé
assertNotNull($x)	Echoue si $x n'est pas initialisé
assertIsA($x, $t)	Echoue si $x n'est pas de la classe ou du type $t
assertEqual($x, $y)	Echoue si $x == $y est faux
assertNotEqual($x, $y)	Echoue si $x == $y est vrai
assertIdentical($x, $y)	Echoue si $x === $y est faux
assertNotIdentical($x, $y)	Echoue si $x === $y est vrai
assertReference($x, $y)	Echoue sauf si $x et $y sont la même variable
assertCopy($x, $y)	Echoue si $x et $y sont la même variable
assertPattern($p, $x)	Echoue sauf si l'expression rationnelle $p capture $x
assertNoPattern($p, $x)	Echoue si l'expression rationnelle $p capture $x
expectError($x)	Echoue si l'erreur correspondante n'arrive pas
expectException($x)	Echoue si l'exception correspondante n'est pas levée
ignoreException($x)	Avale toutes les exceptions correspondantes qui surviendraient
assert($e)	Echoue sur un objet attente $e qui échouerait

Toutes les méthodes d'assertion peuvent recevoir une description optionnelle : cette description sert pour étiqueter le résultat. Sans elle, une message par défaut est envoyée à la place : il est généralement suffisant. Ce message par défaut peut encore être encadré dans votre propre message si vous incluez "%s" dans la chaîne. Toutes les assertions renvoient vrai / true en cas de succès et faux / false en cas d'échec.

D'autres exemples...

$variable = null;
$this->assertNull($variable, 'Should be cleared');

...passera et normalement n'affichera aucun message. Si vous avez configuré le testeur pour afficher aussi les succès alors le message sera affiché comme tel.

$this->assertIdentical(0, false, 'Zero is not false [%s]');

Ceci échouera étant donné qu'il effectue une vérification sur le type en plus d'une comparaison sur les deux valeurs. La partie "%s" est remplacée par le message d'erreur par défaut qui aurait été affiché si nous n'avions pas fourni le nôtre. Cela nous permet d'emboîter les messages de test.

$a = 1;
$b = $a;
$this->assertReference($a, $b);

Échouera étant donné que la variable $b est une copie de $a.

$this->assertPattern('/hello/i', 'Hello world');

Là, ça passe puisque la recherche est insensible à la casse et que donc hello est bien repérable dans Hello world.

$this->expectError();
trigger_error('Catastrophe');

Ici la vérification attrape le message "Catastrophe" sans vérifier le texte et passe. Elle enlève l'erreur de la queue au passage.

$this->expectError('Catastrophe');
trigger_error('Catastrophe');

La vérification d'erreur suivante teste non seulement l'existance de l'erreur mais aussi le texte qui, dans le cas présent, correspond et donc un nouveau succès. Si des erreurs non vérifiées sont laissées pour compte à la fin d'une méthode de test alors un exception sera levé dans le test.

Notez que SimpleTest ne peut pas attraper des erreurs PHP au moment de la compilation.

Les scénarios de tests peuvent utiliser des méthodes bien pratiques pour déboguer le code ou pour étendre la suite...

setUp()	Est lancée avant chaque méthode de test
tearDown()	Est lancée après chaque méthode de test
pass()	Envoie un succès
fail()	Envoie un échec
error()	Envoi un évènement exception
signal($type, $payload)	Envoie un message défini par l'utilisateur au rapporteur du test
dump($var)	Effectue un print_r() formaté pour du déboguage rapide et grossier

Etendre les scénarios de test

Bien sûr des méthodes supplémentaires de test peuvent être ajoutées pour créer d'autres types de scénario de test afin d'étendre le framework...

require_once('simpletest/autorun.php');

class FileTester extends UnitTestCase {
    function FileTester($name = false) {
        $this->UnitTestCase($name);
    }

    function assertFileExists($filename, $message = '%s') {
        $this->assertTrue(
                file_exists($filename),
                sprintf($message, 'File [$filename] existence check'));
    }
}

Ici la bibliothèque SimpleTest est localisée dans un répertoire local appelé simpletest. Pensez à le modifier pour votre propre environnement.

Alternativement vous pourriez utiliser dans votre code un directive SimpleTestOptions::ignore('FileTester');.

Ce nouveau scénario peut être hérité exactement comme un scénario de test classique...

class FileTestCase extends FileTester {

    function setUp() {
        @unlink('../temp/test.txt');
    }

    function tearDown() {
        @unlink('../temp/test.txt');
    }

    function testCreation() {
        $writer = &new FileWriter('../temp/test.txt');
        $writer->write('Hello');
        $this->assertFileExists('../temp/test.txt');
    }
}

Si vous souhaitez un scénario de test sans toutes les assertions de UnitTestCase mais uniquement avec les vôtres propres, vous aurez besoin d'étendre la classe SimpleTestCase à la place. Elle se trouve dans simple_test.php en lieu et place de unit_tester.php. A consulter plus tard si vous souhaitez incorporer les scénarios d'autres testeurs unitaires dans votre suite de test.

Lancer un unique scénario de test

Ce n'est pas souvent qu'il faille lancer des scénarios avec un unique test. Sauf lorsqu'il s'agit de s'arracher les cheveux sur un module à problème sans pour autant désorganiser la suite de test principale. Avec autorun aucun échafaudage particulier n'est nécessaire, il suffit de lancer votre test et vous y êtes.

Vous pouvez même décider quel rapporteur (par exemple, TextReporter ou HtmlReporter) vous préférez pour un fichier spécifique quand il est lancé tout seul...

<?php
require_once('simpletest/autorun.php');
SimpleTest :: prefer(new TextReporter());
require_once('../classes/writer.php');

class FileTestCase extends UnitTestCase {
    ...
}
?>

Ce script sera lancé tel que mais il n'y aura aucun succès ou échec avant que des méthodes de test soient ajoutées.