Tests et Intégration Continue¶

Pré-requis¶

PHPUnit¶

Installation¶

wget https://phar.phpunit.de/phpunit.phar
chmod +x phpunit.phar
sudo mv phpunit.phar /usr/local/bin/phpunit

Selenium Server¶

http://www.seleniumhq.org

Installation¶

wget http://selenium-release.storage.googleapis.com/2.53/selenium-server-standalone-2.53.1.jar
java -jar selenium-server-standalone-2.53.1.jar

Robot Framework¶

http://robotframework.org/

Installation¶

sudo apt-get install python python-dev python-pip libjpeg-dev
sudo pip install selenium robotframework robotframework-selenium2library robotframework-selenium2screenshots requests robotframework-requests Pillow robotframework-archivelibrary

Avertissement

Il faut utiliser la version 2.7 de python.

Avertissement

La librairie selenium2screenshots doit être modifiée pour fonctionner correctement.

vim /usr/local/lib/python2.7/dist-packages/Selenium2Screenshots/keywords.robot

:%s/u'  '/u'  '  count=1/g

Jenkins¶

jenkins.openmairie.org

Arboresence du répertoire tests¶

.
├── [drwxrwxr-x]  binary_files
├── [drwxrwxr-x]  doc
├── [drwxrwxr-x]  results
├── [drwxrwxr-x]  resources
│   ├── [drwxrwxr-x]  app
│   │   ├── [drwxrwxr-x]  gen
│   │   ├── [-rw-rw-r--]  __init__.py
│   │   ├── [-rw-rw-r--]  om_tests.py
│   │   └── [-rw-rw-r--]  keywords.robot
│   ├── [drwxrwxr-x]  core
│   ├── [-rw-rw-r--]  __init__.py
│   └── [-rw-rw-r--]  resources.robot
├── [-rwxrwxr-x]  om-tests
├── [-rw-rw-r--]  config.xml
├── [-rw-rw-r--]  000_generation.robot
└── [-rw-rw-r--]  000_test_unitaire.php

tests/om-tests¶

Ce fichier doit être exécutable.

#!/usr/bin/python
from resources.app.om_tests import om_tests
tests = om_tests()
tests.main()

tests/config.xml¶

<phpunit>
  <testsuites>
    <testsuite name="openmairie">
        <file>000_test_unitaire.php</file>
    </testsuite>
  </testsuites>
</phpunit>

tests/000_generation.robot¶

*** Settings ***
Resource  resources/resources.robot
Suite Setup  For Suite Setup
Suite Teardown  For Suite Teardown
Documentation  Le 'Framework' de l'application permet de générer
...  automatiquement certains scripts en fonction du modèle de données. Lors
...  du développement la règle est la suivante : toute modification du
...  modèle de données doit entrainer une regénération complète de tous les
...  scripts. Pour vérifier à chaque modification du code que la règle a bien
...  été respectée, ce 'Test Suite' permet de lancer une génération complète.
...  Si un fichier est généré alors le test doit échoué.


*** Test Cases ***
Génération complète

    Depuis la page d'accueil    admin    admin
    Générer tout

tests/000_test_unitaire.php¶

<?php
class General extends PHPUnit_Framework_TestCase {

    /**
     * Méthode lancée en début de traitement
     */
    public function setUp() {
    }

    /**
     * Méthode lancée en fin de traitement
     */
    public function tearDown() {
    }

    /**
     * Test Case n°01
     */
    public function test_case_01() {
        require_once "../obj/utils.class.php";
        @session_start();
        $_SESSION['collectivite'] = 1;
        $_SESSION['login'] = "admin";
        $_SERVER['REQUEST_URI'] = "";
        $f = new utils("nohtml");
        $f->disableLog();

        $this->assertEquals($year, 2015);

        $f->__destruct();
    }
}
?>

tests/doc/¶

Répertoire destiné à recevoir la génération de la documentation des mots clés Robot Framework.

tests/results/¶

Répertoire destiné à recevoir la génération des rapports et des captures d’écran produits pendant l’exécution des tests. Afin que ces nouveaux fichiers ne gênent pas l’utilisation des commandes Subversion, tous les fichiers à l’intérieur de ce dossier sont ignorés grâce à la propriété svn:ignore.

tests/binary_files/¶

Répertoire destiné à recevoir les fichiers de configuration ou d’initialisation de l’environnement de tests.

tests/resources/¶

Répertoire contenant les ressources utilisées par les tests suite.

tests/resources/init.py¶

Fichier vide pour définir le répertoire resources comme un module python.

tests/resources/resources.robot¶

*** Settings ***
#
Resource          core${/}om_resources.robot
#
Resource          app${/}keywords.robot

*** Variables ***
${SERVER}           localhost
${PROJECT_NAME}     openexemple
${BROWSER}          firefox
${DELAY}            0
${ADMIN_USER}       admin
${ADMIN_PASSWORD}   admin
${PROJECT_URL}      http://${SERVER}/${PROJECT_NAME}/
${PATH_BIN_FILES}   ${EXECDIR}${/}binary_files${/}
${TITLE}            :: openMairie :: openexemple

*** Keywords ***
For Suite Setup
    # Les keywords définit dans le resources.robot sont prioritaires
    Set Library Search Order    resources
    Ouvrir le navigateur
    Tests Setup


For Suite Teardown
    Fermer le navigateur

tests/resources/app/¶

Répertoire contenant les fichiers de déclaration de mots clé dédiés à l’application.

tests/resources/app/gen/¶

Répertoire destiné à recevoir des fichiers de mots clé générés à partir du modèle de données.

tests/resources/app/init.py¶

Fichier vide pour définir le répertoire app comme un module python.

tests/resources/app/om_tests.py¶

#!/usr/bin/python
# -*- coding: utf-8 -*-
from resources.core.om_tests import om_tests_core


class om_tests(om_tests_core):
    """
    """

    _database_name_default = "openexemple"
    _instance_name_default = "openexemple"

tests/resources/app/keywords.robot¶

*** Settings ***
Documentation   Keywords openexemple.

*** Keywords ***
Depuis le listing
    [Documentation]
    [Arguments]  ${listing_obj}
    Go To  ${PROJECT_URL}scr/tab.php?obj=${listing_obj}

tests/resources/core/¶

Répertoire récupéré depuis le core du framework via un EXTERNALS.

tests/resources/core/  svn://scm.adullact.net/svnroot/openmairie/openmairie_exemple/trunk/tests/resources/core/

Fonctionnement et Utilisation¶

Pré-requis¶

Les tests doivent être joués dans un environnement balisé et reproductible à l’identique. Pour ce faire il est nécessaire avant chaque lancement de test, de dérouler une routine qui permet de mettre en place un environnement de tests. Un script permet de dérouler cette routine de manière automatisée :

./om-tests -c initenv

Ce script permet de :

supprimer la base de données
créer la base de données
initialiser la base de données grâce au script data/pgsql/install.sql
redémarrer apache pour prendre les traductions en compte
donner les droits à apache pour les dossiers dans lequel il peut écrire
faire un lien symbolique vers le dossier de l’applicatif pour que les tests en question dans le dossier /var/www/

Les tests sont prévus pour être exécutés sur le navigateur Firefox. Il est possible d’utiliser une version spécifique automatiquement lors de l’execution des tests. Pour définir une version de navigateur spécifique il faut :

télécharger le navigateur Firefox conseillé :
- 64 bits
- 32 bits
extraire l’application dans le dossier souhaité
créer un fichier de configuration dans votre dossier utilisateur :

vim ~/.om-tests/config.cfg
[browser]
src_path=[chemin du navigateur spécifique]
dest_path=/usr/local/bin/firefox

Tous les tests¶

Lancer tous les tests avec initialisation de l’environnement de tests

./om-tests -c runall

Un seul TestSuite¶

Lancer un TestSuite avec initialisation de l’environnement de tests

./om-tests -c runone -t 000_testsuite_a_executer.robot

Lancer un TestSuite sans initialisation de l’environnement de tests

./om-tests -c runone -t 000_testsuite_a_executer.robot --noinit

Développement et bonnes pratiques¶

Il est prévu de consigner ici les bonnes pratiques et les consignes pour le développement des tests.

Documentation RobotFramework¶

Librairie du framework openMairie Core.

Cette documentation de la librairie du framework openMairie a été générée avec la commande suivante :

./om-tests -c gendoc

La commande est automatiquement exécutée lorsque l’on lance un ou tous les TestSuite. La documentation est générée au format HTML dans le répertoire tests/doc. Il y a une documentation par dossier de ressources :

tests/resources/app → tests/doc/app.html

tests/resources/core → tests/doc/core.html

RobotFramework :

http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html

Librairies :

Base - BuiltIn : http://robotframework.org/robotframework/latest/libraries/BuiltIn.html
Base - String : http://robotframework.org/robotframework/latest/libraries/String.html
Base - Collections : http://robotframework.org/robotframework/latest/libraries/Collections.html
Base - OperatingSystem : http://robotframework.org/robotframework/latest/libraries/OperatingSystem.html
Selenium2 : http://rtomac.github.io/robotframework-selenium2library/doc/Selenium2Library.html
Requests : http://bulkan.github.io/robotframework-requests/
Selenium2Screenshots : https://robotframework-selenium2screenshots.readthedocs.org/en/latest/_downloads/keywords.html

Convention de nommage¶

Un fichier de test par thème fonctionnel, une TestCase par fonctionnalité.
Convention de nommage :
- des fichiers : mon_theme_fonctionnel.robot
- des testcase : Saisir un nouvel élément

Génération¶

Pré-requis : créer le dossier “gen” dans “../tests/resources/core/gen/”.

Lancer une génération complète à chaque modification de la structure de la base de données permet de créer les mots-clefs basiques de chaque table : « depuis le contexte », « ajouter », « modifier », « supprimer » et « saisir ».

Bonnes pratiques¶

Éviter d’utiliser les sélecteurs XPATH, les sélecteurs CSS ou par ID sont largement préférables.
Isolation des tests : chacun des tests ajouté doit être indépendant de ceux existants (consitution de son propre jeu de données, accès aux éléments par recherche, éventuellement nettoyage des données crées, etc).

Tests et Intégration Continue¶

Pré-requis¶

PHPUnit¶

Installation¶

Selenium Server¶

Installation¶

Robot Framework¶

Installation¶

Jenkins¶

Arboresence du répertoire tests¶

tests/om-tests¶

tests/config.xml¶

tests/000_generation.robot¶

tests/000_test_unitaire.php¶

tests/doc/¶

tests/results/¶

tests/binary_files/¶

tests/resources/¶

tests/resources/__init__.py¶

tests/resources/resources.robot¶

tests/resources/app/¶

tests/resources/app/gen/¶

tests/resources/app/__init__.py¶

tests/resources/app/om_tests.py¶

tests/resources/app/keywords.robot¶

tests/resources/core/¶

Fonctionnement et Utilisation¶

Pré-requis¶

Tous les tests¶

Un seul TestSuite¶

Développement et bonnes pratiques¶

Documentation RobotFramework¶

Convention de nommage¶

Génération¶

Bonnes pratiques¶

tests/resources/init.py¶

tests/resources/app/init.py¶