Archunit - für alle, die es noch nicht kennen...

03.12.2022

Ich trage mich schon seit einer Weile mit dem Gedanken, einer größeren Leserschaft ein Werkzeug nahezubringen über das ich in einem der Projekte in meinem $dayjob gestolpert bin. Dabei handelt es sich um ein Testframework namens ArchUnit. Dieses Framework erlaubt es, diverse Metriken einer Codebasis zu testen, die sich grob in die Bereiche Architektur, Coding Style oder Model Check einordnen lassen.

Zu den einzelnen verfügbaren Tests zählen unter anderem solche wie Checks ob Package-Grenzen eingehalten werden oder ob bestimmte Namenskonventionen betreffend Klassen, Interfaces oder Methoden eingehalten werden. Des Weiteren ist es möglich, die Benutzung oder Nichtbenutzung bestimmter Apis zu überwachen.

Dazu schreibt man fluid Statements wie etwa diese beiden Beispiele hier, die Softwareentwicklern ohne weiteren Kommentar bereits sagen sollten, welche Kriterien der Codebasis hier vaslidiert werden sollen:

classes().that().resideInAPackage("..foo..")
    .should().onlyHaveDependentClassesThat().resideInAnyPackage("..source.one..", "..foo..");
classes().that().areAssignableTo(EntityManager.class)
    .should().onlyHaveDependentClassesThat().areAnnotatedWith(Transactional.class);

Hier noch ein nicht ganz so triviales Beispiel, das aber durchaus auch verständlich ist:

layeredArchitecture()
    .consideringAllDependencies()
    .layer("Controller").definedBy("..controller..")
    .layer("Service").definedBy("..service..")
    .layer("Persistence").definedBy("..persistence..")

.whereLayer("Controller").mayNotBeAccessedByAnyLayer() .whereLayer("Service").mayOnlyBeAccessedByLayers("Controller") .whereLayer("Persistence").mayOnlyBeAccessedByLayers("Service");

Am meisten (und positivsten) hat mich aber die Möglichkeit überrascht, Checks auf im Projekt vorhandene UML-Diagramme anzuwenden, die in PlantUML-Syntax vorliegen.

Den vollen Funktions- und Möglichkeitsumfang hier darzulegen würde viel zu weit führen - ich verweise dafür auf die hervorragende Dokumentation und diverse Tutorial- und Demonstrationsprojekte - in diesem hier kann man neben vielen anderen Validierungen auch Beispiele für die angesprochene PlantUML-Integration finden.

Es existieren Integrationen speziell für Junit4 und Junit5 - man kann das Framework aber auch mit beliebigen anderen Testframeworks benutzen - Beispiele dafür finden sich ebenfalls in der Dokumentation und dem Demonstrationsprojekt.

Artikel, die hierher verlinken

π ≠ PI (?)

30.12.2024

Ich habe bereits verschiedentlich über esoterische numerische Probleme bei der Arbeit mit Computern berichtet.

ethersyncj - Java Bindings für Ethersync

23.11.2024

Ich wurde über einen Post auf Mastodon auf ein Projekt aufmerksam, das mir so interessant erschien, dass ich daraus meine neueste Fingerübung machte...

Alle Artikel rss Wochenübersicht Monatsübersicht Codeberg Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • 8TB Raid5 mit Raspberry Pi

    25.04.2020

    Ich habe mir neulich überlegt, ob man einen Pi als Raid benutzen könnte - aber nicht mit dem ewig gleichen Setup mit 4 USB-Sticks...

    Weiterlesen...

Neueste Artikel

  • Watch David Byrne Lead a Massive Choir in Singing David Bowie’s “Heroes”

    Durch die Seite Open Culture bin ich auf diesen spektakulären Auftritt aufmerksam geworden:

    Weiterlesen
  • Zufälliges Füllen der Ebene

    Ich fand neulich einen sehr interessanten Artikel Zum Thema der algorithmischen Erzeugung von dekorativen (obwohl - das liegt im Auge des Betrachters) Bildern.

    Weiterlesen
  • Sicherheit beim Fernzugang per SSH

    Ich habe vor einiger Zeit bereits zwei Vorträge gestaltet und dafür meine Ideen zur unkomplizierten Erstellung von Präsentationen genutzt - nun ist ein weiterer hinzugekommen.

    Weiterlesen

Manche nennen es Blog, manche Web-Seite - ich schreibe hier hin und wieder über meine Erlebnisse, Rückschläge und Erleuchtungen bei meinen Hobbies.

Wer daran teilhaben und eventuell sogar davon profitieren möchte, muss damit leben, daß ich hin und wieder kleine Ausflüge in Bereiche mache, die nichts mit IT, Administration oder Softwareentwicklung zu tun haben.

Ich wünsche allen Lesern viel Spaß und hin und wieder einen kleinen AHA!-Effekt...

PS: Meine öffentlichen Codeberg-Repositories findet man hier.