Änderung der Methoden- und Klassensichtbarkeit für JUnit 5

Änderung der Methoden- und Klassensichtbarkeit für JUnit 5

Eine der Freuden des Programmierens ist das ständige Lernen, das erforderlich ist, um auf dem Laufenden zu bleiben. Eines der Probleme besteht darin, dass wir Vertrautheit und Nutzungsmuster aufbauen, die sich auf die Einführung neuer Ansätze auswirken können. Sensei kann bei der Migration helfen, indem er veraltete Muster identifiziert und uns mit der Lösung, die wir in Zukunft verwenden können, auffordert.

Als ich beispielsweise von JUnit 4 auf JUnit 5 migrierte, war ich es gewohnt, alle meine Testklassen und Methoden als öffentlich zu schreiben. Aber mit JUnit 5 können sie paketprivat sein.

z. B. statt:

öffentliche Klasse JUnit5VisibilityTest {
@Test
public void thisdoesnotNeedToBePublic () {
assertions.assertTrue (wahr);
}
}

Ich möchte wirklich schreiben:

Klasse JUnit5VisibilityTest {
@Test
void thisdoesnotNeedToBePublic () {
assertions.assertTrue (wahr);
}
}

Ich habe eine Weile gebraucht, um das Muskelgedächtnis aufzubauen, um das zu codieren, und ich mache immer noch ab und zu einen Fehler.

Sensei verwenden

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

Um das zu erreichen, habe ich ein Rezept kreiert:

Name - JUnit: JUnit 5-Testmethoden müssen nicht öffentlich sein
Beschreibung - JUnit 5-Testmethoden benötigen keine öffentliche Sichtbarkeit
Level — Fehler

Ich habe es als Fehler eingestuft, weil ich diese Programmierpraxis ausrotten möchte und das Problem beim Schreiben von Code in der IDE besser sichtbar machen möchte.

Änderung der Klassendeklaration

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

Und wo die Klasse den Modifikator public hat:

suche:
klasse:
mit:
Kind:
Anmerkung:
Typ: „org.junit.jupiter.api.Test“
Modifikator: „öffentlich“

Dann ändert der Quickfix den Modifikator, um die Sichtbarkeit zu entfernen, sodass er die Standardeinstellung ist und die Standardeinstellung Paket privat ist, wonach ich suche.

Verfügbare Korrekturen:
- name: „Entferne die öffentliche Sichtbarkeit aus der JUnit 5-Testklasse“
Aktionen:
- Modifikatoren ändern:
Sichtbarkeit: „“

Änderung der Methodendeklarationen

Das Rezept für die Änderung der Methodendeklaration ist dem Klassenrezept sehr ähnlich.

Zuerst suche ich nach öffentlichen Methoden, die mit @Test von JUnit 5 annotiert sind.

suche:
Methode:
Anmerkung:
Typ: „org.junit.jupiter.api.Test“
Modifikator: „öffentlich“

Und dann ändere ich den Modifikator auf Standardsichtbarkeit.

Verfügbare Korrekturen:
- name: „Entferne die öffentliche Sichtbarkeit der @Test -Methode“
Aktionen:
- Modifikatoren ändern:
Sichtbarkeit: „“

Hinweis: Änderung 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 für:

„Alles reparieren: 'JUnit: JUnit 5-Testmethoden müssen nicht öffentlich sein' Probleme in der Datei“

Wenn ich diese Option auswähle, korrigiert Sensei alle Fälle des Problems, nicht nur das, das ich ausgewählt habe.

Änderung der Klasse

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

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

Name - JUnit: Junit 5-Testklassen müssen nicht öffentlich sein
Beschreibung - Junit 5-Testklassen müssen nicht öffentlich sein
Level — Fehler

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

suche:
klasse:
Modifikator: „öffentlich“
Irgendein von:
- Kind:
Methode:
Anmerkung:
Typ: „Test“

Ich kann die Änderung an der Klassendefinition mit der ChangeModifiers-Aktion erneut vornehmen.

Verfügbare Korrekturen:
- name: „Entferne die öffentliche Sichtbarkeit der Klasse @Test“
Aktionen:
- Modifikatoren ändern:
Sichtbarkeit: „“

Résumé

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

Benutze das 'Level', um dich zu warnen. Wenn es sich um ein Problem handelt, das ich in meiner Codierung auszumerzen versuche, mache ich es zunächst als „Fehler“ und reduziere es dann, während ich mich vom Codierungsansatz entwöhne.

Denken Sie daran, dass Sie Sensei verwenden können, um alle Probleme in der aktuellen Datei gleichzeitig zu beheben, indem Sie die Drop-down-Menüoption verwenden, wenn Sie den QuickFix anwenden.

Indem ich ein Sensei-Rezept erstelle, kann ich meinen alten Programmieransatz in Echtzeit sehen. Und QuickFix it, um den Ansatz zu verstärken, falls ich gelegentlich beim Programmieren einen Fehler mache.

---

Sie können Sensei von IntelliJ aus mit „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 `sensei-blog-examples`-Repository im GitHub-Konto von Secure Code Warrior im Modul `junitexamples`.

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