Le mode "loop" - tharkun/atoum GitHub Wiki

Lorsqu'un développeur fait du développement piloté par les tests, il travaille de la manière suivante :

1. Il commence par créer le test correspondant à ce qu'il veut développer ;
2. Il exécute le test qu'il vient de créer ;
3. Il écrit le code permettant au test de passer avec succès ;
4. Il modifie ou complète son test et repart à l'étape 2 ;

Concrètement, cela signifie qu'il doit :

1. Créer son code dans son éditeur favori ;
2. Quitter son éditeur pour utiliser une console afin d'exécuter son test ;
3. Revenir à son éditeur pour écrire le code permettant au test de passer avec succès ;
4. Revenir à la console afin de relancer l'exécution de son test ;
5. Revenir à son éditeur afin de modifier ou compléter son test ;

Il y a donc bien un cycle qui se répétera tant que la fonctionnalité n'aura pas été développé dans son intégralité.
Cependant, ce cycle est complexe et impose de nombreux allers-retours entre plusieurs logiciels, ainsi que la saisie récurrente d'une même commande dans le terminal afin de lancer l'exécution des tests unitaires.
Pour ceux qui travaille avec VIM, atoum est fourni en standard avec un plug-in pour cet éditeur permettant de lancer les tests et à en consulter les résultats sans avoir à le quitter, ce qui fluidifie fortement la production du code.
Et pour ceux n'utilisant pas VIM, atoum propose le mode "loop" disponible via les arguments -l ou --loop, qui permet au développeur de ne pas avoir à relancer manuellement les tests et permet donc de fluidifier le processus de développement.
Dans ce mode, atoum commence par exécuter une première fois les tests qui lui sont demandés.
Une fois les tests terminés, si les tests ont été passé avec succès par le code, atoum se met simplement en attente :

# php tests/units/classes/adapter.php -l
> atoum version DEVELOPMENT by Frédéric Hardy (/Users/fch/Atoum)
> PHP path: /usr/local/bin/php
> PHP version:
=> PHP 5.3.8 (cli) (built: Sep 21 2011 23:14:37)
=> Copyright (c) 1997-2011 The PHP Group
=> Zend Engine v2.3.0, Copyright (c) 1998-2011 Zend Technologies
=>     with Xdebug v2.1.1, Copyright (c) 2002-2011, by Derick Rethans
> mageekguy\atoum\tests\units\adapter...
[S___________________________________________________________][1/1]
=> Test duration: 0.02 second.
=> Memory usage: 0.25 Mb.
> Total test duration: 0.02 second.
> Total test memory usage: 0.25 Mb.
> Code coverage value: 100.00%
> Running duration: 0.16 second.
Success (1 test, 0 method, 2 assertions, 0 error, 0 exception) !
Press <Enter> to reexecute, press any other key to stop...

Si le développeur presse une autre touche que Enter, atoum se terminera.
Dans le cas contraire, atoum re-exécutera à nouveau les mêmes tests, sans que le développeur n'ait à faire une autre action.
Dans le cas ou le code ne passe pas les tests avec succès, c'est à dire si des assertions ne sont pas vérifiées ou si il y a eu des erreurs ou des exceptions, atoum se met également en attente :

 php tests/units/classes/adapter.php -l
> atoum version DEVELOPMENT by Frédéric Hardy (/Users/fch/Atoum)
> PHP path: /usr/local/bin/php
> PHP version:
=> PHP 5.3.8 (cli) (built: Sep 21 2011 23:14:37)
=> Copyright (c) 1997-2011 The PHP Group
=> Zend Engine v2.3.0, Copyright (c) 1998-2011 Zend Technologies
=>     with Xdebug v2.1.1, Copyright (c) 2002-2011, by Derick Rethans
> mageekguy\atoum\tests\units\adapter...
[F___________________________________________________________][1/1]
=> Test duration: 0.00 second.
=> Memory usage: 0.00 Mb.
> Total test duration: 0.00 second.
> Total test memory usage: 0.00 Mb.
> Running duration: 0.17 second.
Failure (1 test, 0 method, 1 failure, 0 error, 0 exception) !
> There is 1 failure:
=> mageekguy\atoum\tests\units\adapter::test__call():
In file /Users/fch/Atoum/tests/units/classes/adapter.php on line 17, mageekguy\atoum\asserters\string::isEqualTo() failed: strings are not equals
-Reference
+Data
@@ -1 +1 @@
-string(13) "4ea0354cd717c"
+string(32) "19798c230d5462b3bdae194f364feffa"
Press <Enter> to reexecute, press any other key to stop...

Tout comme dans le cas ou tout s'est bien passé, si le développeur presse une autre touche que Enter, atoum se terminera.
Cependant, s'il presse la touche Enter, au lieu de rejouer les mêmes tests comme dans le cas ou les tests ont été passés avec succès, atoum n'exécutera que les tests qui ne sont pas passés avec succès, au lieu de les rejouer dans leur intégralité.
Le développeur pourra alors dépiler les problèmes et rejouer les tests en erreur autant de fois que nécessaire simplement en appuyant sur Enter.
De plus, une fois que tous les tests en échec passeront à nouveau avec succès, atoum exécutera automatiquement la totalité de la suite de tests afin de détecter les éventuelles régressions introduite par la ou les corrections effectuées par le développeur.
Bien évidemment, le mode "loop" ne prend en compte que le fichier de test unitaire exécuté directement par PHP, comme dans l'exemple ci-dessous, ou bien ceux définis à l'aide de l'un des arguments suivants ou une combinaison de ces arguments :

• -f qui permet de spécifier le fichier de test à exécuter ;
• -d qui permet d'exécuter les fichiers de test contenus dans des répertoires ;
• -ns qui permet d'exécuter les classes de test contenues dans des espaces de nommage spécifiques ;
• -m qui permet d'exécuter uniquement certaine classe ou certaine méthode de test ;
• -t qui permet d'exécuter uniquement les tests portant un ou plusieurs tags spécifiques ;

L'argument -h permet d'obtenir une description plus détaillée de ces différents arguments.