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

2021/4/24 14:25:24

本文主要是介绍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.        }


  8.        public IActionResult UserInfo(string userId)

  9.        {

  10.            if (string.IsNullOrEmpty(userId))

  11.            {

  12.                throw new ArgumentNullException(nameof(userId));

  13.            }


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

  15.            return View(user);

  16.        }


  17.    }

测试代码:

  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.            var ctrl = new UserController(userService.Object);

  7.            //对空参数进行assert

  8.            Assert.ThrowsException<ArgumentNullException>(() => {

  9.                var result = ctrl.UserInfo(null);

  10.            });

  11.            //对空参数进行assert

  12.            Assert.ThrowsException<ArgumentNullException>(() => {

  13.                var result = ctrl.UserInfo("");

  14.            });


  15.            var result = ctrl.UserInfo("1");

  16.            Assert.IsNotNull(result);

  17.            Assert.IsInstanceOfType(result, typeof(ViewResult));

  18.        }

我们对一个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.            }) ;


  9.            var ctrl = new UserController(userService.Object);

  10.            Assert.ThrowsException<ArgumentNullException>(() => {

  11.                var result = ctrl.UserInfo(null);

  12.            });

  13.            Assert.ThrowsException<ArgumentNullException>(() => {

  14.                var result = ctrl.UserInfo("");

  15.            });


  16.            var result = ctrl.UserInfo("1");

  17.            Assert.IsNotNull(result);

  18.            Assert.IsInstanceOfType(result, typeof(ViewResult));

  19.            //对viewModel进行assert

  20.            var vr = result as ViewResult;

  21.            Assert.IsNotNull(vr.Model);

  22.            Assert.IsInstanceOfType(vr.Model, typeof(User));

  23.            var user = vr.Model as User;

  24.            Assert.AreEqual("x", user.Id);

  25.        }

对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.            }


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


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


  9.            return View(user);

  10.        }

修改测试用例,加入对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.            }) ;


  9.            var ctrl = new UserController(userService.Object);

  10.            Assert.ThrowsException<ArgumentNullException>(() => {

  11.                var result = ctrl.UserInfo(null);

  12.            });

  13.            Assert.ThrowsException<ArgumentNullException>(() => {

  14.                var result = ctrl.UserInfo("");

  15.            });


  16.            var result = ctrl.UserInfo("1");

  17.            Assert.IsNotNull(result);

  18.            Assert.IsInstanceOfType(result, typeof(ViewResult));


  19.            var vr = result as ViewResult;

  20.            Assert.IsNotNull(vr.Model);

  21.            Assert.IsInstanceOfType(vr.Model, typeof(User));

  22.            var user = vr.Model as User;

  23.            Assert.AreEqual("x", user.Id);

  24.            //对viewData进行assert

  25.            Assert.IsTrue(vr.ViewData.ContainsKey("title"));

  26.            var title = vr.ViewData["title"];

  27.            Assert.AreEqual("user_info", title);

  28.        }

对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.            }) ;


  9.            var ctrl = new UserController(userService.Object);

  10.            Assert.ThrowsException<ArgumentNullException>(() => {

  11.                var result = ctrl.UserInfo(null);

  12.            });

  13.            Assert.ThrowsException<ArgumentNullException>(() => {

  14.                var result = ctrl.UserInfo("");

  15.            });


  16.            var result = ctrl.UserInfo("1");

  17.            Assert.IsNotNull(result);

  18.            Assert.IsInstanceOfType(result, typeof(ViewResult));


  19.            var vr = result as ViewResult;

  20.            Assert.IsNotNull(vr.Model);

  21.            Assert.IsInstanceOfType(vr.Model, typeof(User));

  22.            var user = vr.Model as User;

  23.            Assert.AreEqual("x", user.Id);


  24.            Assert.IsTrue(vr.ViewData.ContainsKey("title"));

  25.            var title = vr.ViewData["title"];

  26.            Assert.AreEqual("user_info", title);

  27.            //对viewBag进行assert

  28.            string title1 = ctrl.ViewBag.title;

  29.            Assert.AreEqual("user_info", title1);

  30.        }

设置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.            }


  20.            return Redirect("login_fail");

  21.        }

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();


  5.            var authenticationService = new Mock<IAuthenticationService>();

  6.            var sp = new Mock<IServiceProvider>();

  7.            sp.Setup(s => s.GetService(typeof(IAuthenticationService)))

  8.                .Returns(() => {

  9.                    return authenticationService.Object;

  10.                });

  11.            ctrl.ControllerContext = new ControllerContext();

  12.            ctrl.ControllerContext.HttpContext = new DefaultHttpContext();

  13.            ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;


  14.           var result = await ctrl.Login("123");

  15.            Assert.IsNotNull(result);

  16.            Assert.IsInstanceOfType(result, typeof(RedirectResult));

  17.            var rr = result as RedirectResult;

  18.            Assert.AreEqual("login_success", rr.Url);


  19.            result = await ctrl.Login("1");

  20.            Assert.IsNotNull(result);

  21.            Assert.IsInstanceOfType(result, typeof(RedirectResult));

  22.            rr = result as RedirectResult;

  23.            Assert.AreEqual("login_fail", rr.Url);

  24.        }

对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.            }


  7.            return Redirect("/login");

  8.        }

测试用例:

  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.                });


  13.            var ctrl = new AccountController();

  14.            ctrl.ControllerContext = new ControllerContext();

  15.            ctrl.ControllerContext.HttpContext = new DefaultHttpContext();

  16.            ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;


  17.            var act = await ctrl.Login();

  18.            Assert.IsNotNull(act);

  19.            Assert.IsInstanceOfType(act, typeof(RedirectResult));

  20.            var rd = act as RedirectResult;

  21.            Assert.AreEqual("/home", rd.Url);

  22.            //设置AuthenticateAsync为fail

  23.            authenticationService.Setup(s => s.AuthenticateAsync(It.IsAny<HttpContext>(), It.IsAny<string>()))

  24.               .ReturnsAsync(AuthenticateResult.Fail(""));


  25.            act = await ctrl.Login();

  26.            Assert.IsNotNull(act);

  27.            Assert.IsInstanceOfType(act, typeof(RedirectResult));

  28.            rd = act as RedirectResult;

  29.            Assert.AreEqual("/login", rd.Url);


  30.        }

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.            }


  11.            base.OnActionExecuting(context);

  12.        }

  13.    }

对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);


  16.            Assert.IsNotNull(actExContext.Result);

  17.            Assert.IsInstanceOfType(actExContext.Result, typeof(ContentResult));

  18.            var cr = actExContext.Result as ContentResult;

  19.            Assert.AreEqual("拒绝访问", cr.Content);


  20.            actContext = new ActionContext(new DefaultHttpContext(), new RouteData(), new ActionDescriptor());

  21.            actContext.HttpContext.Request.Path = "/1/123";

  22.            listFilters = new List<IFilterMetadata>();

  23.            argDict = new Dictionary<string, object>();

  24.            actExContext = new ActionExecutingContext(

  25.                actContext,

  26.                listFilters,

  27.                argDict,

  28.                new AccountController()

  29.                );

  30.            filter.OnActionExecuting(actExContext);

  31.            Assert.IsNull(actExContext.Result);

  32.        }

关注我的公众号一起玩转技术

图片




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


扫一扫关注最新编程教程