Add documentation and minimal examples for differences between testing in Debug mode and testing in Release mode.

GeorgKreuzmayr · GeorgKreuzmayr · commit 7c333e591e17 · 2021-01-28T17:57:03.000+01:00
Signed-off-by: GeorgKreuzmayr &lt;g.kreuzmayr@gmail.com&gt;
diff --git a/ExampleTest/LimitationsOnReleaseTest.cs b/ExampleTest/LimitationsOnReleaseTest.cs
@@ -0,0 +1,77 @@
+//  Copyright 2019 Florian Gather <florian.gather@tngtech.com>
+// 	Copyright 2019 Fritz Brandhuber <fritz.brandhuber@tngtech.com>
+// 	Copyright 2020 Pavel Fischer <rubbiroid@gmail.com>
+// 
+// 	SPDX-License-Identifier: Apache-2.0
+// 
+
+using System.Linq;
+using ArchUnitNET.Domain;
+using ArchUnitNET.Domain.Extensions;
+using ArchUnitNET.Loader;
+using Xunit;
+
+namespace ExampleTest
+{
+    public class LimitationsOnReleaseTest
+    {
+        private static readonly Architecture Architecture =
+            new ArchLoader().LoadAssembly(typeof(LimitationsOnReleaseTest).Assembly).Build();
+
+        private static IType _edgeCaseDataClass = Architecture.GetClassOfType(typeof(EdgeCaseData));
+        private static IType _missingDependencyClass = Architecture.GetClassOfType(typeof(MissingDependencyClass));
+
+        [Fact]
+        public void CastTest()
+        {
+            var typeDependencies = _edgeCaseDataClass.Members
+                .Where(t => t.FullName.Contains(nameof(EdgeCaseData.MethodWithCastDependency))).ToList().First()
+                .GetTypeDependencies().ToList();
+            
+            Assert.Contains(_missingDependencyClass, typeDependencies);
+        }
+        
+        [Fact]
+        public void NullVariableTest()
+        {
+            var methodWithCastDependencyDependencies = _edgeCaseDataClass.Members
+                .Where(t => t.FullName.Contains(nameof(EdgeCaseData.MethodWithNullVariable))).ToList().First()
+                .GetTypeDependencies().ToList();
+            
+            Assert.Contains(_missingDependencyClass, methodWithCastDependencyDependencies);
+        }
+        
+        [Fact]
+        public void TypeOfDependencyTest()
+        {
+            var methodWithTypeOfDependencyDependencies = _edgeCaseDataClass.Members
+                .Where(t => t.FullName.Contains(nameof(EdgeCaseData.MethodWithTypeOfDependency))).ToList().First()
+                .GetTypeDependencies().ToList();
+
+            Assert.Contains(_missingDependencyClass, methodWithTypeOfDependencyDependencies);
+        }
+    }
+
+    internal class EdgeCaseData
+    {
+        public void MethodWithTypeOfDependency()
+        {
+            var a = typeof(MissingDependencyClass);
+        }
+        public void MethodWithCastDependency()
+        {
+            var a = (MissingDependencyClass) new SubClass();
+        }
+
+        public void MethodWithNullVariable()
+        {
+            MissingDependencyClass a = null;
+        }
+    }
+    internal class MissingDependencyClass
+    {
+    }
+    internal class SubClass : MissingDependencyClass
+    {
+    }
+}
diff --git a/documentation/docs/api.md b/documentation/docs/api.md
@@ -36,4 +36,5 @@ Here you can find the full API of ArchUnitNET.
 
 ## Limitations
 
-* [Constant Fields] (limitations/constant_fields.md)
+* [Debug Artifacts](limitations/debug_artifacts.md)
+* [Constant Fields](limitations/constant_fields.md)
diff --git a/documentation/docs/limitations/debug_artifacts.md b/documentation/docs/limitations/debug_artifacts.md
@@ -0,0 +1,11 @@
+##Debug Artifacts
+ArchUnitNET gathers information about the architecture from analyzing 
+binaries, therefore running tests with the Release option (`dotnet test -c Release`) instead of the Debug
+option (`dotnet test -c Debug`) can lead to not finding dependencies you normally would expect to find. 
+The edge cases we so far found are not initializing a local variable, casting an object and using
+the typeof() statement. A minimal example for each edge case can be found [here](https://github.com/TNG/ArchUnitNET/blob/master/ExampleTest/LimitationsOnReleaseTest.cs).
+
+
+If you come across another edge case, where executing tests in Debug mode leads to other results than executing 
+tests in Release mode, let us know via a [github issue](https://github.com/TNG/ArchUnitNET/issues).
+ 
