ASP.NET Core 对Controller进行单元测试
单元测试对我们的代码质量非常重要。很多同学都会对业务逻辑或者工具方法写测试用例，但是往往忽略了对Controller层写单元测试。我所在的公司没见过一个对Controller写过测试的。今天来演示下如果对Controller进行单元测试。以下内容默认您对单元测试有所了解，比如如何mock一个接口。在这里多叨叨一句，面向接口的好处，除了能够快速的替换实现类（其实大部分接口不会有多个实现），最大的好处就是可以进行mock，可以进行单元测试。
测试Action
下面的Action非常简单，非常常见的一种代码。根据用户id去获取用户信息然后展示出来。下面看看如何对这个Action进行测试。
public class UserController : Controller
{
private readonly IUserService _userService;
public UserController(IUserService userService)
{
_userService = userService;
}
public IActionResult UserInfo(string userId)
{
if (string.IsNullOrEmpty(userId))
{
throw new ArgumentNullException(nameof(userId));
}
var user = _userService.Get(userId);
return View(user);
}
}
测试代码：
[TestMethod()]
public void UserInfoTest()
{
var userService = new Mock<IUserService>();
userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User());
var ctrl = new UserController(userService.Object);
//对空参数进行assert
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo(null);
});
//对空参数进行assert
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo("");
});
var result = ctrl.UserInfo("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(ViewResult));
}
我们对一个Action进行测试主要的思路就是模拟各种入参，使测试代码能够到达所有的分支，并且Assert输出是否为空，是否为指定的类型等。
对ViewModel进行测试
我们编写Action的时候还会涉及ViewModel给视图传递数据，这部分也需要进行测试。修改测试用例，加入对ViewModel的测试代码：
[TestMethod()]
public void UserInfoTest()
{
var userService = new Mock<IUserService>();
userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
{
Id = "x"
}) ;
var ctrl = new UserController(userService.Object);
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo(null);
});
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo("");
});
var result = ctrl.UserInfo("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(ViewResult));
//对viewModel进行assert
var vr = result as ViewResult;
Assert.IsNotNull(vr.Model);
Assert.IsInstanceOfType(vr.Model, typeof(User));
var user = vr.Model as User;
Assert.AreEqual("x", user.Id);
}
对ViewData进行测试
我们编写Action的时候还会涉及ViewData给视图传递数据，这部分同样需要测试。修改Action代码，对ViewData进行赋值：
public IActionResult UserInfo(string userId)
{
if (string.IsNullOrEmpty(userId))
{
throw new ArgumentNullException(nameof(userId));
}
var user = _userService.Get(userId);
ViewData["title"] = "user_info";
return View(user);
}
修改测试用例，加入对ViewData的测试代码：
[TestMethod()]
public void UserInfoTest()
{
var userService = new Mock<IUserService>();
userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
{
Id = "x"
}) ;
var ctrl = new UserController(userService.Object);
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo(null);
});
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo("");
});
var result = ctrl.UserInfo("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(ViewResult));
var vr = result as ViewResult;
Assert.IsNotNull(vr.Model);
Assert.IsInstanceOfType(vr.Model, typeof(User));
var user = vr.Model as User;
Assert.AreEqual("x", user.Id);
//对viewData进行assert
Assert.IsTrue(vr.ViewData.ContainsKey("title"));
var title = vr.ViewData["title"];
Assert.AreEqual("user_info", title);
}
对ViewBag进行测试
因为ViewBag事实上是ViewData的dynamic类型的包装，所以Action代码不用改，可以直接对ViewBag进行测试：
[TestMethod()]
public void UserInfoTest()
{
var userService = new Mock<IUserService>();
userService.Setup(s => s.Get(It.IsAny<string>())).Returns(new User()
{
Id = "x"
}) ;
var ctrl = new UserController(userService.Object);
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo(null);
});
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo("");
});
var result = ctrl.UserInfo("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(ViewResult));
var vr = result as ViewResult;
Assert.IsNotNull(vr.Model);
Assert.IsInstanceOfType(vr.Model, typeof(User));
var user = vr.Model as User;
Assert.AreEqual("x", user.Id);
Assert.IsTrue(vr.ViewData.ContainsKey("title"));
var title = vr.ViewData["title"];
Assert.AreEqual("user_info", title);
//对viewBag进行assert
string title1 = ctrl.ViewBag.title;
Assert.AreEqual("user_info", title1);
}
设置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在客户端生成登录凭证，否则跳到登录失败页面。
public async Task<IActionResult> Login(string password)
{
if (password == "123")
{
var claims = new List<Claim>
{
new Claim("UserName","x")
};
var authProperties = new AuthenticationProperties
{
};
var claimsIdentity = new ClaimsIdentity(
claims, CookieAuthenticationDefaults.AuthenticationScheme);
await HttpContext.SignInAsync(
CookieAuthenticationDefaults.AuthenticationScheme,
new ClaimsPrincipal(claimsIdentity),
authProperties);
return Redirect("login_success");
}
return Redirect("login_fail");
}
HttpContext.SignInAsync其实个时扩展方法，SignInAsync其实最终是调用了IAuthenticationService里的SignInAsync方法。所以我们需要mock的就是IAuthenticationService接口，否者代码走到HttpContext.SignInAsync会提示找不到IAuthenticationService的service。而IAuthenticationService本身是通过IServiceProvider注入到程序里的，所以同时需要mock接口IServiceProvider。
[TestMethod()]
public async Task LoginTest()
{
var ctrl = new AccountController();
var authenticationService = new Mock<IAuthenticationService>();
var sp = new Mock<IServiceProvider>();
sp.Setup(s => s.GetService(typeof(IAuthenticationService)))
.Returns(() => {
return authenticationService.Object;
});
ctrl.ControllerContext = new ControllerContext();
ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;
var result = await ctrl.Login("123");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(RedirectResult));
var rr = result as RedirectResult;
Assert.AreEqual("login_success", rr.Url);
result = await ctrl.Login("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(RedirectResult));
rr = result as RedirectResult;
Assert.AreEqual("login_fail", rr.Url);
}
对HttpContext.AuthenticateAsync进行mock
HttpContext.AuthenticateAsync同样比较常用。这个扩展方法同样是在IAuthenticationService里，所以测试代码跟上面的SignInAsync类似，只是需要对AuthenticateAsync继续mock返回值success or fail。
public async Task<IActionResult> Login()
{
if ((await HttpContext.AuthenticateAsync()).Succeeded)
{
return Redirect("/home");
}
return Redirect("/login");
}
测试用例：
[TestMethod()]
public async Task LoginTest1()
{
var authenticationService = new Mock<IAuthenticationService>();
//设置AuthenticateAsync为success
authenticationService.Setup(s => s.AuthenticateAsync(It.IsAny<HttpContext>(), It.IsAny<string>()))
.ReturnsAsync(AuthenticateResult.Success(new AuthenticationTicket(new System.Security.Claims.ClaimsPrincipal(), "")));
var sp = new Mock<IServiceProvider>();
sp.Setup(s => s.GetService(typeof(IAuthenticationService)))
.Returns(() => {
return authenticationService.Object;
});
var ctrl = new AccountController();
ctrl.ControllerContext = new ControllerContext();
ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
ctrl.ControllerContext.HttpContext.RequestServices = sp.Object;
var act = await ctrl.Login();
Assert.IsNotNull(act);
Assert.IsInstanceOfType(act, typeof(RedirectResult));
var rd = act as RedirectResult;
Assert.AreEqual("/home", rd.Url);
//设置AuthenticateAsync为fail
authenticationService.Setup(s => s.AuthenticateAsync(It.IsAny<HttpContext>(), It.IsAny<string>()))
.ReturnsAsync(AuthenticateResult.Fail(""));
act = await ctrl.Login();
Assert.IsNotNull(act);
Assert.IsInstanceOfType(act, typeof(RedirectResult));
rd = act as RedirectResult;
Assert.AreEqual("/login", rd.Url);
}
Filter进行测试
我们写Controller的时候往往需要配合很多Filter使用，所以Filter的测试也很重要。下面演示下如何对Fitler进行测试。
public class MyFilter: ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext context)
{
if (context.HttpContext.Request.Path.Value.Contains("/abc/"))
{
context.Result = new ContentResult() {
Content = "拒绝访问"
};
}
base.OnActionExecuting(context);
}
}
对Filter的测试最主要的是模拟ActionExecutingContext参数，以及其中的HttpContext等，然后对预期进行Assert。
[TestMethod()]
public void OnActionExecutingTest()
{
var filter = new MyFilter();
var actContext = new ActionContext(new DefaultHttpContext(),new RouteData(), new ActionDescriptor());
actContext.HttpContext.Request.Path = "/abc/123";
var listFilters = new List<IFilterMetadata>();
var argDict = new Dictionary<string, object>();
var actExContext = new ActionExecutingContext(
actContext ,
listFilters ,
argDict ,
new AccountController()
);
filter.OnActionExecuting(actExContext);
Assert.IsNotNull(actExContext.Result);
Assert.IsInstanceOfType(actExContext.Result, typeof(ContentResult));
var cr = actExContext.Result as ContentResult;
Assert.AreEqual("拒绝访问", cr.Content);
actContext = new ActionContext(new DefaultHttpContext(), new RouteData(), new ActionDescriptor());
actContext.HttpContext.Request.Path = "/1/123";
listFilters = new List<IFilterMetadata>();
argDict = new Dictionary<string, object>();
actExContext = new ActionExecutingContext(
actContext,
listFilters,
argDict,
new AccountController()
);
filter.OnActionExecuting(actExContext);
Assert.IsNull(actExContext.Result);
}
ASP.NET Core 对Controller进行单元测试的更多相关文章
- Asp.Net Core 减少Controller获取重复注入对象
原文:Asp.Net Core 减少Controller获取重复注入对象 版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/u012770274/art ...
- How to read request body in a asp.net core webapi controller?
原文 How to read request body in a asp.net core webapi controller? A clearer solution, works in ASP.Ne ...
- 测试 ASP.NET Core API Controller
本文需要您了解ASP.NET Core MVC/Web API, xUnit以及Moq相关知识. 这里有xUnit和Moq的介绍: https://www.cnblogs.com/cgzl/p/917 ...
- asp.net core 声明controller的方法
1, 对类名直接添加Controller, 如TestController. 2, 继承Controller 类. 3, 对类名添加controller的属性, 如[Controller]
- ASP.NET Core 入门（3）（单元测试Xunit及Shouldly的使用）
一.本篇简单介绍下在ASP.NET Core项目如何使用单元测试,例子是使用VS自带的Xunit来测试Web API接口,加上一款开源的断言工具Shouldly,方便写出更简洁.可读行更好的测试代码. ...
- Asp.Net Core 单元测试正确姿势
背景 ASP.NET Core 支持依赖关系注入 (DI) 软件设计模式,并且默认注入了很多服务,具体可以参考 官方文档, 相信只要使用过依赖注入框架的同学,都会对此有不同深入的理解,在此无需赘言. ...
- ASP.NET Core中的Controller
ASP.NET CORE出现之前我们实现的Controller,MVC都继承自Controller基类,WebApi的话继承自ApiController.现在ASP.NET CORE把MVC跟WebA ...
- ASP.NET Core Controller与IOC的羁绊
前言 看到标题可能大家会有所疑问Controller和IOC能有啥羁绊,但是我还是拒绝当一个标题党的.相信有很大一部分人已经知道了这么一个结论,默认情况下ASP.NET Core的Controller ...
- Asp.Net Core 轻松学-利用xUnit进行主机级别的网络集成测试
前言 在开发 Asp.Net Core 应用程序的过程中,我们常常需要对业务代码编写单元测试,这种方法既快速又有效,利用单元测试做代码覆盖测试,也是非常必要的事情:但是,但我们需要对系统进行集 ...
随机推荐
- 这次终于可以愉快的进行 appium 自动化测试了
appium 是进行 app 自动化测试非常成熟的一套框架.但是因为 appium 设计到的安装内容比较多,很多同学入门都跪在了环境安装的部分.本篇讲述 appium 安卓环境的搭建,希望让更多童鞋轻 ...
- group by和having注意事项
执行和编写顺序:join->where->group by->having 其中where与having的区别: where用于在group by分组之前过滤掉某些行, group ...
- Spring Cloud Stream微服务消息框架
简介 随着近些年微服务在国内的盛行,消息驱动被提到的越来越多.主要原因是系统被拆分成多个模块后,一个业务往往需要在多个服务间相互调用,不管是采用HTTP还是RPC都是同步的,不可避免快等慢的情况发生, ...
- 【译】Gartner CWPP市场指南
https://www.gartner.com/doc/reprints?id=1-1YSHGBQ8&ct=200416&st=sb?utm_source=marketo&ut ...
- 2020本科校招-从小白到拿到30k offer的学习经历
本文是个人的2020年年中总结 还有十几天就要毕业,面临着身份从学生到互联网社畜的转变,未来的一切捉摸不定,但凡心中万千情绪,也只能「但行好事,莫问前程」. 介绍下博主背景:计算机本科大四,刚进大三时 ...
- jchdl - RTL实例 - And
https://mp.weixin.qq.com/s/86d_sFN0xVqk1xRaRyoAkg 使用rtl语法,实现简单的与门. 参考链接 https://github.com/wjcdx ...
- java eclipse tomcat
Port 8080 required by Tomcat v9.0 Server at localhost is already in use. The server may already be r ...
- CSDN怎么跳转到指定的位置
位置1 只需要给上面的链接和下面的id一致即可 位置1
- Java实现 LeetCode 424 替换后的最长重复字符
424. 替换后的最长重复字符 给你一个仅由大写英文字母组成的字符串,你可以将任意位置上的字符替换成另外的字符,总共可最多替换 k 次.在执行上述操作后,找到包含重复字母的最长子串的长度. 注意: 字 ...
- Java实现 LeetCode 309 最佳买卖股票时机含冷冻期
309. 最佳买卖股票时机含冷冻期 给定一个整数数组,其中第 i 个元素代表了第 i 天的股票价格 . 设计一个算法计算出最大利润.在满足以下约束条件下,你可以尽可能地完成更多的交易(多次买卖一支股 ...