我想在我的 WebAPI 控制器上“单元”测试一个方法。
此方法依赖于与它一起发送的标头。
所以
HttpContext.Current.Request.Headers["name"]
需要在方法体中有一个值。
这样做的最佳方法是什么？我以为我可以设置将填充 HttpContext 的 ControllerContext，但无法使其正常工作。
我不希望使用模拟框架或任何其他第三方工具，因为我的理解是 WebAPI2 可以很好地处理这个用例。
如果这是最好的方法，我很乐意设置 HttpContext.Current。
【问题讨论】：
标签： c# asp.net unit-testing asp.net-web-api asp.net-web-api2
嗨，我参加聚会可能有点晚了，但我遇到了同样的问题，这就是我最终要做的。
正如其他人所指出的，在控制器操作中使用 Request.Headers 而不是 HttpCurrentContext，例如
[Route("")]
[HttpGet]
public IHttpActionResult Get()
{
// The header can have multiple values, I call SingleOrDefault as I only expect 1 value.
var myHeader = Request.Headers.GetValues("X-My-Header").SingleOrDefault();
if (myHeader == "success")
{
return Ok<string>("Success!");
}
return BadRequest();
}
这样就很容易创建一个 HttpControllerContext 并像这样设置请求属性：
[TestMethod]
public void Get_HeaderIsValid()
{
// Arrange
var controller = new ConfigurationsController(null);
var controllerContext = new HttpControllerContext();
var request = new HttpRequestMessage();
request.Headers.Add("X-My-Header", "success");
// Don't forget these lines, if you do then the request will be null.
controllerContext.Request = request;
controller.ControllerContext = controllerContext;
// Act
var result = controller.Get() as OkNegotiatedContentResult<string>;
// Assert
Assert.IsNotNull(result);
Assert.AreEqual("Success!", result.Content);
}
希望这会有所帮助:)
附：不要忘记在测试项目中添加 Web.Api.Core Reference :)
【讨论】：
有时，您几乎/无法控制正在为其编写测试的代码。如果它已经被设计为使用HttpContext.Current，并且您不断收到"Operation is not supported on this platform." 错误，就像我遇到的那样，这将有所帮助。
public static class NameValueCollectionExtensions
{
public static NameValueCollection AddValue(this NameValueCollection headers, string key, string value)
{
Type t = headers.GetType();
t.InvokeMember("MakeReadWrite", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, headers, null);
t.InvokeMember("InvalidateCachedArrays", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, headers, null);
t.InvokeMember("BaseAdd", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, headers, new object[] { key, new System.Collections.ArrayList() { value } });
t.InvokeMember("MakeReadOnly", BindingFlags.InvokeMethod | BindingFlags.NonPublic | BindingFlags.Instance, null, headers, null);
return headers;
}
}
在同一个命名空间中使用该类，您可以添加如下标题：
HttpContext.Current.Request.Headers.AddValue("header_key", "header_value");
当然，如果您不喜欢扩展方法，您可以随时使用包装方法。
我希望这对某人有所帮助。
【讨论】：
注意：此答案适用于问题的通用标题，但在这种特殊情况下，用户有外部代码依赖于他无法控制的 HttpContext.Current。如果这也是你的情况，这不是要走的路。对于大多数其他用户，仍然建议这样做
不要依赖 WebAPI 中的 HttpContext.Current。一般建议避免在 WebAPI 中使用它，主要原因之一是单元可测试性。
另请注意，我将返回一个 IHttpActionResult，这将使测试更加容易。
只需使用控制器成员Request.Headers，然后您可以通过测试中的上下文对象进行设置
public class MyController : ApiController
{
public IHttpActionResult Get()
{
if (Request.Headers. /* insert your code here */)
{
// Do Something
}
}
}
public class TestClass
{
public void Test()
{
// Arrange
var controller = new MyController();
var request = new HttpRequestMessage();
request.Headers... // setup your test here
// Act
var result = controller.Get();
// Assert
// Verify here
}
}
这是一个完整的内存集成测试的端到端示例（再次注意，您需要使用整个管道中可用的 Request 属性而不是 HttpContext.Current。此代码取自：WebAPI tests there代码中还有更多样式的集成测试。
// Do any setup work
HttpConfiguration config = new HttpConfiguration();
config.Routes.MapHttpRoute("Default", "{controller}/{action}");
// Setup in memory server and client
HttpServer server = new HttpServer(config);
HttpClient client = new HttpClient(server);
// Act
HttpResponseMessage response = client.GetAsync("http://localhost/" + requestUrl).Result;
// Assert
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
Assert.Equal(count, response.Content.ReadAsAsync<int>().Result);
【讨论】：
我会推荐它。
当您创建私有控制器对象时，请同时设置这些设置。
private HomeController createHomeController()
{
var httpContext = new DefaultHttpContext();
httpContext.Request.Headers["Key"] = "value123";
var controllerContext = new ControllerContext
{
HttpContext = httpContext
};
return new HomeController()
{
ControllerContext = controllerContext
};
}
【讨论】：
您可以模拟 HTTP 请求上下文。你在使用像 Moq 这样的模拟框架吗？这使得模拟请求标头集合变得容易。如果不使用起订量，请参阅此 SO question。
【讨论】：