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