ASP.NET Core對Controller進(jìn)行單元測試的完整步驟
更新時間：2020年06月19日 08:40:47 作者：Agile.Zhou
這篇文章主要給大家介紹了關(guān)于ASP.NET Core對Controller進(jìn)行單元測試的完整步驟，文中通過示例代碼介紹的非常詳細(xì)，對大家學(xué)習(xí)或者使用ASP.NET Core具有一定的參考學(xué)習(xí)價值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧
前言
單元測試對我們的代碼質(zhì)量非常重要。很多同學(xué)都會對業(yè)務(wù)邏輯或者工具方法寫測試用例，但是往往忽略了對Controller層寫單元測試。我所在的公司沒見過一個對Controller寫過測試的。今天來演示下如果對Controller進(jìn)行單元測試。以下內(nèi)容默認(rèn)您對單元測試有所了解，比如如何mock一個接口。在這里多叨叨一句，面向接口的好處，除了能夠快速的替換實(shí)現(xiàn)類（其實(shí)大部分接口不會有多個實(shí)現(xiàn)），最大的好處就是可以進(jìn)行mock，可以進(jìn)行單元測試。
測試Action
下面的Action非常簡單，非常常見的一種代碼。根據(jù)用戶id去獲取用戶信息然后展示出來。下面看看如何對這個Action進(jìn)行測試。
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);
//對空參數(shù)進(jìn)行assert
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo(null);
});
//對空參數(shù)進(jìn)行assert
Assert.ThrowsException<ArgumentNullException>(() => {
var result = ctrl.UserInfo("");
});
var result = ctrl.UserInfo("1");
Assert.IsNotNull(result);
Assert.IsInstanceOfType(result, typeof(ViewResult));
}
我們對一個Action進(jìn)行測試主要的思路就是模擬各種入?yún)?，使測試代碼能夠到達(dá)所有的分支，并且Assert輸出是否為空，是否為指定的類型等。
對ViewModel進(jìn)行測試
我們編寫Action的時候還會涉及ViewModel給視圖傳遞數(shù)據(jù)，這部分也需要進(jìn)行測試。修改測試用例，加入對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進(jìn)行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進(jìn)行測試
我們編寫Action的時候還會涉及ViewData給視圖傳遞數(shù)據(jù)，這部分同樣需要測試。修改Action代碼，對ViewData進(jìn)行賦值：
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進(jìn)行assert
Assert.IsTrue(vr.ViewData.ContainsKey("title"));
var title = vr.ViewData["title"];
Assert.AreEqual("user_info", title);
}
對ViewBag進(jìn)行測試
因?yàn)閂iewBag事實(shí)上是ViewData的dynamic類型的包裝，所以Action代碼不用改，可以直接對ViewBag進(jìn)行測試：
[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進(jìn)行assert
string title1 = ctrl.ViewBag.title;
Assert.AreEqual("user_info", title1);
}
設(shè)置HttpContext
我們編寫Action的時候很多時候需要調(diào)用基類里的HttpContext，比如獲取Request對象，獲取Path，獲取Headers等等，所以有的時候需要自己實(shí)例化HttpContext以進(jìn)行測試。
var ctrl = new AccountController(); ctrl.ControllerContext = new ControllerContext(); ctrl.ControllerContext.HttpContext = new DefaultHttpContext();
對HttpContext.SignInAsync進(jìn)行mock
我們使用ASP.NET Core框架進(jìn)行登錄認(rèn)證的時候，往往使用HttpContext.SignInAsync進(jìn)行認(rèn)證授權(quán)，所以單元測試的時候也需要進(jìn)行mock。下面是一個典型的登錄Action，對密碼進(jìn)行認(rèn)證后調(diào)用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其實(shí)個時擴(kuò)展方法，SignInAsync其實(shí)最終是調(diào)用了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進(jìn)行mock
HttpContext.AuthenticateAsync同樣比較常用。這個擴(kuò)展方法同樣是在IAuthenticationService里，所以測試代碼跟上面的SignInAsync類似，只是需要對AuthenticateAsync繼續(xù)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>();
//設(shè)置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);
//設(shè)置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進(jìn)行測試
我們寫Controller的時候往往需要配合很多Filter使用，所以Filter的測試也很重要。下面演示下如何對Fitler進(jìn)行測試。
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參數(shù)，以及其中的HttpContext等，然后對預(yù)期進(jìn)行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);
}
總結(jié)
到此這篇關(guān)于ASP.NET Core對Controller進(jìn)行單元測試的文章就介紹到這了,更多相關(guān)ASP.NET Core對Controller單元測試內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
最近修改了個分頁存儲過程，作為菜鳥，還是從中獲益良多，這里就開始今天的分頁之旅了2011-10-10
asp.net JSONHelper JSON幫助類2010-01-01
用ASP.NET編寫能夠顯示圖標(biāo)漸變的效果，簡單實(shí)用，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2015-09-09
詳解ASP.NET Core 中基于工廠的中間件激活的實(shí)現(xiàn)方法
這篇文章主要介紹了ASP.NET Core 中基于工廠的中間件激活的實(shí)現(xiàn)方法，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-11-11
這篇文章主要為大家詳細(xì)介紹了NetCore1.1+Linux部署的初體驗(yàn)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-06-06
解析GridView自帶分頁及與DropDownList結(jié)合使用
本文主要介紹了GridView自帶的分頁功能的實(shí)現(xiàn)方法。具有一定的參考價值，需要的朋友一起來看下吧2016-12-12
下面小編就為大家分享一篇WPF水珠效果按鈕組的實(shí)現(xiàn)教程，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2017-12-12
以前在學(xué)習(xí)Asp.net時備受困擾的就是提交驗(yàn)證這塊，網(wǎng)上流行的關(guān)于圖片驗(yàn)證的教程大都存在很多問題2008-10-10
WEB上調(diào)用HttpWebRequest奇怪問題的解決方法
WEB上調(diào)用HttpWebRequest奇怪問題的解決方法...2007-04-04
asp.net源程序編譯為dll文件并調(diào)用的實(shí)現(xiàn)過程
這篇文章主要介紹了asp.net源程序編譯為dll文件并調(diào)用的實(shí)現(xiàn)過程,非常有實(shí)用價值,需要的朋友可以參考下2014-07-07