Net Core教程

ASP.NET Core 对Controller进行单元测试

本文主要是介绍ASP.NET Core 对Controller进行单元测试，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

单元测试对我们的代码质量非常重要。很多同学都会对业务逻辑或者工具方法写测试用例，但是往往忽略了对Controller层写单元测试。我所在的公司没见过一个对Controller写过测试的。今天来演示下如果对Controller进行单元测试。以下内容默认您对单元测试有所了解，比如如何mock一个接口。在这里多叨叨一句，面向接口的好处，除了能够快速的替换实现类（其实大部分接口不会有多个实现），最大的好处就是可以进行mock，可以进行单元测试。

测试Action

下面的Action非常简单，非常常见的一种代码。根据用户id去获取用户信息然后展示出来。下面看看如何对这个Action进行测试。

  1.    public class UserController : Controller
  2.     {
  3.         private readonly IUserService _userService;
  4.         public UserController(IUserService userService)
  5.         {
  6.             _userService = userService;
  7.         }

  9.         public IActionResult UserInfo(string userId)
  10.         {
  11.             if (string.IsNullOrEmpty(userId))
  12.             {
  13.                 throw new ArgumentNullException(nameof(userId));
  14.             }

  16.             var user = _userService.Get(userId);
  17.             return View(user);
  18.         }

  20.     }
测试代码：
  1.   [TestMethod()]
  2.         public void UserInfoTest()
  3.         {

  5.             var userService = new Mock<IUserService>();
  6.             userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User());

  8.             var ctrl = new UserController(userService.Object);
  9.             //对空参数进行assert
  10.             Assert.ThrowsException<ArgumentNullException>(() => {
  11.                 var result = ctrl.UserInfo(null);
  12.             });
  13.             //对空参数进行assert
  14.             Assert.ThrowsException<ArgumentNullException>(() => {
  15.                 var result = ctrl.UserInfo("");
  16.             });

  18.             var result = ctrl.UserInfo("1");
  19.             Assert.IsNotNull(result);
  20.             Assert.IsInstanceOfType(result, typeof(ViewResult));
  21.         }
我们对一个Action进行测试主要的思路就是模拟各种入参，使测试代码能够到达所有的分支，并且Assert输出是否为空，是否为指定的类型等。
对ViewModel进行测试
我们编写Action的时候还会涉及ViewModel给视图传递数据，这部分也需要进行测试。修改测试用例，加入对ViewModel的测试代码：
  1.   [TestMethod()]
  2.         public void UserInfoTest()
  3.         {
  4.             var userService = new Mock<IUserService>();
  5.             userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
  6.             {
  7.                 Id = "x"
  8.             }) ;

  10.             var ctrl = new UserController(userService.Object);
  11.             Assert.ThrowsException<ArgumentNullException>(() => {
  12.                 var result = ctrl.UserInfo(null);
  13.             });
  14.             Assert.ThrowsException<ArgumentNullException>(() => {
  15.                 var result = ctrl.UserInfo("");
  16.             });

  18.             var result = ctrl.UserInfo("1");
  19.             Assert.IsNotNull(result);
  20.             Assert.IsInstanceOfType(result, typeof(ViewResult));
  21.             //对viewModel进行assert
  22.             var vr = result as ViewResult;
  23.             Assert.IsNotNull(vr.Model);
  24.             Assert.IsInstanceOfType(vr.Model, typeof(User));
  25.             var user = vr.Model as User;
  26.             Assert.AreEqual("x", user.Id);
  27.         }
对ViewData进行测试
我们编写Action的时候还会涉及ViewData给视图传递数据，这部分同样需要测试。修改Action代码，对ViewData进行赋值：
  1.    public IActionResult UserInfo(string userId)
  2.         {
  3.             if (string.IsNullOrEmpty(userId))
  4.             {
  5.                 throw new ArgumentNullException(nameof(userId));
  6.             }

  8.             var user = _userService.Get(userId);

  10.             ViewData["title"] = "user_info";

  12.             return View(user);
  13.         }
修改测试用例，加入对ViewData的测试代码：
  1.    [TestMethod()]
  2.         public void UserInfoTest()
  3.         {
  4.             var userService = new Mock<IUserService>();
  5.             userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
  6.             {
  7.                 Id = "x"
  8.             }) ;

  10.             var ctrl = new UserController(userService.Object);
  11.             Assert.ThrowsException<ArgumentNullException>(() => {
  12.                 var result = ctrl.UserInfo(null);
  13.             });
  14.             Assert.ThrowsException<ArgumentNullException>(() => {
  15.                 var result = ctrl.UserInfo("");
  16.             });

  18.             var result = ctrl.UserInfo("1");
  19.             Assert.IsNotNull(result);
  20.             Assert.IsInstanceOfType(result, typeof(ViewResult));

  22.             var vr = result as ViewResult;
  23.             Assert.IsNotNull(vr.Model);
  24.             Assert.IsInstanceOfType(vr.Model, typeof(User));
  25.             var user = vr.Model as User;
  26.             Assert.AreEqual("x", user.Id);
  27.             //对viewData进行assert
  28.             Assert.IsTrue(vr.ViewData.ContainsKey("title"));
  29.             var title = vr.ViewData["title"];
  30.             Assert.AreEqual("user_info", title);
  31.         }
对ViewBag进行测试
因为ViewBag事实上是ViewData的dynamic类型的包装，所以Action代码不用改，可以直接对ViewBag进行测试：
  1.      [TestMethod()]
  2.         public void UserInfoTest()
  3.         {
  4.             var userService = new Mock<IUserService>();
  5.             userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
  6.             {
  7.                 Id = "x"
  8.             }) ;

  10.             var ctrl = new UserController(userService.Object);
  11.             Assert.ThrowsException<ArgumentNullException>(() => {
  12.                 var result = ctrl.UserInfo(null);
  13.             });
  14.             Assert.ThrowsException<ArgumentNullException>(() => {
  15.                 var result = ctrl.UserInfo("");
  16.             });

  18.             var result = ctrl.UserInfo("1");
  19.             Assert.IsNotNull(result);
  20.             Assert.IsInstanceOfType(result, typeof(ViewResult));

  22.             var vr = result as ViewResult;
  23.             Assert.IsNotNull(vr.Model);
  24.             Assert.IsInstanceOfType(vr.Model, typeof(User));
  25.             var user = vr.Model as User;
  26.             Assert.AreEqual("x", user.Id);

  28.             Assert.IsTrue(vr.ViewData.ContainsKey("title"));
  29.             var title = vr.ViewData["title"];
  30.             Assert.AreEqual("user_info", title);
  31.             //对viewBag进行assert
  32.             string title1 = ctrl.ViewBag.title;
  33.             Assert.AreEqual("user_info", title1);
  34.         }
设置HttpContext
我们编写Action的时候很多时候需要调用基类里的HttpContext，比如获取Request对象，获取Path，获取Headers等等，所以有的时候需要自己实例化HttpContext以进行测试。
    var ctrl = new AccountController();    ctrl.ControllerContext = new ControllerContext();    ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
对HttpContext.SignInAsync进行mock
我们使用ASP.NET Core框架进行登录认证的时候，往往使用HttpContext.SignInAsync进行认证授权，所以单元测试的时候也需要进行mock。下面是一个典型的登录Action，对密码进行认证后调用SignInAsync在客户端生成登录凭证，否则跳到登录失败页面。
  1.    public async Task<IActionResult> Login(string password)
  2.         {
  3.             if (password == "123")
  4.             {
  5.                 var claims = new List<Claim>
  6.                 {
  7.                   new Claim("UserName","x")
  8.                 };
  9.                 var authProperties = new AuthenticationProperties
  10.                 {
  11.                 };
  12.                 var claimsIdentity = new ClaimsIdentity(
  13.                   claims, CookieAuthenticationDefaults.AuthenticationScheme);
  14.                 await HttpContext.SignInAsync(
  15.                     CookieAuthenticationDefaults.AuthenticationScheme,
  16.                     new ClaimsPrincipal(claimsIdentity),
  17.                     authProperties);
  18.                 return Redirect("login_success");
  19.             }

  21.             return Redirect("login_fail");
  22.         }
HttpContext.SignInAsync其实个时扩展方法，SignInAsync其实最终是调用了IAuthenticationService里的SignInAsync方法。所以我们需要mock的就是IAuthenticationService接口，否者代码走到HttpContext.SignInAsync会提示找不到IAuthenticationService的service。而IAuthenticationService本身是通过IServiceProvider注入到程序里的，所以同时需要mock接口IServiceProvider。
  1.     [TestMethod()]
  2.         public async Task LoginTest()
  3.         {
  4.             var ctrl = new AccountController();

  6.             var authenticationService = new Mock<IAuthenticationService>();
  7.             var sp = new Mock<IServiceProvider>();
  8.             sp.Setup(s => s.GetService(typeof(IAuthenticationService)))
  9.                 .Returns(() => {
  10.                     return authenticationService.Object;
  11.                 });
  12.             ctrl.ControllerContext = new ControllerContext();
  13.             ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
  14.             ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;

  16.            var result = await ctrl.Login("123");
  17.             Assert.IsNotNull(result);
  18.             Assert.IsInstanceOfType(result, typeof(RedirectResult));
  19.             var rr = result as RedirectResult;
  20.             Assert.AreEqual("login_success", rr.Url);

  22.             result = await ctrl.Login("1");
  23.             Assert.IsNotNull(result);
  24.             Assert.IsInstanceOfType(result, typeof(RedirectResult));
  25.             rr = result as RedirectResult;
  26.             Assert.AreEqual("login_fail", rr.Url);
  27.         }
对HttpContext.AuthenticateAsync进行mock
HttpContext.AuthenticateAsync同样比较常用。这个扩展方法同样是在IAuthenticationService里，所以测试代码跟上面的SignInAsync类似，只是需要对AuthenticateAsync继续mock返回值success or fail。
  1.      public async Task<IActionResult> Login()
  2.         {
  3.             if ((await HttpContext.AuthenticateAsync()).Succeeded)
  4.             {
  5.                 return Redirect("/home");
  6.             }

  8.             return Redirect("/login");
  9.         }
测试用例：
  1.         [TestMethod()]
  2.         public async Task LoginTest1()
  3.         {
  4.             var authenticationService = new Mock<IAuthenticationService>();
  5.             //设置AuthenticateAsync为success
  6.             authenticationService.Setup(s => s.AuthenticateAsync(It.IsAny<HttpContext>(), It.IsAny<string>()))
  7.                 .ReturnsAsync(AuthenticateResult.Success(new AuthenticationTicket(new System.Security.Claims.ClaimsPrincipal(), "")));
  8.             var sp = new Mock<IServiceProvider>();
  9.             sp.Setup(s => s.GetService(typeof(IAuthenticationService)))
  10.                 .Returns(() => {
  11.                     return authenticationService.Object;
  12.                 });

  14.             var ctrl = new AccountController();
  15.             ctrl.ControllerContext = new ControllerContext();
  16.             ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
  17.             ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;

  19.             var act = await ctrl.Login();
  20.             Assert.IsNotNull(act);
  21.             Assert.IsInstanceOfType(act, typeof(RedirectResult));
  22.             var rd = act as RedirectResult;
  23.             Assert.AreEqual("/home", rd.Url);
  24.             //设置AuthenticateAsync为fail
  25.             authenticationService.Setup(s => s.AuthenticateAsync(It.IsAny<HttpContext>(), It.IsAny<string>()))
  26.                .ReturnsAsync(AuthenticateResult.Fail(""));

  28.             act = await ctrl.Login();
  29.             Assert.IsNotNull(act);
  30.             Assert.IsInstanceOfType(act, typeof(RedirectResult));
  31.             rd = act as RedirectResult;
  32.             Assert.AreEqual("/login", rd.Url);

  34.         }
Filter进行测试
我们写Controller的时候往往需要配合很多Filter使用，所以Filter的测试也很重要。下面演示下如何对Fitler进行测试。
  1.     public class MyFilter: ActionFilterAttribute
  2.     {
  3.         public override void OnActionExecuting(ActionExecutingContext context)
  4.         {
  5.             if (context.HttpContext.Request.Path.Value.Contains("/abc/"))
  6.             {
  7.                 context.Result = new ContentResult() {
  8.                     Content = "拒绝访问"
  9.                 };
  10.             }

  12.             base.OnActionExecuting(context);
  13.         }
  14.     }
对Filter的测试最主要的是模拟ActionExecutingContext参数，以及其中的HttpContext等，然后对预期进行Assert。
  1.        [TestMethod()]
  2.         public void OnActionExecutingTest()
  3.         {
  4.             var filter = new MyFilter();
  5.             var actContext = new ActionContext(new DefaultHttpContext(),new RouteData(), new ActionDescriptor());
  6.             actContext.HttpContext.Request.Path = "/abc/123";
  7.             var listFilters = new List<IFilterMetadata>();
  8.             var argDict = new Dictionary<string, object>();
  9.             var actExContext = new ActionExecutingContext(
  10.                 actContext ,
  11.                 listFilters ,
  12.                 argDict ,
  13.                 new AccountController()
  14.                 );
  15.              filter.OnActionExecuting(actExContext);

  17.             Assert.IsNotNull(actExContext.Result);
  18.             Assert.IsInstanceOfType(actExContext.Result, typeof(ContentResult));
  19.             var cr = actExContext.Result as ContentResult;
  20.             Assert.AreEqual("拒绝访问", cr.Content);

  22.             actContext = new ActionContext(new DefaultHttpContext(), new RouteData(), new ActionDescriptor());
  23.             actContext.HttpContext.Request.Path = "/1/123";
  24.             listFilters = new List<IFilterMetadata>();
  25.             argDict = new Dictionary<string, object>();
  26.             actExContext = new ActionExecutingContext(
  27.                 actContext,
  28.                 listFilters,
  29.                 argDict,
  30.                 new AccountController()
  31.                 );
  32.             filter.OnActionExecuting(actExContext);
  33.             Assert.IsNull(actExContext.Result);
  34.         }
关注我的公众号一起玩转技术

图片


                    

                        这篇关于ASP.NET Core 对Controller进行单元测试的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！
                    


                


                
                
 

                
                

                    

                        
您可能喜欢

                        
                    

                

                

            

             
            
            
            
        

        
        

        

            

                
栏目导航