Verwendung von ArchUnit zur Verifizierung von Architekturregeln

[MrSebastian]

Regeln

Prios

1

• ParameterizedTest hält sich an Namenskonvention -> Einhaltung der Namenskonvention bei Tests #767
• Testmethoden sind package scoped -> Einhaltung der Sichtbarkeit von Testmethoden #768
• Nested-Klassen referenzieren Methoden in einer zu testenden Klasse -> Einhaltung der Regeln für Nested Testsuits #769
• Es gibt keine Beziehungen zwischen den Packages DTO, Model und domain (Versuch: Timebox) -> Einhaltung der zu den Datenmodellen #770
• @BeforeEach -> setup -> Einhaltung der Regeln für BeforeEach-Methoden #771
• @AfterEach -> teardown -> Einheitliche Regel für AfterEach-Methoden #772

2

• DTOs sind Records
• Models sind Records
• Enums in Entitäten sind mit Enumerated.String annotiert da wir keine Zahlen in der Datenbank wollen
• Parameter in Methoden final

3

• FLyway-Namingconvention
• Controller-Methoden sind mit OpenAPI Annotationen versehen
  • Operation mit description
  • Es gibt eine Response-Beschreibung zu dem definierten HttpStatus
    • Bsp.: ist die Rückgabe ein Objekt und gibt es keine Status Annotation ist die Antwort 200#
• Alle Methoden einer Service-Klasse sind abgesichert
  • Methoden die keine Absicherung haben sollen wurden explizit als solche markiert

Todo

• Regeln abstimmen
• Umsetzung planen
• In RefArch zurückfließen lassen -> Issue + ggf. Umsetzung
• Verweis in Doku auf automatische Prüfung ergänzen