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.

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


Vor 5 Jahren hier im Blog

  • AtomicInteger vs. Integer

    24.03.2019

    Ich habe am Wochenende wieder einmal mit Java-Benchmarks experimentiert

    Weiterlesen...

Neueste Artikel

  • Konstruktive Geometrie mit dem Computer

    Ich habe in einem vorhergehenden Artikel beschrieben, dass ich eine weitere neue Graphik-Primitive erstellt habe. Dabei musste ich mir meine verschütteten Trigonometrie-Kenntnisse wieder vor Augen führen - mit Bleistift und Papier. Das müsste doch auch anders gehen dachte ich mir und begann...

    Weiterlesen...
  • GitHub-Projekte

    Mal abgesehen von den anderen Links, die ich in unregelmäßigen Intervallen hier poste kommt heute ein Schwung (aus meiner Sicht) interessanter/skurriler Projekte auf GitHub:

    Weiterlesen...
  • Mehrere Datenbanken und Postgis-Erweiterung in Docker

    Ich hatte ja schon beschrieben, dass ich mich in diesem Jahr wieder intensiver um mein Geoinformationssystem EBMap4D kümmern möchte. Dazu habe ich jetzt einige infrastrukturelle Vorbereitungen getroffen...

    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, muß 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 GitHub-Repositories findet man hier - meine öffentlichen GitLab-Repositories finden sich dagegen hier.