it-at-m / Wahllokalsystem

system that supports elections in the city of munich
https://opensource.muenchen.de/
MIT License
5 stars 0 forks source link

naming conventions for testing #414

Open vjohnslhm opened 2 weeks ago

vjohnslhm commented 2 weeks ago

Beschreibung

Damit der Code übersichtlicher und einheitlicher ist, sollte überlegt werden, Naming Conventions zu befolgen.

Beispiel

Beispiel für Nr. 5 aus der Liste ("Should_ExpectedBehavior_When_StateUnderTest"-Convention) siehe Vorfälle und Vorkommnisse Service:

void should_return_WahlbezirkEreignisseDTO_when_given_valid_wahlbezirkid() {}

statt

void serviceCalled() {}

Argumente

Folgende Vor- und Nachteile die mir einfallen:

+ -
Vereinheitlichung längere Methodennamen
bessere Lesbarkeit durch klare Struktur ggf für einige Testfälle schwierig anzuwenden
einfache Identifizierung von Tests
MrSebastian commented 6 days ago

Ergebnis

vjohnslhm commented 5 days ago

Issues erstellt für die Services Basisdaten (#429), Briefwahl (#430), Broadcast (#431), EAI (#432), Infomanagement (#434), Wahlvorbereitung (#436), und Wahlvorstand (#437).

Die Services Auth, Ergebnismeldung und Monitoring sind noch nciht implementiert, daher sind keine Anpassungstickets notwendig.

Der Service VorfaelleundVorkommnisse wurde bereits umgesetzt (#137)