Qu’est-ce que Pest ?

Pest, c’est la touche de simplicité utile à laquelle Nuno Maduro a donné vie pour tester votre code PHP. Il mise avant tout sur la clarté. Et devinez quoi ? Pas besoin de le coller obligatoirement à un projet Laravel. Même si, avouons-le, vous rateriez une occasion rêvée d’utiliser ses plugins incroyables. Pest, c’est un peu comme le nappage chocolat sur le gâteau 🍰 PHPUnit.

De plus, il est très régulièrement mis à jour, preuve de l’excellente santé du package.

Introduction aux tests

Si vous n’avez jamais exploré le monde des tests PHP et que l’envie vous démange, tout d’abord : Bravo ! C’est une étape cruciale, et même si ça demande un peu d’apprentissage, c’est le genre de pratique qui devient rapidement un réflexe super utile. D’ailleurs, il y a quelque temps, j’ai fait une vidéo pour vous présenter ce Framework sympa :

Les plugins Laravel

J’utiliserai Pest dans le contexte du Framework PHP Laravel, mais gardez à l’esprit que Pest n’a aucune opinion à ce sujet. Vous allez pouvoir vous armer de fonctions, commandes et autres expectations en tout genre qui vont vous faciliter grandement la tâche. N’hésitez pas à installer les plugins Laravel si vous vous lancez sur un projet d’envergure.

Je pars du principe que vous avez des bases relativement solide sur le Framework Laravel.

Les points fondamentaux

Nous allons passer en revue plusieurs points essentiels pour écrire vos tests. En clair, chacune des étapes listées ci-dessous sera quelque chose qu’il faudra savoir faire tôt ou tard pour tester une application.

Les expectations

L’API d’expectation vous permet de spécifier le résultat attendu d’un test, ici, on veut rigoureusement s’attendre à des égalités sur des données ou des événements.

La fonction expect prendra en paramètre une variable et vous serez libre d’enchaîner la/les méthode(s) souhaitée(s). Vos tests seront plus lisibles et donc plus efficaces en terme d’expérience développeur ! Toute la pléthore d’expectations sont disponible sur le site officiel.

$value = 'Hello World!';

expect($value)
    ->toBeString()
    ->toEqual('Hello World!')
    ->not->toBeInt()
    ->not->toBeArray();

L’authentification

L’authentification est nécessaire durant un test lorsque vous voulez effectuer une requête qui demande un utilisateur connecté, et celà peu importe le middleware d’authentification. Les plugins Laravel nous gratifie d’une superbe méthode actingAs()

it('can store a post', function () {
    $user = User::factory()->create();

    actingAs($user)
        ->post(route('posts.store'), ['title' => 'Hello World!', 'content' => 'My first article.'])
        ->assertOk();
 });

Le Mocking

Vous voilà investi de la sacrosainte mission de générer un système de facture pour votre application. Votre code est propre, les calculs sont bons, à la virgule prête, et le fichier PDF est généré avec succès. Seulement voilà, vous n’avez pas forcément envie de créer un PDF à chaque lancement de vos tests. La solution est aussi simple, il vous suffit de mocker la classe qui s’en occupe.

it('can generate an invoice', function () {
       \Pest\Laravel\mock(GenerateInvoicePdf::class, function (MockInterface $mock) {
        $mock->shouldReceive('handle')->once();
    });
    
    // Code de génération de facture
 });

Les réponses d’API

Vous voici de nouveau reparti pour la création d’une API avec Laravel. Vous avez une route qui renvoie des données enrobées dans vos Resources. Comment la tester ? Encore une fois rien de plus simple, pas de magie spécifique du côté de Pest, mais c’est un passage obligé que de savoir tester les réponses d’API.

it('can list user courses', function () {
    $user = User::factory()
        ->hasCourses(5)
        ->create();

    actingAs($user)
        ->get(route('events'))
        ->assertOk()
        ->assertJsonCount(5, 'events')
        ->assertJson(
            fn (AssertableJson $json) => $json->where('events.0.id', 1)->etc()
        );
});

Bien s’organiser

Tout ça c’est bien beau mais quid de l’organisation des tests, des données à envoyer et de l’architecture à respecter ?

Les Datasets

Vous avez la possibilité de passer un jeu de données via la méthode with() comme indiqué dans la documentation, cependant si votre projet commence à grossir et que vous souhaitez réutiliser pas mal de fois les mêmes données, il est plus pratique de placer cette logique dans des fichiers. Pour ce faire, il faut créer un dossier Datasets dans lequel on place ceci :

dataset('admin', [
    'administrateur' => fn () => User::factory()->create(['role' => EnumRoles::ADMIN]),
]);

test('admin can create a member', function ($admin) {
    actingAs($admin);
    
    // Test connecté avec un administrateur
})->with('admin');

Les blocs Describe

Dans les ajouts récents de Pest, nous pouvons compter celui des blocs Describe qui vous permettra de grouper vos tests par thème et de leur affecter des actions communes.

describe('posts', function () {
    it('can create a post', function () {
        // Test pour créer un post
    });
    
    it('can update a post', function () {
        // Test pour mettre à jour un post
    });
    
    it('can delete a post', function () {
        // Test pour supprimer un post
    });
})->repeat(100);

Tests d’architecture

Cela fait partie des grandes nouveautés de Pest, les tests d’architectures vous permettront facilement de poser des règles générales sur la façon dont votre code doit être écrit et/ou organisé.

Je peux vouloir que mes Contrôleurs d’API soient invokable(), ou encore m’assurer de n’avoir oublié aucun débugger.

test('Api Controllers must be invokable')
    ->expect('App\Http\Controllers\Api')
    ->toBeInvokable();

test('ensures no debugging')
    ->expect(['dd', 'dump', 'ray', 'var_dump'])
    ->not->toBeUsed();

test('ensures strict classes')
    ->expect('App')
    ->toUseStrictTypes();

test('Api controllers extends nothing')
    ->expect('App\Http\Controllers\Api')
    ->toExtendNothing();

Conclusion

Pest est un outil puissant pour écrire des tests automatisés en PHP, mettant l’accent sur la simplicité et la lisibilité du code de test. Que vous utilisiez Laravel ou non, Pest peut être une excellente option pour améliorer la qualité de votre code en garantissant qu’il fonctionne comme prévu.

Dans cet article, nous avons survolé certains concepts clés de Pest, notamment :

• Les expectations pour spécifier les résultats attendus des tests.
• L’utilisation de l’authentification pour les tests nécessitant un utilisateur connecté.
• Le mocking pour simuler des comportements et isoler certaines parties du code.
• Les tests de réponses d’API pour vérifier les sorties JSON et les ressources.
• L’organisation des tests avec les Datasets et les blocs Describe.
• Les tests d’architecture pour définir des règles générales sur le code.

Pest offre une approche élégante pour écrire des tests de qualité tout en maintenant une syntaxe lisible et expressive. Si vous cherchez à améliorer vos compétences en matière de tests automatisés en PHP, Pest pourrait être un excellent ajout à votre boîte à outils. N’oubliez pas de consulter la documentation officielle de Pest pour en savoir plus sur ses fonctionnalités et son utilisation optimale.