Review: Add more realistic shopping example application for onion arc…

…hitecture. Adjust integration test to match example.

Issue: #174
Signed-off-by: Peter Gafert <[email protected]>

archunit-example/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/OnionArchitectureTest.java

@@ -13,14 +13,13 @@
 @RunWith(ArchUnitRunner.class)
 @AnalyzeClasses(packages = "com.tngtech.archunit.example.onionarchitecture")
 public class OnionArchitectureTest {
-    private static final String BASE_PACKAGE = "com.tngtech.archunit.example.onionarchitecture";
 
     @ArchTest
     static final ArchRule onion_architecture_is_respected = onionArchitecture()
-            .domainModel(String.format("%s.domain.model..", BASE_PACKAGE))
-            .domainService(String.format("%s.domain.service..", BASE_PACKAGE))
-            .application(String.format("%s.application..", BASE_PACKAGE))
-            .adapter("cli", String.format("%s.adapter.cli..", BASE_PACKAGE))
-            .adapter("persistence", String.format("%s.adapter.persistence..", BASE_PACKAGE))
-            .adapter("rest", String.format("%s.adapter.rest..", BASE_PACKAGE));
+            .domainModels("..domain.model..")
+            .domainServices("..domain.service..")
+            .applicationServices("..application..")
+            .adapter("cli", "..adapter.cli..")
+            .adapter("persistence", "..adapter.persistence..")
+            .adapter("rest", "..adapter.rest..");
 }

archunit-example/example-junit5/src/test/java/com/tngtech/archunit/exampletest/junit5/OnionArchitectureTest.java

@@ -10,14 +10,13 @@
 @ArchTag("example")
 @AnalyzeClasses(packages = "com.tngtech.archunit.example.onionarchitecture")
 public class OnionArchitectureTest {
-    private static final String BASE_PACKAGE = "com.tngtech.archunit.example.onionarchitecture";
 
     @ArchTest
     static final ArchRule onion_architecture_is_respected = onionArchitecture()
-            .domainModel(String.format("%s.domain.model..", BASE_PACKAGE))
-            .domainService(String.format("%s.domain.service..", BASE_PACKAGE))
-            .application(String.format("%s.application..", BASE_PACKAGE))
-            .adapter("cli", String.format("%s.adapter.cli..", BASE_PACKAGE))
-            .adapter("persistence", String.format("%s.adapter.persistence..", BASE_PACKAGE))
-            .adapter("rest", String.format("%s.adapter.rest..", BASE_PACKAGE));
+            .domainModels("..domain.model..")
+            .domainServices("..domain.service..")
+            .applicationServices("..application..")
+            .adapter("cli", "..adapter.cli..")
+            .adapter("persistence", "..adapter.persistence..")
+            .adapter("rest", "..adapter.rest..");
 }

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/cli/AdministrationCLI.java

@@ -0,0 +1,20 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.cli;
+
+import com.tngtech.archunit.example.onionarchitecture.adapter.persistence.ProductRepository;
+import com.tngtech.archunit.example.onionarchitecture.application.AdministrationPort;
+import com.tngtech.archunit.example.onionarchitecture.application.ShoppingApplication;
+
+@SuppressWarnings("unused")
+public class AdministrationCLI {
+    public static void main(String[] args) {
+        AdministrationPort port = ShoppingApplication.openAdministrationPort();
+        handle(args, port);
+    }
+
+    private static void handle(String[] args, AdministrationPort port) {
+        // violates the pairwise independence of adapters
+        ProductRepository repository = port.getInstanceOf(ProductRepository.class);
+        long count = repository.getTotalCount();
+        // parse arguments and re-configure application according to count through port
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ProductId.java

@@ -0,0 +1,20 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import java.util.UUID;
+
+@SuppressWarnings("unused")
+public class ProductId {
+    private final UUID id;
+
+    public ProductId(UUID id) {
+        if (id == null) {
+            throw new IllegalArgumentException("ID must not be null");
+        }
+        this.id = id;
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getSimpleName() + "{id=" + id + '}';
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ProductJpaRepository.java

@@ -0,0 +1,17 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import com.tngtech.archunit.example.onionarchitecture.domain.model.Product;
+import com.tngtech.archunit.example.onionarchitecture.domain.service.ProductName;
+
+@SuppressWarnings("unused")
+public class ProductJpaRepository implements ProductRepository {
+    @Override
+    public Product read(ProductId id) {
+        return new Product(id, new ProductName("would normally be read"));
+    }
+
+    @Override
+    public long getTotalCount() {
+        return 0;
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ProductRepository.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import com.tngtech.archunit.example.onionarchitecture.domain.model.Product;
+
+// Violates the architecture because Domain must be the owner of the interfaces, not the persistence adapter
+public interface ProductRepository {
+    Product read(ProductId id);
+
+    long getTotalCount();
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ShoppingCartId.java

@@ -0,0 +1,19 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import java.util.UUID;
+
+public class ShoppingCartId {
+    private final UUID id;
+
+    public ShoppingCartId(UUID id) {
+        if (id == null) {
+            throw new IllegalArgumentException("ID must not be null");
+        }
+        this.id = id;
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getSimpleName() + "{id=" + id + '}';
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ShoppingCartJpaRepository.java

@@ -0,0 +1,17 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import com.tngtech.archunit.example.onionarchitecture.domain.model.ShoppingCart;
+
+@SuppressWarnings("unused")
+public class ShoppingCartJpaRepository implements ShoppingCartRepository {
+    @Override
+    public ShoppingCart read(ShoppingCartId id) {
+        // would normally load fully initialized shopping cart
+        return new ShoppingCart(id);
+    }
+
+    @Override
+    public void save(ShoppingCart shoppingCart) {
+        // store shopping cart via JPA
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/persistence/ShoppingCartRepository.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.persistence;
+
+import com.tngtech.archunit.example.onionarchitecture.domain.model.ShoppingCart;
+
+// Violates the architecture because Domain must be the owner of the interfaces, not the persistence adapter
+public interface ShoppingCartRepository {
+    ShoppingCart read(ShoppingCartId id);
+
+    void save(ShoppingCart shoppingCart);
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/adapter/rest/ShoppingController.java

@@ -0,0 +1,22 @@
+package com.tngtech.archunit.example.onionarchitecture.adapter.rest;
+
+import java.util.UUID;
+
+import com.tngtech.archunit.example.onionarchitecture.adapter.persistence.ProductId;
+import com.tngtech.archunit.example.onionarchitecture.adapter.persistence.ShoppingCartId;
+import com.tngtech.archunit.example.onionarchitecture.domain.service.OrderQuantity;
+import com.tngtech.archunit.example.onionarchitecture.domain.service.ShoppingService;
+
+@SuppressWarnings("unused")
+public class ShoppingController {
+    private final ShoppingService shoppingService;
+
+    public ShoppingController(ShoppingService shoppingService) {
+        this.shoppingService = shoppingService;
+    }
+
+    // @POST or similar
+    public void addToShoppingCart(UUID shoppingCartId, UUID productId, int quantity) {
+        shoppingService.addToShoppingCart(new ShoppingCartId(shoppingCartId), new ProductId(productId), new OrderQuantity(quantity));
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/application/AdministrationPort.java

@@ -0,0 +1,5 @@
+package com.tngtech.archunit.example.onionarchitecture.application;
+
+public interface AdministrationPort {
+    <T> T getInstanceOf(Class<T> type);
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/application/ShoppingApplication.java

@@ -0,0 +1,16 @@
+package com.tngtech.archunit.example.onionarchitecture.application;
+
+public class ShoppingApplication {
+    public static void main(String[] args) {
+        // start the whole application / provide IOC features
+    }
+
+    public static AdministrationPort openAdministrationPort() {
+        return new AdministrationPort() {
+            @Override
+            public <T> T getInstanceOf(Class<T> type) {
+                throw new UnsupportedOperationException("Not yet implemented");
+            }
+        };
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/domain/model/OrderItem.java

@@ -0,0 +1,24 @@
+package com.tngtech.archunit.example.onionarchitecture.domain.model;
+
+import com.tngtech.archunit.example.onionarchitecture.domain.service.OrderQuantity;
+
+public class OrderItem {
+    private final Product product;
+    private final OrderQuantity quantity;
+
+    public OrderItem(Product product, OrderQuantity quantity) {
+        if (product == null) {
+            throw new IllegalArgumentException("Product must not be null");
+        }
+        if (quantity == null) {
+            throw new IllegalArgumentException("Quantity not be null");
+        }
+        this.product = product;
+        this.quantity = quantity;
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getSimpleName() + "{product=" + product + ", quantity=" + quantity + '}';
+    }
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/onionarchitecture/domain/model/PaymentMethod.java

@@ -0,0 +1,5 @@
+package com.tngtech.archunit.example.onionarchitecture.domain.model;
+
+@SuppressWarnings("WeakerAccess")
+public class PaymentMethod {
+}