How do I mock the HttpContext in ASP.NET MVC using Moq?

Question

[TestMethod]
public void Home_Message_Display_Unknown_User_when_coockie_does_not_exist()
{
    var context = new Mock<HttpContextBase>();
    var request = new Mock<HttpRequestBase>();
    context
        .Setup(c => c.Request)
        .Returns(request.Object);
    HomeController controller = new HomeController();

    controller.HttpContext = context; //Here I am getting an error (read only).
    ...
 }

my base controller has an overrride of the Initialize that get's this requestContext. I am trying to pass this along but I am not doing something right.

protected override void Initialize(System.Web.Routing.RequestContext requestContext)
{
    base.Initialize(requestContext);
}

Where can I get more information on mocking my RequestContext and HttpContext using Moq? I am trying to mock cookies and the general context.

score 62 · Answer 1 · edited Jan 10 '14 at 18:13

62

HttpContext is read-only, but it is actually derived from the ControllerContext, which you can set.

 controller.ControllerContext = new ControllerContext( context.Object, new RouteData(), controller );

edited Jan 10 '14 at 18:13

Sachin Kainth

41,237
78
185
289

answered Sep 21 '09 at 01:05

tvanfosson

490,224
93
683
780

This one worked for me by allowing me to set a mock HttpContext on the controller. – Joel Malone May 14 '12 at 12:22

score 42 · Answer 2 · edited Apr 25 '13 at 12:46

42

Create a request, response and put them both to HttpContext:

HttpRequest httpRequest = new HttpRequest("", "http://mySomething/", "");
StringWriter stringWriter = new StringWriter();
HttpResponse httpResponse = new HttpResponse(stringWriter);
HttpContext httpContextMock = new HttpContext(httpRequest, httpResponse);

edited Apr 25 '13 at 12:46

Sklivvz

28,698
24
111
164

answered Sep 21 '09 at 14:30

0100110010101

5,971
5
31
37

The question is about the *Base classes, ie HttpRequestBase, not HttpRequest - not sure why both are needed myself and even more annoying that they are "sealed". No way to set LogonUserIdentity :( – Chris Kimpton Oct 22 '10 at 08:57
If they're marshalled my reference, it's still possible via remoting, so it shouldn't be a problem. – 0100110010101 Oct 22 '10 at 11:46
1

@ChrisKimpton: As a last resort, there's always _reflection_ ;-) – Oliver Jan 15 '14 at 16:57
This works when attaching it to the controller, like this: controller.ControllerContext = new ControllerContext( new HttpContextWrapper(httpContextMock), new RouteData(), controller); – Andreas Vendel Jun 25 '14 at 13:31
yes. you can indeed set .LogonUserIdentity -- _request.Setup(n => n.LogonUserIdentity).Returns((WindowsIdentity.GetCurrent)); – KevinDeus Oct 16 '14 at 21:52

score 14 · Answer 3 · answered Jun 30 '15 at 12:02

Thanks user 0100110010101.

It worked for me and here i had an issue while writing the testcase for the below code :

 var currentUrl = Request.Url.AbsoluteUri;

And here is the lines which solved the problem

HomeController controller = new HomeController();
//Mock Request.Url.AbsoluteUri 
HttpRequest httpRequest = new HttpRequest("", "http://mySomething", "");
StringWriter stringWriter = new StringWriter();
HttpResponse httpResponse = new HttpResponse(stringWriter);
HttpContext httpContextMock = new HttpContext(httpRequest, httpResponse);
controller.ControllerContext = new ControllerContext(new HttpContextWrapper(httpContextMock), new RouteData(), controller);

Might be helpful for the others.

I can't seem to use the HttpRequest type - is that something else now? — Vincent Buscarello, Jul 11 '18 at 19:22
This is not useful because all the fields in HttpRequest are immutable — A X, Jul 07 '19 at 21:57

score 7 · Answer 4 · edited Nov 08 '12 at 10:16

Here's how I used the ControllerContext to pass a fake Application path:

[TestClass]
public class ClassTest
{
    private Mock<ControllerContext> mockControllerContext;
    private HomeController sut;

    [TestInitialize]
    public void TestInitialize()
    {
        mockControllerContext = new Mock<ControllerContext>();
        sut = new HomeController();
    }
    [TestCleanup]
    public void TestCleanup()
    {
        sut.Dispose();
        mockControllerContext = null;
    }
    [TestMethod]
    public void Index_Should_Return_Default_View()
    {

        // Expectations
        mockControllerContext.SetupGet(x => x.HttpContext.Request.ApplicationPath)
            .Returns("/foo.com");
        sut.ControllerContext = mockControllerContext.Object;

        // Act
        var failure = sut.Index();

        // Assert
        Assert.IsInstanceOfType(failure, typeof(ViewResult), "Index() did not return expected ViewResult.");
    }
}

The MVC code will execute it and throw a null exception if it's not there. — Joshua Ramirez, Jan 15 '13 at 16:29

Dinis Cruz · Answer 5 · 2014-09-04T23:43:09.723

Here is an example of how you can set this up: Mocking HttpContext HttpRequest and HttpResponse for UnitTests (using Moq)

Note the extension methods which really help to simplify the usage of this mocking classes:

var mockHttpContext = new API_Moq_HttpContext();

var httpContext = mockHttpContext.httpContext();

httpContext.request_Write("<html><body>".line()); 
httpContext.request_Write("   this is a web page".line());  
httpContext.request_Write("</body></html>"); 

return httpContext.request_Read();

Here is an example of how to write a Unit Test using moq to check that an HttpModule is working as expected: Unit Test for HttpModule using Moq to wrap HttpRequest

Update: this API has been refactored to

HttpContextFactory.cs
these multiple Http* Extension Methods files

Links are broken - please include the code in your answer – Hades Jan 06 '20 at 10:12 — Hades, Jan 06 '20 at 10:12

How do I mock the HttpContext in ASP.NET MVC using Moq?

5 Answers5

Linked

Related