Skip to main content

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"));
  6.  
  7.  
  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.

del.icio.us Tags: ,

Comments

  1. 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);

    ReplyDelete
  2. @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.

    ReplyDelete

Post a Comment

Popular posts from this blog

Mocking HttpCookieCollection in HttpRequestBase

When unit testing ASP.NET MVC2 projects the issue of injecting HttpContext is quickly encountered.  There seem to be many different ways / recommendations for mocking HttpContextBase to improve the testability of controllers and their actions.  My investigations into that will probably be a separate blog post in the near future but for now I want to cover something that had me stuck for longer than it probably should have.  That is how to mock non abstract/interfaced classes within HttpRequestBase and HttpResponseBase – namely the HttpCookieCollection class.   The code sample below illustrates how it can be used within a mocked instance of HttpRequestBase.  Cookies can be added / modified within the unit test code prior to being passed into the code being tested.   After it’s been called, using a combination of MOQ’s Verify and NUnit’s Assert it is possible to check how many times the collection is accessed (but you have to include the set up calls) and that the relevant cookies have …

Injecting HttpContextBase into an MVC Controller

It is a shame that when the ASP.NET MVC framework was released they did not think to build IoC support into the infrastructure. All the major components of the MVC engine appear to magically inherit instances of HttpContext and it’s related objects – which can cause no end of problems if you are trying to utilise Unit Testing and IoC. Reading around various articles on the subject just to get around this one problem requires the implementation of several different concepts and you are still left with a work around. The code below, along with the other links referenced in this article is my stab at resolving the issue. There’s probably nothing new here, but it does attempt to relate all the information needed to do this for Castle Windsor. The overview is that all controllers will need to inherit from a base controller, which takes an instance of HttpContext into it’s constructor. It then overrides the property HttpContext in the main controller class, supplying it’s own version…

Unit Testing Workflow Code Activities - Part 1

When I first started looking into Windows Workflow one of the first things that I liked about it was how it separated responsibilities. The workflow was responsible for handling the procedural logic with all it's conditional statements, etc. Whilst individual code activities could be written to handle the business logic processing; created in small easily re-usable components. To try and realise my original perception this series of blog posts will cover the unit testing of bespoke code activities; broken down into: Part One: Unit testing a code activity with a (generic) cast return type (this post)Part Two: Unit testing a code activity that assigns it's (multiple) output to "OutArguments" (Not yet written)So to make a start consider the following really basic code activity; it expects an InArgument<string> of "Input" and returns a string containing the processed output; in this case a reverse copy of the value held in "Input".namespace Ex…