如何在 .Net Core 测试中模拟 UserManager？

Question

如何在 .Net Core 测试中模拟 UserManager？

c#unit-testingasp.net-coremockingasp.net-core-identity

53

我有以下代码。我正在尝试运行一个创建用户的测试用例。到目前为止，这是我所尝试的：

public class CreateUserCommandHandlerTest
{
    private Mock<UserManager<ApplicationUser>> _userManager;
    private CreateUserCommandHandler _systemUnderTest;

    public CreateUserCommandHandlerTest()
    {
        _userManager = MockUserManager.GetUserManager<ApplicationUser>();
        var user = new ApplicationUser() { UserName = "ancon1", Email = "ancon@mail.com", RoleType = RoleTypes.Anonymous };
        _userManager
            .Setup(u => u.CreateAsync(user, "ancon2")).ReturnsAsync(IdentityResult.Success);
        _systemUnderTest = new CreateUserCommandHandler(_userManager.Object);
    }

    [Fact]
    public async void Handle_GivenValidInput_ReturnsCreatedResponse()
    {
        var command = new CreateUserCommand { Username = "ancon1", Email = "ancon@mail.com", Password = "ancon2", RoleType = RoleTypes.Anonymous };
        var result = await _systemUnderTest.Handle(command, default(CancellationToken));
        Assert.NotNull(result);
        Assert.IsType<Application.Commands.CreatedResponse>(result);
    }
}

我的用户管理器在这里：

public static class MockUserManager
{
    public static Mock<UserManager<TUser>> GetUserManager<TUser>()
        where TUser : class
    {
        var store = new Mock<IUserStore<TUser>>();
        var passwordHasher = new Mock<IPasswordHasher<TUser>>();
        IList<IUserValidator<TUser>> userValidators = new List<IUserValidator<TUser>>
        {
            new UserValidator<TUser>()
        };
        IList<IPasswordValidator<TUser>> passwordValidators = new List<IPasswordValidator<TUser>>
        {
            new PasswordValidator<TUser>()
        };
        userValidators.Add(new UserValidator<TUser>());
        passwordValidators.Add(new PasswordValidator<TUser>());
        var userManager = new Mock<UserManager<TUser>>(store.Object, null, passwordHasher.Object, userValidators, passwordValidators, null, null, null, null);
        return userManager;
    }
}

我的命令处理程序如下：

 public class CreateUserCommandHandler : IRequestHandler<CreateUserCommand, BaseCommandResponse>
{
    private readonly UserManager<ApplicationUser> _userManager;

    public CreateUserCommandHandler(UserManager<ApplicationUser> userManager)
    {
        _userManager = userManager;
    }

    public async Task<BaseCommandResponse> Handle(CreateUserCommand createUserCommand, CancellationToken cancellationToken)
    {
        var user = new ApplicationUser { UserName = createUserCommand.Username, Email = createUserCommand.Email, RoleType = createUserCommand.RoleType };
        var result = await _userManager.CreateAsync(user, createUserCommand.Password);
        if (result.Succeeded)
        {
            return new CreatedResponse();
        }

        ErrorResponse errorResponse = new ErrorResponse(result.Errors.Select(e => e.Description).First());

        return errorResponse;
    }
}

当我运行测试时，出现“对象引用未设置为对象的实例”的错误。

我做错了什么？

- Anushka Madushan

3个回答

45

aspnet/Identity 是开源的，你可以看看他们是如何模拟它的。

他们是这样做的：MockHelpers.cs

TestUserManager

public static UserManager<TUser> TestUserManager<TUser>(IUserStore<TUser> store = null) where TUser : class
{
    store = store ?? new Mock<IUserStore<TUser>>().Object;
    var options = new Mock<IOptions<IdentityOptions>>();
    var idOptions = new IdentityOptions();
    idOptions.Lockout.AllowedForNewUsers = false;
    options.Setup(o => o.Value).Returns(idOptions);
    var userValidators = new List<IUserValidator<TUser>>();
    var validator = new Mock<IUserValidator<TUser>>();
    userValidators.Add(validator.Object);
    var pwdValidators = new List<PasswordValidator<TUser>>();
    pwdValidators.Add(new PasswordValidator<TUser>());
    var userManager = new UserManager<TUser>(store, options.Object, new PasswordHasher<TUser>(),
        userValidators, pwdValidators, new UpperInvariantLookupNormalizer(),
        new IdentityErrorDescriber(), null,
        new Mock<ILogger<UserManager<TUser>>>().Object);
    validator.Setup(v => v.ValidateAsync(userManager, It.IsAny<TUser>()))
        .Returns(Task.FromResult(IdentityResult.Success)).Verifiable();
    return userManager;
}

- Nick Chapsas

如果您能添加一个基于您链接的类的简单代码示例，那就太好了。这将使答案对未来的用户更有用，因为链接可能会随着时间的推移而失效。 - Sixto Saez

@SixtoSaez 感谢您的建议，我已添加了代码片段。 - Nick Chapsas

我刚遇到了完全相同的问题。哇，所有这些都是为了模拟用户管理器？不知道为什么没有UserManager<T>的接口？存储似乎有一个（IUserStore<>），等等。 - Todd Langdon

1

如果你需要在测试中使用DbContext（我使用InMemory DbContext实现），你可以传递它并创建一个真正的UserStore实例，而不是Mock，例如：var store = new UserStore<TUser>(yourDbContextInstance); - Sam

我本来希望能够直接调用这个方法，但它并不是库的一部分。 - Jess

感谢@NickChapsas的答案，非常有用。然而，我花了很多时间才弄清楚如何使用它。使用您提供的'TestUserManager'时，我无法解决模拟的问题，因为它在调用时会抛出异常。不过，我的解决方案是使用您提供的相同资源中的'MockUserManager'。您认为这是正确的应用吗？ - milpataki

5

在 .NetCore 2.2 版本中，你需要稍微不同地处理。将它视为对 @Nick Chapsas 回答的更新。

首先，你必须使用 IUserPasswordStore 而不是 IUserStore。IUserPasswordStore 继承自 IUserStore，但 UserManager 希望得到 IUserPasswordStore。否则，有些东西将无法正常工作。

如果你想测试 UserManager 的真实行为（例如 CreateUserAsync），你可以使用 UserValidator 和 PasswordValidator 的真实实现。你可能只是想确保你的方法对 CreateUser 错误的反应是否符合预期。

这是我的更新示例：

UserManager<TUser> CreateUserManager() where TUser : class
{
    Mock<IUserPasswordStore<TUser>> userPasswordStore = new Mock<IUserPasswordStore<TUser>>();
    userPasswordStore.Setup(s => s.CreateAsync(It.IsAny<TUser>(), It.IsAny<CancellationToken>()))
        .Returns(Task.FromResult(IdentityResult.Success));

    var options = new Mock<IOptions<IdentityOptions>>();
    var idOptions = new IdentityOptions();

    //this should be keep in sync with settings in ConfigureIdentity in WebApi -> Startup.cs
    idOptions.Lockout.AllowedForNewUsers = false;
    idOptions.Password.RequireDigit = true;
    idOptions.Password.RequireLowercase = true;
    idOptions.Password.RequireNonAlphanumeric = true;
    idOptions.Password.RequireUppercase = true;
    idOptions.Password.RequiredLength = 8;
    idOptions.Password.RequiredUniqueChars = 1;

    idOptions.SignIn.RequireConfirmedEmail = false;

    // Lockout settings.
    idOptions.Lockout.DefaultLockoutTimeSpan = TimeSpan.FromMinutes(5);
    idOptions.Lockout.MaxFailedAccessAttempts = 5;
    idOptions.Lockout.AllowedForNewUsers = true;


    options.Setup(o => o.Value).Returns(idOptions);
    var userValidators = new List<IUserValidator<TUser>>();
    UserValidator<TUser> validator = new UserValidator<TUser>();
    userValidators.Add(validator);

    var passValidator = new PasswordValidator<TUser>();
    var pwdValidators = new List<IPasswordValidator<TUser>>();
    pwdValidators.Add(passValidator);
    var userManager = new UserManager<TUser>(userPasswordStore.Object, options.Object, new PasswordHasher<TUser>(),
        userValidators, pwdValidators, new UpperInvariantLookupNormalizer(),
        new IdentityErrorDescriber(), null,
        new Mock<ILogger<UserManager<TUser>>>().Object);

    return userManager;
}

请注意，UserPasswordStore有一个方法（CreateAsync），如果希望测试UserManager的CreateAsync，则应该对其进行模拟。

密码和锁定设置取自我的项目。它们应与您的设置保持同步，以便您可以测试实际内容。

当然，您不会测试例如PasswordValidator，但您可以测试自己的方法，例如：

//Part of user service
public async Task<IdentityResult> Register(UserDto data)
{
    SystemUser user = ConvertDtoToUser(data);
    IdentityResult result = userManager.CreateAsync(user, data.Password);

    //some more code that is dependent on the result
}

- Adam Jachocki

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

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

- djangojazz · Accepted Answer

我知道这已经是几个月前的旧帖子了，但我一直在回到这个帖子。我将在此主题上扩展自己的答案，因为仅指向Haok的GitHub示例就像说：“读一本书”一样，因为它很大。它没有准确指出问题以及你需要做什么。你需要隔离一个模拟对象，但不仅如此，你还需要“设置”“CreateAsync”的方法。所以我们把它分成三个部分：

如果您正在使用MOQ或类似框架，请 MOCK。
您需要设置您期望从UserManager获得结果的方法。
可选地，您可以从模拟Entity Framework Core 2.1或类似的地方注入一些通用列表，以便您实际上可以看到IDentity Users的列表实际上增加或减少。不仅 UserManager 成功了而已

所以说我有一个帮助方法来返回Mocked UserManager。它与Haok代码略有不同:

public static Mock<UserManager<TUser>> MockUserManager<TUser>(List<TUser> ls) where TUser : class
{
    var store = new Mock<IUserStore<TUser>>();
    var mgr = new Mock<UserManager<TUser>>(store.Object, null, null, null, null, null, null, null, null);
    mgr.Object.UserValidators.Add(new UserValidator<TUser>());
    mgr.Object.PasswordValidators.Add(new PasswordValidator<TUser>());

    mgr.Setup(x => x.DeleteAsync(It.IsAny<TUser>())).ReturnsAsync(IdentityResult.Success);
    mgr.Setup(x => x.CreateAsync(It.IsAny<TUser>(), It.IsAny<string>())).ReturnsAsync(IdentityResult.Success).Callback<TUser, string>((x, y) => ls.Add(x));
    mgr.Setup(x => x.UpdateAsync(It.IsAny<TUser>())).ReturnsAsync(IdentityResult.Success);

    return mgr;
}

这关键在于我正在注入一个通用的“TUser”，这就是我将要测试并注入其列表的东西。类似于我的示例：

 private List<ApplicationUser> _users = new List<ApplicationUser>
 {
      new ApplicationUser("User1", "user1@bv.com") { Id = 1 },
      new ApplicationUser("User2", "user2@bv.com") { Id = 2 }
 };
    
 ...

 private _userManager = MockUserManager<ApplicationUser>(_users).Object;

最后，我正在测试一个与这个实现类似的存储库模式，我想进行测试：

 public async Task<int> CreateUser(ApplicationUser user, string password) => (await _userManager.CreateAsync(user, password)).Succeeded ? user.Id : -1;

我这样测试它：

 [Fact]
 public async Task CreateAUser()
 {
      var newUser = new ApplicationUser("NewUser", "New@test.com");
      var password = "P@ssw0rd!";

      var result = await CreateUser(newUser, password);

      Assert.Equal(3, _users.Count);
  }

我的关键在于不仅“设置”了 CreateAsync，而且提供了回调函数，这样我就可以看到我注入的列表被增加了。希望这能帮助别人。