如何在ASP.NET 5 / MVC 6的单元测试中访问HttpContext

Question

如何在ASP.NET 5 / MVC 6的单元测试中访问HttpContext

asp.netunit-testinghttpcontextasp.net-core-mvc

13

假设我在我的中间件中设置了一个值到http上下文中，例如HttpContext.User。

我如何在我的单元测试中测试http上下文。这是我尝试做的一个示例：

中间件

public class MyAuthMiddleware
{
    private readonly RequestDelegate _next;

    public MyAuthMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        context.User = SetUser(); 
        await next(context);
    }
}

测试

[Fact]
public async Task UserShouldBeAuthenticated()
{
    var server = TestServer.Create((app) => 
    {
        app.UseMiddleware<MyAuthMiddleware>();
    });

    using(server)
    {
        var response = await server.CreateClient().GetAsync("/");
        // After calling the middleware I want to assert that 
        // the user in the HttpContext was set correctly
        // but how can I access the HttpContext here?
    }
}

- Sul Aga

4个回答

8

asp.net 5/MVC6的RC1版本使得在单元测试中手动设置HttpContext成为可能，这太棒了！

        DemoController demoController = new DemoController();
        demoController.ActionContext = new ActionContext();
        demoController.ActionContext.HttpContext = new DefaultHttpContext();
        demoController.HttpContext.Session = new DummySession();

平台提供了DefaultHttpContext类。DummySession可以只是一个简单的实现ISession接口的类。这样做可以大大简化事情，因为不再需要模拟。

- Tuukka Lindroos

1

HttpContext 已被更名为 ControllerContext。但是你的回答对实现相关的事情很有用。 - thoean

3

如果您在与其余代码隔离的情况下对中间件类进行单元测试，那将会更好。

由于HttpContext类是一个抽象类，您可以使用像Moq这样的模拟框架（将"Moq": "4.2.1502.911"添加到您的project.json文件中作为依赖项），以验证已设置用户属性。

例如，您可以编写以下测试，以验证您的中间件Invoke函数正在设置httpContext中的User属性并调用下一个中间件：

[Fact]
public void MyAuthMiddleware_SetsUserAndCallsNextDelegate()
{
    //Arrange
    var httpContextMock = new Mock<HttpContext>()
            .SetupAllProperties();
    var delegateMock = new Mock<RequestDelegate>();
    var sut = new MyAuthMiddleware(delegateMock.Object);

    //Act
    sut.Invoke(httpContextMock.Object).Wait();

    //Assert
    httpContextMock.VerifySet(c => c.User = It.IsAny<ClaimsPrincipal>(), Times.Once);
    delegateMock.Verify(next => next(httpContextMock.Object), Times.Once);
}

你可以编写额外的测试来验证用户是否具有预期值，因为你将能够使用httpContextMock.Object.User获取设置的User对象：

Assert.NotNull(httpContextMock.Object.User);
//additional validation, like user claims, id, name, roles

- Daniel J.G.

只是提醒一下...使用Moq也可以，但它目前在Core CLR上无法工作。 - Kiran

好的，知道了！如果你想要目标定位于core clr，你要么需要使用DefaultHttpContext（如你的示例中所示），要么创建扩展HttpContext的手动模拟类。 - Daniel J.G.

是的，虽然最好使用DefaultHttpContext，因为它是专为单元测试设计的。 - Kiran

2

请看这篇帖子：

在单元测试中设置HttpContext.Current.Session

我认为你需要的是这个。

public static HttpContext FakeHttpContext(string url)
{
    var uri = new Uri(url);
    var httpRequest = new HttpRequest(string.Empty, uri.ToString(),
                                        uri.Query.TrimStart('?'));
    var stringWriter = new StringWriter();
    var httpResponse = new HttpResponse(stringWriter);
    var httpContext = new HttpContext(httpRequest, httpResponse);

    var sessionContainer = new HttpSessionStateContainer("id",
                                    new SessionStateItemCollection(),
                                    new HttpStaticObjectsCollection(),
                                    10, true, HttpCookieMode.AutoDetect,
                                    SessionStateMode.InProc, false);

    SessionStateUtility.AddHttpSessionStateToContext(
                                         httpContext, sessionContainer);

    return httpContext;
}

然后您可以像这样使用它：

request.SetupGet(req => req.Headers).Returns(new NameValueCollection());
HttpContextFactory.Current.Request.Headers.Add(key, value);

- Charlie Afford

3

这不适用于ASP.Net 5/MVC 6，因为它具有新的HttpContext模型。 - Daniel J.G.

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Kiran · Accepted Answer

以下是您可以使用的两种方法：

// Directly test the middleware itself without setting up the pipeline
[Fact]
public async Task Approach1()
{
    // Arrange
    var httpContext = new DefaultHttpContext();
    var authMiddleware = new MyAuthMiddleware(next: (innerHttpContext) => Task.FromResult(0));

    // Act
    await authMiddleware.Invoke(httpContext);

    // Assert
    // Note that the User property on DefaultHttpContext is never null and so do
    // specific checks for the contents of the principal (ex: claims)
    Assert.NotNull(httpContext.User);
    var claims = httpContext.User.Claims;
    //todo: verify the claims
}

[Fact]
public async Task Approach2()
{
    // Arrange
    var server = TestServer.Create((app) =>
    {
        app.UseMiddleware<MyAuthMiddleware>();

        app.Run(async (httpContext) =>
        {
            if(httpContext.User != null)
            {
                await httpContext.Response.WriteAsync("Claims: "
                    + string.Join(
                        ",",
                        httpContext.User.Claims.Select(claim => string.Format("{0}:{1}", claim.Type, claim.Value))));
            }
        });
    });

    using (server)
    {
        // Act
        var response = await server.CreateClient().GetAsync("/");

        // Assert
        var actual = await response.Content.ReadAsStringAsync();
        Assert.Equal("Claims: ClaimType1:ClaimType1-value", actual);
    }
}