Mocking HttpContext HttpRequest and HttpResponse for UnitTests (using Moq)
I just added support to O2 Platform for easy mocking of HttpContext, HttpRequest and HttpResponse (very useful for ASP.NET Unit Test and Security Scripting).
The solution is based on the Moq Mocking framework and on the great info provided in this , this and this posts
As an example, this is how the Input Stream of the HttpRequest can be maniplated (same logic for the OutputStream):
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();
The API_Moq_HttpContext class is the one that implements the Mocking infrastructure
public class API_Moq_HttpContext
{
public Mock<HttpContextBase> MockContext { get; set; }
public Mock<HttpRequestBase> MockRequest { get; set; }
public Mock<HttpResponseBase> MockResponse { get; set; }
public Mock<HttpSessionStateBase> MockSession { get; set; }
public Mock<HttpServerUtilityBase> MockServer { get; set; }
public Mock<IPrincipal> MockUser { get; set; }
public Mock<IIdentity> MockIdentity { get; set; }
public HttpContextBase HttpContextBase { get; set; }
public HttpRequestBase HttpRequestBase { get; set; }
public HttpResponseBase HttpResponseBase { get; set; }
public API_Moq_HttpContext()
{
createBaseMocks();
setupNormalRequestValues();
}
public API_Moq_HttpContext createBaseMocks()
{
MockContext = new Mock<HttpContextBase>();
MockRequest = new Mock<HttpRequestBase>();
MockResponse = new Mock<HttpResponseBase>();
MockSession = new Mock<HttpSessionStateBase>();
MockServer = new Mock<HttpServerUtilityBase>();
MockContext.Setup(ctx => ctx.Request).Returns(MockRequest.Object);
MockContext.Setup(ctx => ctx.Response).Returns(MockResponse.Object);
MockContext.Setup(ctx => ctx.Session).Returns(MockSession.Object);
MockContext.Setup(ctx => ctx.Server).Returns(MockServer.Object);
HttpContextBase = MockContext.Object;
HttpRequestBase = MockRequest.Object;
HttpResponseBase = MockResponse.Object;
return this;
}
public API_Moq_HttpContext setupNormalRequestValues()
{
//Context.User
var MockUser = new Mock<IPrincipal>();
var MockIdentity = new Mock<IIdentity>();
MockContext.Setup(context => context.User).Returns(MockUser.Object);
MockUser.Setup(context => context.Identity).Returns(MockIdentity.Object);
//Request
MockRequest.Setup(request =>request.InputStream).Returns(new MemoryStream());
//Response
MockResponse.Setup(response =>response.OutputStream).Returns(new MemoryStream());
return this;
}
}
At the moment it has a couple extension methods to help writing and reading data from the HttpRequest InputStream and HttpResponse OutputStream
public static class API_Moq_HttpContext_ExtensionMethods
{
public static HttpContextBase httpContext(this API_Moq_HttpContext moqHttpContext)
{
return moqHttpContext.HttpContextBase;
}
public static HttpContextBase request_Write(this HttpContextBase httpContextBase,string text)
{
httpContextBase.stream_Write(httpContextBase.Request.InputStream, text);
return httpContextBase;
}
public static string request_Read(this HttpContextBase httpContextBase)
{
return httpContextBase.stream_Read(httpContextBase.Request.InputStream);
}
public static HttpContextBase response_Write(this HttpContextBase httpContextBase,string text)
{
httpContextBase.stream_Write(httpContextBase.Response.OutputStream, text);
return httpContextBase;
}
public static string response_Read(this HttpContextBase httpContextBase)
{
return httpContextBase.stream_Read(httpContextBase.Response.OutputStream);
}
public static HttpContextBase stream_Write(this HttpContextBase httpContextBase, Stream inputStream, string text)
{
var streamWriter = new StreamWriter(inputStream);
inputStream.Position = inputStream.property("Length").str().toInt();
streamWriter.Write(text);
streamWriter.Flush();
inputStream.Position = 0;
return httpContextBase;
}
public static string stream_Read(this HttpContextBase httpContextBase, Stream inputStream)
{
var originalPosition = inputStream.Position;
var streamReader = new StreamReader(inputStream);
var requestData = streamReader.ReadToEnd();
inputStream.Position = originalPosition;
return requestData;
}
}
6 Comments »
Leave a comment
About
The O2 platform represents a new paradigm for how to perform, document and distribute Web Application security reviews. O2 is designed to Automate Security Consultants Knowledge and Workflows and to Allow non-security experts to access and consume Security Knowledge.
O2 can also be a very powerful prototyping and fast-development tool for .NET. Most O2 APIs are written using a Fluent API design, and its core has been published as a separate project called FluentSharp (hosted at CodePlex)
Download
Windows ClickOnce Installer:
Mailing List
The best place to keep updated with the lastest news and developers it to subscribe to the OWASP O2 Platform Mailing list (you can read its archives here)
OWASP O2 Platform Blog 
[…] the Mocking HttpContext HttpRequest and HttpResponse for UnitTests (using Moq) API, here is a unit test that uses it to test if a method used inside an HttpModule is doing the […]
[…] Mocking HttpContext HttpRequest and HttpResponse for UnitTests (using Moq) […]
inputStream.Position = inputStream.property(“Length”).str().toInt();
Is this an error???????
You are right, I think at the time I must have though that the ‘Length’ property of the Stream class was private (hence the use of the {object}.property(…) O2 method)
That line can be replaced with (int)inputStream.Length;
Btw, since this post, I’ve added a couple more methods to this O2 Script file: http://o2platform.googlecode.com/svn/trunk/O2_Scripts/APIs/Moq/API_Moq_HttpContext.cs
And this:
var httpContext = mockHttpContext.httpContext();
??????????????/
That one is correct. That httpContent() method will return a HttpContextBase object, ie this:
HttpContextBase httpContext = mockHttpContext.httpContext();
I called it httpContext since the idea is that you should be using this HttpContextBase object instead of the native HttpContext object. The HttpContextBase is created via:
HttpContextBase = MockContext.Object;
where MockContext is
MockContext = new Mock();