Review: Restructure example project -> aspects should be separated. G…

…rouped most of the original project into subproject "layers", even if it contains some classes like ClassViolatingCodingRules. Extracted cycles and plantuml as separate aspects and integrated onion architecture. Issue: #174 Signed-off-by: Peter Gafert <[email protected]>
TNG · Jul 19, 2019 · 5873ef6 · 5873ef6
1 parent a9a5a6a
commit 5873ef6
Show file tree

Hide file tree

Showing 212 changed files with 737 additions and 772 deletions.
diff --git a/...unit-example/example-plain/src/test/resources/frozen/6f3a1e55-3673-4950-a3be-857751b3d515 b/...unit-example/example-plain/src/test/resources/frozen/6f3a1e55-3673-4950-a3be-857751b3d515
diff --git a/...unit-example/example-plain/src/test/resources/frozen/d8e3c650-e214-402f-8cfa-33a8607785d3 b/...unit-example/example-plain/src/test/resources/frozen/d8e3c650-e214-402f-8cfa-33a8607785d3
diff --git a/archunit-example/archunit-example/example-plain/src/test/resources/frozen/stored.rules b/archunit-example/archunit-example/example-plain/src/test/resources/frozen/stored.rules
diff --git a/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/CodingRulesTest.java b/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/CodingRulesTest.java
@@ -1,7 +1,8 @@
 package com.tngtech.archunit.exampletest.junit4;
 
+import java.util.logging.Logger;
+
 import com.tngtech.archunit.core.domain.JavaClasses;
-import com.tngtech.archunit.core.domain.JavaModifier;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -10,8 +11,6 @@
 import org.junit.experimental.categories.Category;
 import org.junit.runner.RunWith;
 
-import java.util.logging.Logger;
-
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.fields;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
 import static com.tngtech.archunit.library.GeneralCodingRules.ACCESS_STANDARD_STREAMS;
@@ -22,7 +21,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class CodingRulesTest {
 
     @ArchTest

diff --git a/...ple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/ControllerRulesTest.java b/...ple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/ControllerRulesTest.java
@@ -4,7 +4,7 @@
 import com.tngtech.archunit.base.PackageMatchers;
 import com.tngtech.archunit.core.domain.JavaClass;
 import com.tngtech.archunit.core.domain.JavaMember;
-import com.tngtech.archunit.example.security.Secured;
+import com.tngtech.archunit.example.layers.security.Secured;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -20,7 +20,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class ControllerRulesTest {
 
     @ArchTest

diff --git a/...nit4/src/test/java/com/tngtech/archunit/exampletest/junit4/CyclicDependencyRulesTest.java b/...nit4/src/test/java/com/tngtech/archunit/exampletest/junit4/CyclicDependencyRulesTest.java
@@ -2,8 +2,8 @@
 
 import com.tngtech.archunit.base.DescribedPredicate;
 import com.tngtech.archunit.core.domain.JavaClass;
-import com.tngtech.archunit.example.cycle.complexcycles.slice1.SliceOneCallingConstructorInSliceTwoAndMethodInSliceThree;
-import com.tngtech.archunit.example.cycle.complexcycles.slice3.ClassCallingConstructorInSliceFive;
+import com.tngtech.archunit.example.cycles.complexcycles.slice1.SliceOneCallingConstructorInSliceTwoAndMethodInSliceThree;
+import com.tngtech.archunit.example.cycles.complexcycles.slice3.ClassCallingConstructorInSliceFive;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -18,7 +18,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example.cycle")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.cycles")
 public class CyclicDependencyRulesTest {
 
     @ArchTest

diff --git a/...le/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/DaoRulesTest.java b/...le/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/DaoRulesTest.java
@@ -18,7 +18,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class DaoRulesTest {
     @ArchTest
     public static final ArchRule DAOs_must_reside_in_a_dao_package =

diff --git a/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/FrozenRulesTest.java b/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/FrozenRulesTest.java
@@ -28,7 +28,7 @@
  */
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class FrozenRulesTest {
 
     @ArchTest

diff --git a/...mple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/InterfaceRulesTest.java b/...mple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/InterfaceRulesTest.java
@@ -5,9 +5,9 @@
 
 import com.tngtech.archunit.core.importer.Location;
 import com.tngtech.archunit.core.importer.Locations;
-import com.tngtech.archunit.example.SomeBusinessInterface;
-import com.tngtech.archunit.example.persistence.first.dao.SomeDao;
-import com.tngtech.archunit.example.service.impl.SomeInterfacePlacedInTheWrongPackage;
+import com.tngtech.archunit.example.layers.SomeBusinessInterface;
+import com.tngtech.archunit.example.layers.persistence.first.dao.SomeDao;
+import com.tngtech.archunit.example.layers.service.impl.SomeInterfacePlacedInTheWrongPackage;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;

diff --git a/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/LayerDependencyRulesTest.java b/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/LayerDependencyRulesTest.java
@@ -12,7 +12,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class LayerDependencyRulesTest {
 
     // 'access' catches only violations by real accesses, i.e. accessing a field, calling a method; compare 'dependOn' further down

diff --git a/...junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/LayeredArchitectureTest.java b/...junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/LayeredArchitectureTest.java
@@ -1,7 +1,7 @@
 package com.tngtech.archunit.exampletest.junit4;
 
-import com.tngtech.archunit.example.SomeMediator;
-import com.tngtech.archunit.example.service.ServiceViolatingLayerRules;
+import com.tngtech.archunit.example.layers.SomeMediator;
+import com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -13,14 +13,14 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class LayeredArchitectureTest {
     @ArchTest
     public static final ArchRule layer_dependencies_are_respected = layeredArchitecture()
 
-            .layer("Controllers").definedBy("com.tngtech.archunit.example.controller..")
-            .layer("Services").definedBy("com.tngtech.archunit.example.service..")
-            .layer("Persistence").definedBy("com.tngtech.archunit.example.persistence..")
+            .layer("Controllers").definedBy("com.tngtech.archunit.example.layers.controller..")
+            .layer("Services").definedBy("com.tngtech.archunit.example.layers.service..")
+            .layer("Persistence").definedBy("com.tngtech.archunit.example.layers.persistence..")
 
             .whereLayer("Controllers").mayNotBeAccessedByAnyLayer()
             .whereLayer("Services").mayOnlyBeAccessedByLayers("Controllers")
@@ -29,9 +29,9 @@ public class LayeredArchitectureTest {
     @ArchTest
     public static final ArchRule layer_dependencies_are_respected_with_exception = layeredArchitecture()
 
-            .layer("Controllers").definedBy("com.tngtech.archunit.example.controller..")
-            .layer("Services").definedBy("com.tngtech.archunit.example.service..")
-            .layer("Persistence").definedBy("com.tngtech.archunit.example.persistence..")
+            .layer("Controllers").definedBy("com.tngtech.archunit.example.layers.controller..")
+            .layer("Services").definedBy("com.tngtech.archunit.example.layers.service..")
+            .layer("Persistence").definedBy("com.tngtech.archunit.example.layers.persistence..")
 
             .whereLayer("Controllers").mayNotBeAccessedByAnyLayer()
             .whereLayer("Services").mayOnlyBeAccessedByLayers("Controllers")

diff --git a/...ple/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/MethodsTest.java b/...ple/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/MethodsTest.java
@@ -1,7 +1,7 @@
 package com.tngtech.archunit.exampletest.junit4;
 
-import com.tngtech.archunit.example.anticorruption.WrappedResult;
-import com.tngtech.archunit.example.security.Secured;
+import com.tngtech.archunit.example.layers.anticorruption.WrappedResult;
+import com.tngtech.archunit.example.layers.security.Secured;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -14,7 +14,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class MethodsTest {
 
     @ArchTest

diff --git a/...le-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/NamingConventionTest.java b/...le-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/NamingConventionTest.java
@@ -1,8 +1,8 @@
 package com.tngtech.archunit.exampletest.junit4;
 
-import com.tngtech.archunit.example.AbstractController;
-import com.tngtech.archunit.example.MyController;
-import com.tngtech.archunit.example.MyService;
+import com.tngtech.archunit.example.layers.AbstractController;
+import com.tngtech.archunit.example.layers.MyController;
+import com.tngtech.archunit.example.layers.MyService;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -14,7 +14,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class NamingConventionTest {
 
     @ArchTest

diff --git a/...e-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/OnionArchitectureTest.java b/...e-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/OnionArchitectureTest.java
@@ -11,9 +11,9 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.onionarchitecture.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.onionarchitecture")
 public class OnionArchitectureTest {
-    private static final String BASE_PACKAGE = "com.tngtech.archunit.onionarchitecture.example";
+    private static final String BASE_PACKAGE = "com.tngtech.archunit.example.onionarchitecture";
 
     @ArchTest
     static final ArchRule onion_architecture_is_respected = onionArchitecture()

diff --git a/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/PlantUmlArchitectureTest.java b/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/PlantUmlArchitectureTest.java
@@ -3,9 +3,9 @@
 import java.net.URL;
 
 import com.tngtech.archunit.base.PackageMatchers;
-import com.tngtech.archunit.example.shopping.catalog.ProductCatalog;
-import com.tngtech.archunit.example.shopping.order.Order;
-import com.tngtech.archunit.example.shopping.product.Product;
+import com.tngtech.archunit.example.plantuml.catalog.ProductCatalog;
+import com.tngtech.archunit.example.plantuml.order.Order;
+import com.tngtech.archunit.example.plantuml.product.Product;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -24,7 +24,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example.shopping")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.plantuml")
 public class PlantUmlArchitectureTest {
     private static final URL plantUmlDiagram = PlantUmlArchitectureTest.class.getResource("shopping_example.puml");
 

diff --git a/.../tngtech/archunit/exampletest/junit4/RestrictNumberOfClassesWithACertainPropertyTest.java b/.../tngtech/archunit/exampletest/junit4/RestrictNumberOfClassesWithACertainPropertyTest.java
@@ -1,7 +1,7 @@
 package com.tngtech.archunit.exampletest.junit4;
 
-import com.tngtech.archunit.example.SomeBusinessInterface;
-import com.tngtech.archunit.example.SomeOtherBusinessInterface;
+import com.tngtech.archunit.example.layers.SomeBusinessInterface;
+import com.tngtech.archunit.example.layers.SomeOtherBusinessInterface;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -14,7 +14,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class RestrictNumberOfClassesWithACertainPropertyTest {
     @ArchTest
     public static final ArchRule no_new_classes_should_implement_SomeBusinessInterface =

diff --git a/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/RuleLibraryTest.java b/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/RuleLibraryTest.java
@@ -9,7 +9,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class RuleLibraryTest {
     @ArchTest
     public static final ArchRules LIBRARY = ArchRules.in(RuleSetsTest.class);

diff --git a/...le/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/RuleSetsTest.java b/...le/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/RuleSetsTest.java
@@ -9,11 +9,11 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class RuleSetsTest {
     @ArchTest
     private final ArchRules CODING_RULES = ArchRules.in(CodingRulesTest.class);
 
     @ArchTest
-    private final ArchRules CYCLIC_DEPENDENCY_RULES = ArchRules.in(CyclicDependencyRulesTest.class);
+    private final ArchRules NAMING_CONVENTION_RULES = ArchRules.in(NamingConventionTest.class);
 }
diff --git a/...le-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SessionBeanRulesTest.java b/...le-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SessionBeanRulesTest.java
@@ -35,7 +35,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class SessionBeanRulesTest {
 
     @ArchTest

diff --git a/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SingleClassTest.java b/...example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SingleClassTest.java
@@ -1,9 +1,9 @@
 package com.tngtech.archunit.exampletest.junit4;
 
-import com.tngtech.archunit.example.SomeOtherBusinessInterface;
-import com.tngtech.archunit.example.core.CoreSatellite;
-import com.tngtech.archunit.example.core.HighSecurity;
-import com.tngtech.archunit.example.core.VeryCentralCore;
+import com.tngtech.archunit.example.layers.SomeOtherBusinessInterface;
+import com.tngtech.archunit.example.layers.core.CoreSatellite;
+import com.tngtech.archunit.example.layers.core.HighSecurity;
+import com.tngtech.archunit.example.layers.core.VeryCentralCore;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -17,7 +17,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class SingleClassTest {
 
     @ArchTest

diff --git a/...ple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SlicesIsolationTest.java b/...ple-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SlicesIsolationTest.java
@@ -2,8 +2,8 @@
 
 import com.tngtech.archunit.base.DescribedPredicate;
 import com.tngtech.archunit.core.domain.JavaClass;
-import com.tngtech.archunit.example.controller.one.UseCaseOneTwoController;
-import com.tngtech.archunit.example.controller.two.UseCaseTwoController;
+import com.tngtech.archunit.example.layers.controller.one.UseCaseOneTwoController;
+import com.tngtech.archunit.example.layers.controller.two.UseCaseTwoController;
 import com.tngtech.archunit.junit.AnalyzeClasses;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.junit.ArchUnitRunner;
@@ -17,7 +17,7 @@
 
 @Category(Example.class)
 @RunWith(ArchUnitRunner.class)
-@AnalyzeClasses(packages = "com.tngtech.archunit.example")
+@AnalyzeClasses(packages = "com.tngtech.archunit.example.layers")
 public class SlicesIsolationTest {
     @ArchTest
     public static final ArchRule controllers_should_only_use_their_own_slice =