Utiliser le testeur rapidement

Parmi les outils de test pour logiciel, le testeur unitaire est le plus proche du développeur. Dans un contexte de développement agile, le code de test se place juste à côté du code source étant donné que tous les deux sont écrits simultanément. Dans ce contexte, SimpleTest aspire à être une solution complète de test pour un développeur PHP et s'appelle "Simple" parce qu'elle devrait être simple à utiliser et à étendre. Ce nom n'était pas vraiment un bon choix. Non seulement cette solution inclut toutes les fonctions classiques qu'on est en droit d'attendre de la part des portages de JUnit et des PHPUnit, mais elle inclut aussi les objets fantaisie ou "mock objects". Sans compter quelques fonctionnalités de JWebUnit : parmi celles-ci la navigation sur des pages web, les tests sur les cookies et l'envoi de formulaire.

La démonstration la plus rapide : l'exemple

Supposons que nous sommes en train de tester une simple classe de log dans un fichier : elle s'appelle Log dans classes/Log.php. Commençons par créer un script de test, appelelé tests/log_test.php. Son contenu est le suivant...

<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');
?>

Ici le répertoire simpletest est soit dans le dossier courant, soit dans les dossiers pour fichiers inclus. Vous auriez à éditer ces arborescences suivant l'endroit où vous avez installé SimpleTest. Ensuite créons un scénario de test...

<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');

class TestOfLogging extends UnitTestCase {
}

?>

A présent il y a 5 lignes de code d'échaffaudage et toujours pas de test. Cependant à partir de cet instant le retour sur investissement arrive très rapidement. Supposons que la classe Log prenne le nom du fichier à écrire dans le constructeur et que nous ayons un répertoire temporaire dans lequel placer ce fichier...

<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');

class TestOfLogging extends UnitTestCase {
  
  function testCreatingNewFile() {
      @unlink('/temp/test.log');
      $log = new Log('/temp/test.log');
      $this->assertFalse(file_exists('/temp/test.log'));
      $log->message('Should write this to a file');
      $this->assertTrue(file_exists('/temp/test.log'));
  }
}
?>

Au lancement du scénario de test, toutes les méthodes qui commencent avec la chaîne test sont identifiées puis exécutées. D'ordinaire nous avons bien plusieurs méthodes de tests. Les assertions dans les méthodes de test envoient des messages vers le framework de test qui affiche immédiatement le résultat. Cette réponse immédiate est importante, non seulement lors d'un crash causé par le code, mais aussi de manière à rapprocher l'affichage de l'erreur au plus près du scénario de test concerné.

Pour voir ces résultats lançons effectivement les tests. S'il s'agit de l'unique scénario de test à lancer, on peut y arriver avec...

<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');

class TestOfLogging extends UnitTestCase {

  function testCreatingNewFile() {
      @unlink('/temp/test.log');
      $log = new Log('/temp/test.log');
      $this->assertFalse(file_exists('/temp/test.log'));
      $log->message('Should write this to a file');
      $this->assertTrue(file_exists('/temp/test.log'));
  }
}

$test = &new TestOfLogging();
$test->run(new HtmlReporter());
?>

En cas échec, l'affichage ressemble à...

...et si ça passe, on obtient...

Construire des groupes de tests

Il est peu probable que dans une véritable application on ait uniquement besoin de passer un seul scénario de test. Cela veut dire que nous avons besoin de grouper les scénarios dans un script de test qui peut, si nécessaire, lancer tous les tests de l'application.

Notre première étape est de supprimer les includes et de défaire notre hack précédent...

<?php
require_once('../classes/log.php');

class TestOfLogging extends UnitTestCase {
  
  function testCreatingNewFile() {
      @unlink('/temp/test.log');
      $log = new Log('/temp/test.log');
      $this->assertFalse(file_exists('/temp/test.log'));
      $log->message('Should write this to a file');
      $this->assertTrue(file_exists('/temp/test.log'));
  }
}
?>

Ensuite nous créons un nouveau fichier appelé tests/all_tests.php. On y insert le code suivant...

<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');

$test = &new GroupTest('All tests');
$test->addTestFile('log_test.php');
$test->run(new HtmlReporter());
?>

Cette méthode GroupTest::addTestFile() va inclure le fichier de scénarios de test et lire parmi toutes les nouvelles classes créées celles qui sont issues de TestCase. Dans un premier temps, seuls les noms sont stockés, de la sorte le lanceur de test peut instancier la classe au fur et à mesure qu'il exécute votre suite de tests.

Pour que ça puisse marcher proprement le fichier de suite de tests ne devrait pas inclure aveuglement d'autres extensions de scénarios de test qui n'exécuteraient pas effectivement de test. Le résulat pourrait être que des tests supplémentaires soient alors être comptabilisés pendant l'exécution des tests. Ce n'est pas un problème grave mais pour éviter ce désagrément, il suffit d'ajouter la commande SimpleTestOptions::ignore() quelque part dans le fichier de scénario de test. Par ailleurs le scénario de test ne devrait pas avoir été inclus ailleurs ou alors aucun scénario ne sera ajouté aux groupes de test. Il s'agirait là d'une erreur autrement sérieuse : si tous les classes de scénario de test sont chargées par PHP, alors la méthode GroupTest::addTestFile() ne pourra pas les détecter.

Pour afficher les résultats, il est seulement nécessaire d'invoquer tests/all_tests.php à partir du serveur web.

Utiliser les objets fantaisie

Avançons un peu plus dans le futur.

Supposons que notre class logging soit testée et terminée. Supposons aussi que nous testons une autre classe qui ait besoin d'écrire des messages de log, disons SessionPool. Nous voulons tester une méthode qui ressemblera probablement à quelque chose comme...

class SessionPool {
  ...
  function logIn($username) {
      ...
      $this->_log->message('User $username logged in.');
      ...
  }
  ...
}

Avec le concept de "réutilisation de code" comme fil conducteur, nous utilisons notre class Log. Un scénario de test classique ressemblera peut-être à...

<?php
require_once('../classes/log.php');
require_once('../classes/session_pool.php');

class TestOfSessionLogging extends UnitTestCase {
  
  function setUp() {
      @unlink('/temp/test.log');
  }
  
  function tearDown() {
      @unlink('/temp/test.log');
  }
  
  function testLogInIsLogged() {
      $log = new Log('/temp/test.log');
      $session_pool = &new SessionPool($log);
      $session_pool->logIn('fred');
      $messages = file('/temp/test.log');
      $this->assertEqual($messages[0], "User fred logged in.\n");
  }
}
?>

Le design de ce scénario de test n'est pas complètement mauvais, mais on peut l'améliorer. Nous passons du temps à tripoter les fichiers de log qui ne font pas partie de notre test. Pire, nous avons créé des liens de proximité entre la classe Log et ce test. Que se passerait-il si nous n'utilisions plus de fichiers, mais la bibliothèque syslog à la place ? Avez-vous remarqué le retour chariot supplémentaire à la fin du message ? A-t-il été ajouté par le loggueur ? Et si il ajoutait aussi un timestamp ou d'autres données ?

L'unique partie à tester réellement est l'envoi d'un message précis au loggueur. Nous réduisons le couplage en créant une fausse classe de logging : elle ne fait qu'enregistrer le message pour le test, mais ne produit aucun résultat. Sauf qu'elle doit ressembler exactement à l'original.

Si l'objet fantaisie n'écrit pas dans un fichier alors nous nous épargnons la suppression du fichier avant et après le test. Nous pourrions même nous épargner quelques lignes de code supplémentaires si l'objet fantaisie pouvait exécuter l'assertion.

Trop beau pour être vrai ? Par chance on peut créer un tel objet très facilement...

<?php
require_once('../classes/log.php');
require_once('../classes/session_pool.php');
Mock::generate('Log');

class TestOfSessionLogging extends UnitTestCase {
  
  function testLogInIsLogged() {
      $log = &new MockLog($this);
      $log->expectOnce('message', array('User fred logged in.'));
      $session_pool = &new SessionPool($log);
      $session_pool->logIn('fred');
      $log->tally();
  }
}
?>

L'appel tally() est nécessaire pour annoncer à l'objet fantaisie qu'il n'y aura plus d'appels ultérieurs. Sans ça l'objet fantaisie pourrait attendre pendant une éternité l'appel de la méthode sans jamais prévenir le scénario de test. Les autres tests sont déclenchés automatiquement quand l'appel à message() est invoqué sur l'objet MockLog. L'appel mock va déclencher une comparaison des paramètres et ensuite envoyer le message "pass" ou "fail" au test pour l'affichage. Des jokers peuvent être inclus ici aussi afin d'empêcher que les tests ne deviennent trop spécifiques.

Les objets fantaisie dans la suite SimpleTest peuvent avoir un ensemble de valeurs de sortie arbitraires, des séquences de sorties, des valeurs de sortie sélectionnées à partir des arguments d'entrée, des séquences de paramètres attendus et des limites sur le nombre de fois qu'une méthode peut être invoquée.

Pour que ce test fonctionne la librairie avec les objets fantaisie doit être incluse dans la suite de tests, par exemple dans all_tests.php.

Tester une page web

Une des exigences des sites web, c'est qu'ils produisent des pages web. Si vous construisez un projet de A à Z et que vous voulez intégrer des tests au fur et à mesure alors vous voulez un outil qui puisse effectuer une navigation automatique et en examiner le résultat. C'est le boulot d'un testeur web.

Effectuer un test web via SimpleTest reste assez primitif : il n'y a pas de javascript par exemple. Pour vous donner une idée, voici un exemple assez trivial : aller chercher une page web, à partir de là naviguer vers la page "about" et finalement tester un contenu déterminé par le client.

<?php
require_once('simpletest/web_tester.php');
require_once('simpletest/reporter.php');

class TestOfAbout extends WebTestCase {
    
  function setUp() {
      $this->get('http://test-server/index.php');
      $this->clickLink('About');
  }
  
  function testSearchEngineOptimisations() {
      $this->assertTitle('A long title about us for search engines');
      $this->assertWantedPattern('/a popular keyphrase/i');
  }
}
$test = &new TestOfAbout();
$test->run(new HtmlReporter());
?>

Avec ce code comme test de recette, vous pouvez vous assurer que le contenu corresponde toujours aux spécifications à la fois des développeurs et des autres parties prenantes au projet.

English Version

You can find the original article in english here : Simple Test for PHP.

24/10/2004
Version originale : Marcus Baker <marcus @ lastcraft . com>
Traduction : Perrick Penet <pk @ onpk . net>
Télécharger SimpleTest pour PHP