C# 返回 IHttpActionResult 时，如何对 Web api 操作方法进行单元测试？
声明：本页面是StackOverFlow热门问题的中英对照翻译，遵循CC BY-SA 4.0协议，如果您需要使用它，必须同样遵循CC BY-SA许可，注明原文地址和作者信息，同时你必须将它归于原作者（不是我）：StackOverFlow
原文地址: http://stackoverflow.com/questions/19936892/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me):
StackOverFlow
How do I unit test web api action method when it returns IHttpActionResult?
提问by sunil
Let's assume this is my action method
让我们假设这是我的操作方法
public IHttpActionResult Get(int id)
{
var status = GetSomething(id);
if (status)
{
return Ok();
}
else
{
return NotFound();
}
}
Test will be
测试将
var httpActionResult = controller.Get(1);
How do I check my http status code after this?
在此之后如何检查我的 http 状态代码？
采纳答案by Kiran Challa
Here Ok()is just a helper for the type OkResultwhich sets the response status to be HttpStatusCode.Ok...so you can just check if the instance of your action result is an OkResult...some examples(written in XUnit):
这Ok()只是OkResult将响应状态设置为HttpStatusCode.Ok...的类型的助手，因此您可以检查您的操作结果的实例是否是OkResult...一些示例（用 编写XUnit）：
// if your action returns: NotFound()
IHttpActionResult actionResult = valuesController.Get(10);
Assert.IsType<NotFoundResult>(actionResult);
// if your action returns: Ok()
actionResult = valuesController.Get(11);
Assert.IsType<OkResult>(actionResult);
// if your action was returning data in the body like: Ok<string>("data: 12")
actionResult = valuesController.Get(12);
OkNegotiatedContentResult<string> conNegResult = Assert.IsType<OkNegotiatedContentResult<string>>(actionResult);
Assert.Equal("data: 12", conNegResult.Content);
// if your action was returning data in the body like: Content<string>(HttpStatusCode.Accepted, "some updated data");
actionResult = valuesController.Get(13);
NegotiatedContentResult<string> negResult = Assert.IsType<NegotiatedContentResult<string>>(actionResult);
Assert.Equal(HttpStatusCode.Accepted, negResult.StatusCode);
Assert.Equal("some updated data", negResult.Content);
回答by Stanislav
This is the accepted answer by Kiran Challa, adapted for NUnit;
这是 Kiran Challa 接受的答案，适用于 NUnit；
var valuesController = controller;
// if your action returns: NotFound()
IHttpActionResult actionResult = valuesController.Get(10);
var notFoundRes = actionResult as NotFoundResult;
Assert.IsNotNull(notFoundRes);
// if your action returns: Ok()
actionResult = valuesController.Get(11);
var posRes = actionResult as OkResult;
Assert.IsNotNull(posRes);
// if your action was returning data in the body like: Ok<string>("data: 12")
actionResult = valuesController.Get(12);
var conNegResult = actionResult as OkNegotiatedContentResult<string>;
Assert.IsNotNull(conNegResult);
Assert.AreEqual("data: 12", conNegResult.Content);
// if your action was returning data in the body like: Content<string>(HttpStatusCode.Accepted, "some updated data");
actionResult = valuesController.Get(13);
var negResult = actionResult as NegotiatedContentResult<string>;
Assert.IsNotNull(negResult);
Assert.AreEqual(HttpStatusCode.Accepted, negResult.StatusCode);
Assert.AreEqual("some updated data", negResult.Content);
回答by psaxton
Time to resurrect a dead question
是时候复活一个死问题了
The current answers all rely on casting the response object to a known type. Unfortunately, the responses do not seem to have a useable hierarchy or implicit conversion path for this to work without intimate knowledge of the controller implementation. Consider the following:
当前的答案都依赖于将响应对象转换为已知类型。不幸的是，如果没有对控制器实现的深入了解，响应似乎没有可用的层次结构或隐式转换路径。考虑以下：
public class MixedCodeStandardController : ApiController {
public readonly object _data = new Object();
public IHttpActionResult Get() {
return Ok(_data);
}
public IHttpActionResult Get(int id) {
return Content(HttpStatusCode.Success, _data);
}
}
Testing the class:
测试类：
var testController = new MixedCodeStandardController();
var getResult = testController.Get();
var posRes = getResult as OkNegotiatedContentResult<object>;
Assert.IsType<OkNegotiatedContentResult<object>>(getResult);
Assert.AreEqual(HttpStatusCode.Success, posRes.StatusCode);
Assert.AreEqual(testController._data, posRes.Content);
var idResult = testController.Get(1);
var oddRes = getResult as OkNegotiatedContentResult<object>; // oddRes is null
Assert.IsType<OkNegotiatedContentResult<object>>(idResult); // throws failed assertion
Assert.AreEqual(HttpStatusCode.Success, oddRes.StatusCode); // throws for null ref
Assert.AreEqual(testController._data, oddRes.Content); // throws for null ref
From outside the black box, the response stream is essentially the same. The test must know how the controller implemented the return call to test it in this way.
从黑匣子外部来看，响应流本质上是相同的。测试必须知道控制器如何实现返回调用以这种方式测试它。
Instead, use the HttpResponseMessage object from the IHttpActionResult returned. This ensures the test can be consistent, even when the controller code may not be:
而是使用返回的 IHttpActionResult 中的 HttpResponseMessage 对象。这确保测试可以保持一致，即使控制器代码可能不是：
var testController = new MixedCodeStandardController();
var getResult = testController.Get();
var getResponse = getResult.ExecuteAsync(CancellationToken.None).Result;
Assert.IsTrue(getResponse.IsSuccessStatusCode);
Assert.AreEqual(HttpStatusCode.Success, getResponse.StatusCode);
var idResult = testController.Get(1);
var idResponse = idResult.ExecuteAsync(CancellationToken.None).Result;
Assert.IsTrue(idResponse.IsSuccessStatusCode);
Assert.AreEqual(HttpStatusCode.Success, idResponse.StatusCode);
回答by Kenmeister
Assert.IsInstanceOfType(httpActionResult, typeof(OkResult));
Assert.IsInstanceOfType(httpActionResult, typeof(OkResult));
回答by Mickey
If IHttpActionResult contain a JSON object, e.g. {"token":"A"}, we can use the following code.
如果 IHttpActionResult 包含一个 JSON 对象，例如 {"token":"A"}，我们可以使用以下代码。
var result = usercontroller.GetLogin("user", "password");
Assert.IsInstanceOfType(result, typeof(OkNegotiatedContentResult<Dictionary<string,string>>));
var content = result as OkNegotiatedContentResult<Dictionary<string, string> >;
Assert.AreEqual("A", content.Content["token"]);
回答by Shahin Dohan
After a few hours of research and trying, I finally figured out how to fully test my Web API 2 methods that return IHttpActionResultand use the OWIN middleware and the default implementation of ASP.NET Identity.
经过几个小时的研究和尝试，我终于想出了如何全面测试我的 Web API 2 方法，这些方法返回IHttpActionResult和使用 OWIN 中间件和 ASP.NET Identity 的默认实现。
I will be testing the Get()method on the following ApiController:
我将Get()在以下方面测试该方法ApiController：
public class AccountController : ApiController
{
private ApplicationUserManager _userManager;
public ApplicationUserManager UserManager => _userManager ?? HttpContext.Current.GetOwinContext().GetUserManager<ApplicationUserManager>();
[Route("api/account"), HttpGet]
public async Task<IHttpActionResult> Get()
{
var user = await UserManager.FindByIdAsync(User.Identity.GetUserId());
if (user == null)
{
ModelState.AddModelError(ModelStateConstants.Errors, "Account not found! Try logging out and in again.");
return BadRequest(ModelState);
}
var roles = await UserManager.GetRolesAsync(user.Id);
var accountModel = new AccountViewModel
{
FullName = user.FullName,
Email = user.Email,
Phone = user.PhoneNumber,
Organization = user.Organization.Name,
Role = string.Join(", ", roles)
};
return Ok(accountModel);
}
protected override void Dispose(bool disposing)
{
if (disposing)
{
if (_userManager != null)
{
_userManager.Dispose();
_userManager = null;
}
}
base.Dispose(disposing);
}
}
Start with a base class that all test classes will inherit from:
从所有测试类都将继承的基类开始：
public class BaseTest
{
protected static User CurrentUser;
protected static IList<string> Roles;
public BaseTest()
{
var email = "[email protected]";
CurrentUser = new User
{
FullName = "Unit Tester",
Email = email,
UserName = email,
PhoneNumber = "123456",
Organization = new Organization
{
Name = "Test Organization"
}
};
Roles = new List<string>
{
"Administrator"
};
}
protected void InitializeApiController(ApiController apiController)
{
//Init fake controller Http and Identity data
var config = new HttpConfiguration();
var request = new HttpRequestMessage();
var routeData = new HttpRouteData(new HttpRoute(""));
apiController.ControllerContext = new HttpControllerContext(config, routeData, request)
{
Configuration = config
};
apiController.User = new GenericPrincipal(new GenericIdentity(""), new[] { "" });
//Initialize Mocks
var appUserMgrMock = GetMockedApplicationUserManager();
var appSignInMgr = GetMockedApplicationSignInManager(appUserMgrMock);
var appDbContext = GetMockedApplicationDbContext();
//Configure HttpContext.Current.GetOwinContext to return mocks
var owin = new OwinContext();
owin.Set(appUserMgrMock.Object);
owin.Set(appSignInMgr.Object);
owin.Set(appDbContext.Object);
HttpContext.Current = new HttpContext(new HttpRequest(null, "http://test.com", null), new HttpResponse(null));
HttpContext.Current.Items["owin.Environment"] = owin.Environment;
}
private static Mock<ApplicationSignInManager> GetMockedApplicationSignInManager(Mock<ApplicationUserManager> appUserMgrMock)
{
var authMgr = new Mock<Microsoft.Owin.Security.IAuthenticationManager>();
var appSignInMgr = new Mock<ApplicationSignInManager>(appUserMgrMock.Object, authMgr.Object);
return appSignInMgr;
}
private Mock<ApplicationUserManager> GetMockedApplicationUserManager()
{
var userStore = new Mock<IUserStore<User>>();
var appUserMgr = new Mock<ApplicationUserManager>(userStore.Object);
appUserMgr.Setup(aum => aum.FindByIdAsync(It.IsAny<string>())).ReturnsAsync(CurrentUser);
appUserMgr.Setup(aum => aum.GetRolesAsync(It.IsAny<string>())).ReturnsAsync(Roles);
return appUserMgr;
}
private static Mock<ApplicationDbContext> GetMockedApplicationDbContext()
{
var dbContext = new Mock<ApplicationDbContext>();
dbContext.Setup(dbc => dbc.Users).Returns(MockedUsersDbSet);
return dbContext;
}
private static IDbSet<User> MockedUsersDbSet()
{
var users = new List<User>
{
CurrentUser,
new User
{
FullName = "Testguy #1",
Email = "[email protected]",
UserName = "[email protected]",
PhoneNumber = "123456",
Organization = new Organization
{
Name = "Test Organization"
}
}
}.AsQueryable();
var usersMock = new Mock<DbSet<User>>();
usersMock.As<IQueryable<User>>().Setup(m => m.Provider).Returns(users.Provider);
usersMock.As<IQueryable<User>>().Setup(m => m.Expression).Returns(users.Expression);
usersMock.As<IQueryable<User>>().Setup(m => m.ElementType).Returns(users.ElementType);
usersMock.As<IQueryable<User>>().Setup(m => m.GetEnumerator()).Returns(users.GetEnumerator);
return usersMock.Object;
}
}
The InitializeApiControllermethod contains the meat and potatoes.
该InitializeApiController方法包含肉和土豆。
Now we can write our tests for AccountController:
现在我们可以编写我们的测试AccountController：
public class AccountControllerTests : BaseTest
{
private readonly AccountController _accountController;
public AccountControllerTests()
{
_accountController = new AccountController();
InitializeApiController(_accountController);
}
[Test]
public async Task GetShouldReturnOk()
{
var result = await _accountController.Get();
var response = await result.ExecuteAsync(CancellationToken.None);
Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
}
}
For everything to work, you'll need to install a bunch of Microsoft.OWIN.*and Microsoft.AspNet.*packages, I'll paste my packages.confighere:
为了一切正常，你需要安装一堆Microsoft.OWIN.*和Microsoft.AspNet.*包，我会packages.config在这里粘贴我的：
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Castle.Core" version="4.3.1" targetFramework="net472" />
<package id="EntityFramework" version="6.2.0" targetFramework="net472" />
<package id="Microsoft.AspNet.Identity.Core" version="2.2.2" targetFramework="net472" />
<package id="Microsoft.AspNet.Identity.EntityFramework" version="2.2.2" targetFramework="net472" />
<package id="Microsoft.AspNet.Identity.Owin" version="2.2.2" targetFramework="net472" />
<package id="Microsoft.AspNet.WebApi.Client" version="5.2.7" targetFramework="net472" />
<package id="Microsoft.AspNet.WebApi.Core" version="5.2.7" targetFramework="net472" />
<package id="Microsoft.AspNet.WebApi.Owin" version="5.2.7" targetFramework="net472" />
<package id="Microsoft.Owin" version="4.0.1" targetFramework="net472" />
<package id="Microsoft.Owin.Host.SystemWeb" version="4.0.1" targetFramework="net472" />
<package id="Microsoft.Owin.Security" version="4.0.1" targetFramework="net472" />
<package id="Microsoft.Owin.Security.Cookies" version="4.0.1" targetFramework="net472" />
<package id="Microsoft.Owin.Security.OAuth" version="4.0.1" targetFramework="net472" />
<package id="Moq" version="4.10.1" targetFramework="net472" />
<package id="Newtonsoft.Json" version="12.0.1" targetFramework="net472" />
<package id="NUnit" version="3.11.0" targetFramework="net472" />
<package id="Owin" version="1.0" targetFramework="net472" />
<package id="System.Runtime.CompilerServices.Unsafe" version="4.5.2" targetFramework="net472" />
<package id="System.Threading.Tasks.Extensions" version="4.5.2" targetFramework="net472" />
</packages>
The test is very simple, but demonstrates that everything works :-)
测试非常简单，但表明一切正常:-)
Happy testing!
测试愉快！
