Visual Studio 2012 Fakes框架测试驱动开发TDD教程

 

一、前言

　　最近团队要尝试TDD（测试驱动开发）的实践，很多人习惯了先代码后测试的流程，对于TDD总心存恐惧，认为没有代码的情况下写测试代码时被架空了，没法写下来，其实，根据个人实践经验，TDD并不可怕，还很可爱，只要你真正去实践了几十个测试用例之后，你会爱上这种形式方式的。微软对于TDD的开发方式是大力支持和推荐的，新发布的VS2012的团队模板就是根据。新的Visual Studio 2012给我们带来了Fakes框架，这是一个针对代码测试时对测试的外界依赖（如数据库，文件等）进行模拟的Mock框架，用上了之后，我立即从Moq的阵营中叛变了^_^。截止到写此文的时间，网上还没有一篇关于Fakes框架的文章（除了“VS11将拥有更好的单元测试工具和Fakes框架”这篇介绍性的之外），就让我们来慢慢摸索着用吧。废话少说，下面我们就来一步一步的使用Visual Studio 2012的Fakes框架来实战一把TDD。

二、需求说明

　　我们要做的是一个普通的用户注册中“检查用户名是否存在”的功能，需求如下：

1. 用户名不能重复
2. 可设置是否启用邮件激活，如果不启用邮件激活，则直接在“正式用户信息表”中检查，反之则还要进入“未激活用户信息表”中进行查询

三、项目结构

　　先分解一下项目的结构，还是传统的三层结构，从底层到上层：

1. Liuliu.Components.Tools：通用工具组件
2. Liuliu.Components.Data：通用数据访问组件，目前只定义了一个数据访问接口的通用基接口IRepository
3. Liuliu.Demo.Core.Models：数据实体类，分两个模块，账户模块（Account）与通用模块（Common）
4. Liuliu.Demo.Core：业务核心层，里面包含Business与DataAccess两个子层，DataAccess实现实体类的数据访问，Business层实现模块的业务逻辑，因为测试的过程中数据访问层的数据库实现会用Fakes框架来模拟，所以数据访问层只提供了接口，不提供实现，Business只调用了DataAccess的接口。我们要做的工作就是用Fakes框架来模拟数据访问层，用TDD的方式来编写Business中的业务实现
5. Liuliu.Demo.Core.Business.UnitTest：单元测试项目，存放着测试Business实现的测试用例。
6. Liuliu.Demo.Consoles：用户操作控制台，功能实现后进行用户操作的UI项目

　　其他的项目与测试无关，略过。

四、开发准备

(一) 应用代码准备

Entity：实体类的通用数据结构

/// <summary>
     ///   数据实体类基类，定义数据库存储的数据结构的通用部分
     /// </summary>
     public abstract class Entity
     {
         /// <summary>
         ///   编号
         /// </summary>
         public int Id { get; set; }

         /// <summary>
         ///   是否逻辑删除（相当于回收站，非物理删除）
         /// </summary>
         public bool IsDelete { get; set; }

         /// <summary>
         ///   添加时间
         /// </summary>
         public DateTime AddDate { get; set; }
     }
IRepository：通用数据访问接口，简单起见，只写了几个增删改查的接口
/// <summary>
     /// 定义仓储模式中的数据标准操作，其实现类是仓储类型。
     /// </summary>
     /// <typeparam name="TEntity">要实现仓储的类型</typeparam>
     public interface IRepository<TEntity> where TEntity : Entity
     {
         #region 公用方法

         /// <summary>
         ///   插入实体记录
         /// </summary>
         /// <param name="entity"> 实体对象 </param>
         /// <param name="isSave"> 是否执行保存 </param>
         /// <returns> 操作影响的行数 </returns>
         int Insert(TEntity entity, bool isSave = true);

         /// <summary>
         ///   删除实体记录
         /// </summary>
         /// <param name="entity"> 实体对象 </param>
         /// <param name="isSave"> 是否执行保存 </param>
         /// <returns> 操作影响的行数 </returns>
         int Delete(TEntity entity, bool isSave = true);

         /// <summary>
         ///   更新实体记录
         /// </summary>
         /// <param name="entity"> 实体对象 </param>
         /// <param name="isSave"> 是否执行保存 </param>
         /// <returns> 操作影响的行数 </returns>
         int Update(TEntity entity, bool isSave = true);

         /// <summary>
         /// 提交当前的Unit Of Work事务，作用与 IUnitOfWork.Commit() 相同。
         /// </summary>
         /// <returns>提交事务影响的行数</returns>
         int Commit();

         /// <summary>
         ///   查找指定编号的实体记录
         /// </summary>
         /// <param name="id"> 指定编号 </param>
         /// <returns> 符合编号的记录，不存在返回null </returns>
         TEntity GetById(object id);

         /// <summary>
         /// 查找指定名称的实体记录，注意：如实体无名称属性则不支持
         /// </summary>
         /// <param name="name">名称</param>
         /// <returns>符合名称的记录，不存在则返回null</returns>
         /// <exception cref="NotSupportedException">当对应实体无名称时引发将引发异常</exception>
         TEntity GetByName(string name);

         #endregion
     }
Member：实体类——用户信息
/// <summary>
     ///   实体类——用户信息
     /// </summary>
     public class Member : Entity
     {
         public string UserName { get; set; }

         public string Password { get; set; }

         public string Email { get; set; }
     }
MemberInactive：实体类——未激活用户信息
/// <summary>
     ///   实体类——未激活用户信息
     /// </summary>
     public class MemberInactive : Entity
     {
         public string UserName { get; set; }

         public string Password { get; set; }

         public string Email { get; set; }
     }
ConfigInfo：实体类——系统配置信息
IMemberDao：数据访问接口——用户信息，仅添加IRepository不满足的接口
/// <summary>
     ///   数据访问接口——用户信息
     /// </summary>
     public interface IMemberDao : IRepository<Member>
     {
         /// <summary>
         ///   由电子邮箱查找用户信息
         /// </summary>
         /// <param name="email"> 电子邮箱地址 </param>
         /// <returns> </returns>
         IEnumerable<Member> GetByEmail(string email);
     }
IMemberInactiveDao：数据访问接口——未激活用户信息，仅添加IRepository不满足的接口
/// <summary>
     ///   数据访问接口——未激活用户信息
     /// </summary>
     public interface IMemberInactiveDao : IRepository<MemberInactive>
     {
         /// <summary>
         ///   由电子邮箱获取未激活的用户信息
         /// </summary>
         /// <param name="email"> 电子邮箱地址 </param>
         /// <returns> </returns>
         IEnumerable<MemberInactive> GetByEmail(string email);
     }
IConfigInfoDao：数据访问接口——系统配置，无额外需求的接口，所以为空接口
/// <summary>
///   数据访问接口——系统配置信息
/// </summary>
public interface IConfigInfoDao : IRepository<ConfigInfo>
{ }
IAccountContract：账户模块业务契约——定义了三个操作，用作注册前的数据检查和注册提交
/// <summary>
     ///   核心业务契约——账户模块
     /// </summary>
     public interface IAccountContract
     {
         /// <summary>
         /// 用户名重复检查
         /// </summary>
         /// <param name="userName">用户名</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         bool UserNameExistsCheck(string userName, string configName);

         /// <summary>
         /// 电子邮箱重复检查
         /// </summary>
         /// <param name="email">电子邮箱</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         bool EmailExistsCheck(string email, string configName);

         /// <summary>
         /// 用户注册
         /// </summary>
         /// <param name="model">注册信息模型</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         RegisterResults Register(Member model, string configName);
     }
以上代码本来想收起来的，但测试时代码展开老失效，所以辛苦大家划了那麽长的鼠标来看下面的正题了\(^o^)/

(二) 测试类准备

1. 添加测试项目的引用

   

2. 添加要模拟实现接口的Fakes程序集，要模拟的接口在Liuliu.Demo.Core程序集中，所以在该程序集上点右键，选择“添加Fakes程序集”菜单项
   

   

3. 添加好了之后，Fakes框架会在测试项目中添加一个Fakes文件夹和一个配置文件，并自动生成引用一个 模拟程序集.Fakes 的程序集和Fakes框架的运行环境Microsoft.QualityTools.Testing.Fakes
   

   

4. 打开对象查看器，可看到生成的Fakes程序集的内容，所有的接口都生成了一个对应的模拟类
   
5. 通过ILSpy对Fakes程序集进行反向，可以看到生成的模拟类如下所示，StubIMemberDao实现了接口IMemberDao，而接口中的公共成员都生成了“方法名+参数类型名”的委托模拟，用以接收外部给模拟方法的执行结果赋值，这样每个方法的返回值都可以被控制
6. 另外生成的Fakes文件夹中的配置文件Liuliu.Demo.Core.fakes内容如下所示
   

   1 <Fakes xmlns="http://schemas.microsoft.com/fakes/2011/">
   2   <Assembly Name="Liuliu.Demo.Core"/>
   3 </Fakes>

   这个配置默认会把测试程序集中的所有接口、类都生成模拟类，当然也可以配置生成指定的类型的模拟，相关知识这里就不讲了，请参阅官方文档：Microsoft Fakes 中的代码生成、编译和命名约定

7. 需要特别说明的是，每次生成，Fakes程序集都会重新生成，所以测试类有更改后想刷新Fakes程序集，只需要把原来的程序集删除再进行生成，或者在测试项目能编译的时候重新编译测试项目即可。

(三) TDD正式开始

1. 给测试项目添加一个单元测试类文件，添加新项 -> Visual C#项 -> 测试 -> 单元测试，命名为AccountServiceTest.cs，推荐命名方式为“测试类名+Test”的方式
2. 添加一个测试方法，关于测试方法的命名，各人有各人的方案，这里推荐一种方案：“测试方法名_执行结果_得到此结果的条件/原因”，并且测试方法是可以使用中文的，比如“UserNameExistsCheck_用户名已存在_用户名在用户信息表中已存在记录”，这种方式好很多好处，特别是团队成员英文水平不太好的时候，如果翻译成英文的方式，很有可能会不知所云，并且中文与需求文档一一对应，非常明了，以下的测试用例中都会运用这种方式，如果不适应请在脑中自行翻译\(^o^)/，建立测试方法如下：

[TestMethod]
         public void UserNameExistsCheck_用户名不存在()
         {
             var userName = "柳柳英侠";
             var configName = "configName";
             var accountService = new AccountService();
             Assert.IsFalse(accountService.UserNameExistsCheck(userName, configName));
         }

 当然，此时运行测试是编译不过的，因为AccountService类根本还没有创建。在Liuliu.Demo.Core.Business.Impl文件夹下添加AccountService类，并实现IAccountContract接口

/// <summary>
     /// 账户模块业务实现类
     /// </summary>
     public class AccountService : IAccountContract
     {
         /// <summary>
         /// 用户名重复检查
         /// </summary>
         /// <param name="userName">用户名</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         public bool UserNameExistsCheck(string userName, string configName)
         {
             throw new NotImplementedException();
         }

         /// <summary>
         /// 电子邮箱重复检查
         /// </summary>
         /// <param name="email">电子邮箱</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         public bool EmailExistsCheck(string email, string configName)
         {
             throw new NotImplementedException();
         }

         /// <summary>
         /// 用户注册
         /// </summary>
         /// <param name="model">注册信息模型</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         public RegisterResults Register(Member model, string configName)
         {
             throw new NotImplementedException();
         }
     }

再次运行测试，是通不过，TDD的基本做法就是让测试尽快通过，所以修改方法UserNameExistsCheck为如下：

/// <summary>
         /// 用户名重复检查
         /// </summary>
         /// <param name="userName">用户名</param>
         /// <param name="configName">系统配置名称</param>
         /// <returns></returns>
         public bool UserNameExistsCheck(string userName, string configName)
         {
             return false;
         }

再次运行测试用例，红叉终于变成绿勾了，我敢打赌，如果你真正实践TDD的话，绿色将是你一定会喜欢的颜色

参数的字符串，值的有效性一定要检查的，所以添加以下两个测试用例，通过ExpectedException特性可能确定抛出异常的类型

所有条件都初始化好了，继续研究需求，就可以把测试用例的所有情况都写出来
[TestMethod]
         [ExpectedException(typeof(NullReferenceException))]
         public void UserNameExistsCheck_引发NullReferenceException异常_系统配置信息无法找到()
         {
             var userName = "柳柳英侠";
             var configName = "configName";
             _member = null;
             _configInfo = null;
             _accountService.UserNameExistsCheck(userName, configName);
         }

         [TestMethod]
         public void UserNameExistsCheck_用户不存在_用户在用户数据库中不存在_and_注册不需要激活()
         {
             var userName = "柳柳英侠";
             var configName = "configName";
             _member = null;
             _configInfo.RegisterConfig.NeedActive = false;
             Assert.IsFalse(_accountService.UserNameExistsCheck(userName, configName));
         }

         [TestMethod]
         public void UserNameExistsCheck_用户不存在_用户在用户数据库中不存在_and_注册需要激活_and_用户名在未激活用户数据库中不存在()
         {
             var userName = "柳柳英侠";
             var configName = "configName";
             _member = null;
             _configInfo.RegisterConfig.NeedActive = true;
             _memberInactive = null;
             Assert.IsFalse(_accountService.UserNameExistsCheck(userName, configName));
         }
编写代码让测试通过
public bool UserNameExistsCheck(string userName, string configName)
         {
             if (string.IsNullOrEmpty(userName))
             {
                 throw new ArgumentNullException("userName");
             }
             if (string.IsNullOrEmpty(configName))
             {
                 throw new ArgumentNullException("configName");
             }
             var member = MemberDao.GetByName(userName);
             if (member != null)
             {
                 return true;
             }
             var configInfo = ConfigInfoDao.GetByName(configName);
             if (configInfo == null)
             {
                 throw new NullReferenceException("系统配置信息为空。");
             }
             if (!configInfo.RegisterConfig.NeedActive)
             {
                 return false;
             }
             var memberInactive = MemberInactiveDao.GetByName(userName);
             if (memberInactive != null)
             {
                 return true;
             }
             return false;
         }

五、总结

　　看起来文章写得挺长了，其实内容并没有多少，篇幅都被代码拉开了。我们来总结一下使用Fakes框架进行TDD开发的步骤：

1. 建立底层接口
2. 创建测试接口的Fakes程序集
3. 创建环境完全初始化的测试类（这点比较麻烦，可以配合T4模板进行生成）
4. 分析需求写测试用例
5. 编写代码让测试用例通过
6. 重构代码，并保证重构的代码仍然能让测试用例通过

　　另外有几点经验之谈：

1. 测试用例的方法名完全可以包含中文，清晰明了
2. 由于测试类的环境已完全初始化，可以根据需求把所有的测试用例一次写出来，不确定的可以留为空方法，也不会影响测试通过
3. 当你习惯了TDD之后，你会离不开它的└(^o^)┘

本篇只对底层的接口进行了模拟，在下篇将对测试类中的私有方法，静态方法等进行模拟，敬请期待^_^o~ 努力！

六、源码下载

LiuliuTDDFakesDemo01.rar

七、参考资料

1.Microsoft Fakes 中的代码生成、编译和命名约定：
http://msdn.microsoft.com/zh-cn/library/hh708916
2.使用存根隔离对单元测试方法中虚拟函数的调用
http://msdn.microsoft.com/zh-cn/library/hh549174
3.使用填充码隔离对单元测试方法中非虚拟函数的调用
http://msdn.microsoft.com/zh-cn/library/hh549176