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

Why do my Android Notification only appear in the status bar?

I'm definitely getting back into Android development, I'm remembering that feeling of 'Surely this should be easier than this!'. All I wanted to do was to schedule a local notification which behaved similar to a push notification pop-up. That is, as well as showing the small icon in the status bar I wanted it to pop up on screen to notify the end user. All seems fairly easily, I found this code for how to schedule a notification. That all worked perfectly, apart from the notification would only appear in the status bar. Searching around I found loads of different answers / solutions, mostly all saying the same thing:It only worked if you used 'NotificationCompat.Builder' in place of 'Notification.Builder', orYou had to set the priority to 'NotificationCompat.PRIORITY_HIGH'As usually happens, none of these solutions worked for me until I added in the missing piece of the jigsaw:- '.setDefaults(Notification.DEFAULT_ALL)'. For me this…

Do "Task Hours" add anything in Scrum (Agile)?

What do task hours add to the overall process in scrum?This was a question that has arisen from all team members in both instances that I've helped teams switch over to scrum. The benefits of artifacts like the comparative story point estimation, the 2 week sprints, stand-ups and the end of sprint demo have been self evident to the team, but as one I think every team member has expressed dismay when it comes to task planning and estimating each task in hours. Left unchecked there is a natural tendency for people to actually begin to dread the start of each sprint purely due to the task planning session.In my current role we've been lucky to investigate this further as a team.The team sat down to discuss the problems it was experiencing with estimating tasks in hours and the following common themes appeared:It is hard: Maybe it shouldn't be, but time estimation is hard! Story points are comparative and abstracted making them easier to determine, but time estimate is gen…

IPhone hangs when running from XCode

I've had this happen a couple of times now and the first time was a little worrying that I'd bricked my iPhone. Basically I was running an application on my phone via XCode and when rebuilding an updated version it failed with a "busy" error message. Stopping XCode and unconnecting my phone had no effect, the phone was stuck displaying the loading screen of the application and wouldn't respond to any key commands. To fix you have to hard reboot, holding the power and home button until the phone reboots - doesn't lose any of the data you have on your phone (a concern the first time I did it).