Bug Fixes

• Fix bug where referenced class objects and instanceof checks were not detected if declared within a lambda (see #992)
• Fix empty records not being detected as records (see #998; thanks a lot to @hankem)
• Fix Javadoc on layeredArchitecture() missing the new consideringDependencies part (see #977; thanks a lot to @Thunderforge)
• Fix user guide still showing DescribedPredicate.apply instead of .test (see #978; thanks a lot to @thmuch)

:warning: If you upgrade from the latest 0.x version, please also refer to the release notes of release candidate 1.0.0-rc1 as these release notes refer to upgrading from the release candidate :warning:

Breaking Changes

• Naming around JavaPackage subpackages and dependencies has been improved to remove ambiguities. In general, whenever all classes from a package and subpackages recursively are involved, this is now called "package tree". Otherwise, it only targets the classes directly within this package (see #919/#968; thanks a lot to @grimsa) The following mapping shows how to translate the old methods to the current methods:
  • getAllClasses() -> getClassesInPackageTree()
  • getAllSubpackages() -> getSubpackagesInTree()
  • getClassDependenciesFromSelf() -> getClassDependenciesFromThisPackageTree()
  • getClassDependenciesToSelf() -> getClassDependenciesToThisPackageTree()
  • getPackageDependenciesFromSelf() -> getPackageDependenciesFromThisPackageTree()
  • getPackageDependenciesToSelf() -> getPackageDependenciesToThisPackageTree()
  • accept(..) -> traversePackageTree(..)
• Importing the default package via ClassFileImporter.importPackages("") will now yields the same result as using importClasspath() without any ImportOption (see #954)
• ClassFileImporter.importClasspath() now behaves consistently to other import APIs. I.e. no default ImportOptions like DoNotIncludeArchives are added anymore, instead all ImportOptions need to be added the same way as for all other import methods (see #958)
• The custom collection ImportOptions has been removed from the public API and been replaced by a standard Collection<ImportOption> where appropriate (see #958)
• The package com.tngtech.archunit.library.plantuml has been moved to com.tngtech.archunit.library.plantuml.rules to make room for adding other PlantUML related features (see #959)
• SLF4J-API has been upgraded from 1.7.30 to 2.0.3, so any log adapter dependency to be used with ArchUnit (e.g. to hook in Log4J) has to be compatible with SLF4J-API 2.x from now on (see #966)

Bug Fixes

• Fix bug where multiple synthetic access calls to methods like access$123(..) would lead to only one access being imported. Note, that these synthetic methods are added for calls to private fields / methods from inner classes to outer classes, etc. (see #957)

Enhancements

Lang

• archunit_ignore_patterns.txt is now also respected by FreezingArchRule. Thus, ignored violations are not added to the ViolationStore anymore (see #915)

Library

• testClassesShouldResideInTheSamePackageAsImplementation(..) now supports multiple test classes with same simple name (see #918; thanks a lot to @mslowiak)
• PlantUmlArchCondition now does not throw exceptions anymore, if a class is in none or multiple components, but instead reports those as standard violations. This way these violations can also be frozen via FreezingArchRule instead of crashing the test (see #960)

Further Acknowledgement

• Thanks a lot to @hankem for upgrading various dependencies, cleaning up code and extensive reviews

Breaking Changes

• All deprecated members and classes have been removed (see #909)
• @AnalyzeClasses() without any explicit locations to import will now import the package of the annotated class by default instead of the whole classpath. To restore the old behavior use @AnalyzeClasses(wholeClasspath = true) (see #828)
• The archunit-junit5-engine-api now resides within the package com.tngtech.archunit.junit.engine_api instead of directly under junit. This only affects users that want to programmatically interface with the ArchUnitTestEngine and should be irrelevant for most users (see #827)
• ArchUnit now needs at least Java 8 to run (see #833)
• The ArchUnit types Function, Predicate and Optional have been replaced by the JDK 8 equivalents
• DescribedPredicate now extends the JDK 8 Predicate, so apply(..) has to be replaced by test(..)
• layeredArchitecture() now forces to decide how to deal with dependencies by adding .considering...Dependencies() in the beginning of the declaration. To restore the old behavior declare it as layeredArchitecture().consideringAllDependencies() (see #892)
• ConditionEvents is now an interface and the interface has been cleaned out of all non-essential methods, e.g. getAllowed(). This was done to increase maintainability and make it easier to optimize the internals. If you are missing any functionality now, please file an issue to discuss it (see #876)
• PackageMatcher was moved from package base to core.domain (see #894)
• Primitive classes now reside in package java.lang to be consistent with the Reflection API's Class.getPackageName() (see #905)
• PlantUmlArchCondition.Configurations has been merged into PlantUmlArchCondition.Configuration (see #891)

Bug Fixes

• While technically no real bug PlantUmlArchCondition.Configuration is now a public class instead of an interface, which solves a (non-fatal) Kotlin compiler warning complaining about the access rights (see #888)

Enhancements

Core

• Accesses from inside of lambdas are now correctly detected. Before, the origin was set as a synthetic method like lambda$xxx$123 instead. JavaAccess can now be queried for isDeclaredInLambda() to distinguish this from an access outside of a lambda (see #847; thanks a lot to @oberprah, @FrederikFinckh)
• Support for Java 19 (see #845)
• It is now possible to analyze try-catch-blocks, e.g. if a method call is wrapped into a try-catch-block catching a certain exception type (see #591; thanks a lot to @crizzis)
• Package identifiers like ..myapp.service.. now support alternations via ..[service|legacy_service]... This also works for capturing groups like (a|b). Note that alternation groups cannot be nested (see #662; thanks a lot to @Pfoerd)
• DescribedPredicate now offers static factory methods and(predicates) and or(predicates) that join together varargs DescribedPredicate<>... or Iterable<DescribedPredicate<>> via AND or OR (see #805)
• The importer now ignores synthetic $SwitchMap$ fields of enums (see #570)
• Private member accesses are now correctly reported between inner classes. Before, the origin was set as a synthetic method access$123 (see #889)
• ImportOption.DoNotIncludeTests now works for plain IntelliJ project layouts (see #696; thanks a lot to @JCook21)

Lang

• New methods codeUnits().should().onlyBeCalled().by{Classes/Methods/...}That(..) (see #810; thanks a lot to @JKLedzion)
• ArchCondition evaluation is now more efficient and has a smaller memory footprint (see #876)
• The ArchCondition to search for transitive dependencies has been improved and now only reports relevant dependencies, in particular when checking for transitive dependencies between packages a and b (see #780; thanks a lot to @Pfoerd)
• New APIs ArchCondition.from(predicate) and ArchConditions.{be/have}(predicate) to easily create ArchConditions from DescribedPredicates (see #855; thanks a lot to @u3r)
• Javadoc of the rules API has been extended to better guide to predefined DescribedPredicates like JavaClass.Predicates or HasName.Predicates (see #912)
• New convenience method ConditionEvent.createMessage(..) to easily create a standard ArchRule violation message like Class <..> some description in (...java:123) (see #826)

Library

• layeredArchitecture() now allows to easily specify how to deal with dependencies from classes within the layers. E.g. should only dependencies that target other classes within the layers be considered? Or all dependencies in the root package of the application? This should solve common confusion about dependencies on classes like java.lang.Object being reported (see #887)
• onionArchitecture() components can now not only be defined by package identifiers but also by predicates (see #894)
• layeredArchitecture() and onionArchitecture() now support ensureAllClassesAreContainedInArchitecture() (see #278; thanks a lot to @roxspring)
• New rule GeneralCodingRules.testClassesShouldResideInTheSamePackageAsImplementation() to check that test classes reside in the same package as their class under test (see #475; thanks a lot to @mslowiak)

JUnit

• The archunit-junit5 can now be used on the modulepath as well as the classpath (see #206)
• JUnit 5 discovery speed is now notably faster in test projects with a lot of dependencies (see #546)
• For JUnit 5 support @ArchTest is now also supported within abstract base classes (see #104; thanks a lot to @hankem)

Further Acknowledgement

• thanks a lot to @marknp for migrating the code base to JDK 8 (see #833)
• thanks a lot to @grimsa for improving the Javadoc on JavaClass.Predicates (see #814)
• thanks a lot to @rweisleder for Javadoc improvements regarding annotation APIs (see #835)
• thanks a lot for various reviews to @hankem, @spanierm42, @kaebiscs, @KorSin, @GandalfIX

Bug Fixes

• Fix exception Never found a JavaCodeUnit that matches supposed origin... occurring with Kotlin inline functions where the descriptor of a method deviates from the signature (this was introduced by checking the return type of the method as well when looking for a call origin in #714; see #804, #807)
• Fix optional layers of LayeredArchitecture failing with the new default behavior archRule.failOnEmptyShould = true (see #809; thanks a lot to @oberprah)

Enhancements

• Log automatic resolution configuration on debug to reduce log clutter (see #802)
• Add new Method ArchRule.allowEmptyShould(boolean) to override the configured archRule.failOnEmptyShould configuration on a per rule basis (see #803, #806, #808; thanks a lot to @oberprah)

Breaking Changes

• As mentioned in Enhancements/Core ArchRules will now by default reject evaluating if the set passed to the should-clause is empty. This will break existing rules that don't check any elements in their should-clause. You can restore the old behavior by setting the ArchUnit property archRule.failOnEmptyShould=false

Bug Fixes

• Fix wrong origins of JavaCall in case of bridge methods. If a class had two methods with the exact same name and parameter types the origin of a JavaCall was picked randomly from them. It now always picks the non-synthetic method (see #513)
• Fix non-deterministic return value of JavaCodeUnit.getMethod(). In case of bridge methods there might be more than one method matching the exact same name and parameters. In these cases the result of getMethod() was random. It now always picks the non-synthetic method (see #256)
• layeredArchitecture() will now allow to combine mayOnlyBeAccessedBy... and mayOnlyAccess.... Previously mayOnlyAccess... would forbid all incoming dependencies (see #739; thanks a lot to @hankem)

Enhancements

Core

• Members targeted by AccessTarget are now resolved like the Java Reflection API would do it. Previously AccessTarget.resolve() would return a set of matching members, the new replacement AccessTarget.resolveMember() returns an optional member making it a lot easier to handle (see #722)
• JavaClass now knows its methodReferencesFromSelf (e.g. Object::toString) and constructorReferencesFromSelf (e.g. Object::new) (see #215; thanks a lot to @KorSin)
• ArchRules will now by default reject evaluating if the set passed to the should-clause is empty. This prevents implementation errors like picking a package in that()... that doesn't even exist and thus composing a rule that doesn't check anything (compare the user guide; see #774; thanks a lot @oberprah)
• The automatic import dependency resolution now resolves classes missing from the import that are only referenced
  • as class object (e.g. Foo.class)
  • in a throws clause (e.g. someMethod() throws FooException)
  • in an instanceof check (e.g. obj instanceof Foo)
  • as an array component type (e.g. Foo[] array;)
  • as an annotation parameter (e.g. @SomeAnnotation(type = Foo.class))
  • as part of a generic type signature (e.g. List<? extends Foo>)
  • Furthermore, the resolution behavior can now be tweaked to resolve deeper or not resolve at all. Thus, users can decide between resolving additional types and performance (compare the user guide; see #728)
• New predefined ImportOption to exclude package-info.class files (see #793; thanks a lot to @TomerFi)

Lang

• Analogously to classes(), there now exists a method members()...should().containNumberOfElements(predicate) (see #179; thanks a lot to @oberprah)

Library

• PlantUmlArchCondition now rejects files that don't specify any components at all or are of an invalid format (see #735; thanks a lot to @pfichtner)

JUnit

• Tests can now be run if their classes are loaded by the context ClassLoader instead of the ArchUnit ClassLoader (see #781; thanks a lot to @stuartwdouglas)
• New method Class<?> FieldSource.getJavaClass() to retrieve the declaring class of the respective field (see #800; thanks a lot to @famod)

Further Acknowledgement

• thanks a lot to @marknp for improving the Javadoc on ArchConditions (see #725)
• thanks a lot to @timtebeek for making the ArchUnit build work with JDK 17 (see #779)

Bug Fixes

• Java class file URLs with spaces are now correctly handled when resolving transitive dependencies (see #683)
• fixed memory leak in ArchUnit JUnit 5 support (see #695)
• three bug fixes regarding generics import (see #700)
  • toplevel generic array types (e.g. T[]) were not detected correctly as method parameters
  • primitive types were missing from the generic JavaCodeUnit.getParameterTypes()
  • inner classes were not detected correctly as upper bounds of type parameters

Enhancements

Core

• support for method and constructor parameter annotations (see #701; thanks a lot to @hankem for extensive reviews)
  • new method JavaCodeUnit.getParameters() that will return parameters in a structured form offering raw type, generic type and annotations
  • new method JavaCodeUnit.getParameterAnnotations() that offers just parameter annotations by index
  • parameter annotations are now part of JavaClass.directDependencies{from/to}Self
• SourceCodeLocation now offers structured access to source file and source class (see #673; thanks a lot to @thmuch)

JUnit

• new option to replace underscores in rule field/method names by spaces in the test description to improve readability (see #626; thanks a lot to @thmuch)

Breaking Changes

• the type JavaClassList has been removed completely. It was used inconsistently and provided very limited value (convenient way to get the names of the classes). On the other hand having a custom list implementation increases maintenance overhead and limits options in the future. Please replace usages of JavaClassList.getNames() by the static utility HasName.Utils.namesOf(classes) which can be used on any Iterable with elements of type HasName (see #633)

Enhancements

Core

• JavaMethod now knows its generic parameter types (retrievable via JavaMethod.getParameterTypes()). Furthermore type arguments of generic method parameter types are now part of the JavaClass.directDependencies{From/To}Self (see #640)

Library

• the PlantUML rule syntax now allows colored components (see #258; thanks a lot to @johthor)

Further Acknowledgement

• thanks a lot to @NilsOliverLinden for further automating the release process (see #646)

Bug Fixes

• Fix bug where some anonymous classes compiled with JDK 7 could not be imported anymore (java.lang.IllegalArgumentException: Can't register multiple enclosing classes, this is likely a bug!) (see #637)

Bug Fixes

• onionArchitecture() no longer loses ignored dependencies, if the description is changed afterwards (see #623; thanks a lot to @thmuch)

Enhancements

Core

• added support for JDK 18 (see #625; thanks a lot to @hankem)
• new method JavaCodeUnit.getTypeParameters(). Also the bounds of these type parameters have been added to JavaClass.directDependencies{From/To}Self (see #616; thanks a lot to @hankem for extensive reviews)
• JavaMethod now knows its generic return type (retrievable via JavaMethod.getReturnType()). Furthermore type arguments of generic method return types are now part of the JavaClass.directDependencies{From/To}Self (see #616; thanks a lot to @hankem for extensive reviews)

JUnit

• upgraded JUnit Platform dependency from 1.7.1 to 1.7.2 (see #628)

Bug Fixes

• The last release archive contained a couple of classes from dependencies that were not relocated and thus lead to duplicate classes warnings in some environments. These classes have been removed (see #593)

Enhancements

Core

• JavaField now knows its generic type (retrievable via JavaField.getType()). Furthermore type arguments of generic field types are now part of the JavaClass.directDependencies{From/To}Self (see #595; thanks a lot to @hankem for extensive reviews)

Lang

• new method noClasses()...should().transitivelyDependOnClassesThat(..)... (see #575; thanks a lot to @hankem)
• the failure descriptions of ArchRules can not be customized (see #343; thanks a lot to @Farbauti89)

Library

• new method layeredArchitecture()...mayOnlyAccessLayers(..)... (see #592; thanks a lot to @GiorgadzeLuka)
• improved readability for cycle rule violations (see #369; thanks a lot to @jzheaux)
• FreezingArchRule can now refreeze all violations, if current violations should simply be added to the ViolationStore without any failure (see #510)

JUnit

• annotations of test methods and fields are now passed to the TestDescription by the JUnit 4 test support (see #552)

Further Acknowledgement

• Thanks a lot to @GiorgadzeLuka and @OLibutzki for improving the documentation

Breaking Changes

• JavaClass.get{All}Interfaces() is now JavaClass.get{All}RawInterfaces() to be consistent with regards to the generic JavaClass.getInterfaces(). We decided that this is still a less painful way than deprecating getInterfaces(), introducting a new getGenericInterfaces(), then deprecate getGenericInterfaces() in favor of getInterfaces() in a later release. To be consistent with other places in ArchUnit JavaClass.getInterfaces() needs to provide the generic version of the interfaces (compare e.g. JavaClass.getSuperclass()).

Enhancements

Core

• Support for Java Records (see #295; thanks a lot to @rweisleder)
• JavaClass now knows its generic interfaces (retrievable via JavaClass.getInterfaces()). Furthermore type arguments of generic interfaces are now part of the JavaClass.directDependencies{From/To}Self (see #551)

Lang

• New syntax methods classes().that().containAny{Members,Fields,Methods,...}That(..) (see #553; thanks a lot to @nils-christian)

Library

• Added an API to calculate Software Architecture Metrics inspired by John Lakos, Robert C. Martin and Herbert Dowalil. For further details check the user guide (see #572; thanks a lot to @hankem and @stefanhechtltng and to @hdowalil for the inspiration and support)

Further Acknowledgement

• Thanks a lot to @rweisleder and @Strohgelaender for improving the documentation

Breaking Changes

• The metaAnnotatedWith(..) predicate, as well as all syntax elements like classes().that().areMetaAnnotatedWith(..) or classes().should().beMetaAnnotatedWith(..), now all also count direct annotations as matching. The background is, that the typical use case always seemed to be "either directly annotated or annotated with some meta-annotated annotation", so we decided to cover this directly.
  • If your rule has metaAnnotatedWith(..).or(annotatedWith(..)) it still works, but you can now drop the annotatedWith(..) part
  • If your rule really wanted to test that the annotation is not a direct annotation, but only meta-annotated on another annotation, this can still be asserted by metaAnnotatedWith(..).and(not(annotatedWith(..))) (see #527)

Enhancements

• Classes appearing in member signatures (like field types or method return values) are now automatically resolved in import (see #530)
• Support for Java 17 (see #535)
• New API to check if a JavaAnnotation has explicitly declared a certain property, i.e. it is set in the annotation and not taken from the default value (see #499)

Lang

• Improved Javadoc and error message to better explain the difference of classes().that().implement(..) and classes().that().areAssignableTo(..)

Library

• New rule to assert no proxy bypasses, e.g. if a Spring bean internally calls an @Async method and thus bypasses the proxy (see #539)

JUnit

• We decided to rename ArchRules.in(..) to ArchTests.in(..), because ArchRules was considered confusing, if the actual behavior is to collect all @ArchTest members of the other class. ArchRules is still present (yet deprecated), so this will not break existing ArchTest suites (see #525)

Bug Fixes

• Fix modulepath issue where sometimes classes on the modulepath would not be imported correctly (see #497)
• FreezingArchRule default violation store now works correctly cross-platform with regards to line separators (see #458, #508)

Enhancements

Core

• JavaClass now knows its generic superclass (retrievable via JavaClass.getSuperclass()). Furthermore type arguments of generic superclasses are now part of the JavaClass.directDependencies{From/To}Self (see #503)
• JavaClass/JavaCodeUnit now know their references to other class objects (e.g. Example in List.of(Example.class)). Furthermore class objects are now part of the JavaClass.directDependencies{From/To}Self (see #518)
• Added new ImportOption.OnlyIncludeTests to execute ArchRules only on test classes (see #501; thanks a lot to @pstanoev)

Further Acknowledgement

• Thanks a lot to @rweisleder for improving the ArchUnit CI
• Thanks a lot to @perlun for improving the Imprint
• Thanks a lot to @sullis for upgrading the SLF4J dependency
• Thanks a lot to @Bananeweizen for improving the user guide

Bug Fixes

• TextFileBasedViolationStore now correctly handles empty violation store files (see #456; thanks a lot to @hankem)
• Fix URL scheme part issue on Windows when reading classpath URLs from manifest files (see #414; thanks a lot to @eriklumme)

Enhancements

Core

• Reduce excessive logging if archunit.properties are overwritten by system properties (see #375; thanks a lot to @ldebruijn)
• New method JavaClass.tryGetConstructor() (see #386; thanks a lot to @rweisleder)
• JavaClass now provides generic type information, i.e. there is now JavaClass.getTypeParameters() (see #398). Furthermore JavaClass now reports type parameter bounds as Dependencies (see #484)
• JavaClass now offers JavaClass.getInstanceofChecks(), which are also reported as Dependencies (see #371; thanks a lot to @t-h-e)
• Support for Java 15 and 16-ea (see #409)
• Resolve imported annotations transitively with the configured ClassResolver (i.e. by default from the classpath). This will make detection of meta-annotations work out of the box now in many cases, without the need to explicitly import these meta-annotation types as well (see #342, #450; thanks a lot to @KorSin)
• New method JavaClass.getBaseComponentType() (see #441; thanks a lot to @hankem)
• Component types (i.e. String for an array String[]) are now detected as dependencies of JavaClass (see #257; thanks a lot to @wengertj)
• New method ..archunit..Optional.getOrThrow(Supplier) (see #391; thanks a lot to @idosal)
• New method JavaClass.getTransitiveDependenciesFromSelf() (see #401; thanks a lot to @hankem)

Lang

• New syntax members().that().haveName{StartingWith/Containing/EndingWith}(..) and members().should().haveName{StartingWith/Containing/EndingWith}(..) (see #239; thanks a lot to @kamer)
• Improve CompositeArchRule.of(..) to accept an Iterable of ArchRule (see #384; thanks a lot to @sullis)
• Clarify difference between access and depend in rule Javadocs (see #313; thanks a lot to @idosal)
• New syntax classes().that().are{Not}Annotations() (see #468)
• New syntax classes().that().doNotBelongToAnyOf(..) (see #422; thanks a lot to @perlun)

Further Acknowledgement

• Thanks a lot to @rweisleder for improving the ArchUnit user guide, development documentation and build
• Thanks a lot to @spanierm for improving OS-JDK-matrix CI builds with GitHub Actions
• Thanks a lot to @gernotstarke for website and documentation improvements (see #478 and #479)
• Thanks a lot to @kamilszymanski and @dariuszzbyrad for Javadoc improvements and code cleanups
• Thanks a lot to @sullis for upgrading various build dependencies
• Thanks a lot to @cristiangreco for introducing Upgrade Gradle Wrapper Action (see #486)

Bug Fixes

• Fix broken Gradle metadata: Migrating the legacy Maven Plugin to the Publish Plugin caused some broken Gradle metadata published to Maven Central by accident. While 0.14.0 should work fine with any other build tool like Maven, Gradle will complain about a missing artifact archunit-junit, which does in fact not exist. This release fixes this by removing the broken metadata.

Breaking Changes

• All methods that have been deprecated up to ArchUnit 0.12.0 have been removed. It might make sense to look through your code for usage of deprecated methods and follow the advice in the Javadoc before upgrading (see #329; thanks a lot to @rweisleder for removing the old deprecations)

Bug Fixes

• Fix for Android where some classes were not imported correctly when run from the command line (see #319; also thanks a lot to @rweisleder for fixing the subsequent URI problems on Windows)
• Fixed surprising behavior when using only{Call/Access}...That()... where the target of the call could not be resolved from the imported classes (see #340)

Enhancements

Core

• JavaPackage now offers methods to retrieve the annotations of the respective package-info (see #263; thanks a lot to @rweisleder)
• ClassFileImporter.importClasspath() now respects any ImportOptions passed via withImportOption(..) (see #296; thanks a lot to @rweisleder)
• JavaMethod and JavaConstructor now have a heuristic line number instead of constant 0 (see #344; thanks a lot to @hankem)

Library

• The algorithm to detect cycles between slices has been improved from BFS to Johnson/Tarjan (see #138; thanks a lot to @torfmaster)
• Cycle detection now has a configurable limit for the max number of cycles to detect (by default 100) and a max number of violations reported (by default 20 dependencies per edge). This can be reconfigured according to the user guide (see #326)
• onionArchitecture() now supports to ignoreDependency(..) analogously to layeredArchitecture() (see #318; thanks a lot to @hankem)
• There now is a rule to forbid field injection in favor of constructor injection (see #288; thanks a lot to @rweisleder)
• There now is a rule to forbid dependencies on upper packages (see #151; thanks a lot to @qoomon for the initiative and POC)

JUnit

• @ArchIgnore, @ArchTag and @ArchTags are now usable as meta-annotations to compose custom annotations that inherit the behavior (analogous to https://junit.org/junit5/docs/current/user-guide/#writing-tests-meta-annotations; see #282; thanks a lot to @daniel-shuy)
• Upgraded dependencies junit-platform-* from 1.5.2 to 1.6.2

Further Acknowledgement

• Thanks a lot to @aaschmid for extensive work to upgrade Gradle to the current version and to @jangalinski for the original initiative and draft (see #192, #284, #306 and #345)

Bug Fixes

• Fixed java.lang.IllegalStateException: Couldn't find module modules of URI jrt:/... being thrown when trying to import JDK classes where JDK version >= 13. The path handling of JrtFileSystemProvider has been fixed according to JEP-220 with JDK 13. Unfortunately ArchUnit was dependent on the old behavior. (see #303)

Breaking Changes

• While technically a very slim chance of really "breaking" anything, the log level of some details during the class file import has been reduced from DEBUG to TRACE (field, method, access and call details, ...) (see #291)

Enhancements

Core

• Annotations and annotation parameters are now detected as dependencies. This could cause new findings when using the rules or library API. In particular JavaClass.getDirectDependencies{From/To}Self() will now also return Dependencies that originate from @FormerlyNotDetected or @Foo(someEnum = SomeEnumFormerlyNotDetected.FOO) or @Foo(bar = @Bar(type = SomeTypeFormerlyNotDetected.class)) (see #136; thanks a lot to @kosani)

Lang

• Some rule API method parameter types were invariant instead of contravariant (effectively preventing a predicate for a super type to be passed). These methods should now be fixed (see #262)
• The rules API now offers more methods to filter and assert the type of class declaration ("top level class", "nested class", "member class", "inner class", "anonymous class" and "local class") (see #207; many thanks to @rweisleder)

Library

• FreezingArchRule by default now not only ignores line numbers, but also numbers after $ which effectively makes the ViolationStore resilient against changes in compiled lambda and anonymous class names (see #248; thanks a lot to @hankem)
• LayeredArchitecture and OnionArchitecture now allow to configure optionalLayers(). In version 0.12.0 the behavior was made more strict, forbidding empty layers / parts of LayeredArchitecture and OnionArchitecture to prevent misconfiguration. This in turn unfortunately broke some valid use cases where empty / optional layers were in fact okay. In version 0.13.0 this is now completely configurable. By default it will still fail to prevent misconfiguration, but a switch of withOptionalLayers(true) or optionalLayer("Some Layer") will allow empty layers (and in turn empty parts of OnionArchitecture) (see #267 and #271; many thanks to @hankem)

JUnit

• there is now a ArchUnit JUnit 5 aggregator POM, i.e. instead of two dependencies archunit-junit5-api and archunit-junit5-engine, it is now also possible to simply add a single dependency archunit-junit5 with scope test / testCompile. Compare the user guide (see #272; thanks a lot to @eddumelendez)
• Dependency upgrades (see #292)
  • junit-platform-* from 1.5.1 to 1.5.2
  • junit4 from 4.12 to 4.13 (in case of problems with archunit-junit4 it should be possible to exclude the transitive dependency to JUnit 4.13 and replace it by a custom 4.12 one)

Further Acknowledgement

• Many thanks to @Bananeweizen for fixing spelling and grammar mistakes in Javadoc / methods

Breaking Changes

• So far ArchUnit's terminology has been a little sloppy with respect to the naming of inner and nested classes. By the JLS "inner classes" are those classes that are nested and not static. ArchUnit's API now reflects this via JavaClass.isNestedClass() versus JavaClass.isInnerClass(). Unfortunately this means that the method formerly called JavaClass.isInnerClass() will now return a different result, i.e. it will only return true, if the class is non-static. On the other hand, the method JavaClass.isNestedClass() will behave exactly like isInnerClass() did in ArchUnit 0.11.0 (see #224; thanks a lot to @rweisleder for the clarification and PR)
• JavaAccessCondition does not filter self-accesses anymore. This was confusing behavior that did not solve the issue it was originally intended for. However, this might lead to additional violations showing up (see #209)

Bug Fixes

• Fixed bug where simple name of local classes was incorrect (see #216; thanks a lot to @rweisleder)
• static modifier was missing from nested classes (see #219; thanks a lot to @rweisleder)

Enhancements

Core

• Support for Java 14 (see #230; thanks a lot to @hankem)
• JavaModifier now contains SYNTHETIC and BRIDGE allowing more introspection and filtering of synthetic members (see #243; thanks a lot to @alexfedorenchik)
• Every property in archunit.properties can now be overwritten by passing a system property. This can be valuable in CI environments, e.g. to specify the ViolationStore path for FreezingArchRule. Compare the user guide (see #252)
• A JavaClass representing an array can now be queried for its component type (see #187; thanks a lot to @alexfedorenchik)
• JavaClass now offers a classpath independent version of getMethod(..) and getConstructor(..) (see #236; thanks a lot to @rweisleder)

Lang

• Extended syntax for classes().thatAreEnums() and classes()...should().beEnums() (see #172; thanks a lot to @rweisleder)

Library

• LayeredArchitecture now also checks that no layer is empty. While originally with good intentions, the ability to define empty layers turned out to do more harm than good (see #177; thanks a lot to @mikomatic)
• LayeredArchitecture now allows layers to be defined by predicate. This allows for a way more flexible definition than simple package patterns (see #228; thanks a lot to @mikomatic)
• FreezingArchRule can now be configured to be more strict, when checking rules. In particular it is possible to forbid updates of the ViolationStore or the creation of a new ViolationStore. This can serve as a safeguard in CI environments, where a missing ViolationStore is typically a misconfiguration. Compare the user guide (see #211; thanks a lot to @hankem for reviewing and providing valuable improvements)

Enhancements

Core

• DescribedPredicate now offers a more lambda compatible factory method DescribedPredicate.describe(description, predicate) (see #188; thanks a lot to @jzheaux)
• New factory method DescribedPredicate.allElements(..) to complement DescribedPredicate.anyElementThat(..) (see https://github.com/TNG/ArchUnit/commit/b8890f447c3621cb16cb21e636b2a5397722c9ec)
• Support for JDK 13 (see #195; thanks a lot to @jqno)
• ArchUnits configuration (archunit.properties) and ignore patterns (archunit_ignore_patterns.txt) are now loaded with the ContextClassLoader instead of the ClassLoader of the respective class (see https://github.com/TNG/ArchUnit/commit/81c31f6b7ffd9c4836e1f8a0303724eb7f05ce83)

Lang

• New method classes().that().belongToAnyOf(..) to match any class or inner class of the passed classes (see #173; thanks a lot to @moboa)
• New method classes().should().haveOnlyPrivateConstructors() (see #204; thanks a lot to @sullis)
• New methods members().should().{have,notHave}FullName[Not][Matching](..) (see #205; thanks a lot to @hankem)

Library

• New FreezingArchRule to wrap any other ArchRule and change the behavior (see #181):
  • on the first run record all existing violations
  • on further runs only fail by unknown violations
  • also on further runs automatically decrease the stored violation count if existing violations are solved
  • compare the user guide
• New Architectures.onionArchitecture() API offering a predefined API for Onion or Hexagonal Architectures, compare the user guide (see #174; thanks a lot to @spanierm)

JUnit

• The JUnit 5 platform dependency has been upgraded to version 1.5.1

Further Acknowledgement

• Thanks a lot to @hankem for adjusting Spotbugs to ignore false positives with JDK 9
• Thanks a lot to @hankem for fixing incompatibilities of some tests with JDK 12
• Thanks a lot to @vincent-fuchs for improving ArchUnit's logging
• Thanks a lot to @sullis for upgrading dependencies

Bug Fixes

• Fixed JavaPackage.getPackageDependenciesFromSelf() containing the package itself if there was a dependency in the same package but not directly imported (e.g. importer.importClasses(Foo.class) where some.pkg.Foo would depend on some.pkg.Bar, which was not imported)

Enhancements

Core

• Some methods now return Collection types instead of Iterable to integrate nicer with streams

Lang

• FieldsShould now contains the negation notHaveRawTypes (see #162; thanks a lot to @asbachb)
• CodeUnitsShould now contains the negations notHaveRawParameterTypes, notHaveRawReturnType and notDeclareThrowableOfType
• The syntax now contains {methods,fields}().should().{be,notBe}{Static,Final} (see #164; thanks a lot to @hankem)

Library

• Slice now also offers dependenciesToSelf additionally to dependenciesFromSelf

Further Acknowledgement

• Thanks a lot to @hankem for reviewing and improving the user guide

Bug Fixes

• JavaPackage.PackageVisitor and JavaPackage.ClassVisitor are now public instead of package-private to be usable as public API

Breaking Changes

• The deprecated method String JavaClass.getPackage() was replaced by JavaPackage JavaClass.getPackage(). To query the package name, please use String JavaClass.getPackageName().
• The deprecated method JavaClass.getDirectDependencies() has been removed -> use JavaClass.getDirectDependenciesFromSelf() instead
• The deprecated field JavaClass.Functions.SIMPLE_NAME has been removed, please use JavaClass.Functions.GET_SIMPLE_NAME

New Deprecation

• ArchUnit does not use contractions anymore within the rules API. So far many methods were phrased like dontHave...() instead of doNotHave...(). In general this seems to be more trouble than worth it and does not read that well without an apostrophe, so all those methods were declared deprecated and have a new counter part without the contraction. A simple search & replace of dont by doNot should fix all those deprecations.
• Some methods were deprecated because they were not precise enough, if generics come into play. For example JavaClass JavaField.getType() is not precise enough, because the type of a field is something else than a JavaClass (like T someField or List<? extends T> someField). Thus all those methods have been deprecated to make room for a future extension with generics and instead got a new version explicitly stating that the "raw type" is meant. For example JavaField.getType() -> JavaField.getRawType(), JavaMethod.getParameters() -> JavaMethod.getRawParameterTypes().
• Formatters.formatLocation(JavaClass, lineNumber) was deprecated in favor of the newly introduced SourceCodeLocation.of(JavaClass, lineNumber) which will report the correct location (i.e. link for IDEs) via toString()

Enhancements

Core

• The default class resolution behavior for classes missing from the import was changed. Before by default missing classes were replaced by stubs, now by default they will be resolved from the classpath. Compare the user guide (see #111)
• JavaClass can now be queried for declared throws clauses, any Throwables declared on methods or constructors count as dependencies of a JavaClass (see #126; thanks a lot to @tngwoerleij)
• JavaClass can now be queried if it is an array (see #114; thanks a lot to @wengertj)
• The resolution of classes from the classpath will now use the context ClassLoader if set (should usually not make any difference, but allows to control the ClassLoader used by ArchUnit for class resolution)
• JavaClass now has a more sophisticated JavaPackage attached to it. It is also possible to retrieve any JavaPackage from JavaClasses. JavaPackage offers a more convenient API for dependencies between packages (see #158; thanks a lot to @goetzd for reviewing and user guide adjustment)
• For arrays JavaClass.getPackageName() now returns the package of the component type instead of empty. While empty is closer to the Java Reflection API, it is not really useful from a point of view of dependencies. Using an array of a type in a package should cause a dependency to that package (see #161)

Lang

• The rules API now provides an extensive support for checks of members / methods / fields (see #38; thanks a lot to @hankem for an extensive review and many improvements)

Library

• It is now possible to create a CompositeArchRule from several ArchRules to check multiple rules at once (see #78; thanks a lot to @bogsi17)
• The PlantUML rules API now understands more types of arrows (description on arrows, arrows from right to left, arrow colors), compare the user guide (see #135)
• New predefined rule to avoid the use of org.joda.time in favor of the java.time API (see #145; thanks a lot to @sullis)
• The slices API is now more configurable to deal with inconsistent package structures and legacy projects. It is now possible to customize the assignment of JavaClasses to Slices by a simple function JavaClass -> Identifier, compare the user guide (see #156)

JUnit

• The JUnit 5 platform dependency has been upgraded to version 1.4.0.

Further Acknowledgement

• Thanks a lot to @alanktwong for improving the CONTRIBUTING docs on how to build the project
• Thanks a lot to @wengertj for removing use of deprecated Gradle API
• Thanks a lot to @olleolleolle for replacing the PNG build badge by SVG
• Thanks a lot to @sullis for updating the Travis build to use OpenJDK 11

Bug Fixes

Fixed memory leak in combination of the newly added ArchRule.AssertionError and JUnit 4. JUnit 4 keeps references to all thrown AssertionErrors through the whole run. Since ArchRule.AssertionError kept a reference to EvaluationResult this could consume a lot of memory, if the respective results were big. This release removes ArchRule.AssertionError (introduced in version 0.9.0).

Note that this is in theory a breaking change, since it would have been possible to catch and process ArchRule.AssertionError. There does not seem to be any clean solution to this problem though, and due to the slim probability that the removal of this part of the API will in fact affect any user, the step seems justified.

If anybody should against all odds have a problem with this, feel free to open an issue and we will find a different solution.

Also ArchUnitTestEngine's engine id has been adjusted from junit-archunit to archunit to get rid of the warning JUnit 5 emits since version 1.3.0.

Enhancements

• Added Java 11 support (see #117; thanks a lot to @hankem)
• ArchUnitTestEngine's UniqueId is now archunit instead of junit-archunit to make it clear that it is not maintained by the JUnit 5 team

Bug Fixes

• Fixed a bug where classes in Jars with white spaces (like Kotlin class files could have) cause an exception during the import (see #103)

Important

The Maven coordinates for com.tngtech.archunit:archunit-junit have changed, since there is now support for JUnit 4 and JUnit 5. The new coordinates for the equivalent artifact are now

com.tngtech.archunit:archunit-junit4:0.9.0

Enhancements

Core

• archunit-ignore-patterns.txt can now contain comments (see #88; many thanks to @bedla)

• a JavaClass' directDependenciesFromSelf and directDependenciesToSelf now contain further dependencies. This affects many rules as well, like layeredArchitecture() which might now detect more violations than before. In particular dependencies now contain dependencies from

  • fields of a certain type
  • method/constructor parameters of a certain type
  • method return types

  (see #92 and #96; many thanks to @msherman32)

• the plugin mechanism activating Java >= 9 support now supports EA versions (see #93; many thanks to @jqno)

Lang

• the rule API now supports a concise way to assert properties of a single class (see #60; many thanks to @msherman32)
• the rule API can now assert that classes haveOnlyFinalFields() (see #86; many thanks to @bgalek)
• the rule API now allows to assert that there are at least / at most / exactly x classes matched by a rule (see #83; many thanks to @bedla)
• rules can now be derived from PlantUML component diagrams (compare the User Guide; see #4; many thanks to @msherman32)
• the rule API now allows to check more general for dependencies instead of just accesses (like interfaces, field types, method parameters, ...) (see #69)
• the rule API now includes several methods to restrict what classes should "only" do, i.e. classes().should().onlyDependOnClassesThat()... or onlyCallMethodsThat(..), etc. (see #84)

JUnit

• ArchUnit now offers extended JUnit 5 support (compare the User Guide; see #34)

Kotlin

• rule suits with JUnit 4 / JUnit 5 can now be written in a concise way and source locations are reported correctly (compare the User Guide; see #77)

Bug Fixes

Fixed bug where deeply nested super classes missing from the import were not resolved correctly from the classpath (see #91; many thanks to @svenackermann for reporting and debugging)

Bug Fixes

Fixed a bug where the classpath property could not be parsed on Windows when using Eclipse Neon. Former versions of ArchUnit assumed all entries would be of the form C:\some\path (which seems to be the case for most IDEs/build tools), now also entries of the form /C:/some/path can be processed (see #79)

Bug Fixes

• Fixed a bug where classes in Jars would not be imported on Windows, if Java version >= 9 and the whole classpath is imported; this only affects an import of the whole classpath with Jars, it does not affect importPackages(..), importPaths(..) or importJars(..) (see #73)

Enhancements

• When specifying a layeredArchitecture(), referring to a missing layer within onlyBeAccessedBy(..) will now throw an exception with a better error message (see #74)