使用 NSubstitute 进行 MVC 单元测试中的 Mocking 用户 IP 地址

Question

我的 HomeController 中有以下方法。 目的是根据IP地址拆分用户，测试不同版本的首页：

        [HttpGet]
        public ActionResult Index()
        {
            var userIpAddress = GetUserIpAddress();

            if (IsIpAddressOddOrEven(userIpAddress))
            {
                return RedirectToAction(HomePage);
            }

            return RedirectToAction(HomePageAlternative);
        }

GetUserIpAddress方法：

private string GetUserIpAddress()
        {
            HttpContext context = System.Web.HttpContext.Current;
            var ipAddress = context.Request.ServerVariables["HTTP_X_FORWARDED_FOR"];

            if (!string.IsNullOrEmpty(ipAddress))
            {
                string[] addresses = ipAddress.Split(',');
                if (addresses.Length != 0)
                {
                    return addresses[0];
                }
            }
            return context.Request.ServerVariables["REMOTE_ADDR"];
        }

我想编写一个单元测试以确保它正常工作。 但是，每次单元测试运行时，它只是使用我目前拥有的 IP 地址。 我正在努力研究如何模拟“GetUserIpAddress”方法的结果以返回奇数或偶数字符串。 到目前为止我的尝试：

        [Test]
        public void Test()
        {
            var controller = CreateMvcController<HomeController>();

            var result = controller.Index();
            controller.HttpContext.Request.ServerVariables["HTTP_X_FORWARDED_FOR"].Returns("1");
            Assert.IsInstanceOf<RedirectToRouteResult>(result);

            var redirectToRouteResult = result as RedirectToRouteResult;

            Assert.AreEqual(HomeController.HomePage, redirectToRouteResult.RouteValues["action"]);
        }

我得到的错误是controller.HttpContext.Request.ServerVariables["HTTP_X_FORWARDED_FOR"].Returns("1"); 不是一个字符串，而是一个 HttpResponseBase，无论如何我都不相信我会以正确的方式去做。 请有人能指出我正确的方向吗？ 谢谢

Answer 1

我建议您将GetUserIpAddress方法移至可以注入HomeController的助手 class 。 因此，您可以在进行单元测试时对其进行模拟。

您的HomeController将是这样的

public HomeController(IUserIpAddressHelper userIpAddressHelper)
{
    _userIpAddressHelper = userIpAddressHelper;
}

[HttpGet]
public ActionResult Index()
{
    var userIpAddress = _userIpAddressHelper.GetUserIpAddress(System.Web.HttpContext.Current);
    if (_userIpAddressHelper.IsIpAddressOddOrEven(userIpAddress))
    {
        return RedirectToAction(HomePage);
    }
    
    return RedirectToAction(HomePageAlternative);
}

因此，您将能够模拟UserIpAddressHelper并在编写测试时注入它。

public void Test()
{
    var userIpAddressHelper = Substitute.For<IUserIpAddressHelper>();
    userIpAddressHelper.GetUserIpAddress(Arg.Any<HttpContext>()).Returns("0.0.0.0");
  
    var controller = new HomeController(userIpAddressHelper);

    var result = controller.Index();

    Assert.IsInstanceOf<RedirectToRouteResult>(result);

    var redirectToRouteResult = result as RedirectToRouteResult;
    Assert.AreEqual(HomeController.HomePage, redirectToRouteResult.RouteValues["action"]);
}