如何在使用 Ninject 时模拟通用 Get 方法并使用 SetUp 方法填充模拟数据库?
How to mock a generic Get method when using Ninject and use a SetUp method to populate the mocked database?
我在我的解决方案中使用 Ninject
和 Moq
进行设置。我使用 Entity Framework,并使用 FakeDbSet 实现(见下文)。这使我能够使用 GetById
、Create
、Update
和其他方法,因为我已经实现了它们。
我所有的服务都有一个方法,例如:
List<Invoice> GetBySpecification(InvoiceSpecification specification);
这是唯一一个我不能轻易模拟的,因为我的实现是这样的,我使用 DbContext
并使用 Where
语句。
public int GetBySpecification(InvoiceSpecification specification)
{
IQueryable<Invoice> query = BuildQuery(specification);
return query.Count();
}
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification)
{
IQueryable<Creditor> query = _db.Creditors;
if (!string.IsNullOrWhiteSpace(specification.Query))
{
var search = specification.Query.ToLower().Trim();
query = query.Where(c => c.OfficeEmail.Contains(search)
|| c.OfficePhone.Contains(search)
|| c.CompanyRegistrationNumber.Contains(search)
|| c.CompanyName.Contains(search)
|| c.LastName.Contains(search)
|| c.FirstName.Contains(search));
}
if (!string.IsNullOrWhiteSpace(specification.CompanyRegistrationNumber))
{
var search = specification.CompanyRegistrationNumber.ToLower().Trim();
query = query.Where(c => c.CompanyRegistrationNumber == search);
}
if (specification.UpdateFrequency.HasValue)
{
query = query.Where(c => c.UpdateFrequency == specification.UpdateFrequency.Value);
}
return query.Where(c => !c.DateDeleted.HasValue);
}
我的问题:
我希望能够在 运行 我的 类 时使用 SetUp
。我想测试我的 GetBySpecification
和 BuildQuery
方法,我在其他方法中使用这些方法并不少见。
我希望能够 运行 一个 SetUp 方法,使用我填充到列表中的 C# 对象在内存中提供一些 "base database",所以当我使用 _db.Creditors
时,它returns 我设置的自定义债权人列表,然后对该列表使用查询。
我想我已经很远了,但我不确定我将如何从这里继续下去。我想我需要以某种方式更新我的解析器/FakeDb 集,但我真的很感激有人在正确的方向上帮助我。
我的 Ninject 解析器:
private static void RegisterServices(IKernel kernel)
{
kernel.Bind<ILikvidoWebsitesApiContext>().ToProvider(new MoqContextProvider());
// other awesome stuff
}
我的 MoqContextProvider:
public class MoqContextProvider : Provider<ILikvidoWebsitesApiContext>
{
protected override ILikvidoWebsitesApiContext CreateInstance(IContext context)
{
var mock = new Mock<ILikvidoWebsitesApiContext>();
mock.Setup(m => m.Creditors).Returns(new FakeDbSet<Creditor>());
return mock.Object;
}
}
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)
{
var keyProperty = typeof(T).GetProperty(
"Id",
BindingFlags.Instance | BindingFlags.Public | BindingFlags.IgnoreCase);
var result = this.SingleOrDefault(obj =>
keyProperty.GetValue(obj).ToString() == keyValues.First().ToString());
return result;
}
public override T Add(T item)
{
_data.Add(item);
// Identity incrementation flow
var prop = item.GetType().GetProperty("Id", typeof(int));
if (prop != null)
{
var value = (int)prop.GetValue(item);
if (value == 0)
{
prop.SetValue(item, _data.Max(d => (int)prop.GetValue(d)) + 1);
}
}
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 new TDerivedEntity Create<TDerivedEntity>() where TDerivedEntity : class, T
{
return Activator.CreateInstance<TDerivedEntity>();
}
public new 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();
}
}
我不明白为什么 EntityFramework 甚至涉及此方法的单元测试。
C#中的三种注入方式:
- 构造函数注入
- 方法注入 <-- 使用这个
- 属性 注射
如果您注入 IQueryable,那么您将把此方法与 Entity Framework 分离。您的逻辑现在无需模拟 EF 即可测试。
让你的第一个方法这样做:
public int GetBySpecification(InvoiceSpecification specification)
{
IQueryable<Invoice> query = BuildQuery(specification, _db.Creditors);
return query.Count();
}
您的第二种方法现在允许注入可查询对象。不再需要EF参与逻辑测试
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
{
if (!string.IsNullOrWhiteSpace(specification.Query))
{
var search = specification.Query.ToLower().Trim();
query = query.Where(c => c.OfficeEmail.Contains(search)
|| c.OfficePhone.Contains(search)
|| c.CompanyRegistrationNumber.Contains(search)
|| c.CompanyName.Contains(search)
|| c.LastName.Contains(search)
|| c.FirstName.Contains(search));
}
if (!string.IsNullOrWhiteSpace(specification.CompanyRegistrationNumber))
{
var search = specification.CompanyRegistrationNumber.ToLower().Trim();
query = query.Where(c => c.CompanyRegistrationNumber == search);
}
if (specification.UpdateFrequency.HasValue)
{
query = query.Where(c => c.UpdateFrequency == specification.UpdateFrequency.Value);
}
return query.Where(c => !c.DateDeleted.HasValue);
}
试一试。
另一个重构想法。 . .
更好的方法是将 QueryBuilder 移动到它自己的对象中。
public interface IInvoiceSpecificationQueryBuilder
{
IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
}
public class InvoiceSpecificationQueryBuilder : IInvoiceSpecificationQueryBuilder
{
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
{
// method logic here
}
}
现在您可以使用三种注入类型中的任何一种将 IInvoiceSpecificationQueryBuilder 注入承载 GetBySpecification() 方法的 class。
要测试 GetBySpecification,您只需测试是否使用正确的参数调用了 BuildQuery。
模拟 EF(不理想但仍然是一个选项)
如果您对模拟 entity framework 死心塌地,那么 bm7716 给了您一篇不错的文章。我在此处实现了该文章中代码的通用实现:https://www.rhyous.com/2015/04/10/how-to-mock-an-entity-framework-dbcontext-and-its-dbset-properties。欢迎您尝试一下。更高版本的 Moq 存在错误,因此请返回 Moq 4.7 以避免它。
更好的选择是 remove/decouple EF 从你的逻辑。
我在我的解决方案中使用 Ninject
和 Moq
进行设置。我使用 Entity Framework,并使用 FakeDbSet 实现(见下文)。这使我能够使用 GetById
、Create
、Update
和其他方法,因为我已经实现了它们。
我所有的服务都有一个方法,例如:
List<Invoice> GetBySpecification(InvoiceSpecification specification);
这是唯一一个我不能轻易模拟的,因为我的实现是这样的,我使用 DbContext
并使用 Where
语句。
public int GetBySpecification(InvoiceSpecification specification)
{
IQueryable<Invoice> query = BuildQuery(specification);
return query.Count();
}
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification)
{
IQueryable<Creditor> query = _db.Creditors;
if (!string.IsNullOrWhiteSpace(specification.Query))
{
var search = specification.Query.ToLower().Trim();
query = query.Where(c => c.OfficeEmail.Contains(search)
|| c.OfficePhone.Contains(search)
|| c.CompanyRegistrationNumber.Contains(search)
|| c.CompanyName.Contains(search)
|| c.LastName.Contains(search)
|| c.FirstName.Contains(search));
}
if (!string.IsNullOrWhiteSpace(specification.CompanyRegistrationNumber))
{
var search = specification.CompanyRegistrationNumber.ToLower().Trim();
query = query.Where(c => c.CompanyRegistrationNumber == search);
}
if (specification.UpdateFrequency.HasValue)
{
query = query.Where(c => c.UpdateFrequency == specification.UpdateFrequency.Value);
}
return query.Where(c => !c.DateDeleted.HasValue);
}
我的问题:
我希望能够在 运行 我的 类 时使用 SetUp
。我想测试我的 GetBySpecification
和 BuildQuery
方法,我在其他方法中使用这些方法并不少见。
我希望能够 运行 一个 SetUp 方法,使用我填充到列表中的 C# 对象在内存中提供一些 "base database",所以当我使用 _db.Creditors
时,它returns 我设置的自定义债权人列表,然后对该列表使用查询。
我想我已经很远了,但我不确定我将如何从这里继续下去。我想我需要以某种方式更新我的解析器/FakeDb 集,但我真的很感激有人在正确的方向上帮助我。
我的 Ninject 解析器:
private static void RegisterServices(IKernel kernel)
{
kernel.Bind<ILikvidoWebsitesApiContext>().ToProvider(new MoqContextProvider());
// other awesome stuff
}
我的 MoqContextProvider:
public class MoqContextProvider : Provider<ILikvidoWebsitesApiContext>
{
protected override ILikvidoWebsitesApiContext CreateInstance(IContext context)
{
var mock = new Mock<ILikvidoWebsitesApiContext>();
mock.Setup(m => m.Creditors).Returns(new FakeDbSet<Creditor>());
return mock.Object;
}
}
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)
{
var keyProperty = typeof(T).GetProperty(
"Id",
BindingFlags.Instance | BindingFlags.Public | BindingFlags.IgnoreCase);
var result = this.SingleOrDefault(obj =>
keyProperty.GetValue(obj).ToString() == keyValues.First().ToString());
return result;
}
public override T Add(T item)
{
_data.Add(item);
// Identity incrementation flow
var prop = item.GetType().GetProperty("Id", typeof(int));
if (prop != null)
{
var value = (int)prop.GetValue(item);
if (value == 0)
{
prop.SetValue(item, _data.Max(d => (int)prop.GetValue(d)) + 1);
}
}
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 new TDerivedEntity Create<TDerivedEntity>() where TDerivedEntity : class, T
{
return Activator.CreateInstance<TDerivedEntity>();
}
public new 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();
}
}
我不明白为什么 EntityFramework 甚至涉及此方法的单元测试。
C#中的三种注入方式:
- 构造函数注入
- 方法注入 <-- 使用这个
- 属性 注射
如果您注入 IQueryable,那么您将把此方法与 Entity Framework 分离。您的逻辑现在无需模拟 EF 即可测试。
让你的第一个方法这样做:
public int GetBySpecification(InvoiceSpecification specification)
{
IQueryable<Invoice> query = BuildQuery(specification, _db.Creditors);
return query.Count();
}
您的第二种方法现在允许注入可查询对象。不再需要EF参与逻辑测试
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
{
if (!string.IsNullOrWhiteSpace(specification.Query))
{
var search = specification.Query.ToLower().Trim();
query = query.Where(c => c.OfficeEmail.Contains(search)
|| c.OfficePhone.Contains(search)
|| c.CompanyRegistrationNumber.Contains(search)
|| c.CompanyName.Contains(search)
|| c.LastName.Contains(search)
|| c.FirstName.Contains(search));
}
if (!string.IsNullOrWhiteSpace(specification.CompanyRegistrationNumber))
{
var search = specification.CompanyRegistrationNumber.ToLower().Trim();
query = query.Where(c => c.CompanyRegistrationNumber == search);
}
if (specification.UpdateFrequency.HasValue)
{
query = query.Where(c => c.UpdateFrequency == specification.UpdateFrequency.Value);
}
return query.Where(c => !c.DateDeleted.HasValue);
}
试一试。
另一个重构想法。 . . 更好的方法是将 QueryBuilder 移动到它自己的对象中。
public interface IInvoiceSpecificationQueryBuilder
{
IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
}
public class InvoiceSpecificationQueryBuilder : IInvoiceSpecificationQueryBuilder
{
public IQueryable<Invoice> BuildQuery(InvoiceSpecification specification, IQueryable<Creditor> query)
{
// method logic here
}
}
现在您可以使用三种注入类型中的任何一种将 IInvoiceSpecificationQueryBuilder 注入承载 GetBySpecification() 方法的 class。
要测试 GetBySpecification,您只需测试是否使用正确的参数调用了 BuildQuery。
模拟 EF(不理想但仍然是一个选项)
如果您对模拟 entity framework 死心塌地,那么 bm7716 给了您一篇不错的文章。我在此处实现了该文章中代码的通用实现:https://www.rhyous.com/2015/04/10/how-to-mock-an-entity-framework-dbcontext-and-its-dbset-properties。欢迎您尝试一下。更高版本的 Moq 存在错误,因此请返回 Moq 4.7 以避免它。
更好的选择是 remove/decouple EF 从你的逻辑。