Ajouter des paramètres aux annotations à l'aide des actions de réécriture

Dans cet article de blog, nous allons :

• Démonstration de la recherche et de la mise en correspondance d'annotations
• Annotations Amen à l'aide de modèles mustache

Sensei permet de faire correspondre les modèles de code problématiques et de les modifier en fonction des 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'au fil du 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 finisse par devenir redondant et non pertinent, voire qu'il ne soit 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 écrire une recette pour détecter quand @Disabled est ajouté sans explication et une solution rapide qui nous rappelle d'ajouter la raison réelle expliquant pourquoi nous l'avons désactivé.

Lorsque je pense à ce que je vais faire, je dois le faire :

• correspond à l'annotation Disabled sans aucun paramètre
• modifiez l'annotation Disabled pour qu'elle contienne un paramètre avec le texte du marqueur "TODO : ajoutez une description ici"

Créer une recette d'alerte

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

Ajoutez ensuite le texte descriptif de base dans les informations générales.

En faisant de la règle un avertissement, tout code correspondant est mis en évidence mais n'apparaît pas comme une erreur flagrante.

Trouver l'annotation

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

Cela permet de mettre en évidence toutes les annotations dans l'aperçu.

Ceci fait, je souhaite filtrer sur le type d'annotation.

Je pourrais simplement utiliser Disabled, mais je qualifie complètement la classe avec le package afin qu'elle ne corresponde qu'à l'annotation de JUnit 5. Comme le code source est affiché dans la prévisualisation, je peux facilement copier et coller ce texte à partir du code réel afin d'éviter les fautes de frappe.

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

c'est-à-dire la recherche :

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

Créer une action de réécriture rapide

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

J'utilise la fonctionnalité Show Variables pour afficher les variables de Mustache et prévisualiser leur contenu.

J'ajoute ensuite le code supplémentaire nécessaire à la création du commentaire de marqueur de lieu.

c'est-à-dire 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 recettes en action.

Résumé

Lors de l'élaboration d'un correctif rapide de réécriture, il est plus facile de rechercher l'élément de code que l'on souhaite réécrire, car il s'agit alors de l'entité propre sur laquelle on peut agir.

Dans cet exemple, j'ai utilisé une action de réécriture pour modifier l'annotation. La réécriture est une action à usage général qui peut s'appliquer à n'importe quel élément de code et constitue une bonne option par défaut à explorer.