我如何模拟 FromSql() 方法？

Question

我想知道除了构建用于模拟 FromSql 的包装器之外还有其他方法吗？我知道这个方法是静态的，但由于他们将 AddEntityFrameworkInMemoryDatabase 之类的东西添加到 entity framework 核心，我认为可能也有解决方案，我在我的项目中使用 EF Core 1.0.1。

我的最终目标是测试这个方法：

public List<Models.ClosestLocation> Handle(ClosestLocationsQuery message)
{
    return _context.ClosestLocations.FromSql(
        "EXEC GetClosestLocations {0}, {1}, {2}, {3}",
        message.LocationQuery.Latitude,
        message.LocationQuery.Longitude,
        message.LocationQuery.MaxRecordsToReturn ?? 10,
        message.LocationQuery.Distance ?? 10
    ).ToList();
}

根据 entity framework 中的 this answer 6，我想确保使用传递给它的同一对象处理我的查询我可以这样做：

[Fact]
public void HandleInvokesGetClosestLocationsWithCorrectData()
{
    var message = new ClosestLocationsQuery
    {
        LocationQuery =
            new LocationQuery {Distance = 1, Latitude = 1.165, Longitude = 1.546, MaxRecordsToReturn = 1}
    };

    var dbSetMock = new Mock<DbSet<Models.ClosestLocation>>();

    dbSetMock.Setup(m => m.FromSql(It.IsAny<string>(), message))
        .Returns(It.IsAny<IQueryable<Models.ClosestLocation>>());

    var contextMock = new Mock<AllReadyContext>();

    contextMock.Setup(c => c.Set<Models.ClosestLocation>()).Returns(dbSetMock.Object);

    var sut = new ClosestLocationsQueryHandler(contextMock.Object);
    var results = sut.Handle(message);

    contextMock.Verify(x => x.ClosestLocations.FromSql(It.IsAny<string>(), It.Is<ClosestLocationsQuery>(y =>
        y.LocationQuery.Distance == message.LocationQuery.Distance &&
        y.LocationQuery.Latitude == message.LocationQuery.Latitude &&
        y.LocationQuery.Longitude == message.LocationQuery.Longitude &&
        y.LocationQuery.MaxRecordsToReturn == message.LocationQuery.MaxRecordsToReturn)));
}

但与 EF 6 中的 SqlQuery<T> 不同，EF Core 中的 FromSql<T> 是静态扩展方法，我问这个问题是因为我认为我可能从错误的角度或那里解决了这个问题可能是比包装器更好的选择，我很感激对此的任何想法。

Answer 1

如果您查看 FromSql<T> 中的代码，您会发现它调用了 source.Provider.CreateQuery<TEntity>。这就是你要嘲笑的。

对于你的情况，我认为你可以用类似的方法解决它：

var mockProvider = new Mock<IQueryProvider>();
mockProvider.Setup(s => s.CreateQuery(It.IsAny<MethodCallExpression>()))
    .Returns(null as IQueryable);
var mockDbSet = new Mock<DbSet<AllReady.Models.ClosestLocation>>();
mockDbSet.As<IQueryable<AllReady.Models.ClosestLocation>>()
    .Setup(s => s.Provider)
    .Returns(mockProvider.Object);
var t = mockDbSet.Object;
context.ClosestLocations = mockDbSet.Object;

var sut = new ClosestLocationsQueryHandler(context);
var results = sut.Handle(message);

不确定之后如何 Verify 在 MethodCallExpression 上，但我认为这是可能的。或者，可能有一种方法可以检查生成的 SQL.

Answer 2

我也遇到了同样的情况，Philippe 给出的答案对我有所帮助，但主要方法是抛出 System.ArgumentNullException。

从this link开始，我终于可以写一些单元测试了...

这是我正在测试的 class：

public class HolidayDataAccess : IHolidayDataAccess
{
    private readonly IHolidayDataContext holDataContext;

    public HolidayDataAccess(IHolidayDataContext holDataContext)
    {
        this.holDataContext = holDataContext;
    }

    public async Task<IEnumerable<HolidayDate>> GetHolidayDates(DateTime startDate, DateTime endDate)
    {
        using (this.holDataContext)
        {
            IList<HolidayDate> dates = await holDataContext.Dates.FromSql($"[dba].[usp_GetHolidayDates] @StartDate = {startDate}, @EndDate = {endDate}").AsNoTracking().ToListAsync();
            return dates;
        }
    }
}

这里是测试方法：

[TestMethod]
public async Task GetHolidayDates_Should_Only_Return_The_Dates_Within_Given_Range()
{
    // Arrange.

        SpAsyncEnumerableQueryable<HolidayDate> dates = new SpAsyncEnumerableQueryable<HolidayDate>();
        dates.Add(new HolidayDate() { Date = new DateTime(2018, 05, 01) });
        dates.Add(new HolidayDate() { Date = new DateTime(2018, 07, 01) });
        dates.Add(new HolidayDate() { Date = new DateTime(2018, 04, 01) });
        dates.Add(new HolidayDate() { Date = new DateTime(2019, 03, 01) });
        dates.Add(new HolidayDate() { Date = new DateTime(2019, 02, 15) });


    var options = new DbContextOptionsBuilder<HolidayDataContext>()
        .UseInMemoryDatabase(databaseName: Guid.NewGuid().ToString())
        .Options;

    HolidayDataContext context = new HolidayDataContext(options);

    context.Dates = context.Dates.MockFromSql(dates);

    HolidayDataAccess dataAccess = new HolidayDataAccess(context);

    //Act.
    IEnumerable<HolidayDate> resutlDates = await dataAccess.GetHolidayDates(new DateTime(2018, 01, 01), new DateTime(2018, 05, 31));

    // Assert.

    Assert.AreEqual(resutlDates.Any(d => d.Date != new DateTime(2019, 03, 01)), true);
    Assert.AreEqual(resutlDates.Any(d => d.Date != new DateTime(2019, 02, 15)), true);

    // we do not need to call this becuase we are using a using block for the context...
    //context.Database.EnsureDeleted();
}

要使用 UseInMemoryDatabase，您需要从 NuGet 添加 Microsoft.EntityFrameworkCore.InMemory 包助手 class 在这里：

public class SpAsyncEnumerableQueryable<T> : IAsyncEnumerable<T>, IQueryable<T>
{
    private readonly IList<T> listOfSpReocrds;

    public Type ElementType => throw new NotImplementedException();

    public IQueryProvider Provider => new Mock<IQueryProvider>().Object;

    Expression IQueryable.Expression => throw new NotImplementedException();

    public SpAsyncEnumerableQueryable()
    {
        this.listOfSpReocrds = new List<T>();
    }        

    public void Add(T spItem) // this is new method added to allow xxx.Add(new T) style of adding sp records...
    {
        this.listOfSpReocrds.Add(spItem);
    }

    public IEnumerator<T> GetEnumerator()
    {
       return this.listOfSpReocrds.GetEnumerator();
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return GetEnumerator();
    }

    IAsyncEnumerator<T> IAsyncEnumerable<T>.GetEnumerator()
    {
        return listOfSpReocrds.ToAsyncEnumerable().GetEnumerator();
    }
}

...以及包含 FromSql 方法模拟的 Db 扩展 class..

public static class DbSetExtensions
{
    public static DbSet<T> MockFromSql<T>(this DbSet<T> dbSet, SpAsyncEnumerableQueryable<T> spItems) where T : class
    {
        var queryProviderMock = new Mock<IQueryProvider>();
        queryProviderMock.Setup(p => p.CreateQuery<T>(It.IsAny<MethodCallExpression>()))
            .Returns<MethodCallExpression>(x => spItems);

        var dbSetMock = new Mock<DbSet<T>>();
        dbSetMock.As<IQueryable<T>>()
            .SetupGet(q => q.Provider)
            .Returns(() => queryProviderMock.Object);

        dbSetMock.As<IQueryable<T>>()
            .Setup(q => q.Expression)
            .Returns(Expression.Constant(dbSetMock.Object));
        return dbSetMock.Object;
    }
}

希望对您有所帮助！

Edits：重构 SpAsyncEnumerableQueryable class 以具有 Add 方法。摆脱了采用 T 数组的参数化构造。实现了 IQueryProvider Provider => new Mock<IQueryProvider>().Object; 以支持 .AsNoTracking()。异步调用 ToList。

Answer 3

旧线程已旧；但是，如果其他人正在寻找；可以对来自 sql 的调用执行最小起订量验证，您必须针对查询提供程序执行此操作。

var providerMock = Mock.Get(((IQueryable<TestEntity>) mockedDbContext.Set<TestEntity>()).Provider);
providerMock.Verify(m => m.CreateQuery<TestEntity>(It.IsAny<MethodCallExpression>()), Times.Once);

同样的方法也适用于 NSub。

方法调用表达式验证可以微调以匹配sql和参数，它包含sql（RawSqlString）和参数（IEnumerable）作为常量表达式。

var mceRawSqlString = (RawSqlString) ((ConstantExpression) mce.Arguments[1]).Value;
var mceParameters = (object[]) ((ConstantExpression) mce.Arguments[2]).Value

其中 mce 是 MethodCallExpression 馈送到 CreateQuery。

我在我的项目中做了一些 MCE 解构 EntityFrameworkCore.Testing 以支持 FromSql 模拟；我将实际匹配外包给支持方法，因为它有点毛茸茸。

queryProviderMock.Setup(m => m.CreateQuery<T>(It.Is<MethodCallExpression>(mce => SpecifiedParametersMatchMethodCallExpression(mce, sqlToMatchAgainst, parametersToMatchAgainst))))

我如何模拟 FromSql() 方法？

How could I Mock the FromSql() method?

c#

unit-testing

moq

entity-framework-core