Refactor on Cache Key Generation tests

Created a base class with the general behaviour for any key generation test

Author: dmalanij

test/WebApi.OutputCache.V2.Tests/CacheKeyGenerationTestsBase.cs

@@ -0,0 +1,60 @@
+using NUnit.Framework;
+using System;
+using System.Net.Http.Headers;
+using System.Web.Http.Controllers;
+
+namespace WebApi.OutputCache.V2.Tests
+{
+    /// <summary>
+    /// Base class for implementing tests for the generation of cache keys (meaning: implementations of the <see cref="ICacheKeyGenerator"/>
+    /// </summary>
+    public abstract class CacheKeyGenerationTestsBase<TCacheKeyGenerator> where TCacheKeyGenerator : ICacheKeyGenerator
+    {
+        private const string ArgumentKey = "filterExpression";
+        private const string ArgumentValue = "val";
+        protected HttpActionContext context;
+        protected MediaTypeHeaderValue mediaType;
+        protected Uri requestUri;
+        protected TCacheKeyGenerator cacheKeyGenerator;
+        protected string BaseCacheKey;
+
+        [SetUp]
+        public virtual void Setup()
+        {
+            requestUri = new Uri("http://localhost:8080/cacheKeyGeneration?filter=val");
+            var controllerType = typeof(TestControllers.CacheKeyGenerationController);
+            var actionMethodInfo = controllerType.GetMethod("Get");
+            var controllerDescriptor = new HttpControllerDescriptor() { ControllerType = controllerType };
+            var actionDescriptor = new ReflectedHttpActionDescriptor(controllerDescriptor, actionMethodInfo);
+            var request = new System.Net.Http.HttpRequestMessage(System.Net.Http.HttpMethod.Get, requestUri.AbsoluteUri);
+
+            context = new HttpActionContext(
+                new HttpControllerContext() { ControllerDescriptor = controllerDescriptor, Request = request },
+                actionDescriptor
+            );
+            mediaType = new MediaTypeHeaderValue("application/json");
+
+            BaseCacheKey = new CacheOutputConfiguration(null).MakeBaseCachekey((TestControllers.CacheKeyGenerationController c) => c.Get(String.Empty));
+            cacheKeyGenerator = BuildCacheKeyGenerator();
+        }
+
+        protected abstract TCacheKeyGenerator BuildCacheKeyGenerator();
+
+        protected virtual void AssertCacheKeysBasicFormat(string cacheKey)
+        {
+            Assert.IsNotNull(cacheKey);
+            StringAssert.StartsWith(BaseCacheKey, cacheKey, "Key does not start with BaseKey");
+            StringAssert.EndsWith(mediaType.ToString(), cacheKey, "Key does not end with MediaType");
+        }
+
+        protected void AddActionArgumentsToContext()
+        {
+            context.ActionArguments.Add(ArgumentKey, ArgumentValue);
+        }
+
+        protected string FormatActionArgumentsForKeyAssertion()
+        {
+            return String.Format("{0}={1}", ArgumentKey, ArgumentValue);
+        }
+    }
+}

test/WebApi.OutputCache.V2.Tests/DefaultCacheKeyGeneratorTests.cs

@@ -6,46 +6,11 @@
 namespace WebApi.OutputCache.V2.Tests
 {
     [TestFixture]
-    public class DefaultCacheKeyGeneratorTests
+    public class DefaultCacheKeyGeneratorTests : CacheKeyGenerationTestsBase<DefaultCacheKeyGenerator>
     {
-        private const string ArgumentKey = "filterExpression";
-        private const string ArgumentValue = "val";
-        private HttpActionContext context;
-        private MediaTypeHeaderValue mediaType;
-        private Uri requestUri;
-        private DefaultCacheKeyGenerator cacheKeyGenerator;
-        private string BaseCacheKey;
-
-        [SetUp]
-        public void Setup()
-        {
-            requestUri = new Uri("http://localhost:8080/cacheKeyGeneration?filter=val");
-            var controllerType = typeof(TestControllers.CacheKeyGenerationController);
-            var actionMethodInfo = controllerType.GetMethod("Get");
-            var controllerDescriptor = new HttpControllerDescriptor() { ControllerType = controllerType };
-            var actionDescriptor = new ReflectedHttpActionDescriptor(controllerDescriptor, actionMethodInfo);
-            var request = new System.Net.Http.HttpRequestMessage(System.Net.Http.HttpMethod.Get, requestUri.AbsoluteUri);
-
-            context = new HttpActionContext(
-                new HttpControllerContext() { ControllerDescriptor = controllerDescriptor, Request = request },
-                actionDescriptor
-            );
-            mediaType = new MediaTypeHeaderValue("application/json");
-
-            cacheKeyGenerator = new DefaultCacheKeyGenerator();
-            BaseCacheKey = new CacheOutputConfiguration(null).MakeBaseCachekey((TestControllers.CacheKeyGenerationController c) => c.Get(String.Empty));
-        }
-
-        private void AssertCacheKeysBasicFormat(string cacheKey)
-        {
-            Assert.IsNotNull(cacheKey);
-            StringAssert.StartsWith(BaseCacheKey, cacheKey, "Key does not start with BaseKey");
-            StringAssert.EndsWith(mediaType.ToString(), cacheKey, "Key does not end with MediaType");
-        }
-
-        private void AddActionArgumentsToContext() 
+        protected override DefaultCacheKeyGenerator BuildCacheKeyGenerator()
         {
-            context.ActionArguments.Add(ArgumentKey, ArgumentValue);
+            return new DefaultCacheKeyGenerator();
         }
 
         [Test]
@@ -73,7 +38,7 @@ public void WithParametersIncludeQueryString_ShouldReturnBaseKeyAndArgumentsAndQ
             var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, false);
 
             AssertCacheKeysBasicFormat(cacheKey);
-            Assert.AreEqual(String.Format("{0}-{1}={2}&{3}:{4}", BaseCacheKey, ArgumentKey, ArgumentValue, requestUri.Query.Substring(1), mediaType), cacheKey, "Key does not match expected <BaseKey>-<Arguments>&<QueryString>:<MediaType>");
+            Assert.AreEqual(String.Format("{0}-{1}&{2}:{3}", BaseCacheKey, FormatActionArgumentsForKeyAssertion(), requestUri.Query.Substring(1), mediaType), cacheKey, "Key does not match expected <BaseKey>-<Arguments>&<QueryString>:<MediaType>");
         }
 
         [Test]
@@ -83,7 +48,7 @@ public void WithParametersExcludeQueryString_ShouldReturnBaseKeyAndArgumentsAndM
             var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, true);
 
             AssertCacheKeysBasicFormat(cacheKey);
-            Assert.AreEqual(String.Format("{0}-{1}={2}:{3}", BaseCacheKey, ArgumentKey, ArgumentValue, mediaType), cacheKey, "Key does not match expected <BaseKey>-<Arguments>:<MediaType>");
+            Assert.AreEqual(String.Format("{0}-{1}:{2}", BaseCacheKey, FormatActionArgumentsForKeyAssertion(), mediaType), cacheKey, "Key does not match expected <BaseKey>-<Arguments>:<MediaType>");
         }
     }
 }

test/WebApi.OutputCache.V2.Tests/WebApi.OutputCache.V2.Tests.csproj

@@ -74,6 +74,7 @@
   <ItemGroup>
     <Compile Include="CacheKeyGeneratorRegistrationTests.cs" />
     <Compile Include="CacheKeyGeneratorTests.cs" />
+    <Compile Include="CacheKeyGenerationTestsBase.cs" />
     <Compile Include="ClientSideTests.cs">
       <SubType>Code</SubType>
     </Compile>