add example test for plant uml

Signed-off-by: Marco Studer <marco.studer@bison-group.com>

Author: studix

ExampleTest/ExampleArchUnitTestPuml.cs

@@ -0,0 +1,27 @@
+using ArchUnitNET.Domain;
+using ArchUnitNET.Fluent;
+using ArchUnitNET.Loader;
+using ArchUnitNET.xUnit;
+using ExampleTest.PlantUml.Addresses;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Xunit;
+using static ArchUnitNET.Fluent.ArchRuleDefinition;
+
+namespace ExampleTest
+{
+    public class ExampleArchUnitTestPuml
+    {
+        private static readonly Architecture Architecture = new ArchLoader().LoadNamespacesWithinAssembly(typeof(Address).Assembly, "ExampleTest.PlantUml").Build();
+
+        [Fact]
+        public void ClassesShouldAdhereToShoppingExampleConsideringOnlyDependenciesInDiagram()
+        {
+            var filename = "./Resources/shopping_example.puml";
+
+            IArchRule adhereToPlantUmlDiagram = Types().Should().AdhereToPlantUmlDiagram(filename);
+            adhereToPlantUmlDiagram.Check(Architecture);
+        }
+    }
+}

ExampleTest/ExampleTest.csproj

@@ -16,4 +16,10 @@
       <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" />
     </ItemGroup>
 
+    <ItemGroup>
+      <None Update="Resources\shopping_example.puml">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      </None>
+    </ItemGroup>
+
 </Project>

ExampleTest/PlantUml/Addresses/Address.cs

@@ -0,0 +1,14 @@
+using ExampleTest.PlantUml.Catalog;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Addresses
+{
+    public class Address
+    {
+        #pragma warning disable CS0169
+        private ProductCatalog productCatalog;
+        #pragma warning restore CS0169
+    }
+}

ExampleTest/PlantUml/Catalog/ProductCatalog.cs

@@ -0,0 +1,23 @@
+using ExampleTest.PlantUml.Orders;
+using ExampleTest.PlantUml.Products;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Catalog
+{
+    public class ProductCatalog
+    {
+        private List<Product> _allProducts = new List<Product>();
+
+        internal void GonnaDoSomethingIllegalWithOrder()
+        {
+            Order order = new Order();
+            foreach (Product product in _allProducts)
+            {
+                product.Register();
+            }
+            order.AddProducts(_allProducts);
+        }
+    }
+}

ExampleTest/PlantUml/Customers/Customer.cs

@@ -0,0 +1,20 @@
+using ExampleTest.PlantUml.Addresses;
+using ExampleTest.PlantUml.Orders;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Customers
+{
+    public class Customer
+    {
+        public Address Address { get; set; }
+
+        internal void AddOrder(Order order)
+        {
+            // simply having such a parameter violates the specified UML diagram
+        }
+
+    }
+
+}

ExampleTest/PlantUml/Importer/ProductImport.cs

@@ -0,0 +1,30 @@
+using ExampleTest.PlantUml.Catalog;
+using ExampleTest.PlantUml.Customers;
+using ExampleTest.PlantUml.Xml.Processor;
+using ExampleTest.PlantUml.Xml.Types;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Importer
+{
+    public class ProductImport
+    {
+        public ProductCatalog productCatalog;
+        public XmlTypes xmlType;
+        public XmlProcessor xmlProcessor;
+
+        public Customer Customer
+        {
+            get
+            {
+                return new Customer(); // violates diagram -> product import may not directly know Customer
+            }
+        }
+
+        ProductCatalog Parse(byte[] xml)
+        {
+            return new ProductCatalog();
+        }
+    }
+}

ExampleTest/PlantUml/Orders/Order.cs

@@ -0,0 +1,33 @@
+using ExampleTest.PlantUml.Addresses;
+using ExampleTest.PlantUml.Customers;
+using ExampleTest.PlantUml.Products;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Orders
+{
+    public class Order
+    {
+        public Customer _customer;
+        private List<Product> _products = new List<Product>();
+
+        public void AddProducts(IList<Product> products)
+        {
+            _products.AddRange(products);
+        }
+
+        internal void Report()
+        {
+            Report(_customer.Address);
+            foreach (Product product in _products)
+            {
+                product.Report();
+            }
+        }
+
+        private void Report(Address address)
+        {
+        }
+    }
+}

ExampleTest/PlantUml/Products/Product.cs

@@ -0,0 +1,31 @@
+using ExampleTest.PlantUml.Customers;
+using ExampleTest.PlantUml.Orders;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Products
+{
+    public class Product
+    {
+        public Customer _customer;
+
+        internal Order Order
+        {
+            get
+            {
+                return null; // the return type violates the specified UML diagram
+            }
+        }
+
+
+        public void Register()
+        {
+        }
+
+        public void Report()
+        {
+        }
+    }
+
+}

ExampleTest/PlantUml/Xml/Processor/XmlProcessor.cs

@@ -0,0 +1,10 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ExampleTest.PlantUml.Xml.Processor
+{
+    public class XmlProcessor
+    {
+    }
+}

…eTest/ExampleArchitectureTestPlantUml.cs …ampleTest/PlantUml/Xml/Types/XmlTypes.csExampleTest/ExampleArchitectureTestPlantUml.cs renamed to ExampleTest/PlantUml/Xml/Types/XmlTypes.cs ExampleTest/ExampleArchitectureTestPlantUml.cs renamed to ExampleTest/PlantUml/Xml/Types/XmlTypes.cs

@@ -2,9 +2,9 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace ExampleTest
+namespace ExampleTest.PlantUml.Xml.Types
 {
-    public class ExampleArchitectureTestPlantUml
+    public class XmlTypes
     {
     }
 }