Ajout de paramètres aux annotations via des actions de réécriture

Dans cet article de blog, nous allons :

• Démontrer la recherche et la correspondance d'annotations
• Modifier les annotations à l'aide de modèles mustache

Sensei permet d'identifier des modèles de code problématiques et de les corriger selon les implémentations convenues. Dans cet exemple, j'utilise @Disabled sans paramètre comme modèle de code problématique.

Annotation de test désactivé

Les tests désactivés sans raison précise peuvent s'avérer problématiques à long terme, car nous oublions pourquoi nous les avons désactivés.

@Disabled
   void thisTestMethodHasNoDisabledReason(){
    Assertions.fail("This test is disabled and should not run");
    }

Le risque est qu'avec le temps, la base de code évolue, que le test désactivé ne soit pas mis à jour en fonction de l'objectif du code, et qu'il devienne finalement redondant, non pertinent, voire jamais réactivé.

Lors des revues de code, nous soulignons souvent qu'il est judicieux d'ajouter une description explicative en tant que paramètre d'annotation.

@Disabled ("Disabled to demonstrate adding a reason")
    void thisTestMethodHasDisabledReason(){
   Assertions.fail("This test is disabled and should not run");
   }

Une recette Sensei

Nous pouvons rédiger une recette pour détecter quand @Disabled est ajouté sans explication, ainsi qu'une correction rapide qui nous rappelle d'ajouter la raison réelle pour laquelle nous l'avons désactivé.

Lorsque je réfléchis à ce que je vais faire, je dois :

• faire correspondre l'annotation Disabled sans aucun paramètre
• modifier l'annotation Disabled pour inclure un paramètre avec le texte marqueur « TODO: add a description here »

Créer une recette d'avertissement

J'utilise Alt+Entrée pour créer une nouvelle recette.

Ensuite, j'ajoute le texte descriptif de base dans les informations générales.

En définissant la règle comme un avertissement, tout code correspondant est mis en surbrillance sans pour autant apparaître comme une erreur flagrante.

Trouver l'annotation

Dans l'éditeur de recettes, je modifie la recherche pour qu'elle corresponde à une annotation.

Cela mettra en surbrillance toutes les annotations dans l'aperçu.

Une fois cela fait, je souhaite filtrer par type d'annotation.

Je pourrais simplement utiliser Disabled, mais je qualifie entièrement la classe avec le package afin qu'elle ne corresponde qu'à l'annotation de JUnit 5. Comme le code source est affiché dans l'aperçu, je peux facilement le copier-coller depuis le code réel pour éviter toute erreur de frappe.

Je souhaite ensuite ne faire correspondre que les annotations sans paramètres, et je peux utiliser l'interface graphique pour cela.

c.-à-d. Recherche :

search:
  annotation:
    type: "org.junit.jupiter.api.Disabled"
    without:
       parameters:
          - {}

Créer une action de correction rapide Rewrite

Pour ma correction rapide, j'utiliserai une action de réécriture (rewrite).

J'utilise la fonctionnalité Afficher les variables pour voir les variables Mustache et prévisualiser le contenu.

Ensuite, j'ajoute le code supplémentaire nécessaire pour créer le commentaire de marquage.

c.-à-d. QuickFix :

availableFixes:
 - name: "Add a todo comment parameter"
   actions:
   - rewrite:
      to: "{{{ . }}}(\"TODO: add a description here\")"
      target: "self"

Sensei en action

Nous avons créé une courte vidéo montrant le processus de création de recette en action.

Résumé

Lors de la création d'une correction rapide de réécriture, il est plus facile de rechercher l'élément de code que l'on souhaite réécrire, car il devient alors l'entité « self » sur laquelle nous pouvons agir.

Dans cet exemple, j'ai utilisé une action de réécriture pour modifier l'annotation. La réécriture est une action polyvalente applicable à tout élément de code et constitue une excellente option par défaut à explorer.