web-dev-qa-db-ja.com

Web APIコントローラーのユニットテスト

私はユニットテストが初めてであり、ブランドのリストを返す、作成したWeb APIコントローラーのユニットテストを作成しようとしています。

私の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
}

ただし、結果は常にnullです。これを正しくテストしていますか、またはモックサービスに3つのアイテムが保存されていることを確認するためにユニットテストコードを変更する必要がありますか？

c#unit-testingasp.net-web-apinunitmoq
10
Johann

テストの特定の動作または引数を期待するようにセットアップを構成する必要があります。

この場合、It.IsAny<T>()を使用して、引数に関して何を期待するかをセットアップに伝えることで、テストが希望どおりに流れるようになります。

GetAllメソッドがFunc<IQueryable<T>, IOrderedQueryable<T>>およびstringの2つのパラメーターを必要とする場合、セットアップはそれらのパラメーターに入力された値に基づいて何をするかを構成します。

[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 を見て、このモックフレームワークの使用方法を理解してください。

5
Nkosi