使用xunit、Shouldy、NSubstitute 测试Entity Framework (EF6.0)

前言

此篇文章只针对ef6.0的特性和API,较早的版本,可能有部分或全部信息不适用。

参考

Entity Framework Testing with a Mocking Framework

NSubstitute完全手册索引

源代码

模拟对象的创建

有两种不同的方法可以用来创建一个内存中的上下文

1.创建自定义模拟对象

创建自定义模拟对象,需要编写自己的上下文和DbSets内存中的实现。
这样我们就可以控制很对的类行为以及编写合理数量的代码。

2.适用Mocking框架创建模拟对象

使用模拟框架(如NSubstitute)你可以有内存的实现上下文和集在运行时动态创建

这篇文章主要主要是讲述如何使用模拟框架。关于如何创建自定义模拟对象,可参阅:Testing with Your Own Test Doubles (EF6 onwards)

为了使用 EF 的 mocking 框架 , 我们将使用 NSubstitute。

测试更早版本

本文中显示的方案取决于我们对EF6中的DbSet所做的一些更改。
对于使用EF5和更早版本的测试,请参阅使用Fake Context进行测试。

局限性

内存模拟测试是提供使用EF的应用程序单元测试级别覆盖率的好方法。但是,在执行操作时,您正在使用的Linq to Obejcts来对内存中的数据执行查询。这可能导致与使用EF的Linq提供程序(linq to entities )将查询转换为针对数据库运行的sql 不同的行为。
比如,在加载相关数据方面。如果您创建了一系列具有相关帖子的博客,那么在使用内存中的数据时,相关帖子将始终被每个博客加载。但是,当对数据库运行时,只有使用Include方法时,才会加载数据。
因此,建议始终包括一些级别的端对端测试(除了单元测试),以确保应用程序对数据库正常工作。


使用准备

本文提供了完整的代码清单,您可以将其复制到Visual Stuio中使用。
需要使用 .Net Framework4.5
1.创建单元测试项目
2.使用nuget添加一下包

Nuget.png

EF模型

我们要测试的服务使用由BloggingContext和Blog和Post类组成的EF模型。 此代码可能是由EF Designer生成的,或者是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属性

上下文中的DbSet 属性标记为虚拟,这将允许模拟框架从我们自己的上下中导出,并使用模拟实现来覆盖这些属性。


测试服务

为了展示使用内存测试模拟对象,我们将为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 <Blog>并将其连接起来,从上下文的“博客”属性返回。 接下来,上下文用于创建一个新的BlogService,然后用它来创建一个新的博客 - 使用AddBlog方法。 最后,测试验证该服务在上下文中添加了一个新的Blog并调用SaveChanges。


using Microsoft.VisualStudio.TestTools.UnitTesting; 
using Moq; 
using System.Data.Entity; 
 
namespace TestingDemo 
{ 
    public class NonQueryTests
    {
        [Fact]
        public void CreateBlog_saves_a_blog_via_context()
        {
            var mockSet = Substitute.For<DbSet<Blog>>();
            var mockContext = Substitute.For<BloggingContext>();
            mockContext.Blogs.Returns(mockSet);

            var addBolg = new Blog(); // 用来验证add 方法 传入的参数使用为预期内容
            mockSet.Add(Arg.Do<Blog>(x => addBolg = x)); 

            var service = new BlogService(mockContext);
            service.AddBlog("ADO.NET Blog", "http://blogs.msdn.com/adonet");
            
            mockSet.Received(1).Add(Arg.Any<Blog>()); // set add 方法调用一次
            mockContext.Received(1).SaveChanges(); // context savechanges 方法调用一次
            
            // 实体属性验证
            addBolg.Name.ShouldBe("ADO.NET Blog");
            addBolg.Url.ShouldBe("http://blogs.msdn.com/adonet");

            addBolg.Name.ShouldNotBe("ADO.NET");
        }
    }
}

测试查询

为了能够针对我们的DbSet测试执行查询,我们需要设置一个IQueryable的实现。 第一步是创建一些内存中的数据 - 我们使用的是List <Blog>。 接下来,我们创建一个上下文和DBSet <Blog>,然后连接DbSet的IQueryable实现 - 它们只是委托给与List <T>一起使用的LINQ to Objects提供程序。为了能够针对我们的DbSet测试执行查询,我们需要设置一个IQueryable的实现。 第一步是创建一些内存中的数据 - 我们使用的是List <Blog>。 接下来,我们创建一个上下文和DBSet <Blog>,然后连接DbSet的IQueryable实现 - 它们只是委托给与List <T>一起使用的LINQ to Objects提供程序。


using Microsoft.VisualStudio.TestTools.UnitTesting; 
using Moq; 
using System.Collections.Generic; 
using System.Data.Entity; 
using System.Linq; 
 
namespace TestingDemo 
{ 
    public class QueryTests
    {
        [Fact]
        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 = Substitute.For<DbSet<Blog>, IQueryable<Blog>>();
            ((IQueryable<Blog>)mockSet).Provider.Returns(data.Provider);
            ((IQueryable<Blog>)mockSet).Expression.Returns(data.Expression);
            ((IQueryable<Blog>)mockSet).ElementType.Returns(data.ElementType);
            ((IQueryable<Blog>)mockSet).GetEnumerator().Returns(data.GetEnumerator());
            
            var mockContext = Substitute.For<BloggingContext>();
            mockContext.Blogs.Returns(mockSet);
            var service = new BlogService(mockContext);
            var blogs = service.GetAllBlogs();
            blogs.Count.ShouldBe(3);
            blogs[0].Name.ShouldBe("AAA");
            blogs[1].Name.ShouldBe("BBB");
            blogs[2].Name.ShouldBe("ZZZ");
            
        }
    }
}


测试异步查询方案

为了使用异步查询,我们需要做更多的工作。 如果我们尝试使用我们的Moq DbSet与GetAllBlogsAsync方法,我们将得到以下异常:为了使用异步查询,我们需要做更多的工作。 如果我们尝试使用我们的Moq DbSet与GetAllBlogsAsync方法,我们将得到以下异常:

System.InvalidOperationException: The source IQueryable doesn't implement IDbAsyncEnumerable<TestingDemo.Blog>. Only sources that implement IDbAsyncEnumerable can be used for Entity Framework asynchronous operations. For more details see http://go.microsoft.com/fwlink/?LinkId=287068._System.InvalidOperationException

为了使用异步方法,我们需要创建一个内存中的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方法编写单元测试。现在我们有一个异步查询提供程序,我们可以为我们的新的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 
{ 
    public class AsyncQueryTests
    {
        [Fact]
        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 = Substitute.For<DbSet<Blog>, IQueryable<Blog>, IDbAsyncEnumerable<Blog>>();

            ((IDbAsyncEnumerable<Blog>)mockSet).GetAsyncEnumerator()
                .Returns(new TestDbAsyncEnumerator<Blog>(data.GetEnumerator()));
            ((IQueryable<Blog>)mockSet).Provider
                .Returns(new TestDbAsyncQueryProvider<Blog>(data.Provider));

            ((IQueryable<Blog>)mockSet).Expression
                .Returns(data.Expression);
            ((IQueryable<Blog>)mockSet).ElementType
                .Returns(data.ElementType);
            ((IQueryable<Blog>)mockSet).GetEnumerator()
                .Returns(data.GetEnumerator());
            
            var mockContext = Substitute.For<BloggingContext>();
            mockContext.Blogs.Returns(mockSet);
            var service = new BlogService(mockContext);
            var blogs = await service.GetAllBlogsAsync();
            blogs.Count.ShouldBe(3);
            blogs[0].Name.ShouldBe("AAA");
            blogs[1].Name.ShouldBe("BBB");
            blogs[2].Name.ShouldBe("ZZZ");
        }
    }
}



QQ:1260825783(诸葛小亮)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,856评论 25 707
  • 打开Dump文件调试 VS方式:用VS打开dumpVS调试a 根据截图中“1”的位置确定程序安装路径,将同版本的程...
    龙翱天际阅读 4,494评论 0 0
  • “如何度过生命的最后24小时?”要被问起这个问题,你会怎么回答? 如果你说,24小时太短暂了,想做的事情实在太多了...
    言射手阅读 1,138评论 3 10
  • 听完了《戴红袖标的大象》,我请孩子们画出印象最深刻的或者说最喜欢的一个角色、场景。 他先是用棕...
    xiaotu_ruo阅读 342评论 0 0