Ändern der Sichtbarkeit von Methoden und Klassen für JUnit 5

Eine der Freuden des Programmierens ist das ständige Lernen, das erforderlich ist, um auf dem neuesten Stand zu bleiben. Eines der Probleme ist, dass wir eine Vertrautheit und Nutzungsmuster aufbauen, die sich auf die Annahme neuer Ansätze auswirken können. Sensei kann bei der Migration helfen, indem es veraltete Muster identifiziert und uns auffordert, den Fix für die Zukunft zu verwenden.

Als ich zum Beispiel von JUnit 4 auf JUnit 5 migriert bin, war ich es gewohnt, alle meine Testklassen und -methoden als öffentlich zu schreiben. Aber mit JUnit 5 können sie package private sein.

z.B. statt:

public class Junit5VisibilityTest {
    @Test
    public void thisDoesNotNeedToBePublic(){
        Assertions.assertTrue(true);
    }
}

Ich möchte wirklich schreiben:

class Junit5VisibilityTest {
    @Test
    void thisDoesNotNeedToBePublic(){
        Assertions.assertTrue(true);
    }
}

Es hat eine Weile gedauert, bis ich das Muskelgedächtnis für diesen Code aufgebaut hatte, und ich mache immer noch hin und wieder Fehler.

Verwendung von Sensei

Mit Sensei kann ich Rezepte erstellen, die die öffentlichen Methoden und Klassen finden und die Deklarationen so ändern, dass sie automatisch package private sind.

Um dies zu erreichen, habe ich ein Rezept erstellt:

Name - JUnit: JUnit 5 test methods do not need to be public
Beschreibung - JUnit 5 test methods do not need public visibility
Level - Error

Ich habe es als Fehler eingestuft, weil ich diese Codierungspraxis ausmerzen möchte und ich möchte, dass das Problem beim Schreiben von Code in der IDE besser sichtbar ist.

Ändern der Klassenerklärung

Um die Klassen zu finden, suche ich nach jeder Klasse, die eine Child-Annotation von @Test aus Junit 5 hat, d. h. org.junit.jupiter.api.Test

Und wo die Klasse den Modifikator public hat:

search:
class:
with:
child:
annotation:
type: "org.junit.jupiter.api.Test"
modifier: "public"

Dann ändert die Schnellreparatur den Modifikator, um die Sichtbarkeit zu entfernen, so dass es der Standard ist, und der Standard ist Paket privat, was ich suche.

availableFixes:
- name: "remove public visibility from JUnit 5 Test class"
actions:
- changeModifiers:
visibility: ""

Ändern der Methodendeklarationen

Das Änderungsrezept für die Methodendeklaration ist dem Klassenrezept sehr ähnlich.

Zunächst suche ich nach öffentlichen Methoden, die mit @Test aus JUnit 5 annotiert sind.

search:
method:
annotation:
type: "org.junit.jupiter.api.Test"
modifier: "public"

Und dann ändere ich den Modifikator auf die Standard-Sichtbarkeit.

availableFixes:
- name: "Remove @Test method public visibility"
actions:
- changeModifiers:
visibility: ""

Hinweis: Ändern mehrerer Methoden

Sensei hat die Möglichkeit, den QuickFix auf alle Verstöße in der aktuellen Datei anzuwenden.

Wenn ich alt+enter verwende, um den QuickFix anzuwenden.

Wenn ich das QuickFix-Namensmenü erweitere, sehe ich eine Option zum:

"Fix All: 'JUnit: JUnit 5 test methods do not need to be public' Probleme in der Datei"

Wenn ich diese Option auswähle, ändert Sensei alle Vorkommen des Problems, nicht nur das von mir ausgewählte.

Ändern der Klasse

Genauso wie eine Methode nicht öffentlich sein muss, muss auch die Klasse nicht öffentlich sein.

Ich kann ein Rezept und einen QuckFix erstellen, um die Klasse zu ändern.

Name - JUnit: Junit 5 Test classes do not need to be public
Beschreibung - Junit 5 Test classes do not need to be public
Level - Error

Wenn ich eine Klasse finde, die öffentlich ist und eine Methode mit einer @Test-Annotation hat. Dann möchte ich die Sichtbarkeit ändern.

search:
class:
modifier: "public"
anyOf:
- child:
method:
annotation:
type: "Test"

Ich kann die Änderung an der Klassendefinition wieder mit der Aktion changeModifiers vornehmen.

availableFixes:
- name: "Remove @Test class public visibility"
actions:
- changeModifiers:
visibility: ""

Zusammenfassung

Ein statisches Analysetool hat mich zunächst auf diesen empfohlenen Ansatz in JUnit aufmerksam gemacht. Aber das statische Analysewerkzeug hat mir nicht geholfen, das Muskelgedächtnis aufzubauen, um meinen Code beim Programmieren zu ändern.

Verwenden Sie den "Level", um Sie zu warnen. Wenn es sich um ein Problem handelt, das ich in meiner Kodierung auszumerzen versuche, stelle ich es zunächst auf "Fehler" und reduziere es dann, während ich mich vom Kodierungsansatz entwöhne.

Denken Sie daran, dass Sie mit Sensei alle Probleme in der aktuellen Datei gleichzeitig beheben können, indem Sie beim Anwenden des QuickFix die Option des Dropdown-Menüs verwenden.

Indem ich ein Sensei Rezept erstelle, kann ich meinen alten Kodierungsansatz in Echtzeit sehen. Und QuickFix es, um den Ansatz zu verstärken, wenn ich gelegentlich in meiner Kodierung ausrutsche.

---

Sie können Sensei aus IntelliJ heraus über "Preferences \ Plugins" (Mac) oder "Settings \ Plugins" (Windows) installieren und dann einfach nach "sensei secure code" suchen.

Den Quellcode und die Rezepte dafür finden Sie im Repository `sensei-blog-examples` im GitHub-Konto Secure Code Warrior , im Modul `junitexamples`.

• https://github.com/securecodewarrior/sensei-blog-examples