feat: add videodb media index with Docker stack

- Add videodb PHP/MySQL media collection manager (Blu-ray, DVD, CD)
- Dockerfile: PHP 8.1 + Apache with GD/mysqli/exif extensions
- docker-compose.yml: app on port 6761 + MySQL 8.0 with health checks
- docker-entrypoint.sh: auto-generates config.inc.php from env vars,
  waits for MySQL, initializes DB schema idempotently
- init-db.php: CLI schema installer using app's own prefix_query() logic
- Persistent volumes for DB, cache, and cover images

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-05-11 09:49:52 +02:00
commit f55c91276e
1230 changed files with 252321 additions and 0 deletions

View File

@@ -0,0 +1,372 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation Simple Test : tester l'authentification</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur l'authentification</h1>
This page...
<ul>
<li>
Passer au travers d'une <a href="#basique">authentification HTTP basique</a>
</li>
<li>
Tester l'<a href="#cookies">authentification basée sur des cookies</a>
</li>
<li>
Gérer les <a href="#session">sessions du navigateur</a> et les timeouts
</li>
</ul>
<div class="content">
<p>
Un des secteurs à la fois délicat et important lors d'un test
de site web reste la sécurité. Tester ces schémas est au coeur
des objectifs du testeur web de SimpleTest.
</p>
<h2>
<a class="target" name="basique"></a>Authentification HTTP basique</h2>
<p>
Si vous allez chercher une page web protégée
par une authentification basique, vous hériterez d'une entête 401.
Nous pouvons représenter ceci par ce test...
<pre>
class AuthenticationTest extends WebTestCase {<strong>
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;showHeaders();
}</strong>
}
</pre>
Ce qui nous permet de voir les entêtes reçues...
<div class="demo">
<h1>File test</h1>
<pre style="background-color: lightgray; color: black">
HTTP/1.1 401 Authorization Required
Date: Sat, 18 Sep 2004 19:25:18 GMT
Server: Apache/1.3.29 (Unix) PHP/4.3.4
WWW-Authenticate: Basic realm="SimpleTest basic authentication"
Connection: close
Content-Type: text/html; charset=iso-8859-1
</pre>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
Sauf que nous voulons éviter l'inspection visuelle,
on souhaite que SimpleTest puisse nous dire si oui ou non
la page est protégée. Voici un test en profondeur sur nos entêtes...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;assertAuthentication('Basic');
$this-&gt;assertResponse(401);
$this-&gt;assertRealm('SimpleTest basic authentication');</strong>
}
}
</pre>
N'importe laquelle de ces assertions suffirait,
tout dépend de la masse de détails que vous souhaitez voir.
</p>
<p>
Un des axes qui traverse SimpleTest est la possibilité d'utiliser
des objets <span class="new_code">SimpleExpectation</span> à chaque fois qu'une
vérification simple suffit.
Si vous souhaitez vérifiez simplement le contenu du realm - l'identification
du domaine - dans notre exemple, il suffit de faire...
<pre>
class AuthenticationTest extends WebTestCase {
function test401Header() {
$this-&gt;get('http://www.lastcraft.com/protected/');
$this-&gt;assertRealm(<strong>new PatternExpectation('/simpletest/i')</strong>);
}
}
</pre>
Ce type de test, vérifier les réponses HTTP, n'est cependant pas commun.
</p>
<p>
La plupart du temps, nous ne souhaitons pas tester
l'authentification en elle-même, mais plutôt
les pages protégées par cette authentification.
Dès que la tentative d'authentification est reçue,
nous pouvons y répondre à l'aide d'une réponse d'authentification :
<pre>
class AuthenticationTest extends WebTestCase {
function testAuthentication() {
$this-&gt;get('http://www.lastcraft.com/protected/');<strong>
$this-&gt;authenticate('Me', 'Secret');</strong>
$this-&gt;assertTitle(...);
}
}
</pre>
Le nom d'utilisateur et le mot de passe seront désormais
envoyés à chaque requête vers ce répertoire
et ses sous-répertoires.
En revanche vous devrez vous authentifier à nouveau
si vous sortez de ce répertoire mais SimpleTest est assez
intelligent pour fusionner les sous-répertoires dans un même domaine.
</p>
<p>
Vous pouvez gagner une ligne en définissant
l'authentification au niveau de l'URL...
<pre>
class AuthenticationTest extends WebTestCase {
function testCanReadAuthenticatedPages() {
$this-&gt;get('http://<strong>Me:Secret@</strong>www.lastcraft.com/protected/');
$this-&gt;assertTitle(...);
}
}
</pre>
Si votre nom d'utilisateur ou mot de passe comporte
des caractères spéciaux, alors n'oubliez pas de les encoder,
sinon la requête ne sera pas analysée correctement.
De plus cette entête ne sera pas envoyée aux
sous requêtes si vous la définissez avec une URL absolue.
Par contre si vous naviguez avec des URL relatives,
l'information d'authentification sera préservée.
</p>
<p>
Normalement, vous utilisez l'appel <span class="new_code">authenticate()</span>. SimpleTest
utilisera alors vos informations de connexion à chaque requête.
</p>
<p>
Pour l'instant, seule l'authentification de base est implémentée
et elle n'est réellement fiable qu'en tandem avec une connexion HTTPS.
C'est généralement suffisant pour protéger
le serveur testé des regards malveillants.
Les authentifications Digest et NTLM pourraient être ajoutées prochainement.
</p>
<h2>
<a class="target" name="cookies"></a>Cookies</h2>
<p>
L'authentification de base ne donne pas assez de contrôle
au développeur Web sur l'interface utilisateur.
Il y a de forte chance pour que cette fonctionnalité
soit codée directement dans l'architecture web
à grand renfort de cookies et de timeouts compliqués.
</p>
<p>
Commençons par un simple formulaire de connexion...
<pre>
&lt;form&gt;
Username:
&lt;input type="text" name="u" value="" /&gt;&lt;br /&gt;
Password:
&lt;input type="password" name="p" value="" /&gt;&lt;br /&gt;
&lt;input type="submit" value="Log in" /&gt;
&lt;/form&gt;
</pre>
Lequel doit ressembler à...
</p>
<p>
<form class="demo">
Username:
<input type="text" name="u" value=""><br>
Password:
<input type="password" name="p" value=""><br>
<input type="submit" value="Log in">
</form>
</p>
<p>
Supposons que, durant le chargement de la page,
un cookie ait été inscrit avec un numéro d'identifiant de session.
Nous n'allons pas encore remplir le formulaire,
juste tester que nous pistons bien l'utilisateur.
Voici le test...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieSetBeforeForm() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;assertCookie('SID');</strong>
}
}
</pre>
Nous nous contentons ici de vérifier que le cookie a bien été défini.
Etant donné que sa valeur est plutôt énigmatique,
elle ne vaudrait pas la peine d'être testée avec...
<pre>
class LogInTest extends WebTestCase {
function testSessionCookieIsCorrectPattern() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;assertCookie('SID', <strong>new PatternExpectation('/[a-f0-9]{32}/i')</strong>);
}
}
</pre>
Si vous utilisez PHP pour gérer vos sessions alors
ce test est encore plus inutile, étant donné qu'il ne fait
que tester PHP lui-même.
</p>
<p>
Le test le plus simple pour vérifier que la connexion a bien eu lieu
reste d'inspecter visuellement la page suivante :
un simple appel à <span class="new_code">WebTestCase::assertText()</span> et le tour est joué.
</p>
<p>
Le reste du test est le même que dans n'importe quel autre formulaire,
mais nous pourrions souhaiter nous assurer
que le cookie n'a pas été modifié depuis la phase de connexion.
Voici comment cela pourrait être testé :
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$session = $this-&gt;getCookie('SID');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');
$this-&gt;assertCookie('SID', $session);</strong>
}
}
</pre>
Ceci confirme que l'identifiant de session
est identique avant et après la connexion.
</p>
<p>
Nous pouvons même essayer de duper notre propre système
en créant un cookie arbitraire pour se connecter...
<pre>
class LogInTest extends WebTestCase {
...
function testSessionCookieSameAfterLogIn() {
$this-&gt;get('http://www.my-site.com/login.php');<strong>
$this-&gt;setCookie('SID', 'Some other session');
$this-&gt;get('http://www.my-site.com/restricted.php');</strong>
$this-&gt;assertWantedPattern('/Access denied/');
}
}
</pre>
Votre site est-il protégé contre ce type d'attaque ?
</p>
<h2>
<a class="target" name="session"></a>Sessions de navigateur</h2>
<p>
Si vous testez un système d'authentification,
la reconnexion par un utilisateur est un point sensible.
Essayons de simuler ce qui se passe dans ce cas :
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterBrowserClose() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');<strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertWantedPattern('/Access denied/');</strong>
}
}
</pre>
La méthode <span class="new_code">WebTestCase::restart()</span> préserve
les cookies dont le timeout n'a pas expiré,
mais jette les cookies temporaires ou expirés.
Vous pouvez spécifier l'heure et la date de leur réactivation.
</p>
<p>
L'expiration des cookies peut être un problème.
Si vous avez un cookie qui doit expirer au bout d'une heure,
nous n'allons pas mettre le test en veille en attendant
que le cookie expire...
</p>
<p>
Afin de provoquer leur expiration,
vous pouvez dater manuellement les cookies,
avant le début de la session.
<pre>
class LogInTest extends WebTestCase {
...
function testLoseAuthenticationAfterOneHour() {
$this-&gt;get('http://www.my-site.com/login.php');
$this-&gt;setField('u', 'Me');
$this-&gt;setField('p', 'Secret');
$this-&gt;clickSubmit('Log in');
$this-&gt;assertWantedPattern('/Welcome Me/');
<strong>
$this-&gt;ageCookies(3600);</strong>
$this-&gt;restart();
$this-&gt;get('http://www.my-site.com/restricted.php');
$this-&gt;assertWantedPattern('/Access denied/');
}
}
</pre>
Après le redémarrage, les cookies seront plus vieux
d'une heure et que tous ceux dont la date d'expiration
sera passée auront disparus.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a> donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,500 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : le composant de navigation web scriptable</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le navigateur scriptable</h1>
This page...
<ul>
<li>
Utiliser le <a href="#scripting">navigateur web dans des scripts</a>
</li>
<li>
<a href="#deboguer">Déboguer</a> les erreurs sur les pages
</li>
<li>
<a href="#unit">Tests complexes avec des navigateurs web multiples</a>
</li>
</ul>
<div class="content">
<p>
Le composant de navigation web de SimpleTest peut être utilisé
non seulement à l'extérieur de la classe <span class="new_code">WebTestCase</span>,
mais aussi indépendamment du framework SimpleTest lui-même.
</p>
<h2>
<a class="target" name="script"></a>Le navigateur scriptable</h2>
<p>
Vous pouvez utiliser le navigateur web dans des scripts PHP
pour confirmer que des services marchent bien comme il faut
ou pour extraire des informations à partir de ceux-ci de façon régulière.
Par exemple, voici un petit script pour extraire
le nombre de bogues ouverts dans PHP 5 à partir
du <a href="http://www.php.net/">site web PHP</a>...
<pre>
&lt;?php
require_once('simpletest/browser.php');
$browser = &amp;new SimpleBrowser();
$browser-&gt;get('http://php.net/');
$browser-&gt;clickLink('reporting bugs');
$browser-&gt;clickLink('statistics');
$browser-&gt;clickLink('PHP 5 bugs only');
$page = $browser-&gt;getContent();
preg_match('/status=Open.*?by=Any.*?(\d+)&lt;\/a&gt;/', $page, $matches);
print $matches[1];
?&gt;
</pre>
Bien sûr Il y a des méthodes plus simple pour réaliser
cet exemple en PHP. Par exemple, vous pourriez juste
utiliser la commande PHP <span class="new_code">file()</span> sur ce qui est
ici une page fixe. Cependant, en utilisant des scripts
avec le navigateur web vous vous autorisez l'authentification,
la gestion des cookies, le chargement automatique des fenêtres,
les redirections, la transmission de formulaires et la capacité
d'examiner les entêtes.
</p>
<p>
Ces méthodes qui se basent sur le contenu textuel des pages
sont fragiles dans un site en constante évolution
et vous voudrez employer une méthode plus directe
pour accéder aux données de façon permanente,
mais pour des tâches simples cette technique peut s'avérer
une solution très rapide.
</p>
<p>
Toutes les méthode de navigation utilisées dans <a href="web_tester_documentation.html">WebTestCase</a> sont présente dans la classe <span class="new_code">SimpleBrowser</span>, mais les assertions sont remplacées par de simples accesseurs. Voici une liste complète des méthodes de navigation de page à page...
<table><tbody>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Ajouter une entête à chaque téléchargement</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $username, $password)</span></td>
<td>Utilise ce proxy à partir de maintenant</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Effectue une requête HEAD</td>
</tr>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Télécharge une page avec un GET</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Télécharge une page avec un POST</td>
</tr>
<tr>
<td><span class="new_code">click($label)</span></td>
<td>Suit un lien visible ou un bouton texte par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label)</span></td>
<td>Suit un lien par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">isLink($label)</span></td>
<td>Vérifie l'existance d'un lien par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Suit un lien par son attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">isLinkById($id)</span></td>
<td>Vérifie l'existance d'un lien par son attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>La page ou la fenêtre URL en cours</td>
</tr>
<tr>
<td><span class="new_code">getTitle()</span></td>
<td>Le titre de la page</td>
</tr>
<tr>
<td><span class="new_code">getContent()</span></td>
<td>Le page ou la fenêtre brute</td>
</tr>
<tr>
<td><span class="new_code">getContentAsText()</span></td>
<td>Sans code HTML à l'exception du text "alt"</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Répète la dernière requête</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Utilise le bouton "précédent" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Utilise le bouton "suivant" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">authenticate($username, $password)</span></td>
<td>Retente la page ou la fenêtre après une réponse 401</td>
</tr>
<tr>
<td><span class="new_code">restart($date)</span></td>
<td>Relance le navigateur pour une nouvelle session</td>
</tr>
<tr>
<td><span class="new_code">ageCookies($interval)</span></td>
<td>Change la date des cookies</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Lance un nouveau cookie</td>
</tr>
<tr>
<td><span class="new_code">getCookieValue($host, $path, $name)</span></td>
<td>Lit le cookie le plus spécifique</td>
</tr>
<tr>
<td><span class="new_code">getCurrentCookieValue($name)</span></td>
<td>Lit le contenue du cookie en cours</td>
</tr>
</tbody></table>
Les méthode <span class="new_code">SimpleBrowser::useProxy()</span> et
<span class="new_code">SimpleBrowser::addHeader()</span> sont spéciales.
Une fois appelées, elles continuent à s'appliquer sur les téléchargements suivants.
</p>
<p>
Naviguer dans les formulaires est similaire à la <a href="form_testing_documentation.html">navigation des formulaires via WebTestCase</a>...
<table><tbody>
<tr>
<td><span class="new_code">setField($label, $value)</span></td>
<td>Modifie tous les champs avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">setFieldByName($name, $value)</span></td>
<td>Modifie tous les champs avec ce nom</td>
</tr>
<tr>
<td><span class="new_code">setFieldById($id, $value)</span></td>
<td>Modifie tous les champs avec cet identifiant</td>
</tr>
<tr>
<td><span class="new_code">getField($label)</span></td>
<td>Accesseur de la valeur d'un élément de formulaire avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">getFieldByName($name)</span></td>
<td>Accesseur de la valeur d'un élément de formulaire avec ce nom</td>
</tr>
<tr>
<td><span class="new_code">getFieldById($id)</span></td>
<td>Accesseur de la valeur de l'élément de formulaire avec cet identifiant</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Transmet le formulaire avec l'étiquette de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Transmet le formulaire avec l'attribut de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Transmet le formulaire avec l'identifiant de son bouton</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son titre (title="*") our son texte alternatif (alt="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son attribut (name="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son identifiant (id="*")</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Transmet le formulaire par son identifiant propre</td>
</tr>
</tbody></table>
Au jourd d'aujourd'hui il n'existe pas beaucoup de méthodes pour lister
les formulaires et les champs disponibles.
<table><tbody>
<tr>
<td><span class="new_code">isClickable($label)</span></td>
<td>Vérifie si un lien existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">isSubmit($label)</span></td>
<td>Vérifie si un bouton existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">isImage($label)</span></td>
<td>Vérifie si un bouton image existe avec cette étiquette ou ce nom</td>
</tr>
<tr>
<td><span class="new_code">getLink($label)</span></td>
<td>Trouve une URL à partir de son label</td>
</tr>
<tr>
<td><span class="new_code">getLinkById($label)</span></td>
<td>Trouve une URL à partir de son identifiant</td>
</tr>
<tr>
<td><span class="new_code">getUrls()</span></td>
<td>Liste l'ensemble des liens de la page courante</td>
</tr>
</tbody></table>
Ce sera probablement
ajouté dans des versions successives de SimpleTest.
</p>
<p>
A l'intérieur d'une page, les fenêtres individuelles peuvent être
sélectionnées. Si aucune sélection n'est réalisée alors
toutes les fenêtres sont fusionnées ensemble dans
une unique et grande page.
Le contenu de la page en cours sera une concaténation des
toutes les fenêtres dans l'ordre spécifié par les balises "frameset".
<table><tbody>
<tr>
<td><span class="new_code">getFrames()</span></td>
<td>Un déchargement de la structure de la fenêtre courante</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>L'index ou l'étiquette de la fenêtre en courante</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Sélectionne la fenêtre numérotée à partir de 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Sélectionne une fenêtre par son étiquette</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Traite toutes les fenêtres comme une seule page</td>
</tr>
</tbody></table>
Lorsqu'on est focalisé sur une fenêtre unique,
le contenu viendra de celle-ci uniquement.
Cela comprend les liens à cliquer et les formulaires à transmettre.
</p>
<h2>
<a class="target" name="deboguer"></a>Où sont les erreurs ?</h2>
<p>
Toute cette masse de fonctionnalités est géniale
lorsqu'on arrive à bien télécharger les pages,
mais ce n'est pas toujours évident.
Pour aider à découvrir les erreurs, le navigateur a aussi
des méthodes pour aider au débogage.
<table><tbody>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Ferme la socket avec un délai trop long</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>L'URL de la page chargée le plus récemment</td>
</tr>
<tr>
<td><span class="new_code">getRequest()</span></td>
<td>L'entête de la requête brute de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getHeaders()</span></td>
<td>L'entête de réponse de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>N'importe quel erreur au niveau de la socket dans le dernier téléchargement</td>
</tr>
<tr>
<td><span class="new_code">getResponseCode()</span></td>
<td>La réponse HTTP de la page ou de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getMimeType()</span></td>
<td>Le type Mime de la page our de la fenêtre</td>
</tr>
<tr>
<td><span class="new_code">getAuthentication()</span></td>
<td>Le type d'authentification dans l'entête d'une provocation 401</td>
</tr>
<tr>
<td><span class="new_code">getRealm()</span></td>
<td>Le realm d'authentification dans l'entête d'une provocation 401</td>
</tr>
<tr>
<td><span class="new_code">getBaseUrl()</span></td>
<td>Uniquement la base de l'URL de la page chargée le plus récemment</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>Nombre de redirections avant que la page ne soit chargée automatiquement</td>
</tr>
<tr>
<td><span class="new_code">setMaximumNestedFrames($max)</span></td>
<td>Protection contre des framesets récursifs</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Neutralise le support des fenêtres</td>
</tr>
<tr>
<td><span class="new_code">useFrames()</span></td>
<td>Autorise le support des fenêtres</td>
</tr>
</tbody></table>
Les méthodes <span class="new_code">SimpleBrowser::setConnectionTimeout()</span>,
<span class="new_code">SimpleBrowser::setMaximumRedirects()</span>,
<span class="new_code">SimpleBrowser::setMaximumNestedFrames()</span>,
<span class="new_code">SimpleBrowser::ignoreFrames()</span>
et <span class="new_code">SimpleBrowser::useFrames()</span> continuent à s'appliquer
sur toutes les requêtes suivantes.
Les autres méthodes tiennent compte des fenêtres.
Cela veut dire que si une fenêtre individuelle ne se charge pas,
il suffit de se diriger vers elle avec
<span class="new_code">SimpleBrowser::setFrameFocus()</span> : ensuite on utilisera
<span class="new_code">SimpleBrowser::getRequest()</span>, etc. pour voir ce qui se passe.
</p>
<h2>
<a class="target" name="unit"></a>Tests unitaires complexes avec des navigateurs multiples</h2>
<p>
Tout ce qui peut être fait dans
<a href="web_tester_documentation.html">WebTestCase</a> peut maintenant
être fait dans un <a href="unit_tester_documentation.html">UnitTestCase</a>.
Ce qui revient à dire que nous pouvons librement mélanger
des tests sur des objets de domaine avec l'interface web...
<pre><strong>
class TestOfRegistration extends UnitTestCase {
function testNewUserAddedToAuthenticator() {</strong>
$browser = new SimpleBrowser();
$browser-&gt;get('http://my-site.com/register.php');
$browser-&gt;setField('email', 'me@here');
$browser-&gt;setField('password', 'Secret');
$browser-&gt;clickSubmit('Register');
<strong>
$authenticator = new Authenticator();
$member = $authenticator-&gt;findByEmail('me@here');
$this-&gt;assertEqual($member-&gt;getPassword(), 'Secret');</strong>
}
}
</pre>
Bien que ça puisse être utile par convenance temporaire,
je ne suis pas fan de ce genre de test. Ce test s'applique
à plusieurs couches de l'application, ça implique qu'il est
plus que probable qu'il faudra le remanier lorsque le code changera.
</p>
<p>
Un cas plus utile d'utilisation directe du navigateur est
le moment où le <span class="new_code">WebTestCase</span> ne peut plus suivre.
Un exemple ? Quand deux navigateurs doivent être utilisés en même temps.
</p>
<p>
Par exemple, supposons que nous voulions interdire
des usages simultanés d'un site avec le même login d'identification.
Ce scénario de test le vérifie...
<pre>
class TestOfSecurity extends UnitTestCase {
function testNoMultipleLoginsFromSameUser() {
$first = &amp;new SimpleBrowser();
$first-&gt;get('http://my-site.com/login.php');
$first-&gt;setField('name', 'Me');
$first-&gt;setField('password', 'Secret');
$first-&gt;clickSubmit('Enter');
$this-&gt;assertEqual($first-&gt;getTitle(), 'Welcome');
$second = &amp;new SimpleBrowser();
$second-&gt;get('http://my-site.com/login.php');
$second-&gt;setField('name', 'Me');
$second-&gt;setField('password', 'Secret');
$second-&gt;clickSubmit('Enter');
$this-&gt;assertEqual($second-&gt;getTitle(), 'Access Denied');
}
}
</pre>
Vous pouvez aussi utiliser la classe <span class="new_code">SimpleBrowser</span>
quand vous souhaitez écrire des scénarios de test en utilisant
un autre outil que SimpleTest, comme PHPUnit par exemple.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API de développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,84 @@
body {
padding-left: 3%;
padding-right: 3%;
}
pre {
font-family: "courier new", courier;
font-size: 80%;
border: 1px solid;
background-color: #cccccc;
padding: 5px;
margin-left: 5%;
margin-right: 8%;
}
.code, .new_code, pre.new_code {
font-weight: bold;
}
div.copyright {
font-size: 80%;
color: gray;
}
div.copyright a {
color: gray;
}
ul.api {
padding-left: 0em;
padding-right: 25%;
}
ul.api li {
margin-top: 0.2em;
margin-bottom: 0.2em;
list-style: none;
text-indent: -3em;
padding-left: 3em;
}
div.demo {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: white;
}
div.demo span.fail {
color: red;
}
div.demo span.pass {
color: green;
}
div.demo h1 {
font-size: 12pt;
text-align: left;
font-weight: bold;
}
table {
border: 2px outset;
border-color: gray;
background-color: white;
margin: 5px;
margin-left: 5%;
margin-right: 5%;
}
td {
font-size: 80%;
}
.shell {
color: white;
}
pre.shell {
border: 4px ridge;
border-color: gray;
padding: 10px;
margin: 5px;
margin-left: 20px;
margin-right: 40px;
background-color: black;
}
form.demo {
background-color: lightgray;
border: 4px outset;
border-color: lightgray;
padding: 10px;
margin-right: 40%;
}

View File

@@ -0,0 +1,451 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : étendre le testeur unitaire avec des classes d'attentes supplémentaires</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les attentes</h1>
This page...
<ul>
<li>
Utiliser les attentes <a href="#fantaisie">pour des tests
plus précis avec des objets fantaisie</a>
</li>
<li>
<a href="#comportement">Changer le comportement d'un objet fantaisie</a>
avec des attentes
</li>
<li>
<a href="#etendre">Créer des attentes</a>
</li>
<li>
Par dessous SimpleTest <a href="#unitaire">utilise des classes d'attente</a>
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="fantaisie"></a>Plus de contrôle sur les objets fantaisie</h2>
<p>
Le comportement par défaut des
<a href="mock_objects_documentation.html">objets fantaisie</a> dans
<a href="http://sourceforge.net/projects/simpletest/">SimpleTest</a>
est soit une correspondance identique sur l'argument,
soit l'acceptation de n'importe quel argument.
Pour la plupart des tests, c'est suffisant.
Cependant il est parfois nécessaire de ramollir un scénario de test.
</p>
<p>
Un des endroits où un test peut être trop serré
est la reconnaissance textuelle. Prenons l'exemple
d'un composant qui produirait un message d'erreur
utile lorsque quelque chose plante. Il serait utile de tester
que l'erreur correcte est renvoyée,
mais le texte proprement dit risque d'être plutôt long.
Si vous testez le texte dans son ensemble alors
à chaque modification de ce même message
-- même un point ou une virgule -- vous aurez
à revenir sur la suite de test pour la modifier.
</p>
<p>
Voici un cas concret, nous avons un service d'actualités
qui a échoué dans sa tentative de connexion à sa source distante.
<pre>
<strong>class NewsService {
...
function publish($writer) {
if (! $this-&gt;isConnected()) {
$writer-&gt;write('Cannot connect to news service "' .
$this-&gt;_name . '" at this time. ' .
'Please try again later.');
}
...
}
}</strong>
</pre>
Là il envoie son contenu vers un classe <span class="new_code">Writer</span>.
Nous pourrions tester ce comportement avec un <span class="new_code">MockWriter</span>...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {<strong>
$writer = new MockWriter($this);
$writer-&gt;expectOnce('write', array(
'Cannot connect to news service ' .
'"BBC News" at this time. ' .
'Please try again later.'));
$service = new NewsService('BBC News');
$service-&gt;publish($writer);
$writer-&gt;tally();</strong>
}
}
</pre>
C'est un bon exemple d'un test fragile.
Si nous décidons d'ajouter des instructions complémentaires,
par exemple proposer une source d'actualités alternative,
nous casserons nos tests par la même occasion sans pourtant
avoir modifié une seule fonctionnalité.
</p>
<p>
Pour contourner ce problème, nous voudrions utiliser
un test avec une expression rationnelle plutôt
qu'une correspondance exacte. Nous pouvons y parvenir avec...
<pre>
class TestOfNewsService extends UnitTestCase {
...
function testConnectionFailure() {
$writer = new MockWriter($this);<strong>
$writer-&gt;expectOnce(
'write',
array(new PatternExpectation('/cannot connect/i')));</strong>
$service = new NewsService('BBC News');
$service-&gt;publish($writer);
$writer-&gt;tally();
}
}
</pre>
Plutôt que de transmettre le paramètre attendu au <span class="new_code">MockWriter</span>,
nous envoyons une classe d'attente appelée <span class="new_code">PatternExpectation</span>.
L'objet fantaisie est suffisamment élégant pour reconnaître
qu'il s'agit d'un truc spécial et pour le traiter différemment.
Plutôt que de comparer l'argument entrant à cet objet,
il utilise l'objet attente lui-même pour exécuter le test.
</p>
<p>
<span class="new_code">PatternExpectation</span> utilise
l'expression rationnelle pour la comparaison avec son constructeur.
A chaque fois qu'une comparaison est fait à travers
<span class="new_code">MockWriter</span> par rapport à cette classe attente,
elle fera un <span class="new_code">preg_match()</span> avec ce motif.
Dans notre scénario de test ci-dessus, aussi longtemps
que la chaîne "cannot connect" apparaît dans le texte,
la fantaisie transmettra un succès au testeur unitaire.
Peu importe le reste du texte.
</p>
<p>
Les classes attente possibles sont...
<table><tbody>
<tr>
<td><span class="new_code">AnythingExpectation</span></td>
<td>Sera toujours validé</td>
</tr>
<tr>
<td><span class="new_code">EqualExpectation</span></td>
<td>Une égalité, plutôt que la plus forte comparaison à l'identique</td>
</tr>
<tr>
<td><span class="new_code">NotEqualExpectation</span></td>
<td>Une comparaison sur la non-égalité</td>
</tr>
<tr>
<td><span class="new_code">IndenticalExpectation</span></td>
<td>La vérification par défaut de l'objet fantaisie qui doit correspondre exactement</td>
</tr>
<tr>
<td><span class="new_code">NotIndenticalExpectation</span></td>
<td>Inverse la logique de l'objet fantaisie</td>
</tr>
<tr>
<td><span class="new_code">PatternExpectation</span></td>
<td>Utilise une expression rationnelle Perl pour comparer une chaîne</td>
</tr>
<tr>
<td><span class="new_code">NoPatternExpectation</span></td>
<td>Passe seulement si l'expression rationnelle Perl échoue</td>
</tr>
<tr>
<td><span class="new_code">IsAExpectation</span></td>
<td>Vérifie le type ou le nom de la classe uniquement</td>
</tr>
<tr>
<td><span class="new_code">NotAExpectation</span></td>
<td>L'opposé de <span class="new_code">IsAExpectation</span>
</td>
</tr>
<tr>
<td><span class="new_code">MethodExistsExpectation</span></td>
<td>Vérifie si la méthode est disponible sur un objet</td>
</tr>
<tr>
<td><span class="new_code">TrueExpectation</span></td>
<td>Accepte n'importe quelle variable PHP qui vaut vrai</td>
</tr>
<tr>
<td><span class="new_code">FalseExpectation</span></td>
<td>Accepte n'importe quelle variable PHP qui vaut faux</td>
</tr>
</tbody></table>
La plupart utilisent la valeur attendue dans le constructeur.
Les exceptions sont les vérifications sur motif,
qui utilisent une expression rationnelle, ainsi que
<span class="new_code">IsAExpectation</span> et <span class="new_code">NotAExpectation</span>,
qui prennent un type ou un nom de classe comme chaîne.
</p>
<h2>
<a class="target" name="comportement"></a>Utiliser les attentes pour contrôler les bouchons serveur</h2>
<p>
Les classes attente peuvent servir à autre chose
que l'envoi d'assertions depuis les objets fantaisie,
afin de choisir le comportement d'un
<a href="mock_objects_documentation.html">objet fantaisie</a>
ou celui d'un <a href="server_stubs_documentation.html">bouchon serveur</a>.
A chaque fois qu'une liste d'arguments est donnée,
une liste d'objets d'attente peut être insérée à la place.
</p>
<p>
Mettons que nous voulons qu'un bouchon serveur
d'autorisation simule une connexion réussie seulement
si il reçoit un objet de session valide.
Nous pouvons y arriver avec ce qui suit...
<pre>
Stub::generate('Authorisation');
<strong>
$authorisation = new StubAuthorisation();
$authorisation-&gt;returns(
'isAllowed',
true,
array(new IsAExpectation('Session', 'Must be a session')));
$authorisation-&gt;returns('isAllowed', false);</strong>
</pre>
Le comportement par défaut du bouchon serveur
est défini pour renvoyer <span class="new_code">false</span>
quand <span class="new_code">isAllowed</span> est appelé.
Lorsque nous appelons cette méthode avec un unique paramètre
qui est un objet <span class="new_code">Session</span>, il renverra <span class="new_code">true</span>.
Nous avons aussi ajouté un deuxième paramètre comme message.
Il sera affiché dans le message d'erreur de l'objet fantaisie
si l'attente est la cause de l'échec.
</p>
<p>
Ce niveau de sophistication est rarement utile :
il n'est inclut que pour être complet.
</p>
<h2>
<a class="target" name="etendre"></a>Créer vos propres attentes</h2>
<p>
Les classes d'attentes ont une structure très simple.
Tellement simple qu'il devient très simple de créer
vos propres version de logique pour des tests utilisés couramment.
</p>
<p>
Par exemple voici la création d'une classe pour tester
la validité d'adresses IP. Pour fonctionner correctement
avec les bouchons serveurs et les objets fantaisie,
cette nouvelle classe d'attente devrait étendre
<span class="new_code">SimpleExpectation</span> ou une autre de ses sous-classes...
<pre>
<strong>class ValidIp extends SimpleExpectation {
function test($ip) {
return (ip2long($ip) != -1);
}
function testMessage($ip) {
return "Address [$ip] should be a valid IP address";
}
}</strong>
</pre>
Il n'y a véritablement que deux méthodes à mettre en place.
La méthode <span class="new_code">test()</span> devrait renvoyer un <span class="new_code">true</span>
si l'attente doit passer, et une erreur <span class="new_code">false</span>
dans le cas contraire. La méthode <span class="new_code">testMessage()</span>
ne devrait renvoyer que du texte utile à la compréhension du test en lui-même.
</p>
<p>
Cette classe peut désormais être employée à la place
des classes d'attente précédentes.
</p>
<p>
Voici un exemple plus typique, vérifier un hash...
<pre>
<strong>class JustField extends EqualExpectation {
private $key;
function __construct($key, $expected) {
parent::__construct($expected);
$this-&gt;key = $key;
}
function test($compare) {
if (! isset($compare[$this-&gt;key])) {
return false;
}
return parent::test($compare[$this-&gt;key]);
}
function testMessage($compare) {
if (! isset($compare[$this-&gt;key])) {
return 'Key [' . $this-&gt;key . '] does not exist';
}
return 'Key [' . $this-&gt;key . '] -&gt; ' .
parent::testMessage($compare[$this-&gt;key]);
}
}</strong>
</pre>
L'habitude a été prise pour séparer les clauses du message avec
"&amp;nbsp;-&gt;&amp;nbsp;".
Cela permet aux outils dérivés de reformater la sortie.
</p>
<p>
Supposons qu'un authentificateur s'attend à recevoir
une ligne de base de données correspondant à l'utilisateur,
et que nous avons juste besoin de valider le nom d'utilisateur.
Nous pouvons le faire très simplement avec...
<pre>
$mock-&gt;expectOnce('authenticate',
array(new JustKey('username', 'marcus')));
</pre>
</p>
<h2>
<a class="target" name="unitaire"></a>Sous le capot du testeur unitaire</h2>
<p>
Le <a href="http://sourceforge.net/projects/simpletest/">framework
de test unitaire SimpleTest</a> utilise aussi dans son coeur
des classes d'attente pour
la <a href="unit_test_documentation.html">classe UnitTestCase</a>.
Nous pouvons aussi tirer parti de ces mécanismes pour réutiliser
nos propres classes attente à l'intérieur même des suites de test.
</p>
<p>
La méthode la plus directe est d'utiliser la méthode
<span class="new_code">SimpleTest::assert()</span> pour effectuer le test...
<pre>
<strong>class TestOfNetworking extends UnitTestCase {
...
function testGetValidIp() {
$server = &amp;new Server();
$this-&gt;assert(
new ValidIp(),
$server-&gt;getIp(),
'Server IP address-&gt;%s');
}
}</strong>
</pre>
<span class="new_code">assert()</span> testera toute attente directement.
</p>
<p>
C'est plutôt sale par rapport à notre syntaxe habituelle
du type <span class="new_code">assert...()</span>.
</p>
<p>
Pour un cas aussi simple, nous créons d'ordinaire une méthode
d'assertion distincte en utilisant la classe d'attente.
Supposons un instant que notre attente soit un peu plus
compliquée et que par conséquent nous souhaitions la réutiliser,
nous obtenons...
<pre>
class TestOfNetworking extends UnitTestCase {
...<strong>
function assertValidIp($ip, $message = '%s') {
$this-&gt;assertExpectation(new ValidIp(), $ip, $message);
}</strong>
function testGetValidIp() {
$server = &amp;new Server();<strong>
$this-&gt;assertValidIp(
$server-&gt;getIp(),
'Server IP address-&gt;%s');</strong>
}
}
</pre>
It is rare to need the expectations for more than pattern
matching, but these facilities do allow testers to build
some sort of domain language for testing their application.
Also, complex expectation classes could make the tests
harder to read and debug.
In effect extending the test framework to create their own tool set.
Il est assez rare que le besoin d'une attente dépasse
le stade de la reconnaissance d'un motif, mais ils permettent
aux testeurs de construire leur propre langage dédié ou DSL
(Domain Specific Language) pour tester leurs applications.
Attention, les classes d'attente complexes peuvent rendre
les tests difficiles à lire et à déboguer.
Ces mécanismes sont véritablement là pour les auteurs
de système qui étendront le framework de test
pour leurs propres outils de test.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
Les attentes imitent les contraintes dans
<a href="http://www.jmock.org/">JMock</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète pour SimpleTest</a>
réalisé avec PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,363 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : tester des formulaires HTML</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les tests de formulaire</h1>
This page...
<ul>
<li>
Modifier les valeurs d'un formulaire et
<a href="#submit">réussir à transmettre un simple formulaire</a>
</li>
<li>
Gérer des <a href="#multiple">objets à valeurs multiples</a>
en initialisant des listes.
</li>
<li>
Le cas des formulaires utilisant Javascript pour
modifier <a href="#hidden-field">un champ caché</a>
</li>
<li>
<a href="#brut">Envoi brut</a> quand il n'existe pas de bouton à cliquer.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="submit"></a>Valider un formulaire simple</h2>
<p>
Lorsqu'une page est téléchargée par <span class="new_code">WebTestCase</span>
en utilisant <span class="new_code">get()</span> ou <span class="new_code">post()</span>
le contenu de la page est automatiquement analysé.
De cette analyse découle le fait que toutes les commandes
à l'intérieur de la balise &lt;form&gt; sont disponibles
depuis l'intérieur du scénario de test.
Prenons par exemple cet extrait de code HTML...
<pre>
&lt;form&gt;
&lt;input type="text" name="a" value="A default" /&gt;
&lt;input type="submit" value="Go" /&gt;
&lt;/form&gt;
</pre>
Il ressemble à...
</p>
<p>
<form class="demo">
<input type="text" name="a" value="A default">
<input type="submit" value="Go">
</form>
</p>
<p>
Nous pouvons naviguer vers ce code, via le site
<a href="http://www.lastcraft.com/form_testing_documentation.php">LastCraft</a>,
avec le test suivant...
<pre>
class SimpleFormTests extends WebTestCase {<strong>
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', 'A default');
}</strong>
}
</pre>
Directement après le chargement de la page toutes les commandes HTML
sont initiées avec leur valeur par défaut, comme elles apparaîtraient
dans un navigateur web. L'assertion teste qu'un objet HTML
avec le nom "a" existe dans la page
et qu'il contient la valeur "A default".
</p>
<p>
Nous pourrions retourner le formulaire tout de suite...
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('a', <strong>new PatternExpectation('/default/')</strong>);
}
}
</pre>
Mais d'abord nous allons changer la valeur du champ texte.
Ce n'est qu'après que nous le transmettrons...
<pre>
class SimpleFormTests extends WebTestCase {
function testDefaultValue() {
$this-&gt;get('http://www.my-site.com/');
$this-&gt;assertField('a', 'A default');<strong>
$this-&gt;setField('a', 'New value');
$this-&gt;clickSubmit('Go');</strong>
}
}
</pre>
Parce que nous n'avons spécifié ni attribut "method"
sur la balise form, ni attribut "action",
le scénario de test suivra le comportement classique d'un navigateur :
transmission des données avec une requête <em>GET</em>
vers la même page. En règle générale SimpleTest essaie d'émuler
le comportement typique d'un navigateur autant que possible,
plutôt que d'essayer d'attraper des attributs manquants sur les balises.
La raison est simple : la cible d'un framework de test est
la logique d'une application PHP, pas les erreurs
-- de syntaxe ou autres -- du code HTML.
Pour les erreurs HTML, d'autres outils tel
<a href="http://www.w3.org/People/Raggett/tidy/">HTMLTidy</a>
devraient être employés, ou même n'importe lequel des validateurs HTML et CSS
déjà sur le marché.
</p>
<p>
Si un champ manque dans n'importe quel formulaire ou si
une option est indisponible alors <span class="new_code">WebTestCase::setField()</span>
renverra <span class="new_code">false</span>. Par exemple, supposons que
nous souhaitons vérifier qu'une option "Superuser"
n'est pas présente dans ce formulaire...
<pre>
<strong>Select type of user to add:</strong>
&lt;select name="type"&gt;
&lt;option&gt;Subscriber&lt;/option&gt;
&lt;option&gt;Author&lt;/option&gt;
&lt;option&gt;Administrator&lt;/option&gt;
&lt;/select&gt;
</pre>
Qui ressemble à...
</p>
<p>
<form class="demo">
<strong>Select type of user to add:</strong>
<select name="type">
<option>Subscriber</option>
<option>Author</option>
<option>Administrator</option>
</select>
</form>
</p>
<p>
Le test suivant le confirmera...
<pre>
class SimpleFormTests extends WebTestCase {
...
function testNoSuperuserChoiceAvailable() {<strong>
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertFalse($this-&gt;setField('type', 'Superuser'));</strong>
}
}
</pre>
La sélection ne sera pas changée si la nouvelle valeur n'est pas une des options.
</p>
<p>
Voici la liste complète des objets supportés à aujourd'hui...
<ul>
<li>Champs texte, y compris les champs masqués (hidden) ou cryptés (password).</li>
<li>Boutons submit, en incluant aussi la balise button, mais pas encore les boutons reset</li>
<li>Aires texte (textarea) avec leur gestion des retours à la ligne (wrap).</li>
<li>Cases à cocher, y compris les cases à cocher multiples dans un même formulaire.</li>
<li>Listes à menu déroulant, y compris celles à sélections multiples.</li>
<li>Boutons radio.</li>
<li>Images.</li>
</ul>
</p>
<p>
Le navigateur proposé par SimpleTest émule les actions
qui peuvent être réalisées par un utilisateur sur
une page HTML standard. Javascript n'est pas supporté et
il y a peu de chance pour qu'il le soit prochainement.
</p>
<p>
Une attention particulière doit être porté aux techniques Javascript
qui changent la valeur d'un champ caché : elles ne peuvent pas être
réalisées avec les commandes classiques de SimpleTest.
Une méthode alternative est proposée plus loin.
</p>
<h2>
<a class="target" name="multiple"></a>Champs à valeurs multiples</h2>
<p>
SimpleTest peut gérer deux types de commandes à valeur multiple :
les menus déroulants à sélection multiple et les cases à cocher
avec le même nom à l'intérieur même d'un formulaire.
La nature de ceux-ci implique que leur initialisation
et leur test sont légèrement différents.
Voici un exemple avec des cases à cocher...
<pre>
&lt;form class="demo"&gt;
<strong>Create privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="c" checked&gt;&lt;br&gt;
<strong>Retrieve privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="r" checked&gt;&lt;br&gt;
<strong>Update privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="u" checked&gt;&lt;br&gt;
<strong>Destroy privileges allowed:</strong>
&lt;input type="checkbox" name="crud" value="d" checked&gt;&lt;br&gt;
&lt;input type="submit" value="Enable Privileges"&gt;
&lt;/form&gt;
</pre>
Qui se traduit par...
</p>
<p>
<form class="demo">
<strong>Create privileges allowed:</strong>
<input type="checkbox" name="crud" value="c" checked><br>
<strong>Retrieve privileges allowed:</strong>
<input type="checkbox" name="crud" value="r" checked><br>
<strong>Update privileges allowed:</strong>
<input type="checkbox" name="crud" value="u" checked><br>
<strong>Destroy privileges allowed:</strong>
<input type="checkbox" name="crud" value="d" checked><br>
<input type="submit" value="Enable Privileges">
</form>
</p>
<p>
Si nous souhaitons désactiver tous les privilèges sauf
ceux de téléchargement (Retrieve) et transmettre cette information,
nous pouvons y arriver par...
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testDisableNastyPrivileges() {
$this-&gt;get('http://www.lastcraft.com/form_testing_documentation.php');
$this-&gt;assertField('crud', array('c', 'r', 'u', 'd'));
$this-&gt;setField('crud', array('r'));
$this-&gt;clickSubmit('Enable Privileges');
}</strong>
}
</pre>
Plutôt que d'initier le champ à une valeur unique,
nous lui donnons une liste de valeurs.
Nous faisons la même chose pour tester les valeurs attendues.
Nous pouvons écrire d'autres bouts de code de test
pour confirmer cet effet, peut-être en nous connectant
comme utilisateur et en essayant d'effectuer une mise à jour.
</p>
<h2>
<a class="target" name="hidden-field"></a>Formulaires utilisant Javascript pour changer un champ caché</h2>
<p>
Si vous souhaitez tester un formulaire dépendant de Javascript
pour la modification d'un champ caché, vous ne pouvez pas
simplement utiliser setField().
Le code suivant <em>ne fonctionnera pas</em> :
<pre>
class SimpleFormTests extends WebTestCase {
function testEmulateMyJavascriptForm() {
<strong>// This does *not* work</strong>
$this-&gt;setField('a_hidden_field', '123');
$this-&gt;clickSubmit('OK');
}
}
</pre>
A la place, vous aurez besoin d'ajouter le paramètre supplémentaire
du formulaire à la méthode clickSubmit() :
<pre>
class SimpleFormTests extends WebTestCase {
function testMyJavascriptForm() {
<strong>$this-&gt;clickSubmit('OK', array('a_hidden_field'=&gt;'123'));</strong>
}
}
</pre>
</p>
<p>
N'oubliez pas que de la sorte, vous êtes effectivement en train
de court-circuitez une partie de votre application (le code Javascript
dans le formulaire) et que peut-être serait-il plus prudent
d'utiliser un outil comme
<a href="http://selenium.openqa.org/">Selenium</a> pour mettre sur pied
un test complet.
</p>
<h2>
<a class="target" name="brut"></a>Envoi brut</h2>
<p>
Si vous souhaitez tester un gestionnaire de formulaire
mais que vous ne l'avez pas écrit ou que vous n'y avez
pas encore accès, vous pouvez créer un envoi de formulaire à la main.
<pre>
class SimpleFormTests extends WebTestCase {
...<strong>
function testAttemptedHack() {
$this-&gt;post(
'http://www.my-site.com/add_user.php',
array('type' =&gt; 'superuser'));
$this-&gt;assertNoUnwantedPattern('/user created/i');
}</strong>
}
</pre>
En ajoutant des données à la méthode <span class="new_code">WebTestCase::post()</span>,
nous émulons la transmission d'un formulaire.
D'ordinaire, vous ne ferez cela que pour parer au plus pressé,
ou alors si vous espérez un tiers (javascript ?) transmette le formulaire.
Il reste quand même exception : si vous souhaitez vous protégez
d'attaques de type "spoofing".
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,265 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : Grouper des tests</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le groupement des tests</h1>
This page...
<ul>
<li>
Plusieurs approches pour <a href="#group">grouper des tests</a> ensemble.
</li>
<li>
Combiner des groupes des tests dans des
<a href="#plus-haut">groupes plus grands</a>.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="grouper"></a>Grouper des tests</h2>
<p>
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...
<pre>
<strong>&lt;?php
require_once(dirname(__FILE__) . '/simpletest/autorun.php');
require_once(dirname(__FILE__) . '/../classes/io.php');
class FileTester extends UnitTestCase {
...
}
class SocketTester extends UnitTestCase {
...
}
?&gt;</strong>
</pre>
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.
</p>
<p>
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 <span class="new_code">UnitTestCase</span>
ou de <span class="new_code">WebTestCase</span>.
Bien sûr vous ne souhaitez pas les lancer en tant que
scénario de tests : il suffit alors de les identifier
comme "abstraites"...
<pre>
<strong>abstract</strong> class MyFileTestCase extends UnitTestCase {
...
}
class FileTester extends MyFileTestCase { ... }
class SocketTester extends UnitTestCase { ... }
</pre>
La classe <span class="new_code">FileTester</span> ne contient aucun test véritable,
il s'agit d'une classe de base pour d'autres scénarios de test.
</p>
<p>
Nous appelons ce fichier <em>file_test.php</em>.
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.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('file_test.php');
?&gt;
</pre>
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...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
<strong>$this-&gt;addFile('file_test.php');</strong>
}
}
?&gt;
</pre>
Voici ce qui arrive : la class <span class="new_code">TestSuite</span>
effecturera le <span class="new_code">require_once()</span> 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.
</p>
<p>
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...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class AllFileTests extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;collect(dirname(__FILE__) . '/unit',
new SimplePatternCollector('/_test.php/'));
}
}
?&gt;
</pre>
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 <span class="new_code">SimplePatternCollector</span> pour
filtrer en fonction d'un motif dans le nom de fichier,
mais c'est son usage le plus courant.
</p>
<p>
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.
</p>
<p>
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 <span class="new_code">addFile()</span>
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.
</p>
<p>
Les tests chargés avec la méthode <span class="new_code">addFile</span> 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.
</p>
<h2>
<a class="target" name="plus-haut"></a>Groupements de plus haut niveau</h2>
<p>
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.
</p>
<p>
Tout ce que nous avons décrit avec des scripts de tests
s'applique pareillement avec des <span class="new_code">TestSuite</span>s...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
}
}</strong>
?&gt;
</pre>
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.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class BigTestSuite extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('file_tests.php');
<strong>$this-&gt;addFile('some_other_test.php');</strong>
}
}
?&gt;
</pre>
Petite précision, en cas de double inclusion, seule la première instance
sera lancée.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,576 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Prise en main rapide de SimpleTest pour PHP -
Tests unitaire et objets fantaisie pour PHP
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Prise en main rapide de SimpleTest</h1>
This page...
<ul>
<li>
<a href="#unit">Utiliser le testeur rapidement</a>
avec un exemple.
</li>
<li>
<a href="#group">Groupes de tests</a>
pour tester en un seul clic.
</li>
<li>
<a href="#mock">Utiliser les objets fantaisie</a>
pour faciliter les tests et gagner en contrôle.
</li>
<li>
<a href="#web">Tester des pages web</a>
au niveau de l'HTML.
</li>
</ul>
<div class="content">
<p>
Le présent article présuppose que vous soyez familier avec
le concept de tests unitaires ainsi que celui de développement
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 complète, particulièrement si
vous découvrez les tests unitaires, consultez la
<a href="http://www.lastcraft.com/unit_test_documentation.php">documentation
en cours</a>, et pour des exemples de scénarios de test,
consultez le
<a href="http://www.lastcraft.com/first_test_tutorial.php">tutorial
sur les tests unitaires</a>.
</p>
<h2>
<a class="target" name="unit"></a>Utiliser le testeur rapidement</h2>
<p>
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 <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>.
</p>
<p>
Ce qui rend cet outil immédiatement utile pour un développeur PHP,
c'est son navigateur web interne.
Il permet des tests qui parcourent des sites web, remplissent
des formulaires et testent le contenu des pages.
Etre capable d'écrire ces tests en PHP veut dire qu'il devient
facile d'écrire des tests de recette (ou d'intégration).
Un exemple serait de confirmer qu'un utilisateur a bien été ajouté
dans une base de données après s'être enregistré sur une site web.
</p>
<p>
La démonstration 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
<span class="new_code">Log</span> dans <em>classes/Log.php</em>. Commençons
par créer un script de test, appelé
<em>tests/log_test.php</em>. Son contenu est le suivant...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
require_once('../classes/log.php');
class TestOfLogging extends <strong>UnitTestCase</strong> {
}
?&gt;
</pre>
Ici le répertoire <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.
Le fichier "autorun.php" fait plus que juste inclure
les éléments de SimpleTest : il lance aussi les tests pour nous.
</p>
<p>
<span class="new_code">TestOfLogging</span> est notre premier scénario de test
et il est pour l'instant vide.
Chaque scénario de test est une classe qui étend une des classes
de base de SimpleTest. Nous pouvons avoir autant de classes de ce type
que nous voulons.
</p>
<p>
Avec ces trois lignes d'échafaudage
l'inclusion de notre classe <span class="new_code">Log</span>, nous avons une suite
de tests. Mais pas encore de test !
</p>
<p>
Pour notre premier test, supposons que la classe <span class="new_code">Log</span>
prenne le nom du fichier à écrire au sein du constructeur,
et que nous avons un répertoire temporaire dans lequel placer
ce fichier.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
class TestOfLogging extends UnitTestCase {
function <strong>testLogCreatesNewFileOnFirstMessage()</strong> {
@unlink('/temp/test.log');
$log = new Log('/temp/test.log');
<strong>$this-&gt;assertFalse(file_exists('/temp/test.log'));</strong>
$log-&gt;message('Should write this to a file');
<strong>$this-&gt;assertTrue(file_exists('/temp/test.log'));</strong>
}
}
?&gt;
</pre>
Au lancement du scénario de test, toutes les méthodes qui
commencent avec la chaîne <span class="new_code">test</span> sont
identifiées puis exécutées.
Si la méthode commence par <span class="new_code">test</span>, c'est un test.
Remarquez bien le nom très long de notre exemple :
<span class="new_code">testLogCreatesNewFileOnFirstMessage()</span>.
C'est bel et bien délibéré : ce style est considéré désirable
et il rend la sortie du test plus lisible.
</p>
<p>
D'ordinaire nous avons bien plusieurs méthodes de tests.
Mais ce sera pour plus tard.
</p>
<p>
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é via un appel à <span class="new_code">print</span>code&gt;.
</p>
<p>
Pour voir ces résultats lançons effectivement les tests.
Aucun autre code n'est nécessaire, il suffit d'ouvrir
la page dans un navigateur.
</p>
<p>
En cas échec, l'affichage ressemble à...
<div class="demo">
<h1>TestOfLogging</h1>
<span class="fail">Fail</span>: testcreatingnewfile-&gt;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 à :
<pre>
&lt;?php<strong>
class Log {
function Log($file_path) {
}
function message() {
}
}</strong>
?&gt;
</pre>
C'est largement plus sympathique d'écrire le code après le test.
Plus que sympatique même - cette technique s'appelle
"Développement Piloté par les Tests" ou
"Test Driven Development" en anglais.
</p>
<p>
Pour plus de renseignements sur le testeur, voyez la
<a href="unit_test_documentation.html">documentation pour les tests de régression</a>.
</p>
<h2>
<a class="target" name="group"></a>Construire des groupes de tests</h2>
<p>
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.
</p>
<p>
Notre première étape est de créer un nouveau fichier appelé
<em>tests/all_tests.php</em> et d'y inclure le code suivant...
<pre>
&lt;?php
<strong>require_once('simpletest/autorun.php');</strong>
class AllTests extends <strong>TestSuite</strong> {
function AllTests() {
$this-&gt;TestSuite(<strong>'All tests'</strong>);
<strong>$this-&gt;addFile('log_test.php');</strong>
}
}
?&gt;
</pre>
L'inclusion de "autorun" permettra à notre future suite
de tests d'être lancée juste en invoquant ce script.
</p>
<p>
La sous-classe <span class="new_code">TestSuite</span> doit chaîner
son constructeur. Cette limitation sera supprimée dans
les versions à venir.
</p>
<p>
The method <span class="new_code">TestSuite::addFile()</span>
will include the test case file and read any new classes
that are descended from <span class="new_code">SimpleTestCase</span>.
Cette méthode <span class="new_code">TestSuite::addTestFile()</span> va
inclure le fichier de scénarios de test et lire parmi
toutes les nouvelles classes créées celles qui sont issues
de <span class="new_code">SimpleTestCase</span>.
<span class="new_code">UnitTestCase</span> est juste un exemple de classe dérivée
depuis <span class="new_code">SimpleTestCase</span> et vous pouvez créer les vôtres.
<span class="new_code">TestSuite::addFile()</span> peut aussi inclure d'autres suites.
</p>
<p>
La classe ne sera pas encore instanciée.
Quand la suite de tests est lancée, elle construira chaque instance
une fois le test atteint, et le détuira juste ensuite.
Cela veut dire que le constructeur n'est lancé qu'une fois avant
chaque initialisation de ce scénario de test et que le destructeur
est lui aussi lancé avant que le test suivant ne commence.
</p>
<p>
Il est commun de grouper des scénarios de test dans des super-classes
qui ne sont pas sensées être lancées, mais qui deviennent une classe de base
pour d'autres tests.
Pour que "autorun" fonctionne proprement les fichiers
des scénarios de test ne devraient pas lancer aveuglement
d'autres extensions de scénarios de test qui ne lanceraient pas
effectivement des tests.
Cela pourrait aboutir à un mauvais comptages des scénarios de test
pendant la procédure.
Pas vraiement un problème majeure, mais pour éviter cet inconvénient
il suffit de marquer vos classes de base comme <span class="new_code">abstract</span>.
SimpleTest ne lance pas les classes abstraites. Et si vous utilisez encore
PHP4 alors une directive <span class="new_code">SimpleTestOptions::ignore()</span>
dans votre fichier de scénario de test aura le même effet.
</p>
<p>
Par ailleurs, le fichier avec le scénario de test ne devrait pas
avoir été inclus ailleurs. Sinon aucun scénario de test
ne sera inclus à ce groupe.
Ceci pourrait se transformer en un problème plus grave :
si des fichiers ont déjà été inclus par PHP alors la méthode
<span class="new_code">TestSuite::addFile()</span> ne les détectera pas.
</p>
<p>
Pour afficher les résultats, il est seulement nécessaire
d'invoquer <em>tests/all_tests.php</em> à partir du serveur
web.
</p>
<p>
Pour plus de renseignements des groupes de tests, voyez le
<a href="group_test_documentation.html">documentation sur le groupement des tests</a>.
</p>
<h2>
<a class="target" name="mock"></a>Utiliser les objets fantaisie</h2>
<p>
Avançons un peu plus dans le futur.
</p>
<p>
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
<span class="new_code">SessionPool</span>. Nous voulons tester une méthode
qui ressemblera probablement à quelque chose comme...
<pre><strong>
class SessionPool {
...
function logIn($username) {
...
$this-&gt;_log-&gt;message('User $username logged in.');
...
}
...
}
</strong>
</pre>
Avec le concept de "réutilisation de code" comme fil
conducteur, nous utilisons notre class <span class="new_code">Log</span>. Un
scénario de test classique ressemblera peut-être à...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
<strong>require_once('../classes/session_pool.php');</strong>
class <strong>TestOfSessionLogging</strong> extends UnitTestCase {
function setUp() {
<strong>@unlink('/temp/test.log');</strong>
}
function tearDown() {
<strong>@unlink('/temp/test.log');</strong>
}
function testLoggingInIsLogged() {
<strong>$log = new Log('/temp/test.log');
$session_pool = &amp;new SessionPool($log);
$session_pool-&gt;logIn('fred');</strong>
$messages = file('/temp/test.log');
$this-&gt;assertEqual($messages[0], "User fred logged in.<strong>\n</strong>");
}
}
?&gt;
</pre>
Nous expliquerons les méthodes <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> plus tard.
</p>
<p>
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 <span class="new_code">Log</span> et ce test. Que se
passerait-il si nous n'utilisions plus de fichiers, mais la
bibliothèque <em>syslog</em> à la place ?
Cela veut dire que notre test <span class="new_code">TestOfSessionLogging</span>
enverra un échec alors même qu'il ne teste pas Logging.
</p>
<p>
Il est aussi fragile sur des petites retouches. 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 ?
</p>
<p>
L'unique partie à tester réellement est l'envoi d'un
message précis au loggueur.
Nous pouvons réduire 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.
</p>
<p>
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.
<p>
</p>
Trop beau pour être vrai ? Pas vraiement on peut créer un tel
objet très facilement...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('../classes/log.php');
require_once('../classes/session_pool.php');
<strong>Mock::generate('Log');</strong>
class TestOfSessionLogging extends UnitTestCase {
function testLoggingInIsLogged() {<strong>
$log = &amp;new MockLog();
$log-&gt;expectOnce('message', array('User fred logged in.'));</strong>
$session_pool = &amp;new SessionPool(<strong>$log</strong>);
$session_pool-&gt;logIn('fred');
}
}
?&gt;
</pre>
L'appel <span class="new_code">Mock::generate()</span> a généré
une nouvelle classe appelé <span class="new_code">MockLog</span>.
Cela ressemble à un clone identique, sauf que nous pouvons
y adjoindre du code de test.
C'est ce que fait <span class="new_code">expectOnce()</span>.
Cela dit que si <span class="new_code">message()</span> m'est appelé,
il a intérêt à l'être avec le paramètre
"User fred logged in.".
</p>
<p>
L'appel <span class="new_code">tally()</span> 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 à <span class="new_code">message()</span> est
invoqué sur l'objet <span class="new_code">MockLog</span> par le code
<span class="new_code">SessionPool::logIn()</span>.
L'appel <span class="new_code">mock</span> 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
pour ne pas avoir à tester tous les paramètres d'un appel
alors que vous ne souhaitez qu'en tester un.
</p>
<p>
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.
</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>
<p>
Pour plus de renseignements sur les objets fantaisie, voyez le
<a href="mock_objects_documentation.html">documentation sur les objets fantaisie</a>.
</p>
<h2>
<a class="target" name="web"></a>Tester une page web</h2>
<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 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.
</p>
<p>
Effectuer un test web via SimpleTest reste assez primitif :
il n'y a pas de javascript par exemple.
La plupart des autres opérations d'un navigateur sont simulées.
</p>
<p>
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.
<pre>
&lt;?php
require_once('simpletest/autorun.php');
<strong>require_once('simpletest/web_tester.php');</strong>
class TestOfAbout extends <strong>WebTestCase</strong> {
function testOurAboutPageGivesFreeReignToOurEgo() {
<strong>$this-&gt;get('http://test-server/index.php');
$this-&gt;click('About');
$this-&gt;assertTitle('About why we are so great');
$this-&gt;assertText('We are really great');</strong>
}
}
?&gt;
</pre>
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.
</p>
<p>
Vous pouvez aussi naviguer à travers des formulaires...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('simpletest/web_tester.php');
class TestOfRankings extends WebTestCase {
function testWeAreTopOfGoogle() {
$this-&gt;get('http://google.com/');
$this-&gt;setField('q', 'simpletest');
$this-&gt;click("I'm Feeling Lucky");
$this-&gt;assertTitle('SimpleTest - Unit Testing for PHP');
}
}
?&gt;
</pre>
...même si cela pourrait constituer une violation
des documents juridiques de Google(tm).
</p>
<p>
Pour plus de renseignements sur comment tester une page web, voyez la
<a href="web_tester_documentation.html">documentation sur tester des scripts web</a>.
</p>
<p>
<a href="http://sourceforge.net/projects/simpletest/"><img src="http://sourceforge.net/sflogo.php?group_id=76550&amp;type=5" width="210" height="62" border="0" alt="SourceForge.net Logo"></a>
</p>
</div>
References and related information...
<ul>
<li>
<a href="https://sourceforge.net/project/showfiles.php?group_id=76550&amp;release_id=153280">Télécharger PHP SimpleTest</a>
depuis <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
L'<a href="http://simpletest.org/api/">API de SimpleTest pour développeur</a>
donne tous les détails sur les classes et assertions existantes.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,933 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : les objets fantaise</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les objets fantaisie</h1>
This page...
<ul>
<li>
<a href="#what">Que sont les objets fantaisie ?</a>
</li>
<li>
<a href="#creation">Créer des objets fantaisie</a>.
</li>
<li>
<a href="#expectations">Les objets fantaisie en tant que critiques</a> avec les attentes.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="what"></a>Que sont les objets fantaisie ?</h2>
<p>
Les objets fantaisie - ou "mock objects" en anglais -
ont deux rôles pendant un scénario de test : acteur et critique.
</p>
<p>
Le comportement d'acteur est celui de simuler
des objets difficiles à initialiser ou trop consommateurs
en temps pendant un test.
Le cas classique est celui de la connexion à une base de données.
Mettre sur pied une base de données de test au lancement
de chaque test ralentirait considérablement les tests
et en plus exigerait l'installation d'un moteur
de base de données ainsi que des données sur la machine de test.
Si nous pouvons simuler la connexion
et renvoyer des données à notre guise
alors non seulement nous gagnons en pragmatisme
sur les tests mais en sus nous pouvons nourrir
notre base avec des données falsifiées
et voir comment il répond. Nous pouvons
simuler une base de données en suspens ou
d'autres cas extrêmes sans avoir à créer
une véritable panne de base de données.
En d'autres termes nous pouvons gagner
en contrôle sur l'environnement de test.
</p>
<p>
Si les objets fantaisie ne se comportaient que comme
des acteurs alors on les connaîtrait sous le nom de
<a href="server_stubs_documentation.html">bouchons serveur</a>.
Il s'agissait originairement d'un patron de conception
identifié par Robert Binder (<a href="">Testing
object-oriented systems</a>: models, patterns, and tools,
Addison-Wesley) en 1999.
</p>
<p>
Un bouchon serveur est une simulation d'un objet ou d'un composant.
Il doit remplacer exactement un composant dans un système
en vue d'effectuer des tests ou un prototypage,
tout en restant ultra-léger.
Il permet aux tests de s'exécuter plus rapidement, ou
si la classe simulée n'a pas encore été écrite,
de se lancer tout court.
</p>
<p>
Cependant non seulement les objets fantaisie jouent
un rôle (en fournissant à la demande les valeurs requises)
mais en plus ils sont aussi sensibles aux messages qui
leur sont envoyés (par le biais d'attentes).
En posant les paramètres attendus d'une méthode
ils agissent comme des gardiens :
un appel sur eux doit être réalisé correctement.
Si les attentes ne sont pas atteintes ils nous épargnent
l'effort de l'écriture d'une assertion de test avec
échec en réalisant cette tâche à notre place.
</p>
<p>
Dans le cas d'une connexion à une base de données
imaginaire ils peuvent tester si la requête, disons SQL,
a bien été formé par l'objet qui utilise cette connexion.
Mettez-les sur pied avec des attentes assez précises
et vous verrez que vous n'aurez presque plus d'assertion à écrire manuellement.
</p>
<h2>
<a class="target" name="creation"></a>Créer des objets fantaisie</h2>
<p>
Tout ce dont nous avons besoin est une classe existante ou une interface,
par exemple une connexion à la base de données qui ressemblerait à...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query($sql) { }
function selectQuery($sql) { }
}</strong>
</pre>
Pour en créer sa version fantaisie nous devons juste
lancer le générateur...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
<strong>Mock::generate('DatabaseConnection');</strong>
</pre>
Ce code génère une classe clone appelée <span class="new_code">MockDatabaseConnection</span>.
Cette nouvelle classe lui ressemble en tout point,
sauf qu'elle ne fait rien du tout.
</p>
<p>
Cette nouvelle classe est génératlement
une sous-classe de <span class="new_code">DatabaseConnection</span>.
Malheureusement, il n'y as aucun moyen de créer une version fantaisie
d'une classe avec une méthode <span class="new_code">final</span> sans avoir
une version fonctionnelle de cette méthode.
Ce n'est pas pas très satisfaisant.
Si la cible est une interface ou si les méthodes <span class="new_code">final</span>
existent dans la classe cible, alors une toute nouvelle classe
est créée, elle implémente juste les même interfaces.
Si vous essayer de faire passer cette classe à travers un indice de type
qui spécifie le véritable nom de l'ancienne classe, alors il échouera.
Du code qui forcerait un indice de type tout en utilisant
des méthodes <span class="new_code">final</span> ne pourrait probablement pas être
testé efficacement avec des objets fantaisie.
</p>
<p>
Si vous voulez voir le code généré, il suffit de faire un <span class="new_code">print</span>
de la sortie de <span class="new_code">Mock::generate()</span>.
VOici le code généré pour la classe <span class="new_code">DatabaseConnection</span>
à la place de son interface...
<pre>
class MockDatabaseConnection extends DatabaseConnection {
public $mock;
protected $mocked_methods = array('databaseconnection', 'query', 'selectquery');
function MockDatabaseConnection() {
$this-&gt;mock = new SimpleMock();
$this-&gt;mock-&gt;disableExpectationNameChecks();
}
...
function DatabaseConnection() {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("DatabaseConnection", $args);
return $result;
}
function query($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("query", $args);
return $result;
}
function selectQuery($sql) {
$args = func_get_args();
$result = &amp;$this-&gt;mock-&gt;invoke("selectQuery", $args);
return $result;
}
}
</pre>
Votre sortie dépendra quelque peu de votre version précise de SimpleTest.
</p>
<p>
En plus des méthodes d'origine de la classe, vous en verrez d'autres
pour faciliter les tests.
Nous y reviendrons.
</p>
<p>
Nous pouvons désormais créer des instances de
cette nouvelle classe à l'intérieur même de notre scénario de test...
<pre>
require_once('simpletest/autorun.php');
require_once('database_connection.php');
Mock::generate('DatabaseConnection');
class MyTestCase extends UnitTestCase {
function testSomething() {
<strong>$connection = new MockDatabaseConnection();</strong>
}
}
</pre>
La version fantaisie contient toutles méthodes de l'originale.
En outre, tous les indices de type seront préservés.
Dison que nos méthodes de requête attend un objet <span class="new_code">Query</span>...
<pre>
<strong>class DatabaseConnection {
function DatabaseConnection() { }
function query(Query $query) { }
function selectQuery(Query $query) { }
}</strong>
</pre>
Si nous lui passons le mauvais type d'objet
ou même pire un non-objet...
<pre>
class MyTestCase extends UnitTestCase {
function testSomething() {
$connection = new MockDatabaseConnection();
$connection-&gt;query('insert into accounts () values ()');
}
}
</pre>
...alors le code renverra une violation de typage,
exactement comme on aurait pû s'y attendre
avec la classe d'origine.
</p>
<p>
Si la version fantaisie implémente bien toutes les méthodes
de l'originale, elle renvoit aussi systématiquement <span class="new_code">null</span>.
Et comme toutes les méthodes qui renvoient toujours <span class="new_code">null</span>
ne sont pas très utiles, nous avons besoin de leur faire dire
autre chose...
</p>
<h2>
<a class="target" name="bouchon"></a>Objets fantaisie en action</h2>
<p>
Changer le <span class="new_code">null</span> renvoyé par la méthode fantaisie
en autre chose est assez facile...
<pre>
<strong>$connection-&gt;returns('query', 37)</strong>
</pre>
Désormais à chaque appel de <span class="new_code">$connection-&gt;query()</span>
nous obtenons un résultat de 37.
Il n'y a rien de particulier à cette valeur de 37.
Cette valeur de retour peut être aussi compliqué que nécessaire.
</p>
<p>
Ici les paramètres ne sont pas significatifs,
nous aurons systématiquement la même valeur en retour
une fois initialisés de la sorte.
Cela pourrait ne pas ressembler à une copie convaincante
de notre connexion à la base de données, mais pour
la demi-douzaine de lignes de code de notre méthode de test
c'est généralement largement assez.
</p>
<p>
Sauf que les choses ne sont pas toujours si simples.
Les itérateurs sont un problème récurrent, si par exemple
renvoyer systématiquement la même valeur entraine
une boucle infinie dans l'objet testé.
Pour ces cas-là, nous avons besoin d'une séquence de valeurs.
Supposons que nous avons un itérateur simple qui ressemble à...
<pre>
class Iterator {
function Iterator() { }
function next() { }
}
</pre>
Il s'agit là de l'itérateur le plus basique que nous puissions imaginer.
Supponsons que cet itérateur ne renvoit que du texte
jusqu'à ce qu'il atteigne la fin et qu'il renvoie alors un false,
nous pouvons le simuler avec...
<pre>
Mock::generate('Iterator');
class IteratorTest extends UnitTestCase() {
function testASequence() {<strong>
$iterator = new MockIterator();
$iterator-&gt;returns('next', false);
$iterator-&gt;returnsAt(0, 'next', 'First string');
$iterator-&gt;returnsAt(1, 'next', 'Second string');</strong>
...
}
}
</pre>
Quand <span class="new_code">next()</span> est appelé par le <span class="new_code">MockIterator</span>
il commencera par renvoyer "First string",
au deuxième passage "Second string" sera renvoyé
et sur n'importe quel autre appel <span class="new_code">false</span> sera renvoyé
à son tour.
Les valeurs renvoyées les unes après les autres auront la priorité
sur la valeur constante.
Cette dernière est la valeur par défaut en quelque sorte.
</p>
<p>
Une autre situation délicate serait une opération
<span class="new_code">get()</span> surchargée.
Un exemple serait un conteneur d'information avec des pairs clef/valeur.
Nous partons cette fois d'une classe de configuration telle...
<pre>
class Configuration {
function Configuration() { ... }
function get($key) { ... }
}
</pre>
C'est une situation courante pour utiliser des objets fantaisie,
étant donné que la véritable configuration sera différente
d'une machine à l'autre et parfois même d'un test à l'autre.
Cependant un problème apparaît quand toutes les données passent
par la méthode <span class="new_code">get()</span> et que nous souhaitons
quand même des résultats différents pour des clefs différentes.
Par chance les objets fantaisie ont un système de filtre...
<pre>
<strong>$config = &amp;new MockConfiguration();
$config-&gt;returns('get', 'primary', array('db_host'));
$config-&gt;returns('get', 'admin', array('db_user'));
$config-&gt;returns('get', 'secret', array('db_password'));</strong>
</pre>
Le dernier paramètre est une liste d'arguements
pour vérifier une correspondance.
Dans ce cas, nous essayons de faire correspondre un argument
qui se trouve être la clef de recherche.
Désormais quand l'objet fantaisie voit
sa méthode <span class="new_code">get()</span> invoquée...
<pre>
$config-&gt;get('db_user')
</pre>
...il renverra "admin".
Il trouve cette valeur en essayant de faire correspondre
l'argument reçu à ceux de ses propres listes : dès qu'une
correspondance complète est trouvé, il s'arrête.
</p>
<p>
Vous pouvez préciser un argument par défaut via...
<pre><strong>
$config-&gt;returns('get', false, array('*'));</strong>
</pre>
Ce n'est pas la même chose que de définir la valeur renvoyée
sans aucun arguement...
<pre><strong>
$config-&gt;returns('get', false);</strong>
</pre>
Dans le premier cas, il acceptera n'importe quel argument,
mais il en faut au moins un.
Dans le deuxième cas, n'importe quel nombre d'arguments
fera l'affaire and il agit comme un attrape-tout après
toutes les autres vérifications.
Notez que si - dans le premier cas - nous ajoutons
d'autres options avec paramètre unique après le joker,
alors elle seront ignorés puisque le joker fera
la première correspondance.
Avec des listes complexes de paramètres, l'ordre devient
important au risque de voir la correspondance souhaitée
masqué par un joker apparu plus tôt.
Déclarez les plus spécifiques d'abord si vous n'êtes pas sûr.
</p>
<p>
Il y a des moments où vous souhaitez qu'une référence
bien spécifique soit servie par l'objet fantaisie plutôt
qu'une copie.
C'est plutôt rare pour dire le moins, mais vous pourriez
être en train de simuler un conteneur qui détiendrait
des primitives, tels des chaînes de caractères.
Par exemple.
<pre>
class Pad {
function Pad() { }
function &amp;note($index) { }
}
</pre>
Dans ce cas, vous pouvez définir une référence dans la liste
des valeurs retournées par l'objet fantaisie...
<pre>
function testTaskReads() {
$note = 'Buy books';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReference(</strong>'note', $note, array(3)<strong>)</strong>;
$task = new Task($pad);
...
}
</pre>
Avec cet assemblage vous savez qu'à chaque fois
que <span class="new_code">$pad-&gt;note(3)</span> est appelé
il renverra toujours la même <span class="new_code">$note</span>,
même si celle-ci est modifiée.
</p>
<p>
Ces trois facteurs, timing, paramètres et références,
peuvent être combinés orthogonalement.
Par exemple...
<pre>
$buy_books = 'Buy books';
$write_code = 'Write code';
$pad = new MockPad();
$vector-&gt;<strong>returnsByReferenceAt(0, 'note', $buy_books, array('*', 3));</strong>
$vector-&gt;<strong>returnsByReferenceAt(1, 'note', $write_code, array('*', 3));</strong>
</pre>
Cela renverra une référence à <span class="new_code">$buy_books</span> et
ensuite à <span class="new_code">$write_code</span>, mais seuleent si deux paramètres
sont utilisés, le deuxième devant être l'entier 3.
Cela devrait couvrir la plupart des situations.
</p>
<p>
Un dernier cas délicat reste : celui d'un objet créant
un autre objet, plus connu sous le patron de conception "fabrique"
(ou "factory").
Supponsons qu'à la réussite d'une requête à
notre base de données imaginaire, un jeu d'enregistrements
est renvoyé sous la forme d'un itérateur, où chaque appel
au <span class="new_code">next()</span> sur notre itérateur donne une ligne
avant de s'arrêtre avec un false.
Cela semble à un cauchemar à simuler, alors qu'en fait un objet
fantaisie peut être créé avec les mécansimes ci-dessus...
<pre>
Mock::generate('DatabaseConnection');
Mock::generate('ResultIterator');
class DatabaseTest extends UnitTestCase {
function testUserFinderReadsResultsFromDatabase() {<strong>
$result = new MockResultIterator();
$result-&gt;returns('next', false);
$result-&gt;returnsAt(0, 'next', array(1, 'tom'));
$result-&gt;returnsAt(1, 'next', array(3, 'dick'));
$result-&gt;returnsAt(2, 'next', array(6, 'harry'));
$connection = new MockDatabaseConnection();
$connection-&gt;returns('selectQuery', $result);</strong>
$finder = new UserFinder(<strong>$connection</strong>);
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
Désormais ce n'est que si notre <span class="new_code">$connection</span>
est appelée par la méthode <span class="new_code">query()</span>
que sera retourné le <span class="new_code">$result</span>,
lui-même s'arrêtant au troisième appel
à <span class="new_code">next()</span>.
Ce devrait être suffisant comme information
pour que notre classe <span class="new_code">UserFinder</span>,
la classe effectivement testée ici,
fasse son boulot.
Un test très précis et toujours pas
de base de données en vue.
</p>
<p>
Nous pourrsion affiner ce test encore plus
en insistant pour que la bonne requête
soit envoyée...
<pre>
$connection-&gt;returns('selectQuery', $result, array(<strong>'select name, id from people'</strong>));
</pre>
Là, c'est une mauvaise idée.
</p>
<p>
Niveau objet, nous avons un <span class="new_code">UserFinder</span>
qui parle à une base de données à travers une interface géante -
l'ensemble du SQL.
Imaginez si nous avions écrit un grand nombre de tests
qui dépendrait désormais de cette requête SQL précise.
Ces requêtes pourraient changer en masse pour tout un tas
de raisons non liés à ce test spécifique.
Par exemple, la règle pour les quotes pourrait changer,
un nom de table pourrait évoluer, une table de liaison pourrait
être ajouté, etc.
Cela entrainerait une ré-écriture de tous les tests à chaque fois
qu'un remaniement est fait, alors même que le comportement lui
n'a pas bougé.
Les tests sont censés aider au remaniement, pas le bloquer.
Pour ma part, je préfère avoir une suite de tests qui passent
quand je fais évoluer le nom des tables.
</p>
<p>
Et si vous voulez une règle, c'est toujours mieux de ne pas
créer un objet fantaisie sur une grosse interface.
</p>
<p>
Par contrast, voici le test complet...
<pre>
class DatabaseTest extends UnitTestCase {<strong>
function setUp() { ... }
function tearDown() { ... }</strong>
function testUserFinderReadsResultsFromDatabase() {
$finder = new UserFinder(<strong>new DatabaseConnection()</strong>);
$finder-&gt;add('tom');
$finder-&gt;add('dick');
$finder-&gt;add('harry');
$this-&gt;assertIdentical(
$finder-&gt;findNames(),
array('tom', 'dick', 'harry'));
}
}
</pre>
Ce test est immunisé contre le changement de schéma.
Il échouera uniquement si vous changez la fonctionnalité,
ce qui correspond bien à ce qu'un test doit faire.
</p>
<p>
Il faut juste faire attention à ces méthodes <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> que nous avons survolé pour l'instant.
Elles doivent vider les tables de la base de données
et s'assurer que le schéma est bien défini.
Cela peut se engendrer un peu de travail supplémentaire,
mais d'ordinaire ce type de code existe déjà - à commencer pour
le déploiement.
</p>
<p>
Il y a au moins un endroit où vous aurez besoin d'objets fantaisie :
c'est la simulation des erreurs.
Exemple, la base de données tombe pendant que <span class="new_code">UserFinder</span>
fait son travail. Le <span class="new_code">UserFinder</span> se comporte-t-il bien ?
<pre>
class DatabaseTest extends UnitTestCase {
function testUserFinder() {
$connection = new MockDatabaseConnection();<strong>
$connection-&gt;throwOn('selectQuery', new TimedOut('Ouch!'));</strong>
$alert = new MockAlerts();<strong>
$alert-&gt;expectOnce('notify', 'Database is busy - please retry');</strong>
$finder = new UserFinder($connection, $alert);
$this-&gt;assertIdentical($finder-&gt;findNames(), array());
}
}
</pre>
Nous avons transmis au <span class="new_code">UserFinder</span>
un objet <span class="new_code">$alert</span>.
Il va transmettre un certain nombre de belles notifications
à l'interface utilisatuer en cas d'erreur.
Nous préfèrerions éviter de saupoudrer notre code avec
des commandes <span class="new_code">print</span> codées en dur si nous pouvons
l'éviter.
Emballer les moyens de sortie veut dire que nous pouvons utiliser
ce code partout. Et cela rend notre code plus facile.
</p>
<p>
Pour faire passer ce test, le finder doit écrire un message sympathique
et compréhensible à l'<span class="new_code">$alert</span>, plutôt que de propager
l'exception. Jusque là, tout va bien.
</p>
<p>
Comment faire en sorte que la <span class="new_code">DatabaseConnection</span> fantaisie
soulève une exception ?
Nous la générons avec la méthode <span class="new_code">throwOn</span> sur l'objet fantaisie.
</p>
<p>
Enfin, que se passe-t-il si la méthode voulue pour la simulation
n'existe pas encore ?
Si vous définissez une valeur de retour sur une méthode absente,
alors SimpleTest vous répondra avec une erreur.
Et si vous utilisez <span class="new_code">__call()</span> pour simuler
des méthodes dynamiques ?
</p>
<p>
Les objets avec des interfaces dynamiques, avec <span class="new_code">__call</span>,
peuvent être problématiques dans l'implémentation courante
des objets fantaisie.
Vous pouvez en créer un autour de la méthode <span class="new_code">__call()</span>
mais c'est très laid.
Et pourquoi un test devrait connaître quelque chose avec un niveau
si bas dans l'implémentation. Il n'a besoin que de simuler l'appel.
</p>
<p>
Il y a bien moyen de contournement : ajouter des méthodes complémentaires
à l'objet fantaisie à la génération.
<pre>
<strong>Mock::generate('DatabaseConnection', 'MockDatabaseConnection', array('setOptions'));</strong>
</pre>
Dans une longue suite de tests cela pourrait entraîner des problèmes,
puisque vous avez probablement déjà une version fantaisie
de la classe appellée <span class="new_code">MockDatabaseConnection</span>
sans les méthodes complémentaires.
Le générateur de code ne générera pas la version fantaisie de la classe
s'il en existe déjà une version avec le même nom.
Il vous deviendra impossible de déterminer où est passée votre méthode
si une autre définition a été lancé au préalable.
</p>
<p>
Pour pallier à ce problème, SimpleTest vous permet de choisir
n'importe autre nom pour la nouvelle classe au moment même où
vous ajouter les méthodes complémentaires.
<pre>
Mock::generate('DatabaseConnection', <strong>'MockDatabaseConnectionWithOptions'</strong>, array('setOptions'));
</pre>
Ici l'objet fantaisie se comportera comme si
<span class="new_code">setOptions()</span> existait bel et bien
dans la classe originale.
</p>
<p>
Les objets fantaisie ne peuvent être utilisés qu'à l'intérieur
des scénarios de test, étant donné qu'à l'apparition d'une attente
ils envoient des messages directement au scénario de test courant.
Les créer en dehors d'un scénario de test entraînera une erreur
de run time quand une attente est déclenchée et qu'il n'y a pas
de scénario de test en cours pour recevoir le message.
Nous pouvons désormais couvrir ces attentes.
</p>
<h2>
<a class="target" name="expectations"></a>Objets fantaisie en tant que critiques</h2>
<p>
Même si les bouchons serveur isolent vos tests des perturbations
du monde réel, ils n'apportent que le moitié des bénéfices possibles.
Vous pouvez obtenir une classe de test qui reçoive les bons messages,
mais cette nouvelle classe envoie-t-elle les bons ?
Le tester peut devenir très bordélique sans
une librairie d'objets fantaise.
</p>
<p>
Voici un exemple, prenons une classe <span class="new_code">PageController</span>
toute simple qui traitera un formulaire de paiement
par carte bleue...
<pre>
class PaymentForm extends PageController {
function __construct($alert, $payment_gateway) { ... }
function makePayment($request) { ... }
}
</pre>
Cette classe a besoin d'un <span class="new_code">PaymentGateway</span>
pour parler concrètement à la banque.
Il utilise aussi un objet <span class="new_code">Alert</span>
pour gérer les erreurs.
Cette dernière classe parle à la page ou au template.
Elle est responsable de l'affichage du message d'erreur
et de la mise en valeur de tout champ du formulaire
qui serait incorrecte.
</p>
<p>
Elle pourrait ressembler à...
<pre>
class Alert {
function warn($warning, $id) {
print '&lt;div class="warning"&gt;' . $warning . '&lt;/div&gt;';
print '&lt;style type="text/css"&gt;#' . $id . ' { background-color: red }&lt;/style&gt;';
}
}
</pre>
</p>
<p>
Portons notre attention à la méthode <span class="new_code">makePayment()</span>.
Si nous n'inscrivons pas un numéro "CVV2" (celui à trois
chiffre au dos de la carte bleue), nous souhaitons afficher
une erreur plutôt que d'essayer de traiter le paiement.
En mode test...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
require_once('payment_form.php');
Mock::generate('Alert');
Mock::generate('PaymentGateway');
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce(
'warn',
array('Missing three digit security code', 'cvv2'));</strong>
$controller = new PaymentForm(<strong>$alert</strong>, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
?&gt;
</pre>
Première question : où sont passés les assertions ?
</p>
<p>
L'appel à <span class="new_code">expectOnce('warn', array(...))</span> annonce
à l'objet fantaisie qu'il faut s'attendre à un appel à <span class="new_code">warn()</span>
avant la fin du test.
Quand il débouche sur l'appel à <span class="new_code">warn()</span>, il vérifie
les arguments. Si ceux-ci ne correspondent pas, alors un échec
est généré. Il échouera aussi si la méthode n'est jamais appelée.
</p>
<p>
Non seulement le test ci-dessus s'assure que <span class="new_code">warn</span>
a bien été appelé, mais en plus qu'il a bien reçu la chaîne
de caractère "Missing three digit security code"
et même le tag "cvv2".
L'équivalent de <span class="new_code">assertIdentical()</span> est appliqué
aux deux champs quand les paramètres sont comparés.
</p>
<p>
Si le contenu du message vous importe peu, surtout dans le cas
d'une interface utilisateur qui change régulièrement,
nous pouvons passer ce paramètre avec l'opérateur "*"...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
$alert-&gt;expectOnce('warn', array(<strong>'*'</strong>, 'cvv2'));
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
function requestWithMissingCvv2() { ... }
}
</pre>
Nous pouvons même rendre le test encore moins spécifique
en supprimant complètement la liste des paramètres...
<pre>
function testMissingCvv2CausesAlert() {
$alert = new MockAlert();
<strong>$alert-&gt;expectOnce('warn');</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
Ceci vérifiera uniquement si la méthode a été appelé,
ce qui est peut-être un peu drastique dans ce cas.
Plus tard, nous verrons comment alléger les attentes
plus précisement.
</p>
<p>
Des tests sans assertions peuvent être à la fois compacts
et très expressifs. Parce que nous interceptons l'appel
sur le chemin de l'objet, ici de classe <span class="new_code">Alert</span>,
nous évitons de tester l'état par la suite.
Cela évite les assertions dans les tests, mais aussi
l'obligation d'ajouter des accesseurs uniquement
pour les tests dans le code original.
Si vous en arrivez à ajouter des accesseurs de ce type,
on parle alors de "state based testing" dans le jargon
("test piloté par l'état"),
il est probablement plus que temps d'utiliser
des objets fantaisie dans vos tests.
On peut alors parler de "behaviour based testing"
(ou "test piloté par le comportement") :
c'est largement mieux !
</p>
<p>
Ajoutons un autre test.
Assurons nous que nous essayons même pas un paiement sans CVV2...
<pre>
class PaymentFormFailuresShouldBeGraceful extends UnitTestCase {
function testMissingCvv2CausesAlert() { ... }
function testNoPaymentAttemptedWithMissingCvv2() {
$payment_gateway = new MockPaymentGateway();
<strong>$payment_gateway-&gt;expectNever('pay');</strong>
$controller = new PaymentForm(new MockAlert(), $payment_gateway);
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
...
}
</pre>
Vérifier une négation peut être très difficile
dans les tests, mais <span class="new_code">expectNever()</span>
rend l'opération très facile heureusement.
</p>
<p>
<span class="new_code">expectOnce()</span> et <span class="new_code">expectNever()</span> sont
suffisants pour la plupart des tests, mais
occasionnellement vous voulez tester plusieurs évènements.
D'ordinaire pour des raisons d'usabilité, nous souhaitons
que tous les champs manquants du formulaire soient
mis en relief, et pas uniquement le premier.
Cela veut dire que nous devrions voir de multiples appels
à <span class="new_code">Alert::warn()</span>, pas juste un...
<pre>
function testAllRequiredFieldsHighlightedOnEmptyRequest() {
$alert = new MockAlert();<strong>
$alert-&gt;expectAt(0, 'warn', array('*', 'cc_number'));
$alert-&gt;expectAt(1, 'warn', array('*', 'expiry'));
$alert-&gt;expectAt(2, 'warn', array('*', 'cvv2'));
$alert-&gt;expectAt(3, 'warn', array('*', 'card_holder'));
$alert-&gt;expectAt(4, 'warn', array('*', 'address'));
$alert-&gt;expectAt(5, 'warn', array('*', 'postcode'));
$alert-&gt;expectAt(6, 'warn', array('*', 'country'));
$alert-&gt;expectCallCount('warn', 7);</strong>
$controller = new PaymentForm($alert, new MockPaymentGateway());
$controller-&gt;makePayment($this-&gt;requestWithMissingCvv2());
}
</pre>
Le compteur dans <span class="new_code">expectAt()</span> précise
le nombre de fois que la méthode a déjà été appelée.
Ici nous vérifions que chaque champ sera bien mis en relief.
</p>
<p>
Notez que nous sommes forcé de tester l'ordre en même temps.
SimpleTest n'a pas encore de moyen pour éviter cela,
mais dans une version future ce sera corrigé.
</p>
<p>
Voici la liste complètes des attentes
que vous pouvez préciser sur une objet fantaisie
dans <a href="http://simpletest.org/">SimpleTest</a>.
Comme pour les assertions, ces méthodes prennent en option
un message d'erreur.
<table>
<thead><tr>
<th>Attente</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td><span class="new_code">expect($method, $args)</span></td>
<td>Les arguements doivent correspondre si appelés</td>
</tr>
<tr>
<td><span class="new_code">expectAt($timing, $method, $args)</span></td>
<td>Les arguements doiven correspondre si appelés lors du passage numéro <span class="new_code">$timing</span>
</td>
</tr>
<tr>
<td><span class="new_code">expectCallCount($method, $count)</span></td>
<td>La méthode doit être appelée exactement <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectMaximumCallCount($method, $count)</span></td>
<td>La méthode ne doit pas être appelée plus de <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectMinimumCallCount($method, $count)</span></td>
<td>La méthode ne doit pas être appelée moins de <span class="new_code">$count</span> fois</td>
</tr>
<tr>
<td><span class="new_code">expectNever($method)</span></td>
<td>La méthode ne doit jamais être appelée</td>
</tr>
<tr>
<td><span class="new_code">expectOnce($method, $args)</span></td>
<td>La méthode ne doit être appelée qu'une seule fois et avec les arguments (en option)</td>
</tr>
<tr>
<td><span class="new_code">expectAtLeastOnce($method, $args)</span></td>
<td>La méthode doit être appelée au moins une seule fois et toujours avec au moins un des arguments attendus</td>
</tr>
</tbody>
</table>
Où les paramètres sont...
<dl>
<dt class="new_code">$method</dt>
<dd>
Le nom de la méthode, sous la forme d'une chaîne de caractères,
à laquelle il faut appliquer la condition.
</dd>
<dt class="new_code">$args</dt>
<dd>
Les argumetns sous la forme d'une liste.
Les jokers peuvent être inclus de la même manière
que pour <span class="new_code">setReturn()</span>.
Cet argument est optionnel pour <span class="new_code">expectOnce()</span>
et <span class="new_code">expectAtLeastOnce()</span>.
</dd>
<dt class="new_code">$timing</dt>
<dd>
La seule marque dans le temps pour tester la condition.
Le premier appel commence à zéro et le comptage se fait
séparement sur chaque méthode.
</dd>
<dt class="new_code">$count</dt>
<dd>Le nombre d'appels attendu.</dd>
</dl>
</p>
<p>
Si vous n'avez qu'un seul appel dans votre test, assurez vous
d'utiliser <span class="new_code">expectOnce</span>.<br>
Utiliser <span class="new_code">$mocked-&gt;expectAt(0, 'method', 'args);</span>
tout seul ne permettra qu'à la méthode de ne jamais être appelée.
Vérifier les arguements et le comptage total sont pour le moment
indépendants.
Ajouter une attente <span class="new_code">expectCallCount()</span> quand
vous utilisez <span class="new_code">expectAt()</span> (dans le cas sans appel)
est permis.
</p>
<p>
Comme les assertions à l'intérieur des scénarios de test,
toutes ces attentes peuvent incorporer une surchage
sur le message sous la forme d'un paramètre supplémentaire.
Par ailleurs le message original peut être inclus dans la sortie
avec "%s".
</p>
</div>
References and related information...
<ul>
<li>
Le papier original sur les Objets fantaisie ou
<a href="http://www.mockobjects.com/">Mock objects</a>.
</li>
<li>
La page du projet SimpleTest sur <a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page d'accueil de SimpleTest sur <a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,321 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>
Aperçu et liste des fonctionnalités des testeurs unitaires PHP et web de SimpleTest PHP
</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Apercu de SimpleTest</h1>
This page...
<ul>
<li>
<a href="#resume">Résumé rapide</a> de l'outil SimpleTest pour PHP.
</li>
<li>
<a href="#fonctionnalites">La liste des fonctionnalites</a>, à la fois présentes et à venir.
</li>
<li>
Il y a beaucoup de <a href="#ressources">ressources sur les tests unitaires</a> sur le web.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="resume"></a>Qu'est-ce que SimpleTest ?</h2>
<p>
Le coeur de SimpleTest est un framework de test construit autour de classes de scénarios de test. Celles-ci sont écrites comme des extensions des classes premières de scénarios de test, chacune élargie avec des méthodes qui contiennent le code de test effectif. Les scripts de test de haut niveau invoque la méthode <span class="new_code">run()</span> à chaque scénario de test successivement. Chaque méthode de test est écrite pour appeler des assertions diverses que le développeur suppose être vraies, <span class="new_code">assertEqual()</span> par exemple. Si l'assertion est correcte, alors un succès est expédié au rapporteur observant le test, mais toute erreur déclenche une alerte et une description de la dissension.
</p>
<p>
Un <a href="unit_test_documentation.html">scénario de test</a> ressemble à...
<pre>
class <strong>MyTestCase</strong> extends UnitTestCase {
<strong>
function testLog() {
$log = &amp;new Log('my.log');
$log-&gt;message('Hello');
$this-&gt;assertTrue(file_exists('my.log'));
}</strong>
}
</pre>
</p>
<p>
Ces outils sont conçus pour le développeur. Les tests sont écrits en PHP directement, plus ou moins simultanément avec la construction de l'application elle-même. L'avantage d'utiliser PHP lui-même comme langage de test est qu'il n'y a pas de nouveau langage à apprendre, les tests peuvent commencer directement et le développeur peut tester n'importe quelle partie du code. Plus simplement, toutes les parties qui peuvent être accédées par le code de l'application peuvent aussi être accédées par le code de test si ils sont tous les deux dans le même langage.
</p>
<p>
Le type de scénario de test le plus simple est le <span class="new_code">UnitTestCase</span>. Cette classe de scénario de test inclut les tests standards pour l'égalité, les références et l'appariement de motifs (via les expressions rationnelles). Ceux-ci testent ce que vous seriez en droit d'attendre du résultat d'une fonction ou d'une méthode. Il s'agit du type de test le plus commun pendant le quotidien du développeur, peut-être 95% des scénarios de test.
</p>
<p>
La tâche ultime d'une application web n'est cependant pas de produire une sortie correcte à partir de méthodes ou d'objets, mais plutôt de produire des pages web. La classe <span class="new_code">WebTestCase</span> teste des pages web. Elle simule un navigateur web demandant une page, de façon exhaustive : cookies, proxies, connexions sécurisées, authentification, formulaires, cadres et la plupart des éléments de navigation. Avec ce type de scénario de test, le développeur peut garantir que telle ou telle information est présente dans la page et que les formulaires ainsi que les sessions sont gérés comme il faut.
</p>
<p>
Un <a href="web_tester_documentation.html">scénario de test web</a> ressemble à...
<pre>
class <strong>MySiteTest</strong> extends WebTestCase {
<strong>
function testHomePage() {
$this-&gt;get('http://www.my-site.com/index.php');
$this-&gt;assertTitle('My Home Page');
$this-&gt;clickLink('Contact');
$this-&gt;assertTitle('Contact me');
$this-&gt;assertWantedPattern('/Email me at/');
}</strong>
}
</pre>
</p>
<h2>
<a class="target" name="fonctionnalites"></a>Liste des fonctionnalites</h2>
<p>
Ci-dessous vous trouverez un canevas assez brut des fonctionnalités à aujourd'hui et pour demain, sans oublier leur date approximative de publication. J'ai bien peur qu'il soit modifiable sans pré-avis étant donné que les jalons dépendent beaucoup sur le temps disponible. Les trucs en vert ont été codés, mais pas forcément déjà rendus public. Si vous avez une besoin pressant pour une fonctionnalité verte mais pas encore publique alors vous devriez retirer le code directement sur le CVS chez SourceFourge. Une fonctionnalitée publiée est indiqué par "Fini".
<table>
<thead>
<tr>
<th>Fonctionnalité</th>
<th>Description</th>
<th>Publication</th>
</tr>
</thead>
<tbody>
<tr>
<td>Scénariot de test unitaire</td>
<td>Les classes de test et assertions de base</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Affichage HTML</td>
<td>L'affichage le plus simple possible</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Autochargement des scénarios de test</td>
<td>Lire un fichier avec des scénarios de test et les charger dans un groupe de tests automatiquement</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Générateur de code d'objets fantaisie</td>
<td>Des objets capable de simuler d'autres objets, supprimant les dépendances dans les tests</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Bouchons serveur</td>
<td>Des objets fantaisie sans résultat attendu à utiliser à l'extérieur des scénarios de test, pour le prototypage par exemple.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Intégration d'autres testeurs unitaires</td>
<td>
La capacité de lire et simuler d'autres scénarios de test en provenance de PHPUnit et de PEAR::Phpunit.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Scénario de test web</td>
<td>Appariement basique de motifs dans une page téléchargée.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Analyse de page HTML</td>
<td>Permet de suivre les liens et de trouver la balise de titre</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Simulacre partiel</td>
<td>Simuler des parties d'une classe pour tester moins qu'une classe ou dans des cas complexes.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Gestion des cookies Web</td>
<td>Gestion correcte des cookies au téléchargement d'une page.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Suivi des redirections</td>
<td>Le téléchargement d'une page suit automatiquement une redirection 300.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Analyse d'un formulaire</td>
<td>La capacité de valider un formulaire simple et d'en lire les valeurs par défaut.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Interface en ligne de commande</td>
<td>Affiche le résultat des tests sans navigateur web.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Mise à nu des attentes d'une classe</td>
<td>Peut créer des tests précis avec des simulacres ainsi que des scénarios de test.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Sortie et analyse XML</td>
<td>Permet de tester sur plusieurs hôtes et d'intégrer des extensions d'acceptation de test.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Scénario de test en ligne de commande</td>
<td>Permet de tester des outils ou scripts en ligne de commande et de manier des fichiers.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Compatibilité avec PHP Documentor</td>
<td>Génération automatique et complète de la documentation au niveau des classes.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Interface navigateur</td>
<td>Mise à nu des niveaux bas de l'interface du navigateur web pour des scénarios de test plus précis.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Authentification HTTP</td>
<td>Téléchargement des pages web protégées avec une authentification basique seulement.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Boutons de navigation d'un navigateur</td>
<td>Arrière, avant et recommencer</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support de SSL</td>
<td>Peut se connecter à des pages de type https.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support de proxy</td>
<td>Peut se connecter via des proxys communs</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Support des cadres</td>
<td>Gère les cadres dans les scénarios de test web.</td>
<td style="color: green;">Fini</td>
</tr>
<tr>
<td>Test de l'upload de fichier</td>
<td>Peut simuler la balise input de type file</td>
<td style="color: red;">1.0.1</td>
</tr>
<tr>
<td>Amélioration sur la machinerie des rapports</td>
<td>Retouche sur la transmission des messages pour une meilleur coopération avec les IDEs</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Amélioration de l'affichage des tests</td>
<td>Une meilleure interface graphique web, avec un arbre des scénarios de test.</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Localisation</td>
<td>Abstraction des messages et génration du code à partir de fichiers XML.</td>
<td style="color: red;">1.1</td>
</tr>
<tr>
<td>Simulation d'interface</td>
<td>Peut générer des objets fantaisie tant vers des interfaces que vers des classes.</td>
<td style="color: red;">2.0</td>
</tr>
<tr>
<td>Test sur es exceptions</td>
<td>Dans le même esprit que sur les tests des erreurs PHP.</td>
<td style="color: red;">2.0</td>
</tr>
<tr>
<td>Rercherche d'éléments avec XPath</td>
<td>Peut utiliser Tidy HTML pour un appariement plus rapide et plus souple.</td>
<td style="color: red;">2.0</td>
</tr>
</tbody>
</table>
La migration vers PHP5 commencera juste après la série des 1.0, à partir de là PHP4 ne sera plus supporté. SimpleTest est actuellement compatible avec PHP5 mais n'utilisera aucune des nouvelles fonctionnalités avant la version 2.
</p>
<h2>
<a class="target" name="ressources"></a>Ressources sur le web pour les tests</h2>
<p>
Le processus est au moins aussi important que les outils. Le type de procédure que fait un usage le plus intensif des outils de test pour développeur est bien sûr l'<a href="http://www.extremeprogramming.org/">Extreme Programming</a>. Il s'agit là d'une des <a href="http://www.agilealliance.com/articles/index">méthodes agiles</a> qui combinent plusieurs pratiques pour "lisser la courbe de coût" du développement logiciel. La plus extrème reste le <a href="http://www.testdriven.com/modules/news/">développement piloté par les tests</a>, où vous devez adhérer à la règle du <cite>pas de code avant d'avoir un test</cite>. Si vous êtes plutôt du genre planninficateur ou que vous estimez que l'expérience compte plus que l'évolution, vous préférerez peut-être l'approche <a href="http://www.therationaledge.com/content/dec_01/f_spiritOfTheRUP_pk.html">RUP</a>. Je ne l'ai pas testé mais je peux voir où vous aurez besoin d'outils de test (cf. illustration 9).
</p>
<p>
La plupart des testeurs unitaires sont dans une certaine mesure un clone de <a href="http://www.junit.org/">JUnit</a>, au moins dans l'interface. Il y a énormément d'information sur le site de JUnit, à commencer par la <a href="http://junit.sourceforge.net/doc/faq/faq.htm">FAQ</a> quie contient pas mal de conseils généraux sur les tests. Une fois mordu par le bogue vous apprécierez sûrement la phrase <a href="http://junit.sourceforge.net/doc/testinfected/testing.htm">infecté par les tests</a> trouvée par Eric Gamma. Si vous êtes encore en train de tergiverser sur un testeur unitaire, sachez que les choix principaux sont <a href="http://phpunit.sourceforge.net/">PHPUnit</a> et <a href="http://pear.php.net/manual/en/package.php.phpunit.php">Pear PHP::PHPUnit</a>. De nombreuses fonctionnalités de SimpleTest leurs font défaut, mais la version PEAR a d'ores et déjà été mise à jour pour PHP5. Elle est aussi recommandée si vous portez des scénarios de test existant depuis <a href="http://www.junit.org/">JUnit</a>.
</p>
<p>
Les développeurs de bibliothèque n'ont pas l'air de livrer très souvent des tests avec leur code : c'est bien dommage. Le code d'une bibliothèque qui inclut des tests peut être remanié avec plus de sécurité et le code de test sert de documentation additionnelle dans un format assez standard. Ceci peut épargner la pêche aux indices dans le code source lorsque qu'un problème survient, en particulier lors de la mise à jour d'une telle bibliothèque. Parmi les bibliothèques utilisant SimpleTest comme testeur unitaire on retrouve <a href="http://wact.sourceforge.net/">WACT</a> et <a href="http://sourceforge.net/projects/htmlsax">PEAR::XML_HTMLSax</a>.
</p>
<p>
Au jour d'aujourd'hui il manque tristement beaucoup de matière sur les objets fantaisie : dommage, surtout que tester unitairement sans eux représente pas mal de travail en plus. L'<a href="http://www.sidewize.com/company/mockobjects.pdf">article original sur les objets fantaisie</a> est très orienté Java, mais reste intéressant à lire. Etant donné qu'il s'agit d'une nouvelle technologie il y a beaucoup de discussions et de débats sur comment les utiliser, souvent sur des wikis comme <a href="http://xpdeveloper.com/cgi-bin/oldwiki.cgi?MockObjects">Extreme Tuesday</a> ou <a href="http://www.mockobjects.com/MocksObjectsPaper.html">www.mockobjects.com</a>ou <a href="http://c2.com/cgi/wiki?MockObject">the original C2 Wiki</a>. Injecter des objets fantaisie dans une classe est un des champs principaux du débat : cet <a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">article chez IBM</a> en est un bon point de départ.
</p>
<p>
Il y a énormement d'outils de test web mais la plupart sont écrits en Java. De plus les tutoriels et autres conseils sont plutôt rares. Votre seul espoir est de regarder directement la documentation pour <a href="http://httpunit.sourceforge.net/">HTTPUnit</a>, <a href="http://htmlunit.sourceforge.net/">HTMLUnit</a> ou <a href="http://jwebunit.sourceforge.net/">JWebUnit</a> et d'espérer y trouver pour des indices. Il y a aussi des frameworks basés sur XML, mais de nouveau la plupart ont besoin de Java pour tourner.
</p>
</div>
References and related information...
<ul>
<li>
<a href="unit_test_documentation.html">Documentation pour SimpleTest</a>.
</li>
<li>
<a href="http://www.lastcraft.com/first_test_tutorial.php">Comment écrire des scénarios de test en PHP</a> est un tutoriel plutôt avancé.
</li>
<li>
<a href="http://simpletest.org/api/">L'API de SimpleTest</a> par phpdoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,475 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : les objets fantaisie partiels</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les objets fantaisie partiels</h1>
This page...
<ul>
<li>
<a href="#injection">Le problème de l'injection d'un objet fantaisie</a>.
</li>
<li>
Déplacer la création vers une méthode <a href="#creation">fabrique protégée</a>.
</li>
<li>
<a href="#partiel">L'objet fantaisie partiel</a> génère une sous-classe.
</li>
<li>
Les objets fantaisie partiels <a href="#moins">testent moins qu'une classe</a>.
</li>
</ul>
<div class="content">
<p>
Un objet fantaisie partiel n'est ni plus ni moins
qu'un modèle de conception pour soulager un problème spécifique
du test avec des objets fantaisie, celui de placer
des objets fantaisie dans des coins serrés.
Il s'agit d'un outil assez limité et peut-être même
une idée pas si bonne que ça. Elle est incluse dans SimpleTest
pour la simple raison que je l'ai trouvée utile
à plus d'une occasion et qu'elle m'a épargnée
pas mal de travail dans ces moments-là.
</p>
<h2>
<a class="target" name="injection"></a>Le problème de l'injection dans un objet fantaisie</h2>
<p>
Quand un objet en utilise un autre il est très simple
d'y faire circuler une version fantaisie déjà prête
avec ses attentes. Les choses deviennent un peu plus délicates
si un objet en crée un autre et que le créateur est celui
que l'on souhaite tester. Cela revient à dire que l'objet
créé devrait être une fantaisie, mais nous pouvons
difficilement dire à notre classe sous test de créer
un objet fantaisie plutôt qu'un "vrai" objet.
La classe testée ne sait même pas qu'elle travaille dans un environnement de test.
</p>
<p>
Par exemple, supposons que nous sommes en train
de construire un client telnet et qu'il a besoin
de créer une socket réseau pour envoyer ses messages.
La méthode de connexion pourrait ressemble à quelque chose comme...
<pre>
<strong>&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
$socket = new Socket($ip, $port);
$socket-&gt;read( ... );
...
}
}
?&gt;</strong>
</pre>
Nous voudrions vraiment avoir une version fantaisie
de l'objet socket, que pouvons nous faire ?
</p>
<p>
La première solution est de passer la socket en
tant que paramètre, ce qui force la création
au niveau inférieur. Charger le client de cette tâche
est effectivement une bonne approche si c'est possible
et devrait conduire à un remaniement -- de la création
à partir de l'action. En fait, c'est là une des manières
avec lesquels tester en s'appuyant sur des objets fantaisie
vous force à coder des solutions plus resserrées sur leur objectif.
Ils améliorent votre programmation.
</p>
<p>
Voici ce que ça devrait être...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
<strong>function connect($socket, $username, $password) {
$socket-&gt;read( ... );
...
}</strong>
}
?&gt;
</pre>
Sous-entendu, votre code de test est typique d'un cas
de test avec un objet fantaisie.
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect($socket, 'Me', 'Secret');
...</strong>
}
}
</pre>
C'est assez évident que vous ne pouvez descendre que d'un niveau.
Vous ne voudriez pas que votre application de haut niveau
crée tous les fichiers de bas niveau, sockets et autres connexions
à la base de données dont elle aurait besoin.
Elle ne connaîtrait pas les paramètres du constructeur de toute façon.
</p>
<p>
La solution suivante est de passer l'objet créé sous la forme
d'un paramètre optionnel...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...<strong>
function connect($ip, $port, $username, $password, $socket = false) {
if (! $socket) {
$socket = new Socket($ip, $port);
}
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
Pour une solution rapide, c'est généralement suffisant.
Ensuite le test est très similaire : comme si le paramètre
était transmis formellement...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret', $socket);
...</strong>
}
}
</pre>
Le problème de cette approche tient dans son manque de netteté.
Il y a du code de test dans la classe principale et aussi
des paramètres transmis dans le scénario de test
qui ne sont jamais utilisés. Il s'agit là d'une approche
rapide et sale, mais qui ne reste pas moins efficace
dans la plupart des situations.
</p>
<p>
Une autre solution encore est de laisser un objet fabrique
s'occuper de la création...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {<strong>
function Telnet($network) {
$this-&gt;_network = $network;
}</strong>
...
function connect($ip, $port, $username, $password) {<strong>
$socket = $this-&gt;_network-&gt;createSocket($ip, $port);
$socket-&gt;read( ... );</strong>
...
return $socket;
}
}
?&gt;
</pre>
Il s'agit là probablement de la réponse la plus travaillée
étant donné que la création est maintenant située
dans une petite classe spécialisée. La fabrique réseau
peut être testée séparément et utilisée en tant que fantaisie
quand nous testons la classe telnet...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$network = new MockNetwork();
$network-&gt;returnsByReference('createSocket', $socket);
$telnet = new Telnet($network);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
Le problème reste que nous ajoutons beaucoup de classes
à la bibliothèque. Et aussi que nous utilisons beaucoup
de fabriques ce qui rend notre code un peu moins intuitif.
La solution la plus flexible, mais aussi la plus complexe.
</p>
<p>
Des techniques comme "l'Injection de Dépendance"
(ou "Dependency Injection") s'attelle au problème
de l'instanciation d'une classe avec beaucoup de paramètres.
Malheureusement la connaissance de ce patron de conception
n'est pas très répandue et si vous êtes en train d'essayer
de faire fonctionner du vieux code, ré-achitecturer toute
l'application n'est pas vraiment une option.
</p>
<p>
Peut-on trouver un juste milieu ?
</p>
<h2>
<a class="target" name="creation"></a>Méthode fabrique protégée</h2>
<p>
Il existe une technique pour palier à ce problème
sans créer de nouvelle classe dans l'application;
par contre elle induit la création d'une sous-classe au moment du test.
Premièrement nous déplaçons la création de la socket dans sa propre méthode...
<pre>
&lt;?php
require_once('socket.php');
class Telnet {
...
function connect($ip, $port, $username, $password) {
<strong>$socket = $this-&gt;createSocket($ip, $port);</strong>
$socket-&gt;read( ... );
...
}<strong>
protected function createSocket($ip, $port) {
return new Socket($ip, $port);
}</strong>
}
?&gt;
</pre>
Une première étape plutôt précautionneuse même pour
du code legacy et intermélé.
Il s'agit là de la seule modification dans le code de l'application.
</p>
<p>
Pour le scénario de test, nous devons créer
une sous-classe de manière à intercepter la création de la socket...
<pre>
<strong>class TelnetTestVersion extends Telnet {
var $mock;
function TelnetTestVersion($mock) {
$this-&gt;mock = $mock;
$this-&gt;Telnet();
}
protected function createSocket() {
return $this-&gt;mock;
}
}</strong>
</pre>
Ici j'ai déplacé la fantaisie dans le constructeur,
mais un setter aurait fonctionné tout aussi bien.
Notez bien que la fantaisie est placée dans une variable
d'objet avant que le constructeur ne soit attaché.
C'est nécessaire dans le cas où le constructeur appelle
<span class="new_code">connect()</span>.
Autrement il pourrait donner un valeur nulle à partir de
<span class="new_code">createSocket()</span>.
</p>
<p>
Après la réalisation de tout ce travail supplémentaire
le scénario de test est assez simple.
Nous avons juste besoin de tester notre nouvelle classe à la place...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion($socket);
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
Cette nouvelle classe est très simple bien sûr.
Elle ne fait qu'initier une valeur renvoyée, à la manière
d'une fantaisie. Ce serait pas mal non plus si elle pouvait
vérifier les paramètres entrants.
Exactement comme un objet fantaisie.
Il se pourrait bien que nous ayons à réaliser cette astuce régulièrement :
serait-il possible d'automatiser la création de cette sous-classe ?
</p>
<h2>
<a class="target" name="partiel"></a>Un objet fantaisie partiel</h2>
<p>
Bien sûr la réponse est "oui"
ou alors j'aurais arrêté d'écrire depuis quelques temps déjà !
Le test précédent a représenté beaucoup de travail,
mais nous pouvons générer la sous-classe en utilisant
une approche à celle des objets fantaisie.
</p>
<p>
Voici donc une version avec objet fantaisie partiel du test...
<pre>
<strong>Mock::generatePartial(
'Telnet',
'TelnetTestVersion',
array('createSocket'));</strong>
class TelnetTest extends UnitTestCase {
...
function testConnection() {<strong>
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');</strong>
}
}
</pre>
La fantaisie partielle est une sous-classe de l'original
dont on aurait "remplacé" les méthodes sélectionnées
avec des versions de test. L'appel à <span class="new_code">generatePartial()</span>
nécessite trois paramètres : la classe à sous classer,
le nom de la nouvelle classe et une liste des méthodes à simuler.
</p>
<p>
Instancier les objets qui en résultent est plutôt délicat.
L'unique paramètre du constructeur d'un objet fantaisie partiel
est la référence du testeur unitaire.
Comme avec les objets fantaisie classiques c'est nécessaire
pour l'envoi des résultats de test en réponse à la vérification des attentes.
</p>
<p>
Une nouvelle fois le constructeur original n'est pas lancé.
Indispensable dans le cas où le constructeur aurait besoin
des méthodes fantaisie : elles n'ont pas encore été initiées !
Nous initions les valeurs retournées à cet instant et
ensuite lançons le constructeur avec ses paramètres normaux.
Cette construction en trois étapes de "new",
suivie par la mise en place des méthodes et ensuite
par la lancement du constructeur proprement dit est
ce qui distingue le code d'un objet fantaisie partiel.
</p>
<p>
A part pour leur construction, toutes ces méthodes
fantaisie ont les mêmes fonctionnalités que dans
le cas des objets fantaisie et toutes les méthodes
non fantaisie se comportent comme avant.
Nous pouvons mettre en place des attentes très facilement...
<pre>
class TelnetTest extends UnitTestCase {
...
function testConnection() {
$socket = new MockSocket();
...
$telnet = new TelnetTestVersion();
$telnet-&gt;setReturnReference('createSocket', $socket);
<strong>$telnet-&gt;expectOnce('createSocket', array('127.0.0.1', 21));</strong>
$telnet-&gt;Telnet();
$telnet-&gt;connect('127.0.0.1', 21, 'Me', 'Secret');
}
}
</pre>
Les objets fantaisie partiels ne sont pas très utilisés.
Je les considère comme transitoire.
Utile lors d'un remaniement, mais une fois que l'application
a eu toutes ses dépendances bien séparées alors
ils peuvent disparaître.
</p>
<h2>
<a class="target" name="moins"></a>Tester moins qu'une classe</h2>
<p>
Les méthodes issues d'un objet fantaisie n'ont pas
besoin d'être des méthodes fabrique, Il peut s'agir
de n'importe quelle sorte de méthode.
Ainsi les objets fantaisie partiels nous permettent
de prendre le contrôle de n'importe quelle partie d'une classe,
le constructeur excepté. Nous pourrions même aller jusqu'à
créer des fantaisies sur toutes les méthodes à part celle
que nous voulons effectivement tester.
</p>
<p>
Cette situation est assez hypothétique, étant donné
que je ne l'ai pas souvent essayée.
Je crains qu'en forçant la granularité d'un objet
on n'obtienne pas forcément un code de meilleur qualité.
Personnellement j'utilise les objets fantaisie partiels
comme moyen de passer outre la création ou alors
de temps en temps pour tester le modèle de conception TemplateMethod.
</p>
<p>
On en revient toujours aux standards de code de votre projet :
c'est à vous de trancher si vous autorisez ce mécanisme ou non.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète pour SimpleTest</a>
à partir de PHPDoc.
</li>
<li>
La méthode fabrique protégée est décrite dans
<a href="http://www-106.ibm.com/developerworks/java/library/j-mocktest.html">
cet article d'IBM</a>. Il s'agit de l'unique papier
formel que j'ai vu sur ce problème.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,630 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : le rapporteur de test</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le rapporteur de test</h1>
This page...
<ul>
<li>
Afficher <a href="#html">les résultats en HTML</a>
</li>
<li>
Afficher et <a href="#autres">rapporter les résultats</a>
dans d'autres formats
</li>
<li>
Utilisé <a href="#cli">SimpleTest depuis la ligne de commande</a>
</li>
<li>
<a href="#xml">Utiliser XML</a> pour des tests distants
</li>
</ul>
<div class="content">
<p>
SimpleTest suit plutôt plus que moins le modèle MVC (Modèle-Vue-Contrôleur).
Les classes "reporter" sont les vues et les modèles
sont vos scénarios de test et leur hiérarchie.
Le contrôleur est le plus souvent masqué à l'utilisateur
de SimpleTest à moins de vouloir changer la façon
dont les tests sont effectivement exécutés,
auquel cas il est possible de surcharger les objets
"runner" (ceux de l'exécuteur) depuis l'intérieur
d'un scénario de test. Comme d'habitude avec MVC,
le contrôleur est plutôt indéfini et il existe d'autres endroits
pour contrôler l'exécution des tests.
</p>
<h2>
<a class="target" name="html"></a>Les résultats rapportés au format HTML</h2>
<p>
L'affichage par défaut est minimal à l'extrême.
Il renvoie le succès ou l'échec avec les barres conventionnelles
- rouge et verte - et affichent une trace d'arborescence
des groupes de test pour chaque assertion erronée. Voici un tel échec...
<div class="demo">
<h1>File test</h1>
<span class="fail">Fail</span>: createnewfile-&gt;True assertion failed.<br>
<div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete.
<strong>0</strong> passes, <strong>1</strong> fails and <strong>0</strong> exceptions.</div>
</div>
Alors qu'ici tous les tests passent...
<div class="demo">
<h1>File test</h1>
<div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete.
<strong>1</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div>
</div>
La bonne nouvelle, c'est qu'il existe pas mal de points
dans la hiérarchie de l'affichage pour créer des sous-classes.
</p>
<p>
Pour l'affichage basé sur des pages web,
il y a la classe <span class="new_code">HtmlReporter</span> avec la signature suivante...
<pre>
class HtmlReporter extends SimpleReporter {
public __construct($encoding) { ... }
public makeDry(boolean $is_dry) { ... }
public void paintHeader(string $test_name) { ... }
public void sendNoCacheHeaders() { ... }
public void paintFooter(string $test_name) { ... }
public void paintGroupStart(string $test_name, integer $size) { ... }
public void paintGroupEnd(string $test_name) { ... }
public void paintCaseStart(string $test_name) { ... }
public void paintCaseEnd(string $test_name) { ... }
public void paintMethodStart(string $test_name) { ... }
public void paintMethodEnd(string $test_name) { ... }
public void paintFail(string $message) { ... }
public void paintPass(string $message) { ... }
public void paintError(string $message) { ... }
public void paintException(string $message) { ... }
public void paintMessage(string $message) { ... }
public void paintFormattedMessage(string $message) { ... }
protected string getCss() { ... }
public array getTestList() { ... }
public integer getPassCount() { ... }
public integer getFailCount() { ... }
public integer getExceptionCount() { ... }
public integer getTestCaseCount() { ... }
public integer getTestCaseProgress() { ... }
}
</pre>
Voici ce que certaines de ces méthodes veulent dire.
Premièrement les méthodes d'affichage que vous voudrez probablement surcharger...
<ul class="api">
<li>
<span class="new_code">HtmlReporter(string $encoding)</span><br>
est le constructeur. Notez que le test unitaire initie
le lien à l'affichage plutôt que l'opposé.
L'affichage est principalement un receveur passif
des évènements de tests. Cela permet d'adapter
facilement l'affichage pour d'autres systèmes
en dehors des tests unitaires, tel le suivi
de la charge de serveurs.
L'"encoding" est le type d'encodage
que vous souhaitez utiliser pour l'affichage du test.
Pour pouvoir effectuer un rendu correct de la sortie
de débogage quand on utilise le testeur web,
il doit correspondre à l'encodage du site testé.
Les chaînes de caractères disponibles
sont indiquées dans la fonction PHP
<a href="http://www.php.net/manual/fr/function.htmlentities.php">html_entities()</a>.
</li>
<li>
<span class="new_code">void paintHeader(string $test_name)</span><br>
est appelé une fois, au début du test quand l'évènement
de démarrage survient. Le premier évènement de démarrage
est souvent délivré par le groupe de tests du niveau
le plus haut et donc c'est de là que le
<span class="new_code">$test_name</span> arrive.
Il peint le titre de la page, CSS, la balise "body", etc.
Il ne renvoie rien du tout (<span class="new_code">void</span>).
</li>
<li>
<span class="new_code">void paintFooter(string $test_name)</span><br>
est appelé à la toute fin du test pour fermer
les balises ouvertes par l'entête de la page.
Par défaut il affiche aussi la barre rouge ou verte
et le décompte final des résultats.
En fait la fin des tests arrive quand l'évènement
de fin de test arrive avec le même nom
que celui qui l'a initié au même niveau.
Le nid des tests en quelque sorte.
Fermer le dernier test finit l'affichage.
</li>
<li>
<span class="new_code">void paintMethodStart(string $test_name)</span><br>
est appelé au début de chaque méthode de test.
Normalement le nom vient de celui de la méthode.
Les autres évènements de départ de test
se comportent de la même manière sauf que
celui du groupe de tests indique au rapporteur
le nombre de scénarios de test qu'il contient.
De la sorte le rapporteur peut afficher une barre
de progrès au fur et à mesure que l'exécuteur
passe en revue les scénarios de test.
</li>
<li>
<span class="new_code">void paintMethodEnd(string $test_name)</span><br>
clôt le test lancé avec le même nom.
</li>
<li>
<span class="new_code">void paintFail(string $message)</span><br>
peint un échec. Par défaut il ne fait qu'afficher
le mot "fail", une trace d'arborescence
affichant la position du test en cours
et le message transmis par l'assertion.
</li>
<li>
<span class="new_code">void paintPass(string $message)</span><br>
ne fait rien, par défaut.
</li>
<li>
<span class="new_code">string getCss()</span><br>
renvoie les styles CSS sous la forme d'une chaîne
à l'attention de la méthode d'entêtes d'une page.
Des styles additionnels peuvent être ajoutés ici
si vous ne surchargez pas les entêtes de la page.
Vous ne voudrez pas utiliser cette méthode dans
des entêtes d'une page surchargée si vous souhaitez
inclure le feuille de style CSS d'origine.
</li>
</ul>
Il y a aussi des accesseurs pour aller chercher l'information
sur l'état courant de la suite de test. Vous les utiliserez
pour enrichir l'affichage...
<ul class="api">
<li>
<span class="new_code">array getTestList()</span><br>
est la première méthode très commode pour les sous-classes.
Elle liste l'arborescence courante des tests
sous la forme d'une liste de noms de tests.
Le premier test -- celui de premier niveau --
sera le premier dans la liste et la méthode de test
en cours sera la dernière.
</li>
<li>
<span class="new_code">integer getPassCount()</span><br>
renvoie le nombre de succès atteint. Il est nécessaire
pour l'affichage à la fin.
</li>
<li>
<span class="new_code">integer getFailCount()</span><br>
renvoie de la même manière le nombre d'échecs.
</li>
<li>
<span class="new_code">integer getExceptionCount()</span><br>
renvoie quant à lui le nombre d'erreurs.
</li>
<li>
<span class="new_code">integer getTestCaseCount()</span><br>
est le nombre total de scénarios lors de l'exécution des tests.
Il comprend aussi les tests groupés.
</li>
<li>
<span class="new_code">integer getTestCaseProgress()</span><br>
est le nombre de scénarios réalisés jusqu'à présent.
</li>
</ul>
Une modification simple : demander à l'HtmlReporter d'afficher
aussi bien les succès que les échecs et les erreurs...
<pre>
<strong>class ReporterShowingPasses extends HtmlReporter {
function paintPass($message) {
parent::paintPass($message);
print "&lt;span class=\"pass\"&gt;Pass&lt;/span&gt;: ";
$breadcrumb = $this-&gt;getTestList();
array_shift($breadcrumb);
print implode("-&amp;gt;", $breadcrumb);
print "-&amp;gt;$message&lt;br /&gt;\n";
}
protected function getCss() {
return parent::getCss() . ' .pass { color: green; }';
}
}</strong>
</pre>
</p>
<p>
Une méthode qui a beaucoup fait jaser reste la méthode <span class="new_code">makeDry()</span>.
Si vous lancez cette méthode, sans paramètre,
sur le rapporteur avant que la suite de test
ne soit exécutée alors aucune méthode de test
ne sera appelée. Vous continuerez à avoir
les évènements entrants et sortants des méthodes
et scénarios de test, mais aucun succès ni échec ou erreur,
parce que le code de test ne sera pas exécuté.
</p>
<p>
La raison ? Pour permettre un affichage complexe
d'une IHM (ou GUI) qui permettrait la sélection
de scénarios de test individuels.
Afin de construire une liste de tests possibles,
ils ont besoin d'un rapport sur la structure du test
pour l'affichage, par exemple, d'une vue en arbre
de la suite de test. Avec un rapporteur lancé
sur une exécution sèche qui ne renverrait
que les évènements d'affichage, cela devient
facilement réalisable.
</p>
<h2>
<a class="target" name="autre"></a>Etendre le rapporteur</h2>
<p>
Plutôt que de modifier l'affichage existant,
vous voudrez peut-être produire une présentation HTML
complètement différente, ou même générer une version texte ou XML.
Plutôt que de surcharger chaque méthode dans
<span class="new_code">HtmlReporter</span> nous pouvons nous rendre
une étape plus haut dans la hiérarchie de classe vers
<span class="new_code">SimpleReporter</span> dans le fichier source <em>simple_test.php</em>.
</p>
<p>
Un affichage sans rien, un canevas vierge
pour votre propre création, serait...
<pre>
<strong>require_once('simpletest/simpletest.php');</strong>
class MyDisplay extends SimpleReporter {<strong>
</strong>
function paintHeader($test_name) { }
function paintFooter($test_name) { }
function paintStart($test_name, $size) {<strong>
parent::paintStart($test_name, $size);</strong>
}
function paintEnd($test_name, $size) {<strong>
parent::paintEnd($test_name, $size);</strong>
}
function paintPass($message) {<strong>
parent::paintPass($message);</strong>
}
function paintFail($message) {<strong>
parent::paintFail($message);</strong>
}
function paintError($message) {<strong>
parent::paintError($message);</strong>
}
function paintException($exception) {<strong>
parent::paintException($exception);</strong>
}
}
</pre>
Aucune sortie ne viendrait de cette classe jusqu'à un ajout de votre part.
</p>
<p>
Sauf qu'il y a un problème : en utilisant cette cette classe
de bas niveau, vous devez explicitement l'invoquer
dans les scripts de test.
La commande "autorun" ne sera pas capable
d'utiliser son contexte courant (qu'elle soit lancée
dans un navigateur web ou via une ligne de commande)
pour sélectionner le rapporteur.
</p>
<p>
Vous invoquez explicitement la lanceur de tests comme suit...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
...ou peut-être comme cela...
<pre>
&lt;?php
require_once('simpletest/simpletest.php');
require_once('my_reporter.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
$test = new MyTest();
$test-&gt;run(<strong>new MyReporter()</strong>);
?&gt;
</pre>
Nous verrons plus comment l'intégrer avec l'"autorun".
</p>
<h2>
<a class="target" name="cli"></a>Le rapporteur en ligne de commande</h2>
<p>
SimpleTest est aussi livré avec un rapporteur
en ligne de commande, minime lui aussi.
Pour utiliser le rapporteur en ligne de commande explicitement,
il suffit de l'intervertir avec celui de la version HTML...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
$test-&gt;run(<strong>new TextReporter()</strong>);
?&gt;
</pre>
Et ensuite d'invoquer la suite de test à partir d'une ligne de commande...
<pre class="shell">
php file_test.php
</pre>
Bien sûr vous aurez besoin d'installer PHP
en ligne de commande. Une suite de test qui
passerait toutes ses assertions ressemble à...
<pre class="shell">
File test
OK
Test cases run: 1/1, Passes: 1, Failures: 0, Exceptions: 0
</pre>
Un échec déclenche un affichage comme...
<pre class="shell">
File test
1) True assertion failed.
in createNewFile
FAILURES!!!
Test cases run: 1/1, Passes: 0, Failures: 1, Exceptions: 0
</pre>
</p>
<p>
Une des principales raisons pour utiliser
une suite de test en ligne de commande tient
dans l'utilisation possible du testeur avec
un processus automatisé. Pour fonctionner comme
il faut dans des scripts shell le script de test
devrait renvoyer un code de sortie non-nul suite à un échec.
Si une suite de test échoue la valeur <span class="new_code">false</span>
est renvoyée par la méthode <span class="new_code">SimpleTest::run()</span>.
Nous pouvons utiliser ce résultat pour terminer le script
avec la bonne valeur renvoyée...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>exit ($test-&gt;run(new TextReporter()) ? 0 : 1);</strong>
?&gt;
</pre>
Bien sûr l'objectif ne serait pas de créer deux scripts de test,
l'un en ligne de commande et l'autre pour un navigateur web,
pour chaque suite de test.
Le rapporteur en ligne de commande inclut
une méthode pour déterminer l'environnement d'exécution...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
$test = new TestSuite('File test');
$test-&gt;addFile('tests/file_test.php');
<strong>if (TextReporter::inCli()) {</strong>
exit ($test-&gt;run(new TextReporter()) ? 0 : 1);
<strong>}</strong>
$test-&gt;run(new HtmlReporter());
?&gt;
</pre>
Il s'agit là de la forme utilisée par SimpleTest lui-même.
Quand vous utilisez l'"autorun.php"
et qu'aucun test n'a été lancé avant la fin,
c'est quasiment le code que SimpleTest lancera
pour vous implicitement.
</p>
<p>
En d'autres termes, ceci donne le même résultat...
<pre>
&lt;?php
require_once('simpletest/autorun.php');
class MyTest extends TestSuite {
function __construct() {
parent::__construct();
$this-&gt;addFile('tests/file_test.php');
}
}
?&gt;
</pre> </p>
<h2>
<a class="target" name="xml"></a>Test distant</h2>
<p>
SimpleTest est livré avec une classe <span class="new_code">XmlReporter</span>
utilisée pour de la communication interne.
Lors de son exécution, le résultat ressemble à...
<pre class="shell">
&lt;?xml version="1.0"?&gt;
&lt;run&gt;
&lt;group size="4"&gt;
&lt;name&gt;Remote tests&lt;/name&gt;
&lt;group size="4"&gt;
&lt;name&gt;Visual test with 48 passes, 48 fails and 4 exceptions&lt;/name&gt;
&lt;case&gt;
&lt;name&gt;testofunittestcaseoutput&lt;/name&gt;
&lt;test&gt;
&lt;name&gt;testofresults&lt;/name&gt;
&lt;pass&gt;This assertion passed&lt;/pass&gt;
&lt;fail&gt;This assertion failed&lt;/fail&gt;
&lt;/test&gt;
&lt;test&gt;
...
&lt;/test&gt;
&lt;/case&gt;
&lt;/group&gt;
&lt;/group&gt;
&lt;/run&gt;
</pre>
Pour faire en sorte ue vos scénarios de test produisent ce format,
dans la ligne de commande, ajoutez le flag <span class="new_code">--xml</span>.
<pre class="shell">
php my_test.php --xml
</pre>
Vous pouvez faire la même chose dans le navigation web
en ajoutant le paramètre <span class="new_code">xml=1</span> dans l'URL.
N'importe quelle valeur "true" fera l'affaire.
</p>
<p>
Vous pouvez utiliser ce format avec le parseur
fourni dans SimpleTest lui-même.
Il s'agit de <span class="new_code">SimpleTestXmlParser</span>
et se trouve <em>xml.php</em> à l'intérieur du paquet SimpleTest...
<pre>
&lt;?php
require_once('simpletest/xml.php');
...
$parser = new SimpleTestXmlParser(new HtmlReporter());
$parser-&gt;parse($test_output);
?&gt;
</pre>
<span class="new_code">$test_output</span> devrait être au format XML,
à partir du rapporteur XML, et pourrait venir
d'une exécution en ligne de commande d'un scénario de test.
Le parseur envoie des évènements au rapporteur exactement
comme tout autre exécution de test.
Il y a des occasions bizarres dans lesquelles c'est en fait très utile.
</p>
<p>
Le plus courant, c'est quand vous voulez isoler
un test sensible au crash.
Vous pouvez collecter la sortie XML en utilisant
l'opérateur antiquote (Ndt : backtick) à partir
d'un autre test.
De la sorte, il tourne dans son propre processus...
<pre>
&lt;?php
require_once('simpletest/xml.php');
if (TextReporter::inCli()) {
$parser = new SimpleTestXmlParser(new TextReporter());
} else {
$parser = new SimpleTestXmlParser(new HtmlReporter());
}
$parser-&gt;parse(`php flakey_test.php --xml`);
?&gt;
</pre>
</p>
<p>
Un autre cas est celui des très longues suites de tests.
</p>
<p>
Elles peuvent venir à bout de la limite de mémoire
par défaut d'un process PHP - 16Mb.
En plaçant la sortie des groupes de test dans du XML
et leur exécution dans des process différents,
le résultat peut être parsé à nouveau pour agréger
les résultats avec moins d'impact sur le test au premier niveau.
</p>
<p>
Parce que la sortie XML peut venir de n'importe où,
ça ouvre des possibilités d'agrégation d'exécutions de test
depuis des serveur distants.
Un scénario de test pour le réaliser existe déjà
à l'intérieur du framework SimpleTest, mais il est encore expérimental...
<pre>
&lt;?php
<strong>require_once('../remote.php');</strong>
require_once('simpletest/autorun.php');
$test_url = ...;
$dry_url = ...;
class MyTestOnAnotherServer extends RemoteTestCase {
function __construct() {
$test_url = ...
parent::__construct($test_url, $test_url . ' --dry');
}
}
?&gt;
</pre>
<span class="new_code">RemoteTestCase</span> prend la localisation réelle
du lanceur de test, tout simplement un page web au format XML.
Il prend aussi l'URL d'un rapporteur initié
pour effectuer une exécution sèche.
Cette technique est employée pour que les progrès
soient correctement rapportés vers le haut.
<span class="new_code">RemoteTestCase</span> peut être ajouté à
une suite de test comme n'importe quelle autre suite de tests.
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
L'<a href="http://simpletest.org/api/">API pour développeur de SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,447 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest pour les tests de régression en PHP</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur les tests unitaires en PHP</h1>
This page...
<ul>
<li>
<a href="#unitaire">Scénarios de test unitaire</a>
et opérations basiques.
</li>
<li>
<a href="#extension_unitaire">Étendre des scénarios de test</a>
pour les personnaliser à votre propre projet.
</li>
<li>
<a href="#lancement_unitaire">Lancer un scénario seul</a>
comme un script unique.
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="unitaire"></a>Scénarios de tests unitaires</h2>
<p>
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 à...
<pre>
<strong>class FileTestCase extends UnitTestCase {
}</strong>
</pre>
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.
</p>
<p>
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...
<pre>
require_once('simpletest/autorun.php');
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
function FileTestCase() {
$this-&gt;UnitTestCase('File test');
}<strong>
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');
$this-&gt;assertTrue(file_exists('../temp/test.txt'), 'File created');
}</strong>
}
</pre>
Le constructeur est optionnel et souvent omis. Sans nom,
le nom de la classe est utilisé comme nom pour le scénario de test.
</p>
<p>
Notre unique méthode de test pour le moment est
<span class="new_code">testCreation()</span> où nous vérifions
qu'un fichier a bien été créé par notre objet
<span class="new_code">Writer</span>. Nous pourrions avoir mis
le code <span class="new_code">unlink()</span> dans cette méthode,
mais en la plaçant dans <span class="new_code">setUp()</span>
et <span class="new_code">tearDown()</span> nous pouvons l'utiliser
pour nos autres méthodes de test que nous ajouterons.
</p>
<p>
La méthode <span class="new_code">setUp()</span> est lancé
juste avant chaque méthode de test.
<span class="new_code">tearDown()</span> est lancé après chaque méthode de test.
</p>
<p>
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
<span class="new_code">setUp()</span>, mais fournit aux codeurs de bibliothèque d'autres crochets.
</p>
<p>
Pour rapporter les résultats de test,
le passage par une classe d'affichage - notifiée par
les différentes méthodes de type <span class="new_code">assert...()</span> -
est utilisée. En voici la liste complète pour
la classe <span class="new_code">UnitTestCase</span>,
celle par défaut dans SimpleTest...
<table><tbody>
<tr>
<td><span class="new_code">assertTrue($x)</span></td>
<td>Echoue si $x est faux</td>
</tr>
<tr>
<td><span class="new_code">assertFalse($x)</span></td>
<td>Echoue si $x est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertNull($x)</span></td>
<td>Echoue si $x est initialisé</td>
</tr>
<tr>
<td><span class="new_code">assertNotNull($x)</span></td>
<td>Echoue si $x n'est pas initialisé</td>
</tr>
<tr>
<td><span class="new_code">assertIsA($x, $t)</span></td>
<td>Echoue si $x n'est pas de la classe ou du type $t</td>
</tr>
<tr>
<td><span class="new_code">assertEqual($x, $y)</span></td>
<td>Echoue si $x == $y est faux</td>
</tr>
<tr>
<td><span class="new_code">assertNotEqual($x, $y)</span></td>
<td>Echoue si $x == $y est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertIdentical($x, $y)</span></td>
<td>Echoue si $x === $y est faux</td>
</tr>
<tr>
<td><span class="new_code">assertNotIdentical($x, $y)</span></td>
<td>Echoue si $x === $y est vrai</td>
</tr>
<tr>
<td><span class="new_code">assertReference($x, $y)</span></td>
<td>Echoue sauf si $x et $y sont la même variable</td>
</tr>
<tr>
<td><span class="new_code">assertCopy($x, $y)</span></td>
<td>Echoue si $x et $y sont la même variable</td>
</tr>
<tr>
<td><span class="new_code">assertPattern($p, $x)</span></td>
<td>Echoue sauf si l'expression rationnelle $p capture $x</td>
</tr>
<tr>
<td><span class="new_code">assertNoPattern($p, $x)</span></td>
<td>Echoue si l'expression rationnelle $p capture $x</td>
</tr>
<tr>
<td><span class="new_code">expectError($x)</span></td>
<td>Echoue si l'erreur correspondante n'arrive pas</td>
</tr>
<tr>
<td><span class="new_code">expectException($x)</span></td>
<td>Echoue si l'exception correspondante n'est pas levée</td>
</tr>
<tr>
<td><span class="new_code">ignoreException($x)</span></td>
<td>Avale toutes les exceptions correspondantes qui surviendraient</td>
</tr>
<tr>
<td><span class="new_code">assert($e)</span></td>
<td>Echoue sur un objet <a href="expectation_documentation.html">attente</a> $e qui échouerait</td>
</tr>
</tbody></table>
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.
</p>
<p>
D'autres exemples...
<pre>
<strong>$variable = null;
$this-&gt;assertNull($variable, 'Should be cleared');</strong>
</pre>
...passera et normalement n'affichera aucun message.
Si vous avez <a href="http://www.lastcraft.com/display_subclass_tutorial.php">
configuré le testeur pour afficher aussi les succès</a>
alors le message sera affiché comme tel.
<pre>
<strong>$this-&gt;assertIdentical(0, false, 'Zero is not false [%s]');</strong>
</pre>
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.
<pre>
<strong>$a = 1;
$b = $a;
$this-&gt;assertReference($a, $b);</strong>
</pre>
Échouera étant donné que la variable <span class="new_code">$b</span>
est une copie de <span class="new_code">$a</span>.
<pre>
<strong>$this-&gt;assertPattern('/hello/i', 'Hello world');</strong>
</pre>
Là, ça passe puisque la recherche est insensible
à la casse et que donc <span class="new_code">hello</span>
est bien repérable dans <span class="new_code">Hello world</span>.
<pre>
<strong>$this-&gt;expectError();</strong>
trigger_error('Catastrophe');
</pre>
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.
<pre>
<strong>$this-&gt;expectError('Catastrophe');</strong>
trigger_error('Catastrophe');
</pre>
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.
</p>
<p>
Notez que SimpleTest ne peut pas attraper des erreurs PHP
au moment de la compilation.
</p>
<p>
Les scénarios de tests peuvent utiliser des méthodes
bien pratiques pour déboguer le code ou pour étendre la suite...
<table><tbody>
<tr>
<td><span class="new_code">setUp()</span></td>
<td>Est lancée avant chaque méthode de test</td>
</tr>
<tr>
<td><span class="new_code">tearDown()</span></td>
<td>Est lancée après chaque méthode de test</td>
</tr>
<tr>
<td><span class="new_code">pass()</span></td>
<td>Envoie un succès</td>
</tr>
<tr>
<td><span class="new_code">fail()</span></td>
<td>Envoie un échec</td>
</tr>
<tr>
<td><span class="new_code">error()</span></td>
<td>Envoi un évènement exception</td>
</tr>
<tr>
<td><span class="new_code">signal($type, $payload)</span></td>
<td>Envoie un message défini par l'utilisateur au rapporteur du test</td>
</tr>
<tr>
<td><span class="new_code">dump($var)</span></td>
<td>Effectue un <span class="new_code">print_r()</span> formaté pour du déboguage rapide et grossier</td>
</tr>
</tbody></table>
</p>
<h2>
<a class="target" name="extension_unitaire"></a>Etendre les scénarios de test</h2>
<p>
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...
<pre>
require_once('simpletest/autorun.php');
<strong>
class FileTester extends UnitTestCase {
function FileTester($name = false) {
$this-&gt;UnitTestCase($name);
}
function assertFileExists($filename, $message = '%s') {
$this-&gt;assertTrue(
file_exists($filename),
sprintf($message, 'File [$filename] existence check'));
}</strong>
}
</pre>
Ici la bibliothèque SimpleTest est localisée
dans un répertoire local appelé <em>simpletest</em>.
Pensez à le modifier pour votre propre environnement.
</p>
<p>
Alternativement vous pourriez utiliser dans votre code
un directive <span class="new_code">SimpleTestOptions::ignore('FileTester');</span>.
</p>
<p>
Ce nouveau scénario peut être hérité exactement
comme un scénario de test classique...
<pre>
class FileTestCase extends <strong>FileTester</strong> {
function setUp() {
@unlink('../temp/test.txt');
}
function tearDown() {
@unlink('../temp/test.txt');
}
function testCreation() {
$writer = &amp;new FileWriter('../temp/test.txt');
$writer-&gt;write('Hello');<strong>
$this-&gt;assertFileExists('../temp/test.txt');</strong>
}
}
</pre>
</p>
<p>
Si vous souhaitez un scénario de test sans
toutes les assertions de <span class="new_code">UnitTestCase</span>
mais uniquement avec les vôtres propres,
vous aurez besoin d'étendre la classe
<span class="new_code">SimpleTestCase</span> à la place.
Elle se trouve dans <em>simple_test.php</em>
en lieu et place de <em>unit_tester.php</em>.
A consulter <a href="group_test_documentation.html">plus tard</a>
si vous souhaitez incorporer les scénarios
d'autres testeurs unitaires dans votre suite de test.
</p>
<h2>
<a class="target" name="lancement_unitaire"></a>Lancer un unique scénario de test</h2>
<p>
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 <em>autorun</em> aucun échafaudage particulier
n'est nécessaire, il suffit de lancer votre test et
vous y êtes.
</p>
<p>
Vous pouvez même décider quel rapporteur
(par exemple, <span class="new_code">TextReporter</span> ou <span class="new_code">HtmlReporter</span>)
vous préférez pour un fichier spécifique quand il est lancé
tout seul...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
SimpleTest :: prefer(new TextReporter());</strong>
require_once('../classes/writer.php');
class FileTestCase extends UnitTestCase {
...
}
?&gt;
</pre>
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.
</p>
</div>
References and related information...
<ul>
<li>
La page de SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API complète de SimpleTest</a>
à partir de PHPDoc.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>

View File

@@ -0,0 +1,570 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation SimpleTest : tester des scripts web</title>
<link rel="stylesheet" type="text/css" href="docs.css" title="Styles">
</head>
<body>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<h1>Documentation sur le testeur web</h1>
This page...
<ul>
<li>
Réussir à <a href="#telecharger">télécharger une page web</a>
</li>
<li>
Tester le <a href="#contenu">contenu de la page</a>
</li>
<li>
<a href="#navigation">Naviguer sur un site web</a> pendant le test
</li>
<li>
Méthodes pour <a href="#requete">modifier une requête</a> et pour déboguer
</li>
</ul>
<div class="content">
<h2>
<a class="target" name="telecharger"></a>Télécharger une page</h2>
<p>
Tester des classes c'est très bien.
Reste que PHP est avant tout un langage
pour créer des fonctionnalités à l'intérieur de pages web.
Comment pouvons tester la partie de devant
-- celle de l'interface -- dans nos applications en PHP ?
Etant donné qu'une page web n'est constituée que de texte,
nous devrions pouvoir les examiner exactement
comme n'importe quelle autre donnée de test.
</p>
<p>
Cela nous amène à une situation délicate.
Si nous testons dans un niveau trop bas,
vérifier des balises avec un motif ad hoc par exemple,
nos tests seront trop fragiles. Le moindre changement
dans la présentation pourrait casser un grand nombre de test.
Si nos tests sont situés trop haut, en utilisant
une version fantaisie du moteur de template pour
donner un cas précis, alors nous perdons complètement
la capacité à automatiser certaines classes de test.
Par exemple, l'interaction entre des formulaires
et la navigation devra être testé manuellement.
Ces types de test sont extrêmement fastidieux
et plutôt sensibles aux erreurs.
</p>
<p>
SimpleTest comprend une forme spéciale de scénario
de test pour tester les actions d'une page web.
<span class="new_code">WebTestCase</span> inclut des facilités pour la navigation,
des vérifications sur le contenu
et les cookies ainsi que la gestion des formulaires.
Utiliser ces scénarios de test ressemble
fortement à <span class="new_code">UnitTestCase</span>...
<pre>
<strong>class TestOfLastcraft extends WebTestCase {
}</strong>
</pre>
Ici nous sommes sur le point de tester
le site de <a href="http://www.lastcraft.com/">Last Craft</a>.
Si ce scénario de test est situé dans un fichier appelé
<em>lastcraft_test.php</em> alors il peut être chargé
dans un script de lancement tout comme des tests unitaires...
<pre>
&lt;?php
require_once('simpletest/autorun.php');<strong>
require_once('simpletest/web_tester.php');</strong>
SimpleTest::prefer(new TextReporter());
class WebTests extends TestSuite {
function WebTests() {
$this-&gt;TestSuite('Web site tests');<strong>
$this-&gt;addFile('lastcraft_test.php');</strong>
}
}
?&gt;
</pre>
J'utilise ici le rapporteur en mode texte
pour mieux distinguer le contenu au format HTML
du résultat du test proprement dit.
</p>
<p>
Rien n'est encore testé. Nous pouvons télécharger
la page d'accueil en utilisant la méthode <span class="new_code">get()</span>...
<pre>
class TestOfLastcraft extends WebTestCase {
<strong>
function testHomepage() {
$this-&gt;assertTrue($this-&gt;get('http://www.lastcraft.com/'));
}</strong>
}
</pre>
La méthode <span class="new_code">get()</span> renverra "true"
uniquement si le contenu de la page a bien été téléchargé.
C'est un moyen simple, mais efficace pour vérifier
qu'une page web a bien été délivré par le serveur web.
Cependant le contenu peut révéler être une erreur 404
et dans ce cas notre méthode <span class="new_code">get()</span> renverrait encore un succès.
</p>
<p>
En supposant que le serveur web pour le site Last Craft
soit opérationnel (malheureusement ce n'est pas toujours le cas),
nous devrions voir...
<pre class="shell">
Web site tests
OK
Test cases run: 1/1, Failures: 0, Exceptions: 0
</pre>
Nous avons vérifié qu'une page, de n'importe quel type,
a bien été renvoyée. Nous ne savons pas encore
s'il s'agit de celle que nous souhaitions.
</p>
<h2>
<a class="target" name="contenu"></a>Tester le contenu d'une page</h2>
<p>
Pour obtenir la confirmation que la page téléchargée
est bien celle que nous attendions,
nous devons vérifier son contenu.
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;get('http://www.lastcraft.com/');
$this-&gt;assertWantedPattern('/why the last craft/i');</strong>
}
}
</pre>
La page obtenue par le dernier téléchargement est
placée dans un buffer au sein même du scénario de test.
Il n'est donc pas nécessaire de s'y référer directement.
La correspondance du motif est toujours effectuée
par rapport à ce buffer.
</p>
<p>
Voici une liste possible d'assertions sur le contenu...
<table><tbody>
<tr>
<td><span class="new_code">assertWantedPattern($pattern)</span></td>
<td>Vérifier une correspondance sur le contenu via une expression rationnelle Perl</td>
</tr>
<tr>
<td><span class="new_code">assertNoUnwantedPattern($pattern)</span></td>
<td>Une expression rationnelle Perl pour vérifier une absence</td>
</tr>
<tr>
<td><span class="new_code">assertTitle($title)</span></td>
<td>Passe si le titre de la page correspond exactement</td>
</tr>
<tr>
<td><span class="new_code">assertLink($label)</span></td>
<td>Passe si un lien avec ce texte est présent</td>
</tr>
<tr>
<td><span class="new_code">assertNoLink($label)</span></td>
<td>Passe si aucun lien avec ce texte est présent</td>
</tr>
<tr>
<td><span class="new_code">assertLinkById($id)</span></td>
<td>Passe si un lien avec cet attribut d'identification est présent</td>
</tr>
<tr>
<td><span class="new_code">assertField($name, $value)</span></td>
<td>Passe si une balise input avec ce nom contient cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertFieldById($id, $value)</span></td>
<td>Passe si une balise input avec cet identifiant contient cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertResponse($codes)</span></td>
<td>Passe si la réponse HTTP trouve une correspondance dans la liste</td>
</tr>
<tr>
<td><span class="new_code">assertMime($types)</span></td>
<td>Passe si le type MIME se retrouve dans cette liste</td>
</tr>
<tr>
<td><span class="new_code">assertAuthentication($protocol)</span></td>
<td>Passe si l'authentification provoquée est de ce type de protocole</td>
</tr>
<tr>
<td><span class="new_code">assertNoAuthentication()</span></td>
<td>Passe s'il n'y pas d'authentification provoquée en cours</td>
</tr>
<tr>
<td><span class="new_code">assertRealm($name)</span></td>
<td>Passe si le domaine provoqué correspond</td>
</tr>
<tr>
<td><span class="new_code">assertHeader($header, $content)</span></td>
<td>Passe si une entête téléchargée correspond à cette valeur</td>
</tr>
<tr>
<td><span class="new_code">assertNoUnwantedHeader($header)</span></td>
<td>Passe si une entête n'a pas été téléchargé</td>
</tr>
<tr>
<td><span class="new_code">assertHeaderPattern($header, $pattern)</span></td>
<td>Passe si une entête téléchargée correspond à cette expression rationnelle Perl</td>
</tr>
<tr>
<td><span class="new_code">assertCookie($name, $value)</span></td>
<td>Passe s'il existe un cookie correspondant</td>
</tr>
<tr>
<td><span class="new_code">assertNoCookie($name)</span></td>
<td>Passe s'il n'y a pas de cookie avec un tel nom</td>
</tr>
</tbody></table>
Comme d'habitude avec les assertions de SimpleTest,
elles renvoient toutes "false" en cas d'échec
et "true" si c'est un succès.
Elles renvoient aussi un message de test optionnel :
vous pouvez l'ajouter dans votre propre message en utilisant "%s".
</p>
<p>
A présent nous pourrions effectué le test sur le titre uniquement...
<pre>
<strong>$this-&gt;assertTitle('The Last Craft?');</strong>
</pre>
En plus d'une simple vérification sur le contenu HTML,
nous pouvons aussi vérifier que le type MIME est bien d'un type acceptable...
<pre>
<strong>$this-&gt;assertMime(array('text/plain', 'text/html'));</strong>
</pre>
Plus intéressant encore est la vérification sur
le code de la réponse HTTP. Pareillement au type MIME,
nous pouvons nous assurer que le code renvoyé se trouve
bien dans un liste de valeurs possibles...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {
$this-&gt;get('http://simpletest.sourceforge.net/');<strong>
$this-&gt;assertResponse(200);</strong>
}
}
</pre>
Ici nous vérifions que le téléchargement s'est
bien terminé en ne permettant qu'une réponse HTTP 200.
Ce test passera, mais ce n'est pas la meilleure façon de procéder.
Il n'existe aucune page sur <em>http://simpletest.sourceforge.net/</em>,
à la place le serveur renverra une redirection vers
<em>http://www.lastcraft.com/simple_test.php</em>.
<span class="new_code">WebTestCase</span> suit automatiquement trois
de ces redirections. Les tests sont quelque peu plus
robustes de la sorte. Surtout qu'on est souvent plus intéressé
par l'interaction entre les pages que de leur simple livraison.
Si les redirections se révèlent être digne d'intérêt,
il reste possible de les supprimer...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {<strong>
$this-&gt;setMaximumRedirects(0);</strong>
$this-&gt;get('http://simpletest.sourceforge.net/');
$this-&gt;assertResponse(200);
}
}
</pre>
Alors l'assertion échoue comme prévue...
<pre class="shell">
Web site tests
1) Expecting response in [200] got [302]
in testhomepage
in testoflastcraft
in lastcraft_test.php
FAILURES!!!
Test cases run: 1/1, Failures: 1, Exceptions: 0
</pre>
Nous pouvons modifier le test pour accepter les redirections...
<pre>
class TestOfLastcraft extends WebTestCase {
function testHomepage() {
$this-&gt;setMaximumRedirects(0);
$this-&gt;get('http://simpletest.sourceforge.net/');
$this-&gt;assertResponse(<strong>array(301, 302, 303, 307)</strong>);
}
}
</pre>
Maitenant ça passe.
</p>
<h2>
<a class="target" name="navigation"></a>Navigeur dans un site web</h2>
<p>
Les utilisateurs ne naviguent pas souvent en tapant les URLs,
mais surtout en cliquant sur des liens et des boutons.
Ici nous confirmons que les informations sur le contact
peuvent être atteintes depuis la page d'accueil...
<pre>
class TestOfLastcraft extends WebTestCase {
...
function testContact() {
$this-&gt;get('http://www.lastcraft.com/');<strong>
$this-&gt;clickLink('About');
$this-&gt;assertTitle('About Last Craft');</strong>
}
}
</pre>
Le paramètre est le texte du lien.
</p>
<p>
Il l'objectif est un bouton plutôt qu'une balise ancre,
alors <span class="new_code">clickSubmit()</span> doit être utilisé avec
le titre du bouton...
<pre>
<strong>$this-&gt;clickSubmit('Go!');</strong>
</pre>
</p>
<p>
La liste des méthodes de navigation est...
<table><tbody>
<tr>
<td><span class="new_code">get($url, $parameters)</span></td>
<td>Envoie une requête GET avec ces paramètres</td>
</tr>
<tr>
<td><span class="new_code">post($url, $parameters)</span></td>
<td>Envoie une requête POST avec ces paramètres</td>
</tr>
<tr>
<td><span class="new_code">head($url, $parameters)</span></td>
<td>Envoie une requête HEAD sans remplacer le contenu de la page</td>
</tr>
<tr>
<td><span class="new_code">retry()</span></td>
<td>Relance la dernière requête</td>
</tr>
<tr>
<td><span class="new_code">back()</span></td>
<td>Identique au bouton "Précédent" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">forward()</span></td>
<td>Identique au bouton "Suivant" du navigateur</td>
</tr>
<tr>
<td><span class="new_code">authenticate($name, $password)</span></td>
<td>Re-essaye avec une tentative d'authentification</td>
</tr>
<tr>
<td><span class="new_code">getFrameFocus()</span></td>
<td>Le nom de la fenêtre en cours d'utilisation</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocusByIndex($choice)</span></td>
<td>Change le focus d'une fenêtre en commençant par 1</td>
</tr>
<tr>
<td><span class="new_code">setFrameFocus($name)</span></td>
<td>Change le focus d'une fenêtre en utilisant son nom</td>
</tr>
<tr>
<td><span class="new_code">clearFrameFocus()</span></td>
<td>Revient à un traitement de toutes les fenêtres comme une seule</td>
</tr>
<tr>
<td><span class="new_code">clickSubmit($label)</span></td>
<td>Clique sur le premier bouton avec cette étiquette</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitByName($name)</span></td>
<td>Clique sur le bouton avec cet attribut de nom</td>
</tr>
<tr>
<td><span class="new_code">clickSubmitById($id)</span></td>
<td>Clique sur le bouton avec cet attribut d'identification</td>
</tr>
<tr>
<td><span class="new_code">clickImage($label, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son titre (title="*") our son texte alternatif (alt="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageByName($name, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son attribut (name="*")</td>
</tr>
<tr>
<td><span class="new_code">clickImageById($id, $x, $y)</span></td>
<td>Clique sur une balise input de type image par son identifiant (id="*")</td>
</tr>
<tr>
<td><span class="new_code">submitFormById($id)</span></td>
<td>Soumet un formulaire sans valeur de soumission</td>
</tr>
<tr>
<td><span class="new_code">clickLink($label, $index)</span></td>
<td>Clique sur une ancre avec ce texte d'étiquette visible</td>
</tr>
<tr>
<td><span class="new_code">clickLinkById($id)</span></td>
<td>Clique sur une ancre avec cet attribut d'identification</td>
</tr>
</tbody></table>
</p>
<p>
Les paramètres dans les méthodes <span class="new_code">get()</span>,
<span class="new_code">post()</span> et <span class="new_code">head()</span> sont optionnels.
Le téléchargement via HTTP HEAD ne modifie pas
le contexte du navigateur, il se limite au chargement des cookies.
Cela peut être utilise lorsqu'une image ou une feuille de style
initie un cookie pour bloquer un robot trop entreprenant.
</p>
<p>
Les commandes <span class="new_code">retry()</span>, <span class="new_code">back()</span>
et <span class="new_code">forward()</span> fonctionnent exactement comme
dans un navigateur. Elles utilisent l'historique pour
relancer les pages. Une technique bien pratique pour
vérifier les effets d'un bouton retour sur vos formulaires.
</p>
<p>
Les méthodes sur les fenêtres méritent une petite explication.
Par défaut, une page avec des fenêtres est traitée comme toutes
les autres. Le contenu sera vérifié à travers l'ensemble de
la "frameset", par conséquent un lien fonctionnera,
peu importe la fenêtre qui contient la balise ancre.
Vous pouvez outrepassé ce comportement en exigeant
le focus sur une unique fenêtre. Si vous réalisez cela,
toutes les recherches et toutes les actions se limiteront
à cette unique fenêtre, y compris les demandes d'authentification.
Si un lien ou un bouton n'est pas dans la fenêtre en focus alors
il ne peut pas être cliqué.
</p>
<p>
Tester la navigation sur des pages fixes ne vous alerte que
quand vous avez cassé un script entier.
Pour des pages fortement dynamiques,
un forum de discussion par exemple,
ça peut être crucial pour vérifier l'état de l'application.
Pour la plupart des applications cependant,
la logique vraiment délicate se situe dans la gestion
des formulaires et des sessions.
Heureusement SimpleTest aussi inclut
<a href="form_testing_documentation.html">
des outils pour tester des formulaires web</a>.
</p>
<h2>
<a class="target" name="requete"></a>Modifier la requête</h2>
<p>
Bien que SimpleTest n'ait pas comme objectif
de contrôler des erreurs réseau, il contient quand même
des méthodes pour modifier et déboguer les requêtes qu'il lance.
Voici une autre liste de méthode...
<table><tbody>
<tr>
<td><span class="new_code">getTransportError()</span></td>
<td>La dernière erreur de socket</td>
</tr>
<tr>
<td><span class="new_code">getUrl()</span></td>
<td>La localisation courante</td>
</tr>
<tr>
<td><span class="new_code">showRequest()</span></td>
<td>Déverse la requête sortante</td>
</tr>
<tr>
<td><span class="new_code">showHeaders()</span></td>
<td>Déverse les entêtes d'entrée</td>
</tr>
<tr>
<td><span class="new_code">showSource()</span></td>
<td>Déverse le contenu brut de la page HTML</td>
</tr>
<tr>
<td><span class="new_code">ignoreFrames()</span></td>
<td>Ne recharge pas les framesets</td>
</tr>
<tr>
<td><span class="new_code">setCookie($name, $value)</span></td>
<td>Initie un cookie à partir de maintenant</td>
</tr>
<tr>
<td><span class="new_code">addHeader($header)</span></td>
<td>Ajoute toujours cette entête à la requête</td>
</tr>
<tr>
<td><span class="new_code">setMaximumRedirects($max)</span></td>
<td>S'arrête après autant de redirections</td>
</tr>
<tr>
<td><span class="new_code">setConnectionTimeout($timeout)</span></td>
<td>Termine la connexion après autant de temps entre les bytes</td>
</tr>
<tr>
<td><span class="new_code">useProxy($proxy, $name, $password)</span></td>
<td>Effectue les requêtes à travers ce proxy d'URL</td>
</tr>
</tbody></table>
</p>
</div>
References and related information...
<ul>
<li>
La page du projet SimpleTest sur
<a href="http://sourceforge.net/projects/simpletest/">SourceForge</a>.
</li>
<li>
La page de téléchargement de SimpleTest sur
<a href="http://www.lastcraft.com/simple_test.php">LastCraft</a>.
</li>
<li>
<a href="http://simpletest.org/api/">L'API du développeur pour SimpleTest</a>
donne tous les détails sur les classes et les assertions disponibles.
</li>
</ul>
<div class="menu_back"><div class="menu">
<a href="index.html">SimpleTest</a>
|
<a href="overview.html">Overview</a>
|
<a href="unit_test_documentation.html">Unit tester</a>
|
<a href="group_test_documentation.html">Group tests</a>
|
<a href="mock_objects_documentation.html">Mock objects</a>
|
<a href="partial_mocks_documentation.html">Partial mocks</a>
|
<a href="reporter_documentation.html">Reporting</a>
|
<a href="expectation_documentation.html">Expectations</a>
|
<a href="web_tester_documentation.html">Web tester</a>
|
<a href="form_testing_documentation.html">Testing forms</a>
|
<a href="authentication_documentation.html">Authentication</a>
|
<a href="browser_documentation.html">Scriptable browser</a>
</div></div>
<div class="copyright">
Copyright<br>Marcus Baker 2006
</div>
</body>
</html>