Eclaircir le Test-Driven Development (TDD) avec Laravel

L'univers du développement est en constante évolution, avec une multitude de pratiques et de méthodologies visant à améliorer la qualité, la robustesse et la maintenabilité du code. Parmi ces approches, le Test-Driven Development (TDD) se distingue en plaçant les tests au cœur du processus de développement.

Dans cet article, nous explorerons le TDD dans le contexte de Laravel, mettant en avant ses principes et son application pratique.

Les Bases du TDD

Le Test-Driven Development suit un cycle simple connu sous le nom de "Red-Green-Refactor". Cette approche, permet de développer des applications robustes avec une structure de test intégrée. Le cycle se déroule comme suit :

1. Red : Commencer par écrire un test qui échoue. Dans le contexte de Laravel, PHPUnit est l'outil de test standard, et il est étroitement intégré pour faciliter ce processus.
2. Green : Implémenter le code minimum nécessaire pour que le test réussisse. Cela implique de respecter uniquement les spécifications requises pour satisfaire le test.
3. Refactor : Améliorer le code sans changer son comportement. Cette étape garantit que le code reste propre et maintenable au fil du temps.

Exemple Pratique avec Laravel

Laravel, au travers de PHPUnit, nous offre un environnement de test solide, permettant aux développeurs de créer des scénarios de test complets pour chaque aspect de leur application. Plongeons dans un exemple concret de TDD en utilisant un cas simple.

Prenons un scénario courant : la création d'un contrôleur pour gérer les commentaires d'un blog. Notre objectif initial est d'assurer que le contrôleur renvoie une liste de commentaires lorsqu'il est appelé.

Étape 1 : Écrire un test simple

Commençons par écrire un test qui spécifie ce que nous attendons du contrôleur. Dans notre répertoire de tests, créons un fichier CommentControllerTest.php :

 1use Tests\TestCase;
 2 
 3class CommentControllerTest extends TestCase
 4{
 5    /** @test */
 6    public function comments_are_returned()
 7    {
 8        $response = $this->get('/comments');
 9        $response->assertStatus(200);
10        $response->assertJson(['comment' => 'Hello world!']);
11    }
12}

Ici, nous testons que l'appel à la route /comments renvoie un statut 200 et un tableau JSON avec du contenu texte. Si nous lançons le test nous constatons qu’il échoue car notre contrôleur et notre route n’ont pas été créés.

Étape 2 : Implémenter le code minimum

Passons à l'implémentation minimale dans le contrôleur CommentController.php :

 1use App\Http\Controllers\Controller;
 2use Illuminate\Http\JsonResponse;
 3use Illuminate\Support\Facades\Response;
 4 
 5class CommentController extends Controller
 6{
 7    public function index(): JsonResponse
 8    {
 9        return Response::json(['comment' => 'Hello world!']);
10    }
11}

Et dans routes/web.php :

1Route::get('/comments', [\App\Http\Controllers\CommentController::class, 'index']);

Maintenant que cette implémentation a été faite nous constatons que le test passe.

Allons à l’étape suivante et assurons nous que ce test fonctionne toujours après que le code ait été refactorisé.

Étape 3 : Refactoriser le code

Pour rappel la refactorisation est une pratique consistant à améliorer la structure du code sans en changer le comportement.

Dans notre exemple, bien que le code soit fonctionnel, nous préférons utiliser le helper response() au lieu de la façade Illuminate\Support\Facades\Response.

 1use App\Http\Controllers\Controller;
 2use Illuminate\Http\JsonResponse;
 3use Illuminate\Support\Facades\Response; 
 4 
 5class CommentController extends Controller
 6{
 7    public function index(): JsonResponse
 8    {
 9        return Response::json(['comment' => 'Hello world!']); 
10        return response()->json(['comment' => 'Hello world!']); 
11    }
12}

En exécutant le test une fois les modifications effectuées il continue de passer avec succès, confirmant que notre code respecte toujours les spécifications initiales.

Cet exemple illustre le cycle de vie du TDD. Les tests servent de spécifications fonctionnelles pour le développement, garantissant que chaque morceau de code est validé avant même d'être implémenté.

Pourquoi le TDD fonctionne bien avec Laravel ?

Si le TDD s’intègre si bien avec le framework c’est parce que son écosystème est fait pour faciliter la création et la gestion des tests :

• L’utilisation de l'injection de dépendances permet de créer des tests cloisonnés en remplaçant facilement les dépendances réelles par des mock objects.
• Les façades simplifient l'accès aux composants essentiels et sont fournies avec leur propre système de mock
• le système Eloquent facilite la création de jeux de données de test via les Factories

Le TDD permet une détection et/ou une correction anticipée des erreurs, sécurisant chaque ajout ou modification grâce à des tests automatisés. Cela allège la maintenance et prévient les régressions, assurant ainsi une base de code stable et fiable.

Conclusion

En conclusion, cet article a brièvement exploré le Test-Driven Development, soulignant ses principes clés et sa compatibilité avec Laravel.

Je vous encourage à expérimenter par vous-même cette méthode de développement. Son utilité peut différer selon l'individu, le projet ou le contexte. Considérez-la comme un outil supplémentaire dans votre arsenal de développeur et forgez votre propre opinion à travers la pratique.

Marc COLLET

Développeur Freelance | Créateur de Solutions Numériques