Moq - Mock DbSet <T>.AddAsyn c не вызывает никаких выполненных вызовов

Question

У меня есть модульный тест, который в основном тестирует поведение EF Core. Класс, который я пытаюсь проверить, выглядит следующим образом:

namespace MusicPortal.Repository.Repository
{
    public class ArtistRepository : IArtistRepository
    {
        private readonly MusicPortalDbContext _context;

        public ArtistRepository(MusicPortalDbContext context)
        {
            _context = context;
        }

        public async Task<MusicPortalDatabaseResponse<bool>> AddNewArtist(Artist artist)
        {
            try
            {
                await _context.Artists.AddAsync(new Artist
                {
                    ArtistType = ArtistTypes.Band,
                    City = artist.City,
                    Country = artist.Country,
                    Genre = artist.Genre,
                    Name = artist.Name,
                    ProfileImageUrl = artist.ProfileImageUrl
                });

                _context.SaveChanges();
                return new MusicPortalDatabaseResponse<bool>
                {
                    HasError = false,
                    Exception = null,
                    Response = true
                };
            }
            catch (Exception e)
            {
                return new MusicPortalDatabaseResponse<bool>
                {
                    HasError = true,
                    Exception = e,
                    Response = false
                };
            }
        }
    }
}

И у меня есть следующий модульный тест для него с использованием Moq

namespace MusicPortal.Tests.Repository.ArtistRepository.AddNewArtist
{
    [TestFixture]
    public class GivenAddingANewArtistToADatabaseFails
    {
        private Mock<DbSet<Artist>> _mockArtistDbSet;
        private Mock<MusicPortalDbContext> _mockContext;

        private IArtistRepository _artistRepository;
        private MusicPortalDatabaseResponse<bool> _addArtistToDbResponse;

        [OneTimeSetUp]
        public async Task Setup()
        {
            _mockArtistDbSet = new Mock<DbSet<Artist>>();
            _mockContext = new Mock<MusicPortalDbContext>();

            _mockArtistDbSet
                .Setup(x => x.AddAsync(It.IsAny<Artist>(), It.IsAny<CancellationToken>()))
                .Callback((Artist artist, CancellationToken token) => { })
                .ReturnsAsync(It.IsAny<EntityEntry<Artist>>());
            _mockContext
                .Setup(x => x.SaveChanges())
                .Throws(new Exception("Cannot save new Artist to Database"));

            _artistRepository = new MusicPortal.Repository.Repository.ArtistRepository(_mockContext.Object);
            _addArtistToDbResponse = await _artistRepository.AddNewArtist(It.IsAny<Artist>());
        }

        [Test]
        public void ThenANegativeResultIsReturned() // pass
        {
            Assert.IsFalse(_addArtistToDbResponse.Response);
            Assert.IsTrue(_addArtistToDbResponse.HasError);
            Assert.IsInstanceOf<Exception>(_addArtistToDbResponse.Exception);
        }

        [Test]
        public void ThenTheArtistContextAddMethodIsCalledOnce() //fail
        {
            _mockArtistDbSet.Verify(x => x.AddAsync(It.IsAny<Artist>(), It.IsAny<CancellationToken>()), Times.Once);
        }

        [Test]
        public void ThenTheArtistsContextSaveMethodIsNeverCalled() //pass
        {
            _mockContext.Verify(x => x.SaveChanges(), Times.Never);
        }
    }
}

Первый и последний проход утверждения, но ThenTheArtistContextAddMethodIsCalledOnce() завершается с ошибкой из-за следующей ошибки:

MusicPortal.Tests.Repository.ArtistRepository.AddNewArtist.GivenAddingANewArtistToADatabaseFails.ThenTheArtistContextAddMethodIsCalledOnce * 1010 исключенных случаев, когда было выдано исключение, исключено: : x => x.AddAsyn c (It.IsAny (), It.IsAny ())

Выполненные вызовы:

Макет: 1> (x): вызовы не выполняются.

в Moq.Mock.Verify (Mock mock, выражение LambdaExpression, Times times, String failMessage) в Moq.Mock 1.Verify[TResult](Expression 1 выражение, Func`1 раз) в MusicPortal.Tests.Repository.ArtistRepository.AddNewArtist .GivenAddingANewArtistToADatabaseFails.ThenTheArtistContextAddMethodIsCalledOnce () в MusicPortal.Tests \ Repository \ ArtistRepository \ AddNewArtist \ GivenAddingANewArtistToADatabaseFails.cs: строка 53 * 10 20 *

Я понимаю, что код проблемы c# _mockArtistDbSet .Setup(x => x.AddAsync(It.IsAny<Artist>(), It.IsAny<CancellationToken>())) .Callback((Artist artist, CancellationToken token) => { }) .ReturnsAsync(It.IsAny<EntityEntry<Artist>>());

И я знаю, что проблема, скорее всего, связана с проблемой asyn c, но я не знаю почему, или в чем проблема Любой совет, решения?

Answer 1

Похоже, что EF Core не так легко проверить с помощью асинхронных c задач, таких как SaveChangesAsync и AddAsync. В конце я последовал руководству MS по тестированию ядра EF и создал фиктивный контекст. Единственным недостатком является то, что я могу только испытать счастливый путь. Хотя пути ошибок проверяются службой, которая использует репозиторий, я надеялся на большее тестовое покрытие на уровне репозитория.

В любом случае, вот спец. c

using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using MusicPortal.Core.Context;
using MusicPortal.Core.Repository;
using MusicPortal.Tests.Repository.ArtistRepository.TestHelpers;
using MusicPortal.Tests.Repository.ArtistRepository.TestHelpers.MockDB;
using NUnit.Framework;
using MockArtistRepository = MusicPortal.Repository.Repository.ArtistRepository;

namespace MusicPortal.Tests.Repository.ArtistRepository.AddNewArtist 
{
    [TestFixture]
    public class GivenANewArtistToInsertIntoTheDb
    {
        private DbContextOptions<MusicPortalDbContext> _options;
        private MusicPortalDatabaseResponse<bool> _mockResponse;

        [OneTimeSetUp]
        public async Task Setup()
        {
            _options = new MockDbFactory("MusicPortalDB").Options;

            using (var context = new MusicPortalDbContext(_options))
            {
                var artistRepository = new MockArtistRepository(context);
                _mockResponse = await artistRepository.AddNewArtist(MockRepositoryData.Artist);
            }
        }

        [Test]
        public void AndThenAPositiveResultIsReturned()
        {
            Assert.Null(_mockResponse.Exception);
            Assert.IsTrue(_mockResponse.Response);
            Assert.IsFalse(_mockResponse.HasError);
        }

        [Test]
        public void ThenTheArtistShouldBeSavedWithNoProblem()
        {
            using (var context = new MusicPortalDbContext(_options))
            {
                Assert.AreEqual(1, context.Artists.Count());
            }
        } 
    }
}

и база данных Mock:

using System;
using Microsoft.EntityFrameworkCore;
using MusicPortal.Core.Context;
using MusicPortal.Core.DBModels;

namespace MusicPortal.Tests.Repository.ArtistRepository.TestHelpers.MockDB
{
    public sealed class MockDbFactory
    {
        public DbContextOptions<MusicPortalDbContext> Options { get; }

        public MockDbFactory(string dbName)
        {
            Options = new DbContextOptionsBuilder<MusicPortalDbContext>()
                .UseInMemoryDatabase(dbName)
                .Options;
        }

        public void AddArtistsToContext()
        {
            using (var context = new MusicPortalDbContext(Options))
            {
                context.Artists.Add(new Artist
                {
                    City = "Orange County",
                    Country = "USA",
                    Events = null,
                    Genre = "Pop Punk",
                    Id = Guid.Parse("8a07504b-8152-4d8b-8e21-74bf64322ebc"),
                    Merchandise = null,
                    Name = "A Day To Remember",
                    ArtistType = "Band",
                    ProfileImageUrl = "https://placehold.it/30x30"
                });

                context.SaveChanges();
            }
        }    
    }
}

Я надеюсь, что это поможет любому, кто смотрит на ту же проблему. Извлеченный урок: не используйте Asyn c, если только вам это не нужно.

Answer 2

Вы объявляете и настраиваете _mockArtistDbSet, но не используете / не присоединяете его к _mockContext. Я думаю, вам нужно добавить что-то вроде:

_mockContext.Setup(m => m.Artist).Returns(_mockArtistDbSet.Object);