Added MVC/WebApi controller conventions

Author: Jake Ginnivan

TestAssembly/Controllers/TestApiController.cs

@@ -0,0 +1,7 @@
+namespace TestAssembly.Controllers
+{
+    public class TestApiController
+    {
+        
+    }
+}

TestStack.ConventionTests/Conventions/ApiControllerConvention.cs

@@ -0,0 +1,40 @@
+namespace TestStack.ConventionTests.Conventions
+{
+    using System;
+    using System.Linq;
+    using TestStack.ConventionTests.ConventionData;
+
+    public class ApiControllerConvention : IConvention<Types>
+    {
+        public void Execute(Types data, IConventionResult result)
+        {
+            var controllers = data.TypesToVerify.Where(IsWebApiController);
+            var typesWhichDoNotEndInController = controllers.Where(c => !c.Name.EndsWith("Controller"));
+
+            var typesWhichEndInController = data.TypesToVerify.Where(t => t.Name.EndsWith("Controller"));
+            var controllersWhichDoNotInheritFromController =
+                typesWhichEndInController.Where(t => !IsMvcController(t) && !IsWebApiController(t));
+
+            result.IsSymmetric(
+                "WebApi controllers must be suffixed with Controller", typesWhichDoNotEndInController,
+                "Types named *Controller must inherit from ApiController or Controller",
+                controllersWhichDoNotInheritFromController);
+        }
+
+        static bool IsMvcController(Type arg)
+        {
+            var isController = arg.FullName == "System.Web.Mvc.Controller";
+            if (arg.BaseType == null)
+                return isController;
+            return isController || IsMvcController(arg.BaseType);
+        }
+
+        static bool IsWebApiController(Type arg)
+        {
+            var isController = arg.FullName == "System.Web.Http.ApiController";
+            if (arg.BaseType == null)
+                return isController;
+            return isController || IsWebApiController(arg.BaseType);
+        }
+    }
+}

TestStack.ConventionTests/Conventions/MvcControllerConvention.cs

@@ -0,0 +1,40 @@
+namespace TestStack.ConventionTests.Conventions
+{
+    using System;
+    using System.Linq;
+    using TestStack.ConventionTests.ConventionData;
+
+    public class MvcControllerConvention : IConvention<Types>
+    {
+        public void Execute(Types data, IConventionResult result)
+        {
+            var controllers = data.TypesToVerify.Where(IsMvcController);
+            var typesWhichDoNotEndInController = controllers.Where(c => !c.Name.EndsWith("Controller"));
+
+            var typesWhichEndInController = data.TypesToVerify.Where(t => t.Name.EndsWith("Controller"));
+            var controllersWhichDoNotInheritFromController =
+                typesWhichEndInController.Where(t => !IsMvcController(t) && !IsWebApiController(t));
+
+            result.IsSymmetric(
+                "Mvc controllers must be suffixed with Controller", typesWhichDoNotEndInController,
+                "Types named *Controller must inherit from ApiController or Controller",
+                controllersWhichDoNotInheritFromController);
+        }
+
+        static bool IsMvcController(Type arg)
+        {
+            var isController = arg.FullName == "System.Web.Mvc.Controller";
+            if (arg.BaseType == null)
+                return isController;
+            return isController || IsMvcController(arg.BaseType);
+        }
+
+        static bool IsWebApiController(Type arg)
+        {
+            var isController = arg.FullName == "System.Web.Http.ApiController";
+            if (arg.BaseType == null)
+                return isController;
+            return isController || IsWebApiController(arg.BaseType);
+        }
+    }
+}

TestStack.ConventionTests/TestStack.ConventionTests.csproj

@@ -61,6 +61,9 @@
     <Compile Include="ConventionData\TypeExtensions.cs" />
     <Compile Include="ConventionFailedException.cs" />
     <Compile Include="IConventionResultContext.cs" />
+    <Compile Include="Conventions\ApiControllerConvention.cs" />
+    <Compile Include="Conventions\MvcControllerConvention.cs" />
+    <Compile Include="IConventionResult.cs" />
     <Compile Include="Internal\ConventionReportFailure.cs" />
     <Compile Include="Internal\ConventionContext.cs" />
     <Compile Include="Internal\ConventionResult.cs" />