Unit testing MVC controllers / Mocking UrlHelper

I have put a name to my pain...

And it is unit testing ASP.Net MVC controllers.

Well perhaps that's unfair. I have no problem unit testing MVC controllers.... until it comes to making use of the "innards" of MVC. Let me be more specific. This week I had a controller action that I needed to test. It looked a little like this:

	using System.Collections.Generic;
	using System.Linq;
	using System.Web.Mvc;
	namespace DemoApp.Areas.Demo.Controllers
	{
	public class DemoController : System.Web.Mvc.Controller
	{
	//....
	public JsonResult Edit(AnObject anObject)
	{
	//Indicate to the client we have saved and pass back the redirect URL
	return Json(new {
	Saved = true,
	RedirectUrl = Url.Action("Details", anObject.AnotherTypeOfId)
	});
	}
	//....
	}
	}

view raw DemoController.cs hosted with ❤ by GitHub

Looks fine right? It's an action that takes a simple object as an argument. That's ok. It returns a JsonResult. No worries. The JsonResult consists of an anonymous class. De nada. The anonymous class has one property that is driven by the controllers UrlHelper. Yeah that shouldn't be an issue... Hold your horses sunshine - you're going nowhere!

Getting disillusioned

Yup, the minute you start pumping in asserts around that UrlHelper driven property you're going to be mighty disappointed. What, you didn't expect the result to be null? Damn shame.

Despite articles on MSDN about how the intention is for MVC to be deliberately testable the sad fact of the matter is that there is a yawning hole around the testing support for controllers in ASP.Net MVC. Whenever you try to test something that makes use of controller "gubbins" you have serious problems. And unfortunately I didn't find anyone out there who could offer the whole solution.

After what I can best describe as a day of pain I found a way to scratch my particular itch. I found a way to write unit tests for controllers that made use of UrlHelper. As a bonus I managed to include the unit testing of Routes and Areas (well kind of) too.

MvcMockControllers updated

This solution is heavily based on the work of Scott Hanselman who wrote and blogged about MvcMockHelpers back in 2008. Essentially I've taken this and tweaked it so I could achieve my ends. My version of MvcMockHelpers looks a little like this:

	using Moq;
	using System;
	using System.Collections.Specialized;
	using System.Web;
	using System.Web.Mvc;
	using System.Web.Routing;
	namespace UnitTest.TestUtilities
	{
	/// <summary>
	/// This class of MVC Mock helpers is originally based on Scott Hanselman's 2008 post:
	/// http://www.hanselman.com/blog/ASPNETMVCSessionAtMix08TDDAndMvcMockHelpers.aspx
	///
	/// This has been updated and tweaked to work with MVC 3 / 4 projects (it hasn't been tested with MVC
	/// 1 / 2 but may work there) and also based my use cases
	/// </summary>
	public static class MvcMockHelpers
	{
	#region Mock HttpContext factories
	public static HttpContextBase MockHttpContext()
	{
	var context = new Mock<HttpContextBase>();
	var request = new Mock<HttpRequestBase>();
	var response = new Mock<HttpResponseBase>();
	var session = new Mock<HttpSessionStateBase>();
	var server = new Mock<HttpServerUtilityBase>();
	request.Setup(r => r.AppRelativeCurrentExecutionFilePath).Returns("/");
	request.Setup(r => r.ApplicationPath).Returns("/");
	response.Setup(s => s.ApplyAppPathModifier(It.IsAny<string>())).Returns<string>(s => s);
	response.SetupProperty(res => res.StatusCode, (int)System.Net.HttpStatusCode.OK);
	context.Setup(h => h.Request).Returns(request.Object);
	context.Setup(h => h.Response).Returns(response.Object);
	context.Setup(ctx => ctx.Request).Returns(request.Object);
	context.Setup(ctx => ctx.Response).Returns(response.Object);
	context.Setup(ctx => ctx.Session).Returns(session.Object);
	context.Setup(ctx => ctx.Server).Returns(server.Object);
	return context.Object;
	}
	public static HttpContextBase MockHttpContext(string url)
	{
	var context = MockHttpContext();
	context.Request.SetupRequestUrl(url);
	return context;
	}
	#endregion
	#region Extension methods
	public static void SetMockControllerContext(this Controller controller,
	HttpContextBase httpContext = null,
	RouteData routeData = null,
	RouteCollection routes = null)
	{
	//If values not passed then initialise
	routeData = routeData ?? new RouteData();
	routes = routes ?? RouteTable.Routes;
	httpContext = httpContext ?? MockHttpContext();
	var requestContext = new RequestContext(httpContext, routeData);
	var context = new ControllerContext(requestContext, controller);
	//Modify controller
	controller.Url = new UrlHelper(requestContext, routes);
	controller.ControllerContext = context;
	}
	public static void SetHttpMethodResult(this HttpRequestBase request, string httpMethod)
	{
	Mock.Get(request).Setup(req => req.HttpMethod).Returns(httpMethod);
	}
	public static void SetupRequestUrl(this HttpRequestBase request, string url)
	{
	if (url == null)
	throw new ArgumentNullException("url");
	if (!url.StartsWith("~/"))
	throw new ArgumentException("Sorry, we expect a virtual url starting with \"~/\".");
	var mock = Mock.Get(request);
	mock.Setup(req => req.QueryString).Returns(GetQueryStringParameters(url));
	mock.Setup(req => req.AppRelativeCurrentExecutionFilePath).Returns(GetUrlFileName(url));
	mock.Setup(req => req.PathInfo).Returns(string.Empty);
	}
	/// <summary>
	/// Facilitates unit testing of anonymouse types - taken from here:
	/// http://stackoverflow.com/a/5012105/761388
	/// </summary>
	public static object GetReflectedProperty(this object obj, string propertyName)
	{
	obj.ThrowIfNull("obj");
	propertyName.ThrowIfNull("propertyName");
	var property = obj.GetType().GetProperty(propertyName);
	if (property == null)
	return null;
	return property.GetValue(obj, null);
	}
	public static T ThrowIfNull<T>(this T value, string variableName) where T : class
	{
	if (value == null)
	throw new NullReferenceException(
	string.Format("Value is Null: {0}", variableName));
	return value;
	}
	#endregion
	#region Private
	static string GetUrlFileName(string url)
	{
	return (url.Contains("?"))
	? url.Substring(0, url.IndexOf("?"))
	: url;
	}
	static NameValueCollection GetQueryStringParameters(string url)
	{
	if (url.Contains("?"))
	{
	var parameters = new NameValueCollection();
	var parts = url.Split("?".ToCharArray());
	var keys = parts[1].Split("&".ToCharArray());
	foreach (var key in keys)
	{
	var part = key.Split("=".ToCharArray());
	parameters.Add(part[0], part[1]);
	}
	return parameters;
	}
	return null;
	}
	#endregion
	}
	}

view raw MvcMockHelpers.cs hosted with ❤ by GitHub

What I want to test

I want to be able to unit test the controller Edit method I mentioned earlier. This method calls the Action method on the controllers Url member (which is, in turn, a UrlHelper) to generate a URL for passing pack to the client. The URL generated should fit with the routing mechanism I have set up. In this case the route we expect a URL for was mapped by the following area registration:

	using System.Web.Mvc;
	namespace DemoApp.Areas.Demo
	{
	public class DemoAreaRegistration : AreaRegistration
	{
	public override string AreaName
	{
	get
	{
	return "DemoArea";
	}
	}
	public override void RegisterArea(AreaRegistrationContext context)
	{
	context.MapRoute(
	"DemoArea_default",
	"Demo/{oneTypeOfId}/{anotherTypeOfId}/{controller}/{action}/{id}",
	new { oneTypeOfId = 0, anotherTypeOfId = 0, action = "Index", id = UrlParameter.Optional }
	);
	}
	}
	}

view raw DemoAreaRegistration.cs hosted with ❤ by GitHub

Enough of the waffle - show me a unit test

Now to the meat; here's a unit test which demonstrates how this is used:

	using System.Collections.Generic;
	using System.Linq;
	using System.Web.Mvc;
	using System.Web.Routing;
	using Microsoft.VisualStudio.TestTools.UnitTesting;
	using Moq;
	namespace UnitTest.Areas.Demo.Controllers
	{
	[TestClass]
	public class UnitTestingAnAreaUsingUrlHelper
	{
	private DemoController _controller;
	[TestInitialize]
	public void InitializeTest()
	{
	_controller = new DemoController();
	}
	[TestMethod]
	public void Edit_updates_the_object_and_returns_a_JsonResult_containing_the_redirect_URL()
	{
	// Arrange
	int anotherTypeOfId = 5332;
	//Register the area as well as standard routes
	RouteTable.Routes.Clear();
	var areaRegistration = new DemoAreaRegistration();
	var areaRegistrationContext = new AreaRegistrationContext(
	areaRegistration.AreaName, RouteTable.Routes);
	areaRegistration.RegisterArea(areaRegistrationContext);
	RouteConfig.RegisterRoutes(RouteTable.Routes);
	//Initialise the controller and setup the context so MVC can pick up the relevant route data
	var httpContext = MvcMockHelpers.MockHttpContext(
	"~/Demo/77969/" + anotherTypeOfId + "/Company/Edit");
	var routeData = RouteTable.Routes.GetRouteData(httpContext);
	_controller.SetMockControllerContext(
	httpContext, routeData, RouteTable.Routes);
	// Act
	var result = _controller.Edit(
	new AnObject{
	WithAProperty = "Something",
	AnotherTypeOfId = anotherTypeOfId });
	// Assert
	Assert.AreEqual("DemoArea", areaRegistration.AreaName);
	Assert.IsInstanceOfType(result, typeof(JsonResult));
	Assert.IsNotNull(result.Data,
	"There should be some data for the JsonResult");
	Assert.AreEqual(true,
	result.Data.GetReflectedProperty("Saved"));
	Assert.AreEqual("/Demo/77969/" + anotherTypeOfId + "/Company/Details",
	result.Data.GetReflectedProperty("RedirectUrl"));
	}
	}
	}

view raw UnitTestingAnAreaUsingUrlHelper.cs hosted with ❤ by GitHub

Let's go through this unit test and breakdown what's happening:

1. Arrange
• We instantiate an int that represents part of the route data.
• We clear out any registered routes from the RouteTable so we're starting with a clean slate.
• We manually register our specific areas (only 1 in this example). This is done because AreaRegistration.RegisterAllAreas() simply doesn't work in the unit test environment. There may be a better solution, one that allows for dynamic area registration but I don't know what it is. This works.
• We register our routes. (By the way, isn't it frustrating that RouteConfig.RegisterRoutes(RouteTable.Routes) works where AreaRegistration.RegisterAllAreas() doesn't?)
• We create a MockHttpContext passing in the URL that would represent the "calling page"; that is to say the URL which would invoke the action we wish to test.
• Using the MockHttpContext and the routes we set up we determine the route data.
• We set the controllers context to the MockHttpContext and pass in the configured routes and the inferred route data.
2. Act
• We call the Edit method on the controller and pass in a newed-up AnObject object.
3. Assert
• Check that the correct area was registered.
• Check that the output from the Edit method is as you would expect.

The most interesting thing you'll note is the controller's UrlHelper is now generating a URL as we might have hoped. The URL is generated making use of our routing, yay! Finally we're also managing to unit test a route registered by our area.

Using Expressions with Constructors

Every now and then you think "x should be easy" - and it isn't. I had one of those situations this morning. Something I thought would take 5 minutes had me still pondering 30 minutes later. I finally cracked it (with the help of a colleague - thanks Marc!) and I wanted to note down what I did since I'm sure to forget this.

So what's the problem?

In our project we had a very simple validation class. It looked a bit like this:

	public class FieldValidation
	{
	public FieldValidation(string fieldName, string message)
	{
	FieldName = fieldName;
	Message = message;
	}
	public string FieldName { get; set; }
	public string Message { get; set; }
	}

view raw FieldValidationBefore.cs hosted with ❤ by GitHub

I wanted to take this class and extend it to have a constructor which allowed me to specify a Type and subsequently an Expression of that Type that allowed me to specify a property. 10 points if you read the last sentence and understood it without reading it a second time.

Code is a better illustration; take a look below. I wanted to go from #1 to #2:

	//#1 Specify field name up front - how we currently use this
	var oldSchoolValidation = new FieldValidation(
	"WithAProperty", "Message of some kind...");
	//#2 Field name driven directly by property - how we want to use this
	var newSchoolValidation = new FieldValidation<AnObject>(
	x => x.WithAProperty, "Message of some kind...");
	/// <summary>
	/// Example class for demo
	/// </summary>
	public class AnObject
	{
	public bool WithAProperty { get; set; }
	}

view raw HowItIsUsed.cs hosted with ❤ by GitHub

"Why?" I hear you ask. Well we had a swathe of statements in the code which test each property for a problem and would create a FieldValidation with the very same property name if one was found. There's no real problem with that but I'm a man that likes to refactor. Property names change and I didn't want to have to remember to manually go through each FieldValidation keeping these in line. If I was using the actual property name to drive the creation of my FieldValidations then that problem disappears. And I like that.

So what's the solution?

Well it's this:

	public class FieldValidation
	{
	public FieldValidation(string fieldName, string message)
	{
	FieldName = fieldName;
	Message = message;
	}
	public string FieldName { get; set; }
	public string Message { get; set; }
	}
	public class FieldValidation<T> : FieldValidation where T : class
	{
	public FieldValidation(
	Expression<Func<T, object>> expression,
	string message)
	{
	//Will work for reference types
	var body = expression.Body as MemberExpression;
	if (body == null)
	{
	//Will work for value types
	var uBody = (UnaryExpression)expression.Body;
	body = uBody.Operand as MemberExpression;
	}
	if (body == null)
	throw new ArgumentException("Invalid property expression");
	FieldName = body.Member.Name;
	Message = message;
	}
	}

view raw FieldValidationAfter.cs hosted with ❤ by GitHub

As you can see we have taken the original FieldValidation class and added in a generic constructor which instead of taking string fieldName as a first argument it takes Expression<Func<T, object>> expression. LINQ's Expression magic is used to determine the supplied property name which is smashing. If you were wondering, the first MemberExpression code is used for reference types. The UnaryExpression wrapping a MemberExpression code is used for value types. A good explanation of this can be found here.

My colleague directed me to this crucial StackOverflow answer which provided some much needed direction when I was thrashing. And that's it; we're done, home free.