Documentation SimpleTest : tester des formulaires HTML

# Documentation sur les tests de formulaire

This page...

- Modifier les valeurs d'un formulaire et réussir à transmettre un simple formulaire
- Gérer des objets à valeurs multiples en initialisant des listes.
- Le cas des formulaires utilisant Javascript pour modifier un champ caché
- Envoi brut quand il n'existe pas de bouton à cliquer.

## Valider un formulaire simple

Lorsqu'une page est téléchargée par WebTestCase en utilisant get() ou post() 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 <form> sont disponibles depuis l'intérieur du scénario de test. Prenons par exemple cet extrait de code HTML...

    <form>
        <input type="text" name="a" value="A default" />
        <input type="submit" value="Go" />
    </form>

Il ressemble à...

Nous pouvons naviguer vers ce code, via le site LastCraft, avec le test suivant...

    class SimpleFormTests extends WebTestCase {
        function testDefaultValue() {
            $this->get('http://www.lastcraft.com/form_testing_documentation.php');
            $this->assertField('a', 'A default');
        }
    }

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".

Nous pourrions retourner le formulaire tout de suite...

    class SimpleFormTests extends WebTestCase {
        function testDefaultValue() {
            $this->get('http://www.lastcraft.com/form_testing_documentation.php');
            $this->assertField('a', new PatternExpectation('/default/'));
        }
    }

Mais d'abord nous allons changer la valeur du champ texte. Ce n'est qu'après que nous le transmettrons...

    class SimpleFormTests extends WebTestCase {

        function testDefaultValue() {
            $this->get('http://www.my-site.com/');
            $this->assertField('a', 'A default');
            $this->setField('a', 'New value');
            $this->clickSubmit('Go');
        }
    }

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 GET 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 HTMLTidy devraient être employés, ou même n'importe lequel des validateurs HTML et CSS déjà sur le marché.

Si un champ manque dans n'importe quel formulaire ou si une option est indisponible alors WebTestCase::setField() renverra false. Par exemple, supposons que nous souhaitons vérifier qu'une option "Superuser" n'est pas présente dans ce formulaire...

    Select type of user to add:
    <select name="type">
        <option>Subscriber</option>
        <option>Author</option>
        <option>Administrator</option>
    </select>

Qui ressemble à...

Select type of user to add:

Le test suivant le confirmera...

    class SimpleFormTests extends WebTestCase {
        ...
        function testNoSuperuserChoiceAvailable() {
            $this->get('http://www.lastcraft.com/form_testing_documentation.php');
            $this->assertFalse($this->setField('type', 'Superuser'));
        }
    }

La sélection ne sera pas changée si la nouvelle valeur n'est pas une des options.

Voici la liste complète des objets supportés à aujourd'hui...

- Champs texte, y compris les champs masqués (hidden) ou cryptés (password).
- Boutons submit, en incluant aussi la balise button, mais pas encore les boutons reset
- Aires texte (textarea) avec leur gestion des retours à la ligne (wrap).
- Cases à cocher, y compris les cases à cocher multiples dans un même formulaire.
- Listes à menu déroulant, y compris celles à sélections multiples.
- Boutons radio.
- Images.

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.

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.

## Champs à valeurs multiples

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...

    <form class="demo">
        Create privileges allowed:
        <input type="checkbox" name="crud" value="c" checked><br>
        Retrieve privileges allowed:
        <input type="checkbox" name="crud" value="r" checked><br>
        Update privileges allowed:
        <input type="checkbox" name="crud" value="u" checked><br>
        Destroy privileges allowed:
        <input type="checkbox" name="crud" value="d" checked><br>
        <input type="submit" value="Enable Privileges">
    </form>

Qui se traduit par...

Create privileges allowed:
Retrieve privileges allowed:
Update privileges allowed:
Destroy privileges allowed:

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...

    class SimpleFormTests extends WebTestCase {
        ...
        function testDisableNastyPrivileges() {
            $this->get('http://www.lastcraft.com/form_testing_documentation.php');
            $this->assertField('crud', array('c', 'r', 'u', 'd'));
            $this->setField('crud', array('r'));
            $this->clickSubmit('Enable Privileges');
        }
    }

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.

## Formulaires utilisant Javascript pour changer un champ caché

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 ne fonctionnera pas :

    class SimpleFormTests extends WebTestCase {
        function testEmulateMyJavascriptForm() {
            // This does *not* work
            $this->setField('a_hidden_field', '123');
            $this->clickSubmit('OK');
        }
    }

A la place, vous aurez besoin d'ajouter le paramètre supplémentaire du formulaire à la méthode clickSubmit() :

    class SimpleFormTests extends WebTestCase {
        function testMyJavascriptForm() {
            $this->clickSubmit('OK', array('a_hidden_field'=>'123'));
        }

    }

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 Selenium pour mettre sur pied un test complet.

## Envoi brut

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.

    class SimpleFormTests extends WebTestCase {
        ...
        function testAttemptedHack() {
            $this->post(
                    'http://www.my-site.com/add_user.php',
                    array('type' => 'superuser'));
            $this->assertNoUnwantedPattern('/user created/i');
        }
    }

En ajoutant des données à la méthode WebTestCase::post(), 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".
References and related information...

- La page du projet SimpleTest sur SourceForge.
- La page de téléchargement de SimpleTest sur LastCraft.
- L'API du développeur pour SimpleTest donne tous les détails sur les classes et les assertions disponibles.

Copyright
Marcus Baker 2006