Monday, 27 September 2010

Unit Testing: Selecting an Action from an MVC Controller

To fully test an MVC web site it is important to test (in isolation) the following:
  1. Behaviour of controller actions
  2. Behaviour of any custom action filters.
  3. The decoration of action filter attributes on controller actions.

To test the 3rd point, you must use reflection to select the desired action from the controller.  The following method takes an action name and a Tuple array of "Type" and "String". Used together this combination should be enough to isolate a desired action.  Note: an empty tuple array is used to define no input parameters, which a null tuple array specifies that this shouldn't be used to restrict the action (in this case the action name must be null)

  1. public MethodInfo SelectAction(Controller controller, string actionName, Tuple[] expectedParameters = null)
  2. {
  3.     var methods = controller.GetType().GetMethods(BindingFlags.Public | BindingFlags.Instance).Where(mi => mi.Name.Equals(actionName));
  4.     if (expectedParameters != null) methods = methods.Where(mi => CompareParameters(mi.GetParameters(), expectedParameters));
  5.     if (methods.Count() == 1) return methods.First();
  6.     var ex = new Exception((methods.Count() == 0) ? "No matching actions could be found on controller" : "More than one matching action could be found on controller"); ex.Data.Add("Controller", controller.GetType()); ex.Data.Add("Action", actionName); if (expectedParameters != null)
  7.     {
  8.         var parameterList = new StringBuilder(); foreach (var expectedParameter in expectedParameters)
  9.         {
  10.             if (parameterList.Length > 0) parameterList.Append(", "); parameterList.AppendFormat("{0} {1}", expectedParameter.Item1.Name, expectedParameter.Item2);
  11.         } ex.Data.Add("ParameterList", string.Format("({0}", parameterList.ToString()));
  12.     } ex.Data.Add("Matching Actions", methods.Count()); throw ex;
  13. }

This can then be called using the simple format below.  This code confirms that the controller has two search actions.  One taking no input parameters, whilst the other takes a bound input model.

  1. public MethodInfo SelectAction(Controller controller, string actionName, Tuple[] expectedParameters = null)
  2. {
  3.     MethodInfo action = null;
  4.     Assert.DoesNotThrow(() => action = SelectAction(new CustomerController((new MockHttpContext()).Object), "Search", new Tuple[] { }));
  5.     Assert.That(action.Name, Is.EqualTo("Search"));
  8.     Assert.DoesNotThrow(() => action = SelectAction(new CustomerController((new MockHttpContext()).Object), "Search", new[] { new Tuple(typeof(CustomerSearchInputModel), "inputModel") }));
  9.     Assert.That(action.Name, Is.EqualTo("Search"));
  10. }

In the next post I will cover how to use this to assert the decoration of action filter attributes. Tags: ,


Julien said...

Something like that allows you to assert the decoration of an action filter on a Controller:
Type t = typeof(SomeController);
Assert.IsTrue(t.GetCustomAttributes(typeof(SomeController), false).Length > 0);

Paul Hadfield said...

@Julien, Thanks - you've reminded me that I must finish and publish the post on asserting the decoration of action filters - hopefully get something done over the weekend.

Post a Comment