Mocking EF DbContext with Moq

本文关键字:Moq with DbContext EF Mocking | 更新日期: 2023-09-27 18:23:59

我正试图用模拟的DbContext为我的服务创建一个单元测试。我创建了一个具有以下功能的接口IDbContext

public interface IDbContext : IDisposable
{
    IDbSet<T> Set<T>() where T : class;
    DbEntityEntry<T> Entry<T>(T entity) where T : class;
    int SaveChanges();
}

我的真实上下文实现了这个接口IDbContextDbContext

现在我试图在上下文中模拟IDbSet<T>,所以它会返回一个List<User>

[TestMethod]
public void TestGetAllUsers()
{
    // Arrange
    var mock = new Mock<IDbContext>();
    mock.Setup(x => x.Set<User>())
        .Returns(new List<User>
        {
            new User { ID = 1 }
        });
    UserService userService = new UserService(mock.Object);
    // Act
    var allUsers = userService.GetAllUsers();
    // Assert
    Assert.AreEqual(1, allUsers.Count());
}

我总是在.Returns:上收到这个错误

The best overloaded method match for
'Moq.Language.IReturns<AuthAPI.Repositories.IDbContext,System.Data.Entity.IDbSet<AuthAPI.Models.Entities.User>>.Returns(System.Func<System.Data.Entity.IDbSet<AuthAPI.Models.Entities.User>>)'
has some invalid arguments

Mocking EF DbContext with Moq

我通过创建一个实现IDbSet<T>FakeDbSet<T>类来解决它

public class FakeDbSet<T> : IDbSet<T> where T : class
{
    ObservableCollection<T> _data;
    IQueryable _query;
    public FakeDbSet()
    {
        _data = new ObservableCollection<T>();
        _query = _data.AsQueryable();
    }
    public virtual T Find(params object[] keyValues)
    {
        throw new NotImplementedException("Derive from FakeDbSet<T> and override Find");
    }
    public T Add(T item)
    {
        _data.Add(item);
        return item;
    }
    public T Remove(T item)
    {
        _data.Remove(item);
        return item;
    }
    public T Attach(T item)
    {
        _data.Add(item);
        return item;
    }
    public T Detach(T item)
    {
        _data.Remove(item);
        return item;
    }
    public T Create()
    {
        return Activator.CreateInstance<T>();
    }
    public TDerivedEntity Create<TDerivedEntity>() where TDerivedEntity : class, T
    {
        return Activator.CreateInstance<TDerivedEntity>();
    }
    public ObservableCollection<T> Local
    {
        get { return _data; }
    }
    Type IQueryable.ElementType
    {
        get { return _query.ElementType; }
    }
    System.Linq.Expressions.Expression IQueryable.Expression
    {
        get { return _query.Expression; }
    }
    IQueryProvider IQueryable.Provider
    {
        get { return _query.Provider; }
    }
    System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
    {
        return _data.GetEnumerator();
    }
    IEnumerator<T> IEnumerable<T>.GetEnumerator()
    {
        return _data.GetEnumerator();
    }
}

现在我的测试是这样的:

[TestMethod]
public void TestGetAllUsers()
{
    //Arrange
    var mock = new Mock<IDbContext>();
    mock.Setup(x => x.Set<User>())
        .Returns(new FakeDbSet<User>
        {
            new User { ID = 1 }
        });
    UserService userService = new UserService(mock.Object);
    // Act
    var allUsers = userService.GetAllUsers();
    // Assert
    Assert.AreEqual(1, allUsers.Count());
}

如果有人仍然感兴趣,我也遇到了同样的问题,发现这篇文章非常有用:实体框架测试与模拟框架(EF6以后)

它只适用于EntityFramework6或更新版本,但它涵盖了从简单的SaveChanges测试到异步查询测试的所有内容,所有这些都使用Moq(以及一些手动类)。

感谢Gaui的伟大想法=)

我确实为您的解决方案添加了一些改进,并希望与大家分享。

  1. 我的FakeDbSet也从DbSet继承来获得额外的方法如AddRange()
  2. 我用List<T>替换了ObservableCollection<T>以通过所有List<>到我的FakeDbSet中已经实现的方法

我的FakeDbSet:

    public class FakeDbSet<T> : DbSet<T>, IDbSet<T> where T : class {
    List<T> _data;
    public FakeDbSet() {
        _data = new List<T>();
    }
    public override T Find(params object[] keyValues) {
        throw new NotImplementedException("Derive from FakeDbSet<T> and override Find");
    }
    public override T Add(T item) {
        _data.Add(item);
        return item;
    }
    public override T Remove(T item) {
        _data.Remove(item);
        return item;
    }
    public override T Attach(T item) {
        return null;
    }
    public T Detach(T item) {
        _data.Remove(item);
        return item;
    }
    public override T Create() {
        return Activator.CreateInstance<T>();
    }
    public TDerivedEntity Create<TDerivedEntity>() where TDerivedEntity : class, T {
        return Activator.CreateInstance<TDerivedEntity>();
    }
    public List<T> Local {
        get { return _data; }
    }
    public override IEnumerable<T> AddRange(IEnumerable<T> entities) {
        _data.AddRange(entities);
        return _data;
    }
    public override IEnumerable<T> RemoveRange(IEnumerable<T> entities) {
        for (int i = entities.Count() - 1; i >= 0; i--) {
            T entity = entities.ElementAt(i);
            if (_data.Contains(entity)) {
                Remove(entity);
            }
        }
        return this;
    }
    Type IQueryable.ElementType {
        get { return _data.AsQueryable().ElementType; }
    }
    Expression IQueryable.Expression {
        get { return _data.AsQueryable().Expression; }
    }
    IQueryProvider IQueryable.Provider {
        get { return _data.AsQueryable().Provider; }
    }
    IEnumerator IEnumerable.GetEnumerator() {
        return _data.GetEnumerator();
    }
    IEnumerator<T> IEnumerable<T>.GetEnumerator() {
        return _data.GetEnumerator();
    }
}

修改dbSet和模拟EF上下文对象很容易:

    var userDbSet = new FakeDbSet<User>();
    userDbSet.Add(new User());
    userDbSet.Add(new User());
    var contextMock = new Mock<MySuperCoolDbContext>();
    contextMock.Setup(dbContext => dbContext.Users).Returns(userDbSet);

现在可以执行Linq查询,但要注意,外键引用可能不会自动创建:

    var user = contextMock.Object.Users.SingeOrDefault(userItem => userItem.Id == 42);

因为上下文对象是模拟的,Context.SaveChanges()不会做任何事情,实体的属性更改可能不会填充到dbSet中。我通过模拟我的SetModifed()方法来填充更改来解决这个问题。

基于这篇MSDN文章,我创建了自己的库来模拟DbContextDbSet:

  • EntityFrameworkMock-GitHub
  • EntityFrameworkMockCore-GitHub

两者都可以在NuGet和GitHub上使用。

我创建这些库的原因是,我想模拟SaveChanges行为,在插入具有相同主键的模型时抛出DbUpdateException,并支持模型中的多列/自动递增主键。

此外,由于DbSetMockDbContextMock都继承自Mock<DbSet>Mock<DbContext>,因此可以使用Moq框架的所有功能。

除Moq外,还有一个NSubstitute实现。

Moq版本的用法如下:

public class User
{
    [Key, Column(Order = 0)]
    public Guid Id { get; set; }
    public string FullName { get; set; }
}
public class TestDbContext : DbContext
{
    public TestDbContext(string connectionString)
        : base(connectionString)
    {
    }
    public virtual DbSet<User> Users { get; set; }
}
[TestFixture]
public class MyTests
{
    var initialEntities = new[]
        {
            new User { Id = Guid.NewGuid(), FullName = "Eric Cartoon" },
            new User { Id = Guid.NewGuid(), FullName = "Billy Jewel" },
        };
        
    var dbContextMock = new DbContextMock<TestDbContext>("fake connectionstring");
    var usersDbSetMock = dbContextMock.CreateDbSetMock(x => x.Users, initialEntities);
    
    // Pass dbContextMock.Object to the class/method you want to test
    
    // Query dbContextMock.Object.Users to see if certain users were added or removed
    // or use Mock Verify functionality to verify if certain methods were called: usersDbSetMock.Verify(x => x.Add(...), Times.Once);
}

如果有人还在寻找答案,我已经实现了一个小库来允许嘲笑DbContext。

步骤1

安装Coderful.EntityFramework.测试nuget包:

Install-Package Coderful.EntityFramework.Testing

步骤2

然后创建一个这样的类:

internal static class MyMoqUtilities
{
    public static MockedDbContext<MyDbContext> MockDbContext(
        IList<Contract> contracts = null,
        IList<User> users = null)
    {
        var mockContext = new Mock<MyDbContext>();
        // Create the DbSet objects.
        var dbSets = new object[]
        {
            MoqUtilities.MockDbSet(contracts, (objects, contract) => contract.ContractId == (int)objects[0] && contract.AmendmentId == (int)objects[1]),
            MoqUtilities.MockDbSet(users, (objects, user) => user.Id == (int)objects[0])
        };
        return new MockedDbContext<SourcingDbContext>(mockContext, dbSets); 
    }
}

步骤3

现在你可以非常容易地创建模拟:

// Create test data.
var contracts = new List<Contract>
{
    new Contract("#1"),
    new Contract("#2")
};
var users = new List<User>
{
    new User("John"),
    new User("Jane")
};
// Create DbContext with the predefined test data.
var dbContext = MyMoqUtilities.MockDbContext(
    contracts: contracts,
    users: users).DbContext.Object;

然后使用你的模拟:

// Create.
var newUser = dbContext.Users.Create();
// Add.
dbContext.Users.Add(newUser);
// Remove.
dbContext.Users.Remove(someUser);
// Query.
var john = dbContext.Users.Where(u => u.Name == "John");
// Save changes won't actually do anything, since all the data is kept in memory.
// This should be ideal for unit-testing purposes.
dbContext.SaveChanges();

全文:http://www.22bugs.co/post/Mocking-DbContext/

我迟到了,但发现这篇文章很有帮助:InMemory测试(MSDN文档)。

它解释了如何使用内存中的DB上下文(它不是数据库),只需很少的编码,并有机会实际测试DBContext实现。