Parameter zu Annotationen hinzufügen mittels Rewrite-Aktionen

In diesem Blogbeitrag werden wir:

• Das Suchen und Abgleichen von Annotationen demonstrieren
• Annotationen mithilfe von Mustache-Templates anpassen

Sensei bietet die Möglichkeit, problematische Codemuster zu finden und sie durch vereinbarte Implementierungen zu ersetzen. In diesem Beispiel verwende ich @Disabled ohne Parameter als problematisches Codemuster.

Deaktivierte Test-Annotation

Deaktivierte Tests ohne Angabe eines Grundes können langfristig problematisch sein, da wir vergessen, warum sie deaktiviert wurden.

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

Das Risiko besteht darin, dass sich die Codebasis im Laufe der Zeit weiterentwickelt, der deaktivierte Test nicht an den Zweck des Codes angepasst wird, schließlich redundant und irrelevant wird und möglicherweise nie wieder aktiviert wird.

Bei Code-Reviews weisen wir oft darauf hin, dass es sinnvoll ist, eine erklärende Beschreibung als Annotationsparameter hinzuzufügen.

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

Ein Sensei-Rezept

Wir können ein Rezept schreiben, um zu erkennen, wenn @Disabled ohne Erklärung hinzugefügt wird, sowie einen Quick Fix, der uns daran erinnert, den tatsächlichen Grund für die Deaktivierung anzugeben.

Wenn ich überlege, was zu tun ist, muss ich:

• die Disabled-Annotation ohne Parameter finden
• die Disabled-Annotation so ändern, dass sie einen Parameter mit dem Platzhaltertext „TODO: add a description here“ enthält

Ein Warnungs-Rezept erstellen

Ich verwende Alt+Enter, um ein neues Rezept zu erstellen.

Anschließend füge ich den grundlegenden Beschreibungstext in den allgemeinen Informationen hinzu.

Indem die Regel als Warnung definiert wird, wird der entsprechende Code hervorgehoben, aber nicht als schwerwiegender Fehler angezeigt.

Annotation finden

Im Rezept-Editor ändere ich die Suche so, dass sie mit einer Annotation übereinstimmt.

Dadurch werden alle Annotationen in der Vorschau hervorgehoben.

Danach möchte ich nach dem Annotationstyp filtern.

Ich könnte einfach „Disabled“ verwenden, aber ich gebe die Klasse vollständig mit dem Paket an, damit nur die Annotation von JUnit 5 gefunden wird. Da der Quellcode in der Vorschau angezeigt wird, kann ich ihn einfach aus dem tatsächlichen Code kopieren und einfügen, um Tippfehler zu vermeiden.

Ich möchte dann nur Annotationen ohne Parameter finden, was ich über die Benutzeroberfläche erledigen kann.

d. h. Suche:

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

Eine Rewrite-Quick-Fix-Aktion erstellen

Für meinen QuickFix verwende ich eine Rewrite-Aktion.

Ich nutze die Variablen anzeigen-Funktion, um mir die Mustache-Variablen anzeigen zu lassen und den Inhalt in der Vorschau zu sehen.

Anschließend füge ich den zusätzlichen Code hinzu, der für den Platzhalter-Kommentar erforderlich ist.

d. h. QuickFix:

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

Sensei in Aktion

Wir haben ein kurzes Video erstellt, das den Prozess der Rezept-Erstellung in Aktion zeigt.

Zusammenfassung

Beim Erstellen eines Rewrite-Quick-Fix ist es einfacher, wenn wir nach dem Code-Element suchen können, das wir umschreiben möchten, da es dann die „self“-Entität ist, auf die wir einwirken können.

In diesem Beispiel habe ich eine Rewrite-Aktion verwendet, um die Annotation zu ändern. Rewrite ist eine universelle Aktion, die auf jedes Code-Element angewendet werden kann und ein guter Ausgangspunkt für eigene Experimente ist.