3. Premiers tests

Vous avez besoin d’écrire une classe de test pour chaque classe testé.

Imaginez que vous vouliez tester la traditionnelle classe HelloWorld, alors vous devez créer la classe de test test\units\HelloWorld.

Avertissement

Si vous débutez avec atoum, il est recommandé d’installer le paquet ´atoum-stubs <https://packagist.org/packages/atoum/stubs>´_. Celui-ci vous fournira de l’auto-complétion au sein de votre IDE.

Note

atoum utilise les espaces de noms. Par exemple, pour tester la classe Vendor\Project\HelloWorld, vous devez créer la classe Vendor\Project\tests\units\HelloWorld.

Voici le code de la classe HelloWorld que nous allons tester.

<?php
# src/Vendor/Project/HelloWorld.php

namespace Vendor\Project;

class HelloWorld
{
    public function getHiAtoum ()
    {
        return 'Hi atoum !';
    }
}

Maintenant, voici le code de la classe de test que nous pourrions écrire.

<?php
# src/Vendor/Project/tests/units/HelloWorld.php

// La classe de test a son propre namespace :
// Le namespace de la classe à tester + "tests\units"
namespace Vendor\Project\tests\units;

// Vous devez inclure la classe testée (si vous n'avez pas d'autoloader)
require_once __DIR__ . '/../../HelloWorld.php';

use atoum;

/*
 * Classe de test pour Vendor\Project\HelloWorld
 *
 * Remarquez qu'elle porte le même nom que la classe à tester
 * et qu'elle dérive de la classe atoum
 */
class HelloWorld extends atoum
{
    /*
     * Cette méthode est dédiée à la méthode getHiAtoum()
     */
    public function testGetHiAtoum ()
    {
        $this
            // création d'une nouvelle instance de la classe à tester
            ->given($this->newTestedInstance)

            ->then

                    // nous testons que la méthode getHiAtoum retourne bien
                    // une chaîne de caractère...
                    ->string($this->testedInstance->getHiAtoum())
                        // ... et que la chaîne est bien celle attendue,
                        // c'est-à-dire 'Hi atoum !'
                        ->isEqualTo('Hi atoum !')
        ;
    }
}

Maintenant, lançons nos tests. Vous devriez voir quelque chose comme ça :

$ ./vendor/bin/atoum -f src/Vendor/Project/tests/units/HelloWorld.php
> PHP path: /usr/bin/php
> PHP version:
=> PHP 5.6.3 (cli) (built: Nov 13 2014 18:31:57)
=> Copyright (c) 1997-2014 The PHP Group
=> Zend Engine v2.6.0, Copyright (c) 1998-2014 Zend Technologies
> Vendor\Project\tests\units\HelloWorld...
[S___________________________________________________________][1/1]
=> Test duration: 0.00 second.
=> Memory usage: 0.25 Mb.
> Total test duration: 0.00 second.
> Total test memory usage: 0.25 Mb.
> Running duration: 0.04 second.
Success (1 test, 1/1 method, 0 void method, 0 skipped method, 2 assertions)!

Nous venons de tester que la méthode getHiAtoum :

• retourne une chaîne de caractère;
• que c’est égale à "Hi atoum !".

Les tests sont passés, tout est au vert. Voilà, votre code est solide comme un roc grâce à atoum !

3.1. Dissection du test

Il est important que vous compreniez chaque chose que nous utilisons dans ce test. Regardons chaque partie.

Nous utilisons l’espace de noms Vendor\Project\tests\units où Vendor\Project est l’espace de noms de la classe et tests\units la partie de l’espace de noms utiliser par atoum pour comprendre que nous sommes dans l’espace de nom de test. Cette espace de nom est configurable et ceci est expliqué dans la section appropriée. Ensuite, à l’intérieur de la méthode testée, nous utilisons une synthaxe spécial given et then. Ils ne font rien d’autre que rendre le test plus lisible. Finalement, nous utilisons un autre truc simple newTestedInstance et testedInstance pour obtenir une instance de la classe testée.