ASP.NET MVC: testing a controller with XUnit

Question

I am trying to use unit testing with XUnit for an ASP.NET v5 MVC v6 app. I can get simple unit testing on methods working. I would like to test Controllers. Right now, I have a HomeController with an Index action that returns the Home/Index view. I want to test that the Index view is the one that is returned.

Here is my current test file:

using Microsoft.AspNet.Mvc;
using Xunit;
using XUnitWithMvcSample.Controllers;

namespace XUnitWithMvcSample.Tests
{
    public class Tests
    {
        private HomeController _homeController;
        public Tests()
        {
            _homeController = new HomeController();
        }
        [Fact]
        public void IndexActionReturnsIndexView()
        {
            var result = _homeController.Index() as ViewResult;
            System.Console.WriteLine(result);
            Assert.Equal("Index", result.ViewName);
        }

    }
}

Here's Controllers/HomeController.cs:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNet.Mvc;


namespace XUnitWithMvcSample.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            return View();
        }
    }
}

When I run the test, it fails, since result.ViewName is null. It looks like result is just an empty ViewResult with nothing to do with _homeController. What do I need to do to get the test to find the Index view in HomeController?

David · Accepted Answer · 2016-01-13 20:02:44Z

9

It sounds like you're trying to test functionality that's in the framework, rather than what's just in the method. All that's in the method is this:

return View();

So, literally, as long as a non-null ViewResult is returned, then the method does what it's expected to do:

// Arrange
var controller = new HomeController();

// Act
var result = controller.Index() as ViewResult;

// Assert
Assert.IsNotNull(result);

Linking that result to a view is part of the ASP.NET MVC Framework and happens outside of that method. Which means that it's not part of the method call itself, but happens outside the scope of the method. That puts it outside the scope of the test.

You'd have to set up a kind of running ASP.NET MVC application and test that application in order to test that functionality, which is more of a black box test than a unit test.

answered Jan 13, 2016 at 20:02

David

221k42 gold badges245 silver badges337 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

carloswm85 Over a year ago

So, David, are you saying that he's doing nothing really? Asking about this: "It sounds like you're trying to test functionality that's in the framework, rather than what's just in the method."

Burak Altin · Accepted Answer · 2017-10-26 04:59:31Z

1

It's a bit late answer but if you can change your action method like that, your test will work.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNet.Mvc;


namespace XUnitWithMvcSample.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            return View("Index");
        }
    }
}

answered Oct 26, 2017 at 4:59

Burak Altin

4687 silver badges7 bronze badges

Collectives™ on Stack Overflow

ASP.NET MVC: testing a controller with XUnit

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related