Testen mit InMemoryTesting with InMemory

Der Anbieter InMemory ist nützlich, wenn Sie Komponenten mithilfe von etwas, das Herstellen einer Verbindung mit der real-Datenbank, ohne den Aufwand für die tatsächliche Datenbankvorgänge entspricht in etwa testen möchten.The InMemory provider is useful when you want to test components using something that approximates connecting to the real database, without the overhead of actual database operations.

Tipp

Sie können anzeigen, dass dieser Artikel Beispiel auf GitHub.You can view this article's sample on GitHub.

InMemory ist nicht mit einer relationalen DatenbankInMemory is not a relational database

EF Datenbank kernanbieter keine relationalen Datenbanken werden.EF Core database providers do not have to be relational databases. InMemory dient als allgemeines Datenbank zum Testen und dient nicht zum Simulieren einer relationalen Datenbank.InMemory is designed to be a general purpose database for testing, and is not designed to mimic a relational database.

Beispiele hierfür sind:Some examples of this include:

  • InMemory können Sie zum Speichern von Daten, die Einschränkungen der referenziellen Integrität in einer relationalen Datenbank verletzen würde.InMemory will allow you to save data that would violate referential integrity constraints in a relational database.

  • Wenn Sie DefaultValueSql(string) für eine Eigenschaft im Modell verwenden, dies ist eine relationale Datenbank-API und hat keine Auswirkungen, bei der Ausführung für InMemory.If you use DefaultValueSql(string) for a property in your model, this is a relational database API and will have no effect when running against InMemory.

Tipp

Für viele Zwecke testen werden diese Unterschiede spielt keine Rolle.For many test purposes these differences will not matter. Allerdings gegebenenfalls für die Tests anhand etwas mehr Verhalten hat wie ein "true" relationale Datenbank sollten Sie die Verwendung SQLite InMemory-Modus.However, if you want to test against something that behaves more like a true relational database, then consider using SQLite in-memory mode.

Beispiel-TestszenarioExample testing scenario

Betrachten Sie den folgenden Dienst, der Anwendungscode im Zusammenhang mit Blogs Eingriffe ermöglicht.Consider the following service that allows application code to perform some operations related to blogs. Er verwendet intern eine DbContext , die eine Verbindung mit einer SQL Server-Datenbank her.Internally it uses a DbContext that connects to a SQL Server database. Wäre es nützlich, um diesem Kontext die Verbindung mit einer InMemory-Datenbank, damit wir effiziente Tests für diesen Dienst schreiben, ohne den Code ändern können, oder viele Vorgänge zum Erstellen eines Tests führen Austauschen des Kontexts double.It would be useful to swap this context to connect to an InMemory database so that we can write efficient tests for this service without having to modify the code, or do a lot of work to create a test double of the context.

using System.Collections.Generic;
using System.Linq;

namespace BusinessLogic
{
    public class BlogService
    {
        private BloggingContext _context;

        public BlogService(BloggingContext context)
        {
            _context = context;
        }

        public void Add(string url)
        {
            var blog = new Blog { Url = url };
            _context.Blogs.Add(blog);
            _context.SaveChanges();
        }

        public IEnumerable<Blog> Find(string term)
        {
            return _context.Blogs
                .Where(b => b.Url.Contains(term))
                .OrderBy(b => b.Url)
                .ToList();
        }
    }
}

Bereiten Sie den KontextGet your context ready

Vermeiden Sie die Konfiguration von zwei DatenbankanbieterAvoid configuring two database providers

In den Tests wirst du extern konfigurieren Sie den Kontext des InMemory-Anbieters verwenden.In your tests you are going to externally configure the context to use the InMemory provider. Wenn Sie einen Datenbankanbieter durch Außerkraftsetzen konfigurieren OnConfiguring in den Kontext, dann müssen Sie fügen Sie bedingte Code zum sicherstellen, dass Sie nur den Datenbankanbieter konfigurieren, wenn Sie noch nicht konfiguriert wurde.If you are configuring a database provider by overriding OnConfiguring in your context, then you need to add some conditional code to ensure that you only configure the database provider if one has not already been configured.

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    if (!optionsBuilder.IsConfigured)
    {
        optionsBuilder.UseSqlServer(@"Server=(localdb)\mssqllocaldb;Database=EFProviders.InMemory;Trusted_Connection=True;ConnectRetryCount=0");
    }
}

Tipp

Bei Verwendung von ASP.NET Core sollte dann nicht mit diesem Code erforderlich, da der Datenbankanbieter bereits außerhalb des Kontexts (in "Startup.cs) konfiguriert ist.If you are using ASP.NET Core, then you should not need this code since your database provider is already configured outside of the context (in Startup.cs).

Fügen Sie einen Konstruktor zu TestzweckenAdd a constructor for testing

Die einfachste Methode zum Aktivieren von Tests mit einer anderen Datenbank so ändern Sie den Kontext, um einen Konstruktor verfügbar machen, das akzeptiert, wird eine DbContextOptions<TContext>.The simplest way to enable testing against a different database is to modify your context to expose a constructor that accepts a DbContextOptions<TContext>.

public class BloggingContext : DbContext
{
    public BloggingContext()
    { }

    public BloggingContext(DbContextOptions<BloggingContext> options)
        : base(options)
    { }

Tipp

DbContextOptions<TContext>Gibt dem Kontext alle zugehörigen Einstellungen, z. B. welche Datenbank für die Verbindung.DbContextOptions<TContext> tells the context all of its settings, such as which database to connect to. Dies ist das gleiche Objekt, das erstellt wird, durch die OnConfiguring-Methode in Ihrem Kontext ausgeführt wird.This is the same object that is built by running the OnConfiguring method in your context.

Schreiben von testsWriting tests

Der Schlüssel für das Testen von mit diesem Anbieter ist die Fähigkeit, teilen Sie den Kontext zum Verwenden des InMemory-Anbieters und Steuern des Bereichs der Datenbank im Arbeitsspeicher.The key to testing with this provider is the ability to tell the context to use the InMemory provider, and control the scope of the in-memory database. Sie möchten in der Regel eine fehlerfreie Datenbank für jede Testmethode.Typically you want a clean database for each test method.

Hier ist ein Beispiel für eine Testklasse, die den InMemory-Datenbank verwendet.Here is an example of a test class that uses the InMemory database. Jede Testmethode gibt einen eindeutigen Datenbanknamen an, was bedeutet, dass jede Methode ihre eigene InMemory-Datenbank hat.Each test method specifies a unique database name, meaning each method has its own InMemory database.

Tipp

Verwenden der .UseInMemoryDatabase() Erweiterungsmethode, Verweis das NuGet-Paket Microsoft.EntityFrameworkCore.InMemory.To use the .UseInMemoryDatabase() extension method, reference the Nuget package Microsoft.EntityFrameworkCore.InMemory.

using BusinessLogic;
using Microsoft.EntityFrameworkCore;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Linq;

namespace TestProject.InMemory
{
    [TestClass]
    public class BlogServiceTests
    {
        [TestMethod]
        public void Add_writes_to_database()
        {
            var options = new DbContextOptionsBuilder<BloggingContext>()
                .UseInMemoryDatabase(databaseName: "Add_writes_to_database")
                .Options;

            // Run the test against one instance of the context
            using (var context = new BloggingContext(options))
            {
                var service = new BlogService(context);
                service.Add("http://sample.com");
            }

            // Use a separate instance of the context to verify correct data was saved to database
            using (var context = new BloggingContext(options))
            {
                Assert.AreEqual(1, context.Blogs.Count());
                Assert.AreEqual("http://sample.com", context.Blogs.Single().Url);
            }
        }

        [TestMethod]
        public void Find_searches_url()
        {
            var options = new DbContextOptionsBuilder<BloggingContext>()
                .UseInMemoryDatabase(databaseName: "Find_searches_url")
                .Options;

            // Insert seed data into the database using one instance of the context
            using (var context = new BloggingContext(options))
            {
                context.Blogs.Add(new Blog { Url = "http://sample.com/cats" });
                context.Blogs.Add(new Blog { Url = "http://sample.com/catfish" });
                context.Blogs.Add(new Blog { Url = "http://sample.com/dogs" });
                context.SaveChanges();
            }

            // Use a clean instance of the context to run the test
            using (var context = new BloggingContext(options))
            {
                var service = new BlogService(context);
                var result = service.Find("cat");
                Assert.AreEqual(2, result.Count());
            }
        }
    }
}