Rendez les tests unitaires lisibles avec Sensei et AssertJ

Les développeurs créent et testent leur propre code à l'aide de différentes méthodes. L'une d'entre elles est le test unitaire, une méthode très populaire qui consiste à tester les plus petites parties de son propre code. Lorsqu'ils sont bien écrits, les tests unitaires peuvent contribuer à améliorer la qualité de votre code, ainsi qu'à réduire les coûts et le temps de développement. Qu'ils soient effectués dans le cadre du développement piloté par les tests (TDD) ou non, les tests unitaires sont un élément clé des pratiques de développement modernes et leur importance a conduit à la création de nombreux cadres de test.

Mais en l'absence d'un cadre de test approprié et de conseils, les tests unitaires peuvent devenir complexes et illisibles car l'accent est mis sur la couverture et la quantité plutôt que sur la qualité et la lisibilité. Cela est particulièrement vrai dans le cas d'une base de code importante et active comportant de nombreux tests unitaires.

Un bon cadre de test permet de créer des tests lisibles, simples et axés sur la qualité. Il permet également de documenter la manière d'utiliser votre code. AssertJ est l'un de ces frameworks.

AssertJ est une API fluide pour écrire des tests unitaires en Java. Elle vous permet d'écrire des assertions de test qui se lisent comme de l'anglais, avec une autocomplétion contextuelle. Si vous avez un grand nombre de tests et que vous avez besoin d'améliorer leur lisibilité, vous pouvez souhaiter les migrer tous vers AssertJ et vous assurer que tous les tests futurs tirent pleinement parti d'AssertJ.

Mais une migration complète peut demander beaucoup d'efforts et de temps pour être réalisée manuellement, c'est pourquoi elle est souvent ignorée ou reportée à d'autres tâches de développement. Nous avons donc créé Sensei - un plugin IntelliJ hautement personnalisable qui peut vous aider à migrer vos tests unitaires actuels pour utiliser AssertJ et permettre à tous les futurs tests d'être écrits de la bonne manière. Cela se fait grâce à un certain nombre de recettes (règles) déjà créées pour vous par l'équipe de développement de Sensei. Sensei permet d'effectuer facilement une migration unique ou d'adopter l'approche de migrations incrémentales vers AssertJ, un test à la fois. Une fois que vous avez migré vers AssertJ, les recettes continuent d'aider les développeurs à appliquer des corrections rapides lorsqu'ils écrivent des tests unitaires afin que vos tests unitaires continuent d'être uniformes, standards et cohérents dans l'ensemble de la base de code.

‍

A propos de Sensei

Sensei est un plugin IntelliJ hautement personnalisable qui analyse et corrige le code indésirable au fur et à mesure que vous le tapez - avec des centaines de transformations de code et de recettes de migration (règles) téléchargeables, ainsi qu'une capacité intégrée à créer vos propres recettes. Avec Sensei, les développeurs peuvent remédier aux mauvais modèles de code au fur et à mesure qu'ils tapent, afin de livrer plus rapidement un code de qualité et, en fin de compte, de l'écrire d'une manière cohérente et standardisée au sein des équipes et des projets.

Voici un exemple de migration qui peut vous aider à voir comment Sensei facilite la migration de vos tests unitaires pour utiliser AssertJ.

Pourquoi AssertJ est-il un excellent framework pour écrire des tests unitaires ?

Au lieu d'écrire un test comme cette assertion JUnit :

vous pouvez l'écrire avec AssertJ :

Cela signifie que vous pouvez lire l'assertion de gauche à droite comme une phrase anglaise, et qu'il est clair quelle est l'attente (dans ce cas, la taille 3). Combien de fois avez-vous écrit une assertion dans le mauvais sens, comme ceci ?

Ce ne sont que des exemples simples. Plus vos vérifications et assertions sont complexes, plus AssertJ vous aide à rendre vos tests simples et lisibles. Il fonctionne bien avec l'auto-complétion de votre IDE. Dès que vous tapez :

il s'affichera avec toutes les choses que vous pouvez vérifier, en fonction du type de monRésultat. S'il s'agit d'une collection, vous pouvez vérifier son contenu, sa taille, si elle contient certaines valeurs ou certains types, etc.

AssertJ supporte les primitives et leurs types encadrés, les types atomiques, les collections, les tableaux, les cartes, les dates, java.time, les Futures, les fichiers/chemins, les InputStreams, les Throwables et les URLs. Et si vous avez un Matcher personnalisé favori pour Hamcrest, vous pouvez l'utiliser avec AssertJ via HamcrestCondition.

Des tests unitaires lisibles permettent aux développeurs de lire le code dans un anglais normal et facilitent donc la détection des erreurs ainsi que l'augmentation de la couverture - ce qui fait d'AssertJ un cadre indispensable pour de bons tests unitaires Java.

Recettes pour migrer les tests unitaires existants vers AssertJ

Nous avons écrit un livre de recettes pour vous aider à écrire du code cohérent avec AssertJ. Il peut vous aider à migrer vos assertions vers AssertJ depuis n'importe lequel de ces frameworks : JUnit 3, JUnit 4, JUnit 5 et FEST-Assert.

Ce livre de recettes peut être configuré dans Sensei pour une utilisation immédiate et vous pouvez trouver les instructions d'installation pour Sensei ici.

Écrire de meilleurs tests unitaires au fur et à mesure que vous codez - améliorer progressivement la qualité de JUnit

Le livre de recettes Sensei pour AssertJ ne vous aide pas seulement à migrer depuis d'autres frameworks. Il contient des recettes qui peuvent vous aider à améliorer l'écriture de vos tests, à briser de vieilles habitudes et à écrire des tests AssertJ plus idiomatiques.

Par exemple, supposons que vous ayez écrit un test qui ressemble à ceci :

Vous l'avez peut-être même migré en utilisant l'une des recettes de migration ci-dessus, à partir de cette assertion de type JUnit :

Le livre de recettes Sensei pour AssertJ contient une recette qui peut également détecter ce vieux style d'assertion et proposer de le convertir en cela :

Une autre recette peut être convertie de la manière suivante :

à cela :

Une migration unique et des pratiques de codage uniformes dans toutes les équipes - avec Sensei

Nous pouvons voir dans nos exemples ci-dessus que la migration manuelle des tests unitaires pour utiliser AssertJ peut impliquer beaucoup d'efforts et de temps qu'il vaut mieux consacrer à l'écriture de meilleurs tests. En utilisant Sensei, vous pouvez facilement migrer vos tests unitaires vers AssertJ en toute confiance. Vous pouvez effectuer une migration unique ou migrer des tests individuels vers AssertJ au fur et à mesure que vous les rencontrez. Sensei offre ce type de flexibilité qui rend les migrations de code moins pénibles.

La migration des tests unitaires n'est qu'un exemple des nombreuses façons dont Sensei peut être utilisé pour écrire un code cohérent dans vos projets. Vous pouvez toujours être à l'affût des anti-modèles ou de certaines transformations manuelles du code que vous rencontrez fréquemment dans les demandes d'extraction ou lorsque vous codez vous-même. Si vous disposez d'un ensemble de directives de codage qui sont souvent ignorées par les développeurs, vous pouvez les convertir en recettes, ce qui permettra aux développeurs d'appliquer les transformations de code approuvées en toute confiance.

Si vous avez des questions, n'hésitez pas à nous contacter ! Rejoignez-nous sur Slack à l'adresse suivante sensei-scw.slack.com