Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Unit Testing DbContext

I've researched some information about techniques I could use to unit test a DbContext. I would like to add some in-memory data to the context so that my tests could run against it. I'm using Database-First approach.

The two articles I've found most usefull were this and this. That approach relies on creating an IContext interface that both MyContext and FakeContext will implement, allowing to Mock the context.

However, I'm trying to avoid using repositories to abstract EF, as pointed by some people, since EF 4.1 already implements repository and unit of work patterns through DbSet and DbContext, and I really would like to preserve all the features implemented by the EF Team without having to maintain them myself with a generic repository, as I already did in other project (and it was kind of painful).

Working with an IContext will lead me to the same path (or won't it?).

I thought about creating a FakeContext that inherits from main MyContext and thus take advantage of the DbContext underneath it to run my tests without hitting the database. I couldn't find similar implementations, so I'm hoping someone can help me on this.

Am I doing something wrong, or could this lead me to some problems that I'm not anticipating?

like image 430
Nelson Reis Avatar asked Jul 20 '11 18:07

Nelson Reis


People also ask

How does EF core help unit testing?

However, when writing unit tests, it's enough to keep the database in memory. Entity Framework Core allows you to run on a virtual database created only in memory. We can also use the SQLite database because it works fast and does not need a server. It also has a mode in which it can run in memory.

What is a DbContext?

A DbContext instance represents a combination of the Unit Of Work and Repository patterns such that it can be used to query from a database and group together changes that will then be written back to the store as a unit. DbContext is conceptually similar to ObjectContext.

What is EF core DbContext?

The Entity Framework Core DbContext class represents a session with a database and provides an API for communicating with the database with the following capabilities: Database Connections. Data operations such as querying and persistance. Change Tracking.


1 Answers

Ask yourself a single question: What are you going to test?

You mentioned FakeContext and Mocking the context - why to use both? Those are just different ways to do the same - provide test only implementation of the context.

There is one more bigger problem - faking or mocking context or set has only one result: You are not testing your real code any more.

Simple example:

public interface IContext : IDisposable {     IDbSet<MyEntity> MyEntities { get; } }  public class MyEntity {     public int Id { get; set; }     public string Path { get; set; }  }  public class MyService {     private bool MyVerySpecialNetMethod(e)     {         return File.Exists(e.Path);     }      public IEnumerable<MyEntity> GetMyEntities()     {         using (IContext context = CreateContext())         {              return context.MyEntities                 .Where(e => MyVerySpecialNetMethod(e))                 .Select(e)                 .ToList();         }     } } 

Now imagine that you have this in your SUT (system under test - in case of unit test it is an unit = usually a method). In the test code you provide FakeContext and FakeSet and it will work - you will have a green test. Now in the production code you will provide a another derived DbContext and DbSet and you will get exception at runtime.

Why? Because by using FakeContext you have also changed LINQ provider and instead of LINQ to Entities you are running LINQ to Objects so calling local .NET methods which cannot be converted to SQL works as well as many other LINQ features which are not available in LINQ to Entities! There are other issues you can find with data modification as well - referential integrity, cascade deletes, etc. That is the reason why I believe that code dealing with context / LINQ to Entities should be covered with integration tests and executed against the real database.

like image 62
Ladislav Mrnka Avatar answered Oct 04 '22 13:10

Ladislav Mrnka