Added another convention test which requires items to be filtered

Jake Ginnivan · Jake Ginnivan · commit 7dca6e8e0018 · 2013-07-26T17:08:46.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -11,4 +11,7 @@ _ReSharper.*
 *.suo
 *.crunchproject.local.xml
 *.crunchsolution.local.xml
-ConventionTests*.nupkg
+ConventionTests*.nupkg
+_NCrunch*
+*.received.txt
+*.orig
diff --git a/TestAssembly/ClassWithNoDefaultCtor.cs b/TestAssembly/ClassWithNoDefaultCtor.cs
@@ -0,0 +1,8 @@
+﻿namespace TestAssembly
+{
+    public class ClassWithNoDefaultCtor
+    {
+        // ReSharper disable once UnusedParameter.Local
+        public ClassWithNoDefaultCtor(string foo) { }
+    }
+}
diff --git a/TestAssembly/ClassWithNonVirtualMethod.cs b/TestAssembly/ClassWithNonVirtualMethod.cs
@@ -1,10 +1,8 @@
-﻿namespace TestAssembly
-{
-    public class ClassWithNonVirtualMethod
-    {
-        public string NonVirtual()
-        {
-            return null;
-        }
-    }
-}
+﻿namespace TestAssembly
+{
+    public class SampleDomainClass
+    {
+        public void TestNonVirtual() { }
+        public virtual void Virtual() { } 
+    }
+}
diff --git a/TestAssembly/ClassWithPrivateDefaultCtor.cs b/TestAssembly/ClassWithPrivateDefaultCtor.cs
@@ -0,0 +1,7 @@
+﻿namespace TestAssembly
+{
+    public class ClassWithPrivateDefaultCtor
+    {
+        private ClassWithPrivateDefaultCtor() { }
+    }
+}
diff --git a/TestAssembly/ClassWithProtectedDefaultCtor.cs b/TestAssembly/ClassWithProtectedDefaultCtor.cs
@@ -0,0 +1,7 @@
+﻿namespace TestAssembly
+{
+    public class ClassWithProtectedDefaultCtor
+    {
+        protected ClassWithProtectedDefaultCtor(){}
+    }
+}
diff --git a/TestAssembly/ClassWithPublicDefaultCtor.cs b/TestAssembly/ClassWithPublicDefaultCtor.cs
@@ -0,0 +1,6 @@
+﻿namespace TestAssembly
+{
+    public class ClassWithPublicDefaultCtor
+    {
+    }
+}
diff --git a/TestAssembly/TestAssembly.csproj b/TestAssembly/TestAssembly.csproj
@@ -39,7 +39,11 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="ClassWithNoDefaultCtor.cs" />
     <Compile Include="ClassWithNonVirtualMethod.cs" />
+    <Compile Include="ClassWithPrivateDefaultCtor.cs" />
+    <Compile Include="ClassWithProtectedDefaultCtor.cs" />
+    <Compile Include="ClassWithPublicDefaultCtor.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.ReferencingBinObj.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.ReferencingBinObj.approved.txt
@@ -1,2 +1,3 @@
 ﻿Convention has failing items
-	TestStack.ConventionTests.Tests is referencing assemblies in the bin or obj folders, bin\Debug\ApprovalTests.dll
+	TestStack.ConventionTests.Tests is referencing assemblies in the bin or obj folders:
+	bin\Debug\ApprovalTests.dll
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.ScriptsNotEmbeddedResources.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.ScriptsNotEmbeddedResources.approved.txt
@@ -0,0 +1,3 @@
+﻿Convention has failing items
+	TestStack.ConventionTests.Tests has the following files which should be embedded resources:
+	Scripts\Script2.sql which currently has a build action of 'None'
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.ScriptsNotEmbeddedResources.approved.txt.orig b/TestStack.ConventionTests.Tests/ProjectBasedConventions.ScriptsNotEmbeddedResources.approved.txt.orig
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.Test.received.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.Test.received.txt
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.cs b/TestStack.ConventionTests.Tests/ProjectBasedConventions.cs
@@ -28,5 +28,21 @@ public void ReferencingBinObj()
                 Convention.Is(convention, new[] { typeof(ProjectBasedConventions).Assembly }));
             Approvals.Verify(exception.Message);
         }
+
+        [Test]
+        public void ScriptsNotEmbeddedResources()
+        {
+            var projectProvider = Substitute.For<IProjectProvider>();
+            var projectLocator = Substitute.For<IProjectLocator>();
+            projectProvider
+                .LoadProjectDocument(Arg.Any<string>())
+                .Returns(XDocument.Parse(Resources.ProjectFileWithInvalidSqlScriptFile));
+
+            var convention = new FilesAreEmbeddedResources(projectLocator, projectProvider);
+
+            var exception = Assert.Throws<ConventionFailedException>(() =>
+                Convention.Is(convention, new[] { typeof(ProjectBasedConventions).Assembly }, i=>i.EndsWith(".sql")));
+            Approvals.Verify(exception.Message);
+        }
     }
 }
diff --git a/TestStack.ConventionTests.Tests/Properties/Resources.Designer.cs b/TestStack.ConventionTests.Tests/Properties/Resources.Designer.cs
diff --git a/TestStack.ConventionTests.Tests/Properties/Resources.resx b/TestStack.ConventionTests.Tests/Properties/Resources.resx
@@ -121,4 +121,7 @@
   <data name="ProjectFileWithBinReference" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Resources\ProjectFileWithBinReference.txt;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Windows-1252</value>
   </data>
+  <data name="ProjectFileWithInvalidSqlScriptFile" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\Resources\ProjectFileWithInvalidSqlScriptFile.txt;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Windows-1252</value>
+  </data>
 </root>
diff --git a/TestStack.ConventionTests.Tests/Resources/ProjectFileWithBinReference.txt b/TestStack.ConventionTests.Tests/Resources/ProjectFileWithBinReference.txt
@@ -92,11 +92,11 @@
     <None Include="packages.config" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
-       Other similar extension points exist, see Microsoft.Common.targets.
-  <Target Name="BeforeBuild">
-  </Target>
-  <Target Name="AfterBuild">
-  </Target>
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
   -->
 </Project>
diff --git a/TestStack.ConventionTests.Tests/Resources/ProjectFileWithInvalidSqlScriptFile.txt b/TestStack.ConventionTests.Tests/Resources/ProjectFileWithInvalidSqlScriptFile.txt
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <None Include="Scripts\Script2.sql" />
+  </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="Scripts\Script1.sql" />
+  </ItemGroup>
+</Project>
diff --git a/TestStack.ConventionTests.Tests/TestStack.ConventionTests.Tests.csproj b/TestStack.ConventionTests.Tests/TestStack.ConventionTests.Tests.csproj
@@ -82,6 +82,9 @@
   <ItemGroup>
     <None Include="Resources\ProjectFileWithBinReference.txt" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="Resources\ProjectFileWithInvalidSqlScriptFile.txt" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.Test.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.Test.approved.txt
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt
@@ -0,0 +1,3 @@
+﻿Convention has failing items
+	TestAssembly.ClassWithNoDefaultCtor does not have a default constructor
+	TestAssembly.ClassWithPrivateDefaultCtor does not have a default constructor
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt.orig b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt.orig
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt
@@ -0,0 +1,3 @@
+﻿Convention has failing items
+	TestAssembly.SampleDomainClass has non virtual method(s):
+	TestNonVirtual
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.cs b/TestStack.ConventionTests.Tests/TypeBasedConventions.cs
@@ -1,5 +1,6 @@
 ﻿namespace TestStack.ConventionTests.Tests
 {
+    using System;
     using ApprovalTests;
     using ApprovalTests.Reporters;
     using NUnit.Framework;
@@ -10,12 +11,25 @@
     [UseReporter(typeof(DiffReporter))]
     public class TypeBasedConventions
     {
+        readonly Type[] itemsToVerify;
+
+        public TypeBasedConventions()
+        {
+            itemsToVerify = typeof(SampleDomainClass).Assembly.GetTypes();
+        }
+
         [Test]
-        public void Test()
+        public void all_methods_are_virtual()
         {
-            var types = typeof(ClassWithNonVirtualMethod).Assembly.GetTypes();
+            var exception = Assert.Throws<ConventionFailedException>(() => Convention.Is<AllMethodsAreVirtual>(itemsToVerify));
 
-            var exception = Assert.Throws<ConventionFailedException>(() => Convention.Is<AllMethodsAreVirtual>(types));
+            Approvals.Verify(exception.Message);
+        }
+
+        [Test]
+        public void all_classes_have_default_constructor()
+        {
+            var exception = Assert.Throws<ConventionFailedException>(() => Convention.Is<AllClassesHaveDefaultConstructor>(itemsToVerify));
 
             Approvals.Verify(exception.Message);
         }
diff --git a/TestStack.ConventionTests/Convention.cs b/TestStack.ConventionTests/Convention.cs
@@ -12,16 +12,44 @@ public static class Convention
         {
             Is(new T(), itemsToVerify);
         }
+        public static void Is<T, T2>(IEnumerable<T2> itemsToVerify, Func<string, bool> filter)
+            where T : ConventionData<T2>, IRuntimeFilter<string>, new()
+        {
+            Is(new T(), itemsToVerify);
+        }
+        public static void Is<T, T2, TItem>(IEnumerable<T2> itemsToVerify, Func<TItem, bool> filter) 
+            where T : ConventionData<T2>, IRuntimeFilter<TItem>, new()
+        {
+            Is(new T(), itemsToVerify);
+        }
 
+        //Item.Is<ConventionData<Type>>
         public static void Is<T>(IEnumerable<Type> itemsToVerify) where T : ConventionData<Type>, new()
         {
             Is(new T(), itemsToVerify);
         }
+        public static void Is<T>(IEnumerable<Type> itemsToVerify, Func<string, bool> filter) where T : ConventionData<Type>, IRuntimeFilter<string>, new()
+        {
+            Is(new T(), itemsToVerify, filter);
+        }
+        public static void Is<T, TItem>(IEnumerable<Type> itemsToVerify, Func<TItem, bool> filter) where T : ConventionData<Type>, IRuntimeFilter<TItem>, new()
+        {
+            Is(new T(), itemsToVerify, filter);
+        }
 
+        //Item.Is<ConventionData<Assembly>>
         public static void Is<T>(IEnumerable<Assembly> itemsToVerify) where T : ConventionData<Assembly>, new()
         {
             Is(new T(), itemsToVerify);
         }
+        public static void Is<T>(IEnumerable<Assembly> itemsToVerify, Func<string, bool> filter) where T : ConventionData<Assembly>, IRuntimeFilter<string>, new()
+        {
+            Is(new T(), itemsToVerify, filter);
+        }
+        public static void Is<T, TItem>(IEnumerable<Assembly> itemsToVerify, Func<TItem, bool> filter) where T : ConventionData<Assembly>, IRuntimeFilter<TItem>, new()
+        {
+            Is(new T(), itemsToVerify, filter);
+        }
 
         public static void Is<T>(ConventionData<T> convention, IEnumerable<T> itemsToVerify)
         {
@@ -30,6 +58,20 @@ public static void Is<T>(ConventionData<T> convention, IEnumerable<T> itemsToVer
                 throw new ConventionFailedException(results);
         }
 
+        public static void Is<TConvention, T>(TConvention convention, IEnumerable<T> itemsToVerify, Func<string, bool> itemFilter)
+            where TConvention : ConventionData<T>, IRuntimeFilter<string>
+        {
+            Is<TConvention, T, string>(convention, itemsToVerify, itemFilter);
+        }
+
+        public static void Is<TConvention, T, TItem>(TConvention convention, IEnumerable<T> itemsToVerify, Func<TItem, bool> itemFilter)
+            where TConvention : ConventionData<T>, IRuntimeFilter<TItem>
+        {
+            var results = Result(convention, itemsToVerify, itemFilter);
+            if (!string.IsNullOrEmpty(results))
+                throw new ConventionFailedException(results);
+        }
+
         public static string Result<T>(ConventionData<T> convention, IEnumerable<T> itemsToVerify)
         {
             var message = new StringBuilder();
@@ -45,5 +87,12 @@ public static string Result<T>(ConventionData<T> convention, IEnumerable<T> item
 
             return message.ToString();
         }
+
+        public static string Result<TConvention, T, TItem>(TConvention convention, IEnumerable<T> itemsToVerify, Func<TItem, bool> itemFilter)
+            where TConvention : ConventionData<T>, IRuntimeFilter<TItem>
+        {
+            convention.SetFilter(itemFilter);
+            return Result(convention, itemsToVerify);
+        }
     }
 }
diff --git a/TestStack.ConventionTests/ConventionData`1.cs b/TestStack.ConventionTests/ConventionData`1.cs
@@ -9,7 +9,6 @@
     public class ConventionData<TItem>
     {
         readonly Action<TItem, StringBuilder> defaultItemDescription = DefaultItemDescriptionMethod;
-        public static readonly Predicate<TItem> All = _ => true;
         public static readonly Predicate<TItem> None = _ => false;
 
         static void DefaultItemDescriptionMethod(TItem item, StringBuilder message)
@@ -19,7 +18,6 @@ static void DefaultItemDescriptionMethod(TItem item, StringBuilder message)
 
         public ConventionData()
         {
-            ItemFilter = All;
             Must = None;
             OrderBy = HashCode;
             ItemDescription = defaultItemDescription;
@@ -37,11 +35,6 @@ public ConventionData()
         /// </summary>
         public Predicate<TItem> Must { get; set; }
 
-        /// <summary>
-        ///     Predicate that finds types that we want to apply out convention to.
-        /// </summary>
-        public Predicate<TItem> ItemFilter { get; set; }
-
         public Action<TItem, StringBuilder> ItemDescription { get; set; }
 
         object HashCode(TItem arg)
diff --git a/TestStack.ConventionTests/Conventions/AllClassesHaveDefaultConstructor.cs b/TestStack.ConventionTests/Conventions/AllClassesHaveDefaultConstructor.cs
@@ -0,0 +1,14 @@
+﻿namespace TestStack.ConventionTests.Conventions
+{
+    using TestStack.ConventionTests.Helpers;
+
+    public class AllClassesHaveDefaultConstructor : ConventionData
+    {
+        public AllClassesHaveDefaultConstructor()
+        {
+            Must = type => type.HasDefaultConstructor();
+            ItemDescription = (type, builder) => 
+                builder.AppendLine(string.Format("{0} does not have a default constructor", type.FullName));
+        }
+    }
+}
diff --git a/TestStack.ConventionTests/Conventions/FilesAreEmbeddedResources.cs b/TestStack.ConventionTests/Conventions/FilesAreEmbeddedResources.cs
diff --git a/TestStack.ConventionTests/Conventions/ProjectDoesNotReferenceDllsFromBinOrObjDirectories.cs b/TestStack.ConventionTests/Conventions/ProjectDoesNotReferenceDllsFromBinOrObjDirectories.cs
diff --git a/TestStack.ConventionTests/Helpers/AssemblyProjectLocator.cs b/TestStack.ConventionTests/Helpers/AssemblyProjectLocator.cs
diff --git a/TestStack.ConventionTests/IRuntimeFilter.cs b/TestStack.ConventionTests/IRuntimeFilter.cs
diff --git a/TestStack.ConventionTests/TestStack.ConventionTests.csproj b/TestStack.ConventionTests/TestStack.ConventionTests.csproj

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +namespace TestAssembly
 +{
 +    public class ClassWithPublicDefaultCtor
 +    {
 +    }
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Convention has failing items`
	`2`	`+ TestStack.ConventionTests.Tests has the following files which should be embedded resources:`
	`3`	`+ Scripts\Script2.sql which currently has a build action of 'None'`