对 Web API 控制器进行单元测试

Question

我是单元测试的新手，我正在尝试为我创建的 Web API 控制器创建单元测试，其中 returns 品牌列表。

我的 Web API 控制器 Get() 方法如下所示：

[HttpGet("/api/Brands/Get", Name = "GetBrands")]
public async Task<IActionResult> Get()
{
    var brands = await _brandsService.GetAll(null, "Image");
    return Json(brands);
}

通用服务方法如下所示：

public async Task<List<T>> GetAll(
    Func<IQueryable<T>, 
    IOrderedQueryable<T>> orderBy = null, 
    string includeProperties = null)
{
    return await _genericRepository.GetAll(orderBy, includeProperties);
}

通用回购方法如下所示：

public async Task<T> Get<TKey>(Expression<Func<T, bool>> filter = null, string includeProperties = "", bool noTracking = false)

{
    includeProperties = includeProperties.Trim() ?? string.Empty;
    IQueryable<T> query = Context.Set<T>();

    if (noTracking)
    {
        query.AsNoTracking();
    }

    if (filter != null)
    {
        query = query.Where(filter);
    }

    foreach (var includeProperty in includeProperties.Split
        (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries))
    {
        query = query.Include(includeProperty);
    }

    return await query.SingleOrDefaultAsync();
}

这是有效的，我正在返回数据库中的品牌列表。

现在我尝试为此创建一个单元测试：

[SetUp]
public void Setup()
{
    Brands = new List<Brand>
    {
        new Brand
        {
            Id = 1,
            Name = "Adidas",
            ImageId = 1
        },
        new Brand
        {
            Id = 2,
            Name = "Nike",
            ImageId = 2
        },
        new Brand
        {
            Id = 3,
            Name = "Puma",
            ImageId = 3
        }
    };
}

[Test]
public async Task Get_ReturnsAAListOfBrands()
{
    //Arrange
    var mockService = new Mock<IGenericService<Brand>>();
    mockService.Setup(repo => repo.GetAll(null, null)).Returns(Task.FromResult(Brands));
    var controller = new BrandsController(mockService.Object);

    //Act
    var result = await controller.Get();
    //Assert
}

然而结果总是空的。我是否正确测试了这个，或者我是否需要更改我的单元测试代码以验证模拟服务是否存储了三个项目？

Answer 1

您需要将设置配置为预期测试的特定行为或参数。

在这种情况下，使用 It.IsAny<T>() 告诉设置在参数方面的期望将允许测试按预期进行。

鉴于GetAll方法需要两个参数 Func<IQueryable<T>, IOrderedQueryable<T>> 和 string，安装程序根据为这些参数输入的值配置要执行的操作。

[Test]
public async Task Get_ReturnsAAListOfBrands() {
    //Arrange
    var mockService = new Mock<IGenericService<Brand>>();
    mockService
        .Setup(repo => repo.GetAll(It.IsAny<Func<IQueryable<Brand>, IOrderedQueryable<Brand>>>(), It.IsAny<string>()))
        .ReturnsAsync(Brands);
    var controller = new BrandsController(mockService.Object);

    //Act
    var result = await controller.Get();
    //Assert
    //...
}

查看 Moq Quickstart 以更好地了解如何使用此模拟框架

对 Web API 控制器进行单元测试

Unit testing a Web API controller

c#

nunit

unit-testing

moq

asp.net-web-api