1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
<?xml version="1.0" encoding="ISO-8859-1" ?>
<page title="Prise en main rapide de SimpleTest" here="Prise en main rapide de SimpleTest">
<long_title>
Prise en main rapide de SimpleTest pour PHP - Tests unitaire et objets fantaisie pour PHP
</long_title>
<content>
<introduction>
<p>
Le prsent article prsuppose que vous soyez familier avec le concept de tests unitaires ainsi que celui de dveloppement web avec le langage PHP. Il s'agit d'un guide pour le nouvel et impatient utilisateur de <a href="https://sourceforge.net/project/showfiles.php?group_id=76550">SimpleTest</a>. Pour une documentation plus complte, particulirement si vous dcouvrez les tests unitaires, consultez la <a href="http://www.lastcraft.com/unit_test_documentation.php">documentation en cours</a>, et pour des exemples de scnarios de test, consultez le <a href="http://www.lastcraft.com/first_test_tutorial.php">tutorial sur les tests unitaires</a>.
</p>
</introduction>
<section name="unit" title="Utiliser le testeur rapidement">
<p>
Parmi les outils de test pour logiciel, le testeur unitaire est le plus proche du dveloppeur. Dans un contexte de dveloppement agile, le code de test se place juste ct du code source tant donn que tous les deux sont crits simultanment. Dans ce contexte, SimpleTest aspire tre une solution complte de test pour un dveloppeur 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 <a href="http://www.junit.org/">JUnit</a> et des <a href="http://sourceforge.net/projects/phpunit/">PHPUnit</a>, mais elle inclut aussi les <a href="http://www.mockobjects.com/">objets fantaisie ou "mock objects"</a>. Sans compter quelques fonctionnalits de <a href="http://sourceforge.net/projects/jwebunit/">JWebUnit</a> : parmi celles-ci la navigation sur des pages web, les tests sur les cookies et l'envoi de formulaire.
</p>
<p>
La dmonstration la plus rapide : l'exemple
</p>
<p>
Supposons que nous sommes en train de tester une simple classe de log dans un fichier : elle s'appelle <code>Log</code> dans <em>classes/Log.php</em>. Commenons par crer un script de test, appel <em>tests/log_test.php</em>. Son contenu est le suivant...
<php><![CDATA[
<strong><?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');
?></strong>
]]></php>
Ici le rpertoire <em>simpletest</em> 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 crons un scnario de test...
<php><![CDATA[
<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');
<strong>
class TestOfLogging extends UnitTestCase {
}</strong>
?>
]]></php>
A prsent il y a 5 lignes de code d'chafaudage et toujours pas de test. Cependant partir de cet instant le retour sur investissement arrive trs rapidement. Supposons que la classe <code>Log</code> prenne le nom du fichier crire dans le constructeur et que nous ayons un rpertoire temporaire dans lequel placer ce fichier...
<php><![CDATA[
<?php
require_once('simpletest/unit_tester.php');
require_once('simpletest/reporter.php');
require_once('../classes/log.php');
class TestOfLogging extends UnitTestCase {
<strong>
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'));
}</strong>
}
?>
]]></php>
Au lancement du scnario de test, toutes les mthodes qui commencent avec la chane <code>test</code> sont identifies puis excutes. D'ordinaire nous avons bien plusieurs mthodes de tests. Les assertions dans les mthodes de test envoient des messages vers le framework de test qui affiche immdiatement le rsultat. Cette rponse immdiate est importante, non seulement lors d'un crash caus par le code, mais aussi de manire rapprocher l'affichage de l'erreur au plus prs du scnario de test concern.
</p>
<p>
Pour voir ces rsultats lanons effectivement les tests. S'il s'agit de l'unique scnario de test lancer, on peut y arriver avec...
<php><![CDATA[
<?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'));
}
}
<strong>
$test = &new TestOfLogging();
$test->run(new HtmlReporter());</strong>
?>
]]></php>
</p>
<p>
En cas chec, l'affichage ressemble ...
<div class="demo">
<h1>testoflogging</h1>
<span class="fail">Fail</span>: testcreatingnewfile->True assertion failed.<br />
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>1</strong> passes and <strong>1</strong> fails.</div>
</div>
...et si a passe, on obtient...
<div class="demo">
<h1>testoflogging</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>2</strong> passes and <strong>0</strong> fails.</div>
</div>
Et si vous obtenez a...
<div class="demo">
<b>Fatal error</b>: Failed opening required '../classes/log.php' (include_path='') in <b>/home/marcus/projects/lastcraft/tutorial_tests/Log/tests/log_test.php</b> on line <b>7</b>
</div>
c'est qu'il vous manque le fichier <em>classes/Log.php</em> qui pourrait ressembler :
<php><![CDATA[
<?php
class Log {
function Log($file_path) {
}
}
?>;
]]></php>
</p>
</section>
<section name="group" title="Construire des groupes de tests">
<p>
Il est peu probable que dans une vritable application on ait uniquement besoin de passer un seul scnario de test. Cela veut dire que nous avons besoin de grouper les scnarios dans un script de test qui peut, si ncessaire, lancer tous les tests de l'application.
</p>
<p>
Notre premire tape est de supprimer les includes et de dfaire notre hack prcdent...
<php><![CDATA[
<?php<strong>
require_once('../classes/log.php');</strong>
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'));<strong>
}
}
?></strong>
]]></php>
Ensuite nous crons un nouveau fichier appel <em>tests/all_tests.php</em>. On y insre le code suivant...
<php><![CDATA[
<strong><?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());
?></strong>
]]></php>
Cette mthode <code>GroupTest::addTestFile()</code> va inclure le fichier de scnarios de test et lire parmi toutes les nouvelles classes cres celles qui sont issues de <code>TestCase</code>. Dans un premier temps, seuls les noms sont stocks, de la sorte le lanceur de test peut instancier la classe au fur et mesure qu'il excute votre suite de tests.
</p>
<p>
Pour que a puisse marcher proprement le fichier de suite de tests ne devrait pas inclure aveuglement d'autres extensions de scnarios de test qui n'excuteraient pas effectivement de test. Le rsultat pourrait tre que des tests supplmentaires soient alors comptabiliss pendant l'excution des tests. Ce n'est pas un problme grave mais pour viter ce dsagrment, il suffit d'ajouter la commande <code>SimpleTestOptions::ignore()</code> quelque part dans le fichier de scnario de test. Par ailleurs le scnario de test ne devrait pas avoir t inclus ailleurs ou alors aucun scnario ne sera ajout aux groupes de test. Il s'agirait l d'une erreur autrement srieuse : si toutes les classes de scnario de test sont charges par PHP, alors la mthode <code>GroupTest::addTestFile()</code> ne pourra pas les dtecter.
</p>
<p>
Pour afficher les rsultats, il est seulement ncessaire d'invoquer <em>tests/all_tests.php</em> partir du serveur web.
</p>
</section>
<section name="mock" title="Utiliser les objets fantaisie">
<p>
Avanons un peu plus dans le futur.
</p>
<p>
Supposons que notre class logging soit teste et termine. Supposons aussi que nous testons une autre classe qui ait besoin d'crire des messages de log, disons <code>SessionPool</code>. Nous voulons tester une mthode qui ressemblera probablement quelque chose comme...
<php><![CDATA[<strong>
class SessionPool {
...
function logIn($username) {
...
$this->_log->message('User $username logged in.');
...
}
...
}
</strong>
]]></php>
Avec le concept de "rutilisation de code" comme fil conducteur, nous utilisons notre class <code>Log</code>. Un scnario de test classique ressemblera peut-tre ...
<php><![CDATA[<strong>
<?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");
}
}
?></strong>
]]></php>
Le design de ce scnario de test n'est pas compltement mauvais, mais on peut l'amliorer. 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 <code>Log</code> et ce test. Que se passerait-il si nous n'utilisions plus de fichiers, mais la bibliothque <em>syslog</em> la place ? Avez-vous remarqu le retour chariot supplmentaire la fin du message ? A-t-il t ajout par le loggueur ? Et si il ajoutait aussi un timestamp ou d'autres donnes ?
</p>
<p>
L'unique partie tester rellement est l'envoi d'un message prcis au loggueur. Nous rduisons le couplage en crant une fausse classe de logging : elle ne fait qu'enregistrer le message pour le test, mais ne produit aucun rsultat. Sauf qu'elle doit ressembler exactement l'original.
</p>
<p>
Si l'objet fantaisie n'crit pas dans un fichier alors nous nous pargnons la suppression du fichier avant et aprs le test. Nous pourrions mme nous pargner quelques lignes de code supplmentaires si l'objet fantaisie pouvait excuter l'assertion.
<p>
</p>
Trop beau pour tre vrai ? Par chance on peut crer un tel objet trs facilement...
<php><![CDATA[
<?php
require_once('../classes/log.php');
require_once('../classes/session_pool.php');<strong>
Mock::generate('Log');</strong>
class TestOfSessionLogging extends UnitTestCase {
function testLogInIsLogged() {<strong>
$log = &new MockLog($this);
$log->expectOnce('message', array('User fred logged in.'));</strong>
$session_pool = &new SessionPool($log);
$session_pool->logIn('fred');<strong>
$log->tally();</strong>
}
}
?>
]]></php>
L'appel <code>tally()</code> est ncessaire pour annoncer l'objet fantaisie qu'il n'y aura plus d'appels ultrieurs. Sans a l'objet fantaisie pourrait attendre pendant une ternit l'appel de la mthode sans jamais prvenir le scnario de test. Les autres tests sont dclenchs automatiquement quand l'appel <code>message()</code> est invoqu sur l'objet <code>MockLog</code>. L'appel <code>mock</code> va dclencher une comparaison des paramtres et ensuite envoyer le message "pass" ou "fail" au test pour l'affichage. Des jokers peuvent tre inclus ici aussi afin d'empcher que les tests ne deviennent trop spcifiques.
</p>
<p>
Les objets fantaisie dans la suite SimpleTest peuvent avoir un ensemble de valeurs de sortie arbitraires, des squences de sorties, des valeurs de sortie slectionnes partir des arguments d'entre, des squences de paramtres attendus et des limites sur le nombre de fois qu'une mthode peut tre invoque.
</p>
<p>
Pour que ce test fonctionne la librairie avec les objets fantaisie doit tre incluse dans la suite de tests, par exemple dans <em>all_tests.php</em>.
</p>
</section>
<section name="web" title="Tester une page web">
<p>
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 intgrer des tests au fur et mesure alors vous voulez un outil qui puisse effectuer une navigation automatique et en examiner le rsultat. C'est le boulot d'un testeur web.
</p>
<p>
Effectuer un test web via SimpleTest reste assez primitif : il n'y a pas de javascript par exemple. Pour vous donner une ide, voici un exemple assez trivial : aller chercher une page web, partir de l naviguer vers la page "about" et finalement tester un contenu dtermin par le client.
<php><![CDATA[
<?php<strong>
require_once('simpletest/web_tester.php');</strong>
require_once('simpletest/reporter.php');
<strong>
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');
}
}</strong>
$test = &new TestOfAbout();
$test->run(new HtmlReporter());
?>
]]></php>
Avec ce code comme test de recette, vous pouvez vous assurer que le contenu corresponde toujours aux spcifications la fois des dveloppeurs et des autres parties prenantes au projet.
</p>
<p>
<a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"/></a>
</p>
</section>
</content>
<internal>
<link>
<a href="#unit">Utiliser le testeur rapidement</a>
avec un exemple.
</link>
<link>
<a href="#group">Groupes de tests</a>
pour tester en un seul clic.
</link>
<link>
<a href="#mock">Utiliser les objets fantaisie</a>
pour faciliter les tests et gagner en contrle.
</link>
<link>
<a href="#web">Tester des pages web</a>
au niveau de l'HTML.
</link>
</internal>
<external>
<link>
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550&release_id=153280">Tlcharger PHP Simple Test</a>
depuis <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</link>
<link>
L'<a href="http://simpletest.sourceforge.net/">API de SimpleTest pour dveloppeur</a>
donne tous les dtails sur les classes et assertions existantes.
</link>
</external>
<meta>
<keywords>
dveloppement logiciel,
programmation php,
outils de dveloppement logiciel,
tutorial php,
scripts php gratuits,
architecture,
ressources php,
objets fantaise,
junit,
php testing,
php unit,
mthodologie,
dveloppement pilot par les tests,
sourceforge,
open source,
unit test,
web tester,
web testing,
outils tests html,
tester des web pages,
php objets fantaise,
naviguer automatiquement sur des sites web,
test automatis,
scripting web,
wget,
test curl,
jmock pour php,
jwebunit,
phpunit,
php unit testing,
php web testing,
jason sweat,
marcus baker,
perrick penet,
topstyle plug in,
phpedit plug in
</keywords>
</meta>
</page>
|
