单元测试依赖于 UserManager 和 RoleManager

Question

我正在尝试对依赖 UserManager 和 RoleManager 的一些方法进行单元测试，但遇到了一些困难。

我是否应该模拟UserManager 和RoleManager，然后将其传递给AdminController？还是我应该首先访问AccountController 的默认SignIn 操作并进行身份验证。我不确定如何做这两种选择或最好的方法是什么。

当不验证/实例化管理器时，我在 UserManager 上得到 NullReferenceExceptions

我的测试

    [Test]
    public void MaxRole_SuperAdmin()
    {
        var adminController = new AdminController();
        var maxRole = adminController.GetMaxRole(SuperAdminUserId);

        Assert.AreEqual(maxRole, "Super Admin");
    }

控制器和方法

[Authorize(Roles = "APGame Admin, APGame Investigator")]
[RequireHttps]
public class AdminController : Controller
{

    private ApplicationUserManager _userManager;

    public ApplicationUserManager UserManager
    {
        get { return _userManager ?? HttpContext.GetOwinContext().GetUserManager<ApplicationUserManager>(); }
        private set { _userManager = value; }
    }

    private ApplicationRoleManager roleManager;

    public ApplicationRoleManager RoleManager
    {
        get
        {
            return roleManager ?? HttpContext.GetOwinContext().Get<ApplicationRoleManager>();
        }
        private set { roleManager = value; }
    }

    public string GetMaxRole(string userId)
    {
        IEnumerable<string> userRoles = UserManager.GetRoles(userId);

        string role = null;

        if (userRoles.Contains("APGame Admin"))
        {
            if (userRoles.Contains("TeVelde Group") && userRoles.Contains("Genomics Group"))
                role = "Super Admin";

            else role = "Admin";
        }

        else if (userRoles.Contains("APGame Investigator"))
        {
            role = "Investigator";
        }

        else if (userRoles.Contains("APGame User"))
        {
            role = "User";
        }

        else
        {
            //TODO: Log no role, HIGH
        }

        return role;
    }
}

Answer 1

如果你关注了我的博文，你应该得到类似 ApplicationUserManager 的构造函数的东西：

public class ApplicationUserManager : UserManager<ApplicationUser>
{
    public ApplicationUserManager(IUserStore<ApplicationUser> store) : base(store)
    {
     // configuration-blah-blah
    }
}

并且您的控制器应该将用户管理器对象注入到构造函数中：

public class AdminController : Controller
{
    private readonly ApplicationUserManager userManager;
    public AdminController(ApplicationUserManager userManager)
    {
        this.userManager = userManager;
    }
}

现在进行测试 - 您需要一个模拟框架。几年前，我曾经将 MOQ 放在每个测试中，现在首选的模拟框架是 NSubstitue，因为语法更易读。目前我很少使用模拟替代品，更喜欢集成测试，甚至深入到数据库中，但这不是这个问题/讨论的目标。

因此，对于您的测试，您需要创建您的被测系统 (SUT) - AdminController：

[Test]
public void MaxRole_SuperAdmin()
{
    var userStoreStub = NSubstitute.Substitute.For<IUserStore<ApplicationUser>>();
    var userManager = new ApplicationUserManager(userStoreStub);
    var sut = new AdminController(userManager);

    //TODO set up method substitutions on userStoreStub - see NSubstitute documentation

    var maxRole = sut.GetMaxRole(SuperAdminUserId);

    Assert.AreEqual(maxRole, "Super Admin");
}

但这是一个非常笨拙的测试。您正在尝试测试太深的东西。我建议您将 GetMaxRole 记录从控制器移到一个单独的类 - 一个服务类，或者这可以是 ApplicationUserManager 的一部分，或者如果您愿意，也可以是 QueryHandler。不管你怎么称呼它，它都不应该是控制器的一部分。我觉得这个方法其实属于ApplicationUserManager。这样你的测试层就减少了一层，你只需要创建用户管理器类，而不是控制器。

鉴于GetMaxRole() 方法是ApplicationUserManager 的一部分，您的测试将变得更小：

[Test]
public void MaxRole_SuperAdmin()
{
    var userStoreStub = NSubstitute.Substitute.For<IUserStore<ApplicationUser>>();
    var sut = new ApplicationUserManager(userStoreStub);

    //TODO set up method substitutions on userStoreStub - see NSubstitute documentation

    var maxRole = sut.GetMaxRole(SuperAdminUserId);

    Assert.AreEqual(maxRole, "Super Admin");
}

将被测方法移出控制器的原因如下：

• 随着时间的推移，我发现控制器很容易随着添加/删除/替换新依赖项而经常更改。如果你有一些关于控制器的测试，你将不得不改变每个测试使用的依赖关系。
• 如果你要在AdminController之外的其他地方使用GetMaxRole方法，你就有麻烦了。除了提供 HTTP(S) 端点之外，控制器不打算共享方法。
• 您的方法的逻辑看起来像域逻辑或业务逻辑。这应该彻底测试。控制器不容易测试，因为它们处理 HTTP 请求和HttpContext，这不容易测试（尽管可能）。此外，最好避免将控制器内容与业务逻辑混合 - 帮助您避免意大利面条代码综合症。

我可以一直谈论这个话题，但最好阅读DI book by Mark Seeman 和Unit Testing book by Roy Osherove。

Answer 2

你应该模拟 UserManager 和 RoleManager 并将它们传递给 AdminController