在ASP.NET Core Controller中模拟HttpRequest [英] Mock HttpRequest in ASP.NET Core Controller

问题描述

我正在ASP.NET Core中构建Web API，并且我想对控制器进行单元测试.

我为数据访问注入了一个接口，我可以轻松地对其进行模拟.但是控制器必须检查Request的标头中是否有令牌，而当我自己直接实例化控制器时，该Request似乎不存在，并且它也是get-only的，所以我什至不能手动设置它.我发现了很多示例来模拟ApiController，但这不是.NET核心.关于如何对.net核心控制器进行单元测试的许多教程和示例，但实际上都没有使用HttpRequest.

我建立了一个MCVE来证明这一点:

[Produces("application/json")]
[Route("api/Players")]
public class PlayersController : Controller
{
    private IAccessor accessor;

    public PlayersController(IAccessor ac = null):base()
    {
        accessor = ac ?? AccessorFactory.GetAccessor();
    }

    /// <summary>
    /// Get all players. Must be logged in.
    /// </summary>
    /// <returns>Ok or Unauthorized.</returns>
    [HttpGet]
    public IActionResult Get()
    {
        Player client = accessor.GetLoggedInPlayer(Request.Headers["token"]); // NRE here because Request is null
        if (client == null) return Unauthorized();
        return Ok(accessor.GetAllPlayers());

    }
}    

我在测试项目中使用Moq和MSTest，然后注入模拟的IAccessor.如何注入请求，或使用控制器初始化请求?我想我的最后选择是反思，但我真的想避免这种情况.

解决方案

在创建被测控制器的实例时，请确保分配一个HttpContext，其中包含要执行的测试所需的依赖关系. /p>

您可以尝试模拟HttpContext并将其提供给控制器，或者仅使用框架提供的DefaultHttpContext

//Arrange
var mockedAccessor = new Mock<IAccessor>();
//...setup mockedAccessor behavior

//...

var httpContext = new DefaultHttpContext(); // or mock a `HttpContext`
httpContext.Request.Headers["token"] = "fake_token_here"; //Set header
 //Controller needs a controller context 
var controllerContext = new ControllerContext() {
    HttpContext = httpContext,
};
//assign context to controller
var controller = new PlayersController (mockedAccessor.Object){
    ControllerContext = controllerContext,
};

//Act
var result = controller.Get();

//...

以上内容假设您已经知道如何模拟像IAccessor这样的控制器依赖关系，并且旨在演示如何提供测试所需的特定于框架的依赖关系.

I'm building a Web API in ASP.NET Core, and I want to unit test the controllers.

I inject an interface for data access, that I can easily mock. But the controller has to check the headers in the Request for a token, and that Request doesn't seem to exist when I simply instantiate the controller myself, and it is also get-only, so I can't even manually set it. I found lots of examples to mock an ApiController, but that isn't .NET core. Also many tutorials and examples of how to unit test .net core controllers, but none actually used the HttpRequest.

I built an MCVE to demonstrate this:

[Produces("application/json")]
[Route("api/Players")]
public class PlayersController : Controller
{
    private IAccessor accessor;

    public PlayersController(IAccessor ac = null):base()
    {
        accessor = ac ?? AccessorFactory.GetAccessor();
    }

    /// <summary>
    /// Get all players. Must be logged in.
    /// </summary>
    /// <returns>Ok or Unauthorized.</returns>
    [HttpGet]
    public IActionResult Get()
    {
        Player client = accessor.GetLoggedInPlayer(Request.Headers["token"]); // NRE here because Request is null
        if (client == null) return Unauthorized();
        return Ok(accessor.GetAllPlayers());

    }
}    

I'm using Moq and MSTest in my test project, and inject a mocked IAccessor. How do I inject the Request, or initialize it with the controller? I guess my last resort would be reflection, but I really want to avoid that.

解决方案

When creating an instance of the controller under test, make sure to assign a HttpContext that contains the required dependencies for the test to be exercised to completion.

You could try mocking a HttpContext and providing that to the controller or just use DefaultHttpContext provided by the framework

//Arrange
var mockedAccessor = new Mock<IAccessor>();
//...setup mockedAccessor behavior

//...

var httpContext = new DefaultHttpContext(); // or mock a `HttpContext`
httpContext.Request.Headers["token"] = "fake_token_here"; //Set header
 //Controller needs a controller context 
var controllerContext = new ControllerContext() {
    HttpContext = httpContext,
};
//assign context to controller
var controller = new PlayersController (mockedAccessor.Object){
    ControllerContext = controllerContext,
};

//Act
var result = controller.Get();

//...

The above assumes you already know how to mock the controller dependencies like IAccessor and was meant to demonstrate how to provide framework specific dependencies needed for the test.

这篇关于在ASP.NET Core Controller中模拟HttpRequest的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！