Дразнящий EF DbContext с Moq
Я пытаюсь создать модульный тест для моего сервиса с помощью поддельного 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
5 ответов
Мне удалось решить это путем создания 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());
}
Если кому-то все еще интересно, у меня возникла та же проблема, и я нашел эту статью очень полезной: Тестирование Entity Framework с использованием Mocking Framework (EF6 и далее)
Это применимо только к Entity Framework 6 или новее, но охватывает все, от простых тестов SaveChanges до тестирования асинхронных запросов с использованием Moq (и нескольких ручных классов).
Спасибо, Гауи, за отличную идею =)
Я добавил некоторые улучшения в ваше решение и хочу поделиться им.
- мой
FakeDbSetтакже присущи отDbSetчтобы получить дополнительные методы, такие какAddRange() - Я заменил
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 и Mock the EF Context Object:
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, я создал свои собственные библиотеки для насмешек DbContext а также DbSet:
Оба доступны на NuGet и GitHub.
Я создал эти библиотеки по той причине, что хотел эмулировать SaveChanges поведение, бросить DbUpdateException при вставке моделей с одинаковым первичным ключом и поддержкой первичных ключей с несколькими столбцами / автоинкрементом в моделях.
Кроме того, так как оба 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);
}
Если кто-то все еще ищет ответы, я реализовал небольшую библиотеку, позволяющую дразнить DbContext.
шаг 1
Установите пакет https://www.nuget.org/packages/Coderful.EntityFramework.Testing:
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).
В нем объясняется, как использовать контекст БД в памяти (который не является базой данных) с преимуществом очень небольшого количества кода и возможностью фактически протестировать ваш DBContext реализация.