I haven’t seen much about using the ASP.NET Core
TestServer and EF Core’s
InMemoryDb together, despite them being a natural fit, so I thought I’d blog about it. There are a few different ways you could achieve this (more options at the bottom of the post), this is just a simple solution.
- Create a custom environment called Testing.
- In your Startup.cs, add a check to see if you’re in the Testing Environment and if so use the
- In your
TestServersetup, set the environment to Testing.
- Grab the
server.Host.Services.GetService(typeof(ApplicationDbContext)) as ApplicationDbContextand add the data you want there.
- You now have an in memory web server and an in memory database working together!
Quick look at final Test class:
Unit tests test a small piece of the raw logic of your code in isolation of any web server, database, file system, etc. Instead of using a real database, you would use a fake or mock database.
Integration tests on the other hand, are a way of doing automated tests that integrate various components of your app together. It might use a combination of a real web server, real web service, real database, real browser, etc. ASP.NET Core gives us an easy way to write integration tests by way of an object called
TestServer allows you to boot up an in memory web server with your full middleware pipeline, full set of dependencies registered, etc. This enables you to do things like hit a route and make sure the server returns the response you expect.
EF Core InMemory Database
EF Core has a provider that lets you run against an in memory database. The intent of this provider is purely for testing purposes.
This has a few benefits:
- The reads and writes are very fast.
- You don’t have to worry about having a real database to run your tests against.
- You don’t have to worry about cleaning up your data after your tests are done. When the tests stop, your in memory database goes away.
Using these two together
By now you may be thinking. “Cool, so I can create an in memory web server and an in memory EF database…. can I combine the two?” The answer is most definitely, yes! I hadn’t seen much out on the Interwebs about this, so hence this blog post.
Let’s assume we have an API endpoint that looks like this:
It’s pretty straight forward, we inject in a DbContext into the Controller (NOTE: DEMO CODE) and then have an endpoint that takes in an ID and will return the appropriate response based on what the database returns.
So what I’d like to do is swap out the real database here for the in memory database. Let’s do it!
First in your ASP.NET Core Application:
- In our Startup.cs, let’s inject an
IHostingEnvironmentin the constructor and save it to a field/property.
- In our
ConfigureServices, let’s check the Environment to see if the current environment is a custom one called “Testing.”
- If so, then rig up the In Memory Database via
services.AddDbContext<ApplicationDbContext>(options => options.UseInMemoryDatabase("TestingDB"));
- Note: TestingDB is just a unique name given to your In Memory Database.
- So it should look like:
Next in your Unit Testing project (I’m using xUnit, but you could use NUnit or MSTest):
1.Create a new Test Class
a. I follow the convention <ClassUnderTest><MethodUnderTest> for the class name.
b. In this case: ApplicationUsersControllerGetApplicationUser
2. Create a new constructor and set up a
WebHostBuilder with the following code. The two biggest pieces are line 9 where we set the Environment to Testing (to match line 14 above where we check the Environment), and line 13 where we grab the ApplicationDbContext from the
ServiceProvider and save that off.
3. Create a new test method
a. I follow the convention Does<Something>_Given<Scenario>.
b. In this case: DoesReturnOk_GivenUserExists
4. Create a user, add it to the context, and save it. Then use the HttpClient we created and saved off above to query our endpoint and ask for the user’s ID.
That’s it! Now run your test and you will have successfully booted an in memory web server with an in memory database.
Now that we’ve tested the Ok path, we should probably test the NotFound path. That’s simple to do as well:
The entire GitHub code can be found here: https://github.com/scottsauber/TestServerAndInMemoryDbDemo. The two interesting parts are the Startup and the Tests.
Some “Before You Copy + Paste” Caveats
- If you don’t like polluting your “Production” Startup class with Testing concerns (which is a very valid concern), you could create a Test only Startup class. Gérald has a great blog post on how to do this near the bottom of his post. On your
TestServerthen just swap out
- In no way am I advocating for injecting in your DbContext directly into your Controller. This is purely just demo code and to remove layers to make it as easy to reason about as possible. Likely you will have at least one “layer” in between your Controller and your DbContext.
- Note that this will be doing a real integration test and I am ONLY swapping out the DB here. If you need to swap out other components (like external services), you will also have to do that yourself via the
- You will want to limit your creation of the TestServer and HttpClient, due to they are mildly expensive (~100-200ms on my machine), and we want our tests to be as fast as possible. If using xUnit, look into
Hope this helps!