Merge pull request #36 from messerli-informatik-ag/excluded-types

Add attribute for excluding specific types

Test.Utility.Test/TypesThatNeedToBeImplementedInAssemblyRetrieverTest.cs

@@ -54,6 +54,8 @@ public void ThrowsWhenAssemblyIsNotFound()
 
         [Theory]
         [TypesThatNeedToBeImplementedInAssemblyData(TestAssemblyName)]
+        [ExcludedTypes(typeof(IInterfaceWithMethod), typeof(ImplementationFactory))]
+        [ExcludedTypes(typeof(AbstractClassWithProperty))]
         public void AttributeSmokeTest(Type type)
         {
             Assert.Contains(type, TypesThatNeedToBeImplementedInAssembly);

Test.Utility/ExcludedTypesAttribute.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Collections.Generic;
+
+namespace Messerli.Test.Utility
+{
+    /// <summary>
+    /// Blacklists a hardcoded list of types. Used together with <see cref="TypesThatNeedToBeImplementedInAssemblyDataAttribute"/>.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
+    public class ExcludedTypesAttribute : Attribute
+    {
+        public ExcludedTypesAttribute(params Type[] types)
+        {
+            Types = types;
+        }
+
+        public IEnumerable<Type> Types { get; }
+    }
+}

Test.Utility/Test.Utility.csproj

@@ -10,7 +10,7 @@
     </PropertyGroup>
     <PropertyGroup>
         <PackageId>Messerli.Test.Utility</PackageId>
-        <Version>0.7.2</Version>
+        <Version>0.7.3</Version>
         <Description>Class library to simplify test-setups.</Description>
         <RepositoryUrl>https://github.com/messerli-informatik-ag/test-utility</RepositoryUrl>
         <RepositoryType>git</RepositoryType>

Test.Utility/TypesThatNeedToBeImplementedInAssemblyDataAttribute.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 using Xunit.Sdk;
@@ -8,6 +9,7 @@ namespace Messerli.Test.Utility
     /// <summary>
     /// <para>
     ///     Provides all types that need to be implemented in an assembly as theory data.
+    ///     You can use <see cref="ExcludedTypesAttribute" /> to exclude types.
     /// </para>
     /// <para>
     ///     The following types need to be implemented (excluding generic types):
@@ -47,8 +49,20 @@ public TypesThatNeedToBeImplementedInAssemblyDataAttribute(string assemblyName)
         }
 
         public override IEnumerable<object[]> GetData(MethodInfo testMethod)
-            => TypesThatNeedToBeImplementedInAssemblyRetriever
+        {
+            var excludedTypes = CollectExcludedTypes(testMethod);
+            return TypesThatNeedToBeImplementedInAssemblyRetriever
                 .GetTypesThatNeedToBeImplementedInAssembly(_assemblyName)
+                .Where(type => !excludedTypes.Contains(type))
                 .Select(type => new object[] { type });
+        }
+
+        private static ISet<Type> CollectExcludedTypes(MethodInfo testMethod)
+        {
+            var types = testMethod
+                .GetCustomAttributes<ExcludedTypesAttribute>()
+                .SelectMany(attr => attr.Types);
+            return new HashSet<Type>(types);
+        }
     }
 }

changelog.md

@@ -58,3 +58,6 @@ Rerelease of 0.6.0 with fixed nuget package.
 
 ## 0.7.2
 - Add extension method `GetRegisteredTypes` on `IComponentContext` to retrieve all registered types.
+
+## 0.7.3
+- Allow blacklisting of types on `TypesThatNeedToBeImplementedInAssemblyData` attribute using a new attribute: `ExcludedTypes`.

global.json

@@ -1,4 +1,7 @@
 {
+    "sdk": {
+        "version": "3.1.201"
+    },
     "msbuild-sdks": {
         "Microsoft.Build.CentralPackageVersions": "2.0.52"
     }