Тестирование с помощью платформы макетирования

Статья
08/24/2023

Примечание.

Только в EF6 и более поздних версиях. Функции, API и другие возможности, описанные на этой странице, появились в Entity Framework 6. При использовании более ранней версии могут быть неприменимы некоторые или все сведения.

При написании тестов для приложения часто желательно избежать попадания в базу данных. Entity Framework позволяет достичь этого путем создания контекста ( с поведением, определенным тестами), который использует данные в памяти.

Параметры создания тестовых двойных

Существует два различных подхода, которые можно использовать для создания в памяти версии контекста.

Создайте собственный тест в два раза . Этот подход включает написание собственной реализации в памяти контекста и DbSets. Это дает вам много контроля над поведением классов, но может включать написание и владение разумным объемом кода.
Используйте платформу макетирования для создания тестовых двойников . С помощью макетной платформы (например, Moq) можно использовать реализацию контекста в памяти и наборы, созданные динамически во время выполнения.

В этой статье рассматривается использование макетной платформы. Сведения о создании собственного теста двойники см. в разделе "Тестирование с помощью собственных двойных тестов".

Чтобы продемонстрировать использование EF с макетной платформой, мы будем использовать Moq. Самый простой способ получить Moq — установить пакет Moq из NuGet.

Тестирование с предварительной версией EF6

Сценарий, показанный в этой статье, зависит от некоторых изменений, внесенных в DbSet в EF6. Тестирование с помощью EF5 и более ранней версии см. в разделе "Тестирование с помощью поддельных контекстов".

Ограничения теста EF в памяти двойны

Двойные тесты в памяти могут быть хорошим способом обеспечить охват битов вашего приложения, использующих EF. Однако при этом используется LINQ to Objects для выполнения запросов к данным в памяти. Это может привести к поведению, отличному от использования поставщика LINQ EF (LINQ to Entity) для перевода запросов в SQL, выполняемых в базе данных.

Одним из примеров такого различия является загрузка связанных данных. Если вы создаете ряд блогов, которые имеют связанные записи, то при использовании данных в памяти связанные записи всегда будут загружаться для каждого блога. Однако при выполнении в базе данных данные загружаются только при использовании метода Include.

По этой причине рекомендуется всегда включать некоторый уровень сквозного тестирования (в дополнение к модульным тестам), чтобы приложение работало правильно с базой данных.

Далее вместе с этой статьей

В этой статье приведены полные описания кода, которые можно скопировать в Visual Studio, чтобы следовать за этим, если вы хотите. Проще всего создать проект модульного теста, и вам потребуется использовать платформа .NET Framework 4.5, чтобы завершить разделы, использующие асинхронный.

Модель EF

Служба, которую мы собираемся протестировать, использует модель EF, которая состоит из bloggingContext и классов Blog и Post. Этот код может быть создан конструктором EF или моделью Code First.

using System.Collections.Generic;
using System.Data.Entity;

namespace TestingDemo
{
    public class BloggingContext : DbContext
    {
        public virtual DbSet<Blog> Blogs { get; set; }
        public virtual DbSet<Post> Posts { get; set; }
    }

    public class Blog
    {
        public int BlogId { get; set; }
        public string Name { get; set; }
        public string Url { get; set; }

        public virtual List<Post> Posts { get; set; }
    }

    public class Post
    {
        public int PostId { get; set; }
        public string Title { get; set; }
        public string Content { get; set; }

        public int BlogId { get; set; }
        public virtual Blog Blog { get; set; }
    }
}

Свойства Virtual DbSet с помощью EF Designer

Обратите внимание, что свойства DbSet в контексте помечены как виртуальные. Это позволит осмеять платформу наследоваться от нашего контекста и переопределить эти свойства с помощью макетной реализации.

Если вы используете код сначала, вы можете напрямую изменить классы. Если вы используете конструктор EF, необходимо изменить шаблон T4, который создает контекст. <Откройте файл model_name.Context.tt>, вложенный в edmx-файл, найдите следующий фрагмент кода и добавьте в виртуальную ключевое слово, как показано ниже.

public string DbSet(EntitySet entitySet)
{
    return string.Format(
        CultureInfo.InvariantCulture,
        "{0} virtual DbSet\<{1}> {2} {{ get; set; }}",
        Accessibility.ForReadOnlyProperty(entitySet),
        _typeMapper.GetTypeName(entitySet.ElementType),
        _code.Escape(entitySet));
}

Проверка службы

Чтобы продемонстрировать тестирование с помощью теста в памяти, мы будем писать несколько тестов для BlogService. Служба может создавать новые блоги (AddBlog) и возвращать все блоги, упорядоченные по имени (GetAllBlogs). Помимо GetAllBlogs, мы также предоставили метод, который будет асинхронно получать все блоги, упорядоченные по имени (GetAllBlogsAsync).

using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Threading.Tasks;

namespace TestingDemo
{
    public class BlogService
    {
        private BloggingContext _context;

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

        public Blog AddBlog(string name, string url)
        {
            var blog = _context.Blogs.Add(new Blog { Name = name, Url = url });
            _context.SaveChanges();

            return blog;
        }

        public List<Blog> GetAllBlogs()
        {
            var query = from b in _context.Blogs
                        orderby b.Name
                        select b;

            return query.ToList();
        }

        public async Task<List<Blog>> GetAllBlogsAsync()
        {
            var query = from b in _context.Blogs
                        orderby b.Name
                        select b;

            return await query.ToListAsync();
        }
    }
}

Тестирование сценариев без запросов

Это все, что нам нужно сделать, чтобы начать тестирование методов без запросов. Следующий тест использует Moq для создания контекста. Затем он создает блог> DbSet<и проводит его из свойства блогов контекста. Затем контекст используется для создания новой службы BlogService, которая затем используется для создания нового блога с помощью метода AddBlog. Наконец, тест проверяет, добавлена ли служба новый блог и называется SaveChanges в контексте.

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using System.Data.Entity;

namespace TestingDemo
{
    [TestClass]
    public class NonQueryTests
    {
        [TestMethod]
        public void CreateBlog_saves_a_blog_via_context()
        {
            var mockSet = new Mock<DbSet<Blog>>();

            var mockContext = new Mock<BloggingContext>();
            mockContext.Setup(m => m.Blogs).Returns(mockSet.Object);

            var service = new BlogService(mockContext.Object);
            service.AddBlog("ADO.NET Blog", "http://blogs.msdn.com/adonet");

            mockSet.Verify(m => m.Add(It.IsAny<Blog>()), Times.Once());
            mockContext.Verify(m => m.SaveChanges(), Times.Once());
        }
    }
}

Тестирование сценариев запросов

Чтобы иметь возможность выполнять запросы к тесту DbSet double, необходимо настроить реализацию IQueryable. Первым шагом является создание некоторых данных в памяти — мы используем блог> списка<. Затем мы создадим контекст и блог> DBSet<, а затем простроим реализацию IQueryable для DbSet— они просто делегируются поставщику объектов LINQ to Objects, который работает с List<T>.

Затем мы можем создать службу BlogService на основе тестового двойника и убедиться, что данные, которые мы возвращаем из GetAllBlogs, упорядочены по имени.

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;

namespace TestingDemo
{
    [TestClass]
    public class QueryTests
    {
        [TestMethod]
        public void GetAllBlogs_orders_by_name()
        {
            var data = new List<Blog>
            {
                new Blog { Name = "BBB" },
                new Blog { Name = "ZZZ" },
                new Blog { Name = "AAA" },
            }.AsQueryable();

            var mockSet = new Mock<DbSet<Blog>>();
            mockSet.As<IQueryable<Blog>>().Setup(m => m.Provider).Returns(data.Provider);
            mockSet.As<IQueryable<Blog>>().Setup(m => m.Expression).Returns(data.Expression);
            mockSet.As<IQueryable<Blog>>().Setup(m => m.ElementType).Returns(data.ElementType);
            mockSet.As<IQueryable<Blog>>().Setup(m => m.GetEnumerator()).Returns(() => data.GetEnumerator());

            var mockContext = new Mock<BloggingContext>();
            mockContext.Setup(c => c.Blogs).Returns(mockSet.Object);

            var service = new BlogService(mockContext.Object);
            var blogs = service.GetAllBlogs();

            Assert.AreEqual(3, blogs.Count);
            Assert.AreEqual("AAA", blogs[0].Name);
            Assert.AreEqual("BBB", blogs[1].Name);
            Assert.AreEqual("ZZZ", blogs[2].Name);
        }
    }
}

Тестирование с помощью асинхронных запросов

Entity Framework 6 представил набор методов расширения, которые можно использовать для асинхронного выполнения запроса. Примеры этих методов включают ToListAsync, FirstAsync, ForEachAsync и т. д.

Так как запросы Entity Framework используют LINQ, методы расширения определяются в IQueryable и IEnumerable. Тем не менее, поскольку они предназначены только для использования с Entity Framework, при попытке использовать их в запросе LINQ, который не является запросом Entity Framework, может возникнуть следующая ошибка:

Исходный IQueryable не реализует IDbAsyncEnumerable{0}. Для асинхронных операций Entity Framework можно использовать только источники, реализующие IDbAsyncEnumerable. Дополнительные сведения см. в следующей статье: http://go.microsoft.com/fwlink/?LinkId=287068.

Хотя асинхронные методы поддерживаются только при выполнении в запросе EF, их можно использовать в модульном тесте при выполнении в памяти двойника dbSet.

Чтобы использовать асинхронные методы, необходимо создать в памяти DbAsyncQueryProvider для обработки асинхронного запроса. Хотя можно было бы настроить поставщик запросов с помощью Moq, гораздо проще создать тестовую двойную реализацию в коде. Код для этой реализации выглядит следующим образом:

using System.Collections.Generic;
using System.Data.Entity.Infrastructure;
using System.Linq;
using System.Linq.Expressions;
using System.Threading;
using System.Threading.Tasks;

namespace TestingDemo
{
    internal class TestDbAsyncQueryProvider<TEntity> : IDbAsyncQueryProvider
    {
        private readonly IQueryProvider _inner;

        internal TestDbAsyncQueryProvider(IQueryProvider inner)
        {
            _inner = inner;
        }

        public IQueryable CreateQuery(Expression expression)
        {
            return new TestDbAsyncEnumerable<TEntity>(expression);
        }

        public IQueryable<TElement> CreateQuery<TElement>(Expression expression)
        {
            return new TestDbAsyncEnumerable<TElement>(expression);
        }

        public object Execute(Expression expression)
        {
            return _inner.Execute(expression);
        }

        public TResult Execute<TResult>(Expression expression)
        {
            return _inner.Execute<TResult>(expression);
        }

        public Task<object> ExecuteAsync(Expression expression, CancellationToken cancellationToken)
        {
            return Task.FromResult(Execute(expression));
        }

        public Task<TResult> ExecuteAsync<TResult>(Expression expression, CancellationToken cancellationToken)
        {
            return Task.FromResult(Execute<TResult>(expression));
        }
    }

    internal class TestDbAsyncEnumerable<T> : EnumerableQuery<T>, IDbAsyncEnumerable<T>, IQueryable<T>
    {
        public TestDbAsyncEnumerable(IEnumerable<T> enumerable)
            : base(enumerable)
        { }

        public TestDbAsyncEnumerable(Expression expression)
            : base(expression)
        { }

        public IDbAsyncEnumerator<T> GetAsyncEnumerator()
        {
            return new TestDbAsyncEnumerator<T>(this.AsEnumerable().GetEnumerator());
        }

        IDbAsyncEnumerator IDbAsyncEnumerable.GetAsyncEnumerator()
        {
            return GetAsyncEnumerator();
        }

        IQueryProvider IQueryable.Provider
        {
            get { return new TestDbAsyncQueryProvider<T>(this); }
        }
    }

    internal class TestDbAsyncEnumerator<T> : IDbAsyncEnumerator<T>
    {
        private readonly IEnumerator<T> _inner;

        public TestDbAsyncEnumerator(IEnumerator<T> inner)
        {
            _inner = inner;
        }

        public void Dispose()
        {
            _inner.Dispose();
        }

        public Task<bool> MoveNextAsync(CancellationToken cancellationToken)
        {
            return Task.FromResult(_inner.MoveNext());
        }

        public T Current
        {
            get { return _inner.Current; }
        }

        object IDbAsyncEnumerator.Current
        {
            get { return Current; }
        }
    }
}

Теперь, когда у нас есть асинхронный поставщик запросов, мы можем написать модульный тест для нового метода GetAllBlogsAsync.

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using System.Collections.Generic;
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using System.Linq;
using System.Threading.Tasks;

namespace TestingDemo
{
    [TestClass]
    public class AsyncQueryTests
    {
        [TestMethod]
        public async Task GetAllBlogsAsync_orders_by_name()
        {

            var data = new List<Blog>
            {
                new Blog { Name = "BBB" },
                new Blog { Name = "ZZZ" },
                new Blog { Name = "AAA" },
            }.AsQueryable();

            var mockSet = new Mock<DbSet<Blog>>();
            mockSet.As<IDbAsyncEnumerable<Blog>>()
                .Setup(m => m.GetAsyncEnumerator())
                .Returns(new TestDbAsyncEnumerator<Blog>(data.GetEnumerator()));

            mockSet.As<IQueryable<Blog>>()
                .Setup(m => m.Provider)
                .Returns(new TestDbAsyncQueryProvider<Blog>(data.Provider));

            mockSet.As<IQueryable<Blog>>().Setup(m => m.Expression).Returns(data.Expression);
            mockSet.As<IQueryable<Blog>>().Setup(m => m.ElementType).Returns(data.ElementType);
            mockSet.As<IQueryable<Blog>>().Setup(m => m.GetEnumerator()).Returns(() => data.GetEnumerator());

            var mockContext = new Mock<BloggingContext>();
            mockContext.Setup(c => c.Blogs).Returns(mockSet.Object);

            var service = new BlogService(mockContext.Object);
            var blogs = await service.GetAllBlogsAsync();

            Assert.AreEqual(3, blogs.Count);
            Assert.AreEqual("AAA", blogs[0].Name);
            Assert.AreEqual("BBB", blogs[1].Name);
            Assert.AreEqual("ZZZ", blogs[2].Name);
        }
    }
}

Поделиться через