如何为 asp.net core web api 控制器编写单元测试

Question

所以我对编写测试非常陌生。我创建了一个 ASP.NET 核心 web api 以及 angular。我必须为 Web API 控制器编写单元测试。我一直在阅读有关如何开始对 ASP.NET Web API 进行单元测试的 Microsoft 文档。但是我仍然非常不确定如何编写适当的测试。

我的控制器代码

[Authorize]
[Route("api/[controller]")]
[ApiController]
public class OrdersController : ControllerBase
{
    private readonly IOrderRepository _repo;
    private readonly IMapper _mapper;
    public OrdersController(IOrderRepository repo, IMapper mapper)
    {
        _repo = repo;
        _mapper = mapper;
    }

    [AllowAnonymous]
    [HttpPost()]
    public async Task<IActionResult> AddOrder(OrderForMappingDto orderForMappingDto)
    {
        //if(orderForMappingDto.ARentalOrNot == null)
        //{
        //    throw new Exception("Value can't be left null");
        //}
        var orderToCreate = _mapper.Map<TblOrder>(orderForMappingDto);
        var createdOrder = await _repo.AddOrder(orderToCreate);

        return Ok(createdOrder);
    }

}

我的仓库代码

public class OrderRepository : IOrderRepository
{
    private readonly MovieRentalDBContext _context;

    public OrderRepository(MovieRentalDBContext context)
    {
        _context = context;
    }
    public async Task<TblOrder> AddOrder(TblOrder tblOrder)
    {
        await _context.TblOrder.AddAsync(tblOrder);
        await _context.SaveChangesAsync();
        return tblOrder;
    }
}

我知道有很多嘲笑要做。但是我是否也需要模拟实体框架？ 我写了一个简单的测试文件。

public void PostsAorder_WhenCalled_ReturnsOkWithResponse()
{
    var mockOrderRepository = new Mock<IOrderRepository>();
    var mockOrderMapper = new Mock<IMapper>();
    var orderControllerObject = new OrdersController(mockOrderRepository.Object, mockOrderMapper.Object);

    Task<IActionResult> contentResult = orderControllerObject.AddOrder(new OrderForMappingDto
    {
        ACustomerId = 3,
        AMovieId = 18,
        ARentalOrNot = false,
        AOrderedDate = DateTime.Now
    }) ;
    //var contentResult = actionResult as OkNegotiatedContentResult<OrderForMappingDto>;
    Assert.IsNotNull(contentResult);
    Assert.IsNotNull(contentResult.Result);
}

OkNegotioatedContent 函数不适用于任务。我该如何使用它来完成任务。此外，即使在 DTO 中它们被归类为 [Required] 时，即使我没有提供最后 3 个参数，测试也会通过。有人可以帮助如何正确修改测试。

映射器配置-

Answer 1

您的测试几乎没问题。首先是固定版本，然后是一些解释：

[Fact]
public async Task GivenAValidOrder_WhenICallTheAsOrder_ThenItReturnsOkWithResponse()
{
    //Arrange
    var mockOrderMapper = new Mock<IMapper>();
    mockOrderMapper.Setup(mapper => mapper.Map<TblOrder>(It.IsAny<OrderForMappingDto>()))
        .Returns(new TblOrder());

    var mockOrderRepository = new Mock<IOrderRepository>();
    mockOrderRepository.Setup(repo => repo.AddOrder(It.IsAny<TblOrder>()))
        .ReturnsAsync((TblOrder order) => order);

    var SUT = new OrdersController(mockOrderRepository.Object, mockOrderMapper.Object);

    //Act
    var contentResult = await SUT.AddOrder(new OrderForMappingDto
    {
        ACustomerId = 3,
        AMovieId = 18,
        ARentalOrNot = false,
        AOrderedDate = DateTime.Now
    });

    //Assert
    Assert.NotNull(contentResult);
    Assert.IsAssignableFrom<OkObjectResult>(contentResult);

    var result = ((OkObjectResult)contentResult).Value;
    Assert.NotNull(result);
    Assert.IsAssignableFrom<TblOrder>(result);
}

1. test 的名称遵循 Given When Then 结构，以便更容易理解在什么情况下控制器的操作应该如何表现。
2. 测试现在是异步的，因为我们需要 await 完成控制器的操作才能检查其结果。
3. 我已将Arrange Act Assert cmets 添加到代码中，以强调哪个阶段从何时开始。
4. 我已将映射器模拟设置为返回一个新的 TblOrder，并将存储库模拟设置为返回它收到的任何内容。
5. 我已将orderControllerObject 重命名为SUT，因为它强调了正在检查的组件（被测系统）。
6. 在结果验证中，我使用了IsAssingableForm 而不是IsType，因为它也会检查派生类。在这种特殊情况下，这不是强制性的，但这是一种很好的做法。
7. 结果类型将是 OkObjectResult 而不是 OkNegotiatedContentResult，因此您应该检查一下。
8. 最后我添加了一个额外的检查，以确保返回的对象的类型是预期的。