如何Mock User.Identity.Name对IndexModel的OnGet方法进行单元测试

针对你遇到的问题，核心是PageModel的User属性只读，无法直接赋值，必须通过配置HttpContext间接设置用户身份。下面是两种实用的解决方案，分别适用于简单场景和需要Mock更多依赖的场景：

方案一：使用DefaultHttpContext（无需Moq，快速配置） #

如果只需要模拟用户身份，不需要Mock其他HttpContext组件（比如Response.Cookies），直接用DefaultHttpContext即可：

using System.Security.Claims;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Xunit;

public class IndexModelTests
{
    [Fact]
    public void OnGet_WithValidUser_RedirectsCorrectly()
    {
        // 1. 创建带用户名的用户身份
        var claimsIdentity = new ClaimsIdentity(
            new[] { new Claim(ClaimTypes.Name, "test_user") }, 
            authenticationType: "TestAuth" // 可选，标识身份验证类型
        );
        var testUser = new ClaimsPrincipal(claimsIdentity);

        // 2. 创建HttpContext并绑定用户
        var httpContext = new DefaultHttpContext();
        httpContext.User = testUser;

        // 3. 将HttpContext关联到PageModel的ControllerContext
        var indexModel = new IndexModel();
        indexModel.ControllerContext = new ControllerContext
        {
            HttpContext = httpContext
        };

        // 4. 执行测试方法
        var result = indexModel.OnGet();

        // 5. 断言逻辑（示例）
        var redirectResult = Assert.IsType<RedirectResult>(result);
        Assert.Equal("/TargetPage", redirectResult.Url); // 替换为你的重定向地址
    }
}

方案二：使用Moq模拟完整上下文（适合需要Mock Cookie等场景） #

如果你的OnGet方法需要操作Cookie，需要MockHttpResponse和IResponseCookies，可以用Moq框架实现：

using System.Security.Claims;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Moq;
using Xunit;

public class IndexModelTests
{
    [Fact]
    public void OnGet_SetsCookieAndRedirects()
    {
        // 1. Mock HttpContext、Response和Cookies
        var mockCookies = new Mock<IResponseCookies>();
        var mockResponse = new Mock<HttpResponse>();
        mockResponse.Setup(r => r.Cookies).Returns(mockCookies.Object);

        var mockHttpContext = new Mock<HttpContext>();
        mockHttpContext.Setup(c => c.Response).Returns(mockResponse.Object);

        // 2. 设置用户身份
        var testUser = new ClaimsPrincipal(
            new ClaimsIdentity(new[] { new Claim(ClaimTypes.Name, "test_user") })
        );
        mockHttpContext.Setup(c => c.User).Returns(testUser);

        // 3. 绑定上下文到PageModel
        var indexModel = new IndexModel();
        indexModel.ControllerContext = new ControllerContext
        {
            HttpContext = mockHttpContext.Object
        };

        // 4. 执行测试
        var result = indexModel.OnGet();

        // 5. 断言（示例）
        Assert.IsType<RedirectResult>(result);
        // 验证Cookie是否被设置（替换为你的Cookie名称）
        mockCookies.Verify(
            c => c.Append(It.Is<string>(name => name == "YourCookieName"), 
                          It.IsAny<string>(), 
                          It.IsAny<CookieOptions>()), 
            Times.Once
        );
    }
}

关键注意点 #

• PageModel的User属性是只读的，它的取值来自HttpContext.User，因此必须通过配置HttpContext来间接设置用户身份。
• ControllerContext是PageModel的可写属性，通过给它赋值包含自定义HttpContext的实例，就能让PageModel使用我们模拟的上下文环境。
• 如果你的OnGet方法依赖其他服务（比如数据库），还需要通过构造函数注入对应的Mock实例。

内容的提问来源于stack exchange，提问作者user21527595