Pims Labs » Qualité http://labs.pimsworld.org Les labs de Pims World Thu, 28 May 2009 08:15:39 +0000 http://wordpress.org/?v=2.7.1 en hourly 1 Tests unitaires avec Zend Studio http://labs.pimsworld.org/2009/01/tests-unitaires-avec-zend-studio/ http://labs.pimsworld.org/2009/01/tests-unitaires-avec-zend-studio/#comments Mon, 19 Jan 2009 18:09:02 +0000 Kal http://labs.pimsworld.org/?p=10 Si vous êtes persuadés de l’intérêt des tests unitaires pour vos développements PHP mais que vous n’avez jamais osé franchir le pas, ce tutoriel est fait pour vous. Afin de migrer en douceur vers les préceptes sacrés de l’eXtreme Programming je vous propose un exemple concret de mise en place des tests unitaires sous l’environnement Zend Studio.

Pour ce faire, nous allons implémenter une bonne vieille pile LIFO en PHP.

Après avoir crée un projet avec Zend Studio et une classe Unit_Stack, on commence par écrire le squelette de cette classe :

/**
* A LIFO Stack
*/
class Unit_Stack
{
    /**
    * Push an item.
    *
    * @param mixed $item
    *
    * @return void
    */
    public function push($item)
    {}
   
    /**
    * Pop an item.
    *
    * @return mixed
    * @throws Exception if stack is empty.
    */
    public function pop()
    {}
   
    /**
    * Count items of stack.
    *
    * @return int
    */
    public function count()
    {}
   
    /**
    * Tells if stack is empty.
    *
    * @return boolean
    */
    public function isEmpty()
    {}
   
    /**
    * Removes all items of stack.
    *
    * @return void
    */
    public function reset()
    {}
}

Les commentaires devraient suffire à expliquer ce qu’est sensée faire cette classe.

L’étape suivante consiste à créer la classe de tests unitaires ou Test Case. Dans l’arborescence tests/unit/Unit/, faire click droit puis new -> PHPUnit Test Case.

Il suffit alors de choisir la classe à tester via le bouton Browse en face de ‘Element to Test’, puis de corriger le nom de la classe de Test générée dans le champ ‘Test File Name’ en virant le préfixe Unit_’. Cela devrait ressembler à ça :

Création d'un Test Case

Création d'un Test Case

Le Test Case généré devrait comprendre :

  • une méthode setUp : lancée avant chaque test.
  • une méthode tearDown : lancée après chaque test.
  • un constructeur : pas vraiment utile.
  • une méthode de test par méthode publique de la classe à tester.

Dans le cadre de cet exemple, je vous invite à supprimer le constructeur ainsi que les méthodes setUp et tearDown.

Nous rentrons maintenant dans le vif du sujet, il s’agit :

  1. d’écrire un test
  2. de lancer le Test Case afin de vérifier (oh surprise) qu’il échoue
  3. d’implémenter la fonctionnalité
  4. de relancer le test et éventuellement corriger jusqu’à ce que le test passe !

Écriture du test

Nous proposons pour la méthode isEmpty l’écriture du test suivant :

public function testIsEmpty ()
{
    $stack = new Unit_Stack();

    // a new stack is empty !
    $this->assertTrue($stack->isEmpty());
}

Lancer le Test Case

Il suffit d’un click droit sur le fichier du Test Case puis de choisir Run as -> PHPUnit Test

Si tout se passe bien, le test devrait apparaître en erreur et les autres en non implémentés.

Résultats test case

Résultats test case

Implémenter la fonctionnalité

public function isEmpty()
{
    return empty($this->_array);
}

Trop facile …

Relancer le test et corriger

Même procédure que le lancement précédent, cette fois le test devrait apparaître comme réussi.

Ensuite….

Il suffit de refaire la même procédure itérativement pour chaque fonctionnalité. A mesure que les nouvelles fonctionnalités sont implémentées, de nouveaux tests peuvent être écrits en plus de ceux générés par Zend Studio. Il suffit de créer une méthode publique dont le nom commence par test.

Si votre application contient plusieurs classes et donc plusieurs Test Case (ce qui est souvent le cas !), il peut être fastidieux de lancer les tests cases un par un, il est alors intéressant d’utiliser les Tests Suites. Il suffit de faire un click droit dans Zend studio sur le répertoire test/unit/ puis New -> PHPUnit Test Suite.

On sélectionne alors les Tests Case à lancer puis finish. Une Suite se lance alors de le même façon qu’un Test Case.

Liens :

]]> http://labs.pimsworld.org/2009/01/tests-unitaires-avec-zend-studio/feed/ Phing automatise les opérations répétitives des développements PHP http://labs.pimsworld.org/2009/01/phing-automatise-les-operations-repetitives-des-developpements-php/ http://labs.pimsworld.org/2009/01/phing-automatise-les-operations-repetitives-des-developpements-php/#comments Wed, 14 Jan 2009 11:09:18 +0000 Stéphane Roucheray http://labs.pimsworld.org/?p=74 L’automatisation des opérations répétitives dans un projet de développement peut être résolue de multiples manières allant du simple script lancé à la main au système d’intégration continue.

La plupart des langages ont standardisé leurs outils, make pour C, Ant pour Java… PHP bénéficie lui aussi d’un tel outil : Phing.

Phing est un projet Open Source très inspiré de Ant. Le concept est assez simple. Un fichier XML décrit une série d’actions possibles pouvant ou non être dépendantes les unes des autres et une ligne de commande permet de déclencher ces actions.

Utilisation de Phing

Un exemple rapide. Nous voulons vérifier que la syntaxe des fichiers PHP de notre projet est bien respectée, qu’aucune erreur ne s’y est glissée, le fichier XML ressemble alors à ça :

Fichier build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="premier_projet" default="lint">
    <target name="lint" description="Vérifie la syntaxe PHP">
        <phplint>
            <fileset dir="/home/mon_projet/src/">
                <include name="**/*.php"/>
                <exclude name="lib/Zend/**/*.php"/>
            </fileset>
        </phplint>
    </target>
</project>

Enregistrez ce fichier avec le nom build.xml (le fichier par défaut utilisé par phing) dans le dossier build de votre projet, par exemple

/home/mon_projet/build/

Ouvrez une console et lancez ensuite la commande phing depuis le dossier du fichier build.xml

Commande

cd /home/mon_projet/build/
phing

Le fichier build.xml est très explicite, cette commande va donc vérifier, pour tous les fichiers PHP de mon dossier source a l’exclusion de ceux de la bibliothèque Zend, que leur syntaxe est bien respectée.

Autre exemple, pour générer automatiquement la documentation de classes PHP.

Fichier build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="premier_projet" default="doc">
    <target name="doc" description="Génère la documentation">
        <phpdoc title="API Documentation"
                destdir="/home/mon_projet/api"
                sourcecode="no" output="HTML:Smarty:PHP">
            <fileset dir="/home/mon_projet/src/">
                <include name="**/*.php"/>
                <exclude name="lib/Zend/**/*.php"/>
            </fileset>
        </phpdoc>
    </target>
</project>

Commandes

cd /home/mon_projet/build/
phing

Phing tout comme Ant gère la dépendance des tâches. Dans notre cas, si nous voulons générer la documentation après la vérification syntaxique. Il suffit de modifier notre fichier build.xml comme suit :

Fichier build.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project name="premier_projet" default="build">
        <target name="lint" description="Vérifie la syntaxe PHP">
            <phplint>
                <fileset dir="/home/mon_projet/src/">
                    <include name="**/*.php"/>
                    <exclude name="lib/Zend/**/*.php"/>
                </fileset>
            </phplint>
        </target>

        <target name="doc" description="Génère la documentation">
            <phpdoc title="API Documentation"
                        destdir="/home/mon_projet/api"
                        sourcecode="no"
                        output="HTML:Smarty:PHP">
                <fileset dir="/home/mon_projet/src/">
                    <include name="**/*.php"/>
                    <exclude name="lib/Zend/**/*.php"/>
                </fileset>
            </phpdoc>
        </target>

        <target
            name="build"
            depends="lint, doc"
            description="Syntaxe PHP et Documentation" />
    </project>

Commande

phing

La commande phing va automatiquement séquencer les 2 tâches lint et doc car la tâche build dépend d’elles.
Si nous voulons seulement générer la documentation il suffit de taper la commande suivante.

Commande

phing doc

Phing est très puissant. Il permet de gérer des tâches conditionnelles, des tâches spécifiques PHP comme l’analyse de code par le compilateur Zend, le lancement de tests unitaires classiques ou avec Selenium. Il sait aussi piloter des tâches plus génériques comme l’update de dépôt SVN ou l’exécution de commandes externes. La liste longue et complète des tâches disponibles se trouve dans la documentation de Phing.

Installation de Phing

Pour installer Phing, le plus simple est d’utiliser PEAR. Sous Ubuntu tapez les commandes suivantes en mode super utilisateur.

Installation de PEAR, la bibliothèque d’extensions à PHP

apt-get install php-pear

Installation de Phing

pear channel-discover pear.phing.info
pear install phing/phing

On en parle ailleurs…

Un article en anglais de Nabeel Shahzad décrit comment il s’est débarrassé des scripts grâce à Phing

]]> http://labs.pimsworld.org/2009/01/phing-automatise-les-operations-repetitives-des-developpements-php/feed/ Installation de Selenium RC sous ubuntu http://labs.pimsworld.org/2008/12/installation-de-selenium-rc-sous-ubuntu/ http://labs.pimsworld.org/2008/12/installation-de-selenium-rc-sous-ubuntu/#comments Wed, 17 Dec 2008 17:36:31 +0000 jrm http://labs.pimsworld.org/?p=3 Selenium

Selenium est initié par ThoughtWorks qui comprend 750 collaborateurs dans 6 pays, ce sont des pionniers de l’agilité et de l’open source. L’objectif de Selenium est de réaliser des tests fonctionnels d’application web (HTML ou XML sur HTPP) ainsi que des tests de compatibilité entre navigateurs.

Selenium est open source (license Apache 2.0), c’est un project actif bien documenté (forum, wiki). Il est décomposé en trois modules :

  • Selenium core
  • Selenium remote control
  • Selenium IDE, plugin Firefox

Selenium core

Moteur en Javascript/HTML, les test s’exécutent directement dans le navigateur, le tout est compatible avec Firefox, IE, Opera et Safari. L’interface d’administration permet la visualisation des scénarii, l’exécution des tests, de débugger (à l’aide de breakpoint), d’afficher des logs ainsi que l’arbre DOM de la page testée.

Il permet l’exécution d’actions comme cliquer, saisir du texte, vérifier le contenu d’une page à l’aide d’assertions. Le scénarii est écrit en “Selenese” qui a une syntaxe très simple : tableau HTML à 3 colonnes (commande + 2 arguments).

Exemple :

JrMLab test
open /
type q jrmlab
clickAndWait btnG
verifyTextPresent Test - Php - JrM` Lab

Selenium Core permet de faire tout ce que peut faire l’utilisateur :

  • Presser/relâcher une touche, saisir du texte
  • Simple/double clic de la souris
  • Drag & drop
  • Mouvement de la souris
  • Sélectionner une pop up ou une frame
  • Édition/suppression de cookies

Il possède aussi une notion d’attente d’événement avec gestion d’un timeout.

Les inconvénients de Selenium Core :

  • Cross-Site Scripting (XSS)
    • Selenium (HTML + JS) doit être déployé sur le même serveur que l’application testée.
  • Les navigateurs doivent être correctement configurés
    • Profil potentiellement différent avant chaque exécution de test
    • Cookies existants
    • Mots de passe ou données de formulaires sauvegardés
  • Difficile à automatiser
    • Lancement du navigateur
    • Rapport d’exécution non exportable

Selenium Remote Control

Selenium RC est une application JAVA 5 qui contrôle le navigateur. Il possède deux modes :

  • automatique : lecture de scénarii au format Selenese
  • interactif : scripting des scénarii en Java, Junit, Ruby, Python, .NET, PHP

Selenium RC permet de démarrer un navigateur avec un profil vierge, il n’y aucun problème de XSS en raison d’un proxy HTPP. Il est donc automatisable pour l’intégration de contenu. Les tests en Java, Ruby, PHP sont plus complets que ceux en selenese. En effet, il est plus facile de réutiliser du code et d’avoir accès à des données non présentes dans le navigateur : informations d’une base de données pour vérifier l’intégralité de certaines données, etc.

Selenium IDE

Selenium IDE est un plugin pour Firefox. Il permet l’enregistrement d’un scénario pouvant être exécuté dans n’importe quel autre navigateur. Il permet aussi l’exécution des tests directement dans Firefox, en effet le moteur Selenium est intégré dans le noyau de Firefox (chrome), aucun problème de Cross-Site Scripting.
Selenium IDE propose aussi un debugger ainsi qu’une méthode d’exportation des tests au format Selenese, Java, Ruby, Python, .NET et PHP.

On se rend alors compte que Selenium IDE facilite l’automatisation d’écriture de tests simples réutilisables pour Selenium RC.

Installation de Selenium

Nous allons voir comment installer Selenium sous Ubuntu.

  • Installer Apache avec PHP5 (ça nous servira pour plus tard) Reportez vous ici
  • Télécharger Selenium RC ici.
  • Dezipper l’archive dans le repertoire de votre choix le mieux étant dans /opt/selenium-rc/
  • Ouvrez un terminal et placez vous dans le repertoire où vous avez dezippé l’archive.

Maintenant il ne nous reste plus qu’à tester le bon fonctionnement du serveur. Exécutez la commande suivante :

$ java -jar selenium-server.jar -interactive

Félicitations, vous venez de lancer le serveur Selenium en mode interactif, ce qui veut dire que vous allez pouvoir directement lancer des commandes à partir de votre terminal.

Nous allons tester notre installation, pour ceci lancez la commande suivante :

cmd=getNewBrowserSession&amp;1=*chrome /usr/lib/firefox/firefox-2-bin&amp;2=http://www.google.com

Firefox s’ouvre et laisse apparaître le debugger de Selenium. Vous devriez logiquement avoir le résultat suivant dans votre terminal (avec un n° de session différent) :

Got result: OK,7b3a771be605421fb0be772c7bed6e8f on session 7b3a771be605421fb0be772c7bed6e8f

Nous venons de récupérer le n° de session généré par Firefox, nous allons maintenant lancer une commande permettant d’atteindre la home de Google :

cmd=open&amp;1=http://www.google.com&amp;sessionId=7b3a771be605421fb0be772c7bed6e8f

Félicitations vous venez de lancer votre première commande Selenium …

]]> http://labs.pimsworld.org/2008/12/installation-de-selenium-rc-sous-ubuntu/feed/