如何对使用Controller.User变量的控制器操作进行单元测试？

Question

我有一个控制器操作,如果用户已登录(User.Identity.IsAuthenticated),它会自动重定向到新页面.为此场景编写单元测试以确保重定向发生的最佳方法是什么？

Answer 1

我一直在使用Moq的以下Mocks来允许在我的单元测试中设置各种条件.首先,HttpContextBase mock:

    public static Mock<HttpContextBase> GetHttpContextMock(bool isLoggedIn)
    {
        var context = new Mock<HttpContextBase>();
        var request = new Mock<HttpRequestBase>();
        var response = new Mock<HttpResponseBase>();
        var session = new Mock<HttpSessionStateBase>();
        var server = new Mock<HttpServerUtilityBase>();
        var principal = AuthenticationAndAuthorization.GetPrincipleMock(isLoggedIn);

        context.SetupGet(c => c.Request).Returns(request.Object);
        context.SetupGet(c => c.Response).Returns(response.Object);
        context.SetupGet(c => c.Session).Returns(session.Object);
        context.SetupGet(c => c.Server).Returns(server.Object);
        context.SetupGet(c => c.User).Returns(principal.Object);

        return context;
    }

每个可能提供有用的模拟的属性都在这里设置.这样,如果我需要添加类似推荐人的东西,我可以使用:

Mock.Get(controller.Request).Setup(s => s.UrlReferrer).Returns(new Uri("http://blah.com/");

"GetPrincipleMock"方法是设置用户的方法.它看起来像这样:

    public static Mock<IPrincipal> GetPrincipleMock(bool isLoggedIn)
    {
        var mock = new Mock<IPrincipal>();

        mock.SetupGet(i => i.Identity).Returns(GetIdentityMock(isLoggedIn).Object);
        mock.Setup(i => i.IsInRole(It.IsAny<string>())).Returns(false);

        return mock;
    }

    public static Mock<IIdentity> GetIdentityMock(bool isLoggedIn)
    {
        var mock = new Mock<IIdentity>();

        mock.SetupGet(i => i.AuthenticationType).Returns(isLoggedIn ? "Mock Identity" : null);
        mock.SetupGet(i => i.IsAuthenticated).Returns(isLoggedIn);
        mock.SetupGet(i => i.Name).Returns(isLoggedIn ? "testuser" : null);

        return mock;
    }

现在,我在测试中的控制器设置如下所示:

var controller = new ProductController();
var httpContext = GetHttpContextMock(true); //logged in, set to false to not be logged in

ControllerContext controllerContext = new ControllerContext(httpContext.Object, new RouteData(), controller);
controller.ControllerContext = controllerContext;

这是一个冗长的设置,但是一旦你掌握了一切,测试各种条件就变得容易多了.

Answer 2

这不是最简单的事情,但可以做到.User属性只是委托给Controller.HttpContext.User.两者都是非虚拟只读属性,因此您无法对它们执行任何操作.但是,Controller.HttpContext委托给ControllerBase.ControllerContext,它是一个可写属性.

因此,您可以在执行受测系统(SUT)之前将Test Double HttpContextBase分配给Controller.ControllerContext.使用Moq,它看起来像这样:

var user = new GenericPrincipal(new GenericIdentity(string.Empty), null);
var httpCtxStub = new Mock<HttpContextBase>();
httpCtxStub.SetupGet(ctx => ctx.User).Returns(user);

var controllerCtx = new ControllerContext();
controllerCtx.HttpContext = httpCtxStub.Object;

sut.ControllerContext = controllerCtx;

然后调用您的操作并验证返回结果是否为RedirectResult.

此测试利用隐含的知识,即当您使用空名称创建GenericIdentity时,它将为IsAuthenticated返回false.您可以考虑使用Mock<IIdentity>替代方法使测试更明确.