用Moq模拟EF DbContext

74

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

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

我的真实上下文实现了此接口IDbContext和DbContext。

现在，我尝试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
c#  unit-testing  entity-framework-5  moq  dbcontext 
— 高井
source
2
尽管这篇文章会很有用，但我认为如果您包括Moq DbContext的实现，那将会更加有用，谢谢您的想法。
— LostNomad311 '18

Answers:

36

我设法通过创建一个FakeDbSet<T>实现IDbSet<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());
}
— 高井
source
— user8128167 2015年
试图在.net Core 1.0下实现此功能，但主要的缺点是IDbSet已被删除，并且构造函数是私有的，因此我什至无法提取自己的接口。
— Paul Gorbas '17
这不再是EF6中的首选方式，因为EF6向DbSet中添加了IDbSet中未反映的新更改（并且如上所述，在Core中已将其删除）。Entityframework.codeplex.com/…DbSet 更具可模拟性，尽管我不确定正确的实现是什么样。
— IronSean
@PaulGorbas我发现用SqlLite设置DbContext比在.net core 2中用Moq设置更容易，例如gist.github.com/mikebridge/a1188728a28f0f53b06fed791031c89d。
— mikebridge '18
有关async EF过载的类似伪造，请参见此处
— -StuartLC，
20

谢谢Gaui的好主意=）

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

  1. 我FakeDbSet也从中DbSet获取其他方法，例如AddRange()
  2. 我更换了ObservableCollection<T>与List<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()方法来填充更改来解决此问题。

— 祖肯
source
试图在.net Core 1.0下实现此功能，但主要的缺点是IDbSet已被删除，并且构造函数是私有的，因此我什至无法提取自己的接口。
— Paul Gorbas '17
1
此答案通过在ASP.NET MVC 5中模拟EF .Add（）函数解决了我的问题。尽管我知道它与Core不相关，但是我能够提取足够的信息来继承现有的类，该类使用dbset，idbset模拟dbset并覆盖Add方法。谢谢！
— CSharpMinor
MySuperCoolDbContext这是一个concreate类吗？
— Jaydeep Shil
MySuperCoolDbContext是您的DbContext的名称
— szuuuken
7

如果有人仍在寻找答案，我已经实现了一个小型库来模拟DbContext。

第1步

安装Coderful.EntityFramework.Testing 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); 
    }
}

第三步

现在，您可以超级轻松地创建模拟：

// 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/

— 尼亚赫
source
1
猜猜您没有维护要与.net core一起使用的软件包。这是我尝试安装的错误：软件包Coderful.EntityFramework.Testing 1.5.1与netcoreapp1.0不兼容
— Paul Gorbas
@PaulGorbas你是对的，该库未针对.net核心进行更新。您是否正在使用EF Core起诉？
— niaher '17
1
我的xUnit测试项目针对框架.NetCoreApp 1.0（也称为EF 7 b4），他们更改了命名约定
— Paul Gorbas，
5

我来晚了，但是发现这篇文章很有帮助：使用InMemory（MSDN Docs）进行测试。

它解释了如何使用内存中的数据库上下文（不是数据库），其好处是只需很少的编码，并有机会实际测试您的DBContext实现。

— 优质催化剂
source
4

基于此MSDN文章，我创建了自己的模拟库DbContext和DbSet：

  • EntityFrameworkMock- GitHub
  • EntityFrameworkMockCore- GitHub

两者均可在NuGet和GitHub上使用。

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

此外，由于DbSetMock和DbContextMock都继承自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);
}
— 韦森特赖特
source
与UpdateFromQueryAsync()zzProjects一起使用吗？entityframework-extensions.net/update-from-query
— JobaDiniz
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.