.NET单元测试-隔离框架

上一篇内容中我们讲到伪对象，并写了一个伪对象，如果阅读文章的你刚刚手写完伪对象，那么我要对你说，你辛苦了，以后你都不需要再手写伪对象了（不得不说，手写伪对象至少能够加深对隔离框架的理解）。

 

何为隔离框架？

一个能够在运行时新建和配置伪对象的可重用的类库，它让开发者不用为了伪对象而编写重复的代码。

即隔离框架可以替我们动态的生成需要的伪对象，节省很多精力。

 

选择隔离框架

目前市面上有很多隔离框架，我们选择了Moq，主要基于以下原因：

1. 强类型：不支持使用字符串来设置期望
2. 不再需要学习录制/播放，只需要构建你自己的Mock，设置好你的期望，调用它，然后有选择地验证它们即可
3. 不用去学习Mock、Stub之间的理论差异了
4. 可以对接口和类进行Mock
5. 重载期望：可以在全局设置时给Mock方法设置缺省的期望，在测试方法中可以根据需要对它进行重载。
6. 它的学习曲线极低，大多数情况下，你甚至无须阅读文档。
7. 免费开源
   ...
   
   （如果之前没有了解过隔离框架，以上2、3点可暂时不予理会）
   
   
   

Moq使用

先来了解一下使用Moq的一般套路，定义以下接口：

public interface ITextReader
{
    void BeginRead();
 
    string Read();
 
    void EndRead();
}

定义一个ITextReader的业务方：

public static bool IsValidHtml(ITextReader textReader)
{
    var htmlString = textReader.Read();
    return htmlString.Contains("html");
}

IsValidHtml方法依赖ITextReader接口来读取字符串，并判断字符串是否是合法html。

 

使用Moq来隔离ITextReader会多简单呢？

[TestMethod]
public void IsValidHtml_EmptyString_returnFalse()
{
    //Arrange
    //新建一个ITextReader的Mock对象，其Object属性即为我们需要的伪对象
    var textReaderMock = new Mock<ITextReader>();
 
 
    //对伪对象的方法进行mock
    //当调用ITextReader接口的Read()方法时，将返回Empty字符串
    textReaderMock.Setup(x => x.Read()).Returns(string.Empty);
 
    //Action
    //将伪对象注入到被测试方法中
    var result = Document.IsValidHtml(textReaderMock.Object);
 
    //Assert
    Assert.IsFalse(result);
}

简单吧(●'◡'●)

 

接下来我们了解一下Moq提供的API

• Setup+Return
  请参见上面的例子
  
  

• Setup+Callback
  当指定方法被调用时，可以收到一个回调函数，方法调用的参数将作为回调函数的参数传递。请看例子：

  //被依赖的第三方接口
  public interface IPaint
  {
   
       void AddElement(int element);
   
   
   
       bool CouldBeSelected();
   
   
       event Action<int, int> SelectionChanged;
   }
   
   
   
  //IPaint接口的业务方
    private readonly IPaint _paint;
    public Document(IPaint paint)
    {
        _paint = paint;
    }
   
    public void AddElements(IEnumerable<int> elements)
    {
        foreach (var i in elements.ToList())
        {
            _paint.AddElement(i);
        }
    }
   
   
    //AddElements的单元测试方法
    [TestMethod]
    public void AddElements_MultiElements_ShouldCallAddElementsMultiTimes()
    {
        var paintMock = new Mock<IPaint>();
   
        var input = new List<int>()
        {
            0,1,2,3,4
        };
   
        var expected = new List<int>();
        //当调用IPaint接口的AddElement方法，且参数是任意int时，出发回掉函数
        paintMock.Setup(x => x.AddElement(It.IsAny<int>())).Callback<int>(i =>
          {
              expected.Add(i);
          });
   
        var document = new Document(paintMock.Object);
   
        document.AddElements(input);
   
        CollectionAssert.AreEqual(input, expected);
    }

 

• SetupSequence
  设置对方法对连续调用的响应：

  [TestMethod]
   public void GetPaintCouldBeSelected_CallTwoTimes_ReturnTrueAndFalse()
   {
       var paintMock = new Mock<IPaint>();
       //连续调用CouldBeSelected方法时，第一次返回true，第二次返回false
       paintMock.SetupSequence(x => x.CouldBeSelected()).Returns(true).Returns(false);
   
       var document = new Document(paintMock.Object);
   
       var result = document.GetPaintCouldBeSelected();
       Assert.IsTrue(result);
       result = document.GetPaintCouldBeSelected();
       Assert.IsFalse(result);
   }

 

• Verify+Times
  对一个方法调用次数进行验证：

  [TestMethod]
   public void AddElements_SingleElement_ShouldCallAddElement()
   {
       var paintMock = new Mock<IPaint>();
   
       //将以任意int作为参数的AddElement方法的调用进行标记，在调用paintMock.Verify方法时对AddElement方法是否经过调用进行验证
       paintMock.Setup(x => x.AddElement(It.IsAny<int>())).Verifiable();
   
       //----------
       //做了一些事情，比如调用了IPaint的AddElement方法
       //----------
       var document = new Document(paintMock.Object);
       document.AddElements(new List<int>() { 1, 2, 3 });
   
       //验证AddElement是否经过调用
       paintMock.Verify();
   }

  当需要对调用次数做限制时，也可以使用另一种方式：

  [TestMethod]
   public void AddElements_SingleElement_ShouldCallAddElement()
   {
       var paintMock = new Mock<IPaint>();
   
       paintMock.Verify(x => x.AddElement(It.IsAny<int>()), Times.Between(1, 3, Range.Inclusive));
   
       //----------
       //做了一些事情，比如调用了IPaint的AddElement方法
       //----------
       var document = new Document(paintMock.Object);
       document.AddElements(new List<int>() { 1, 2, 3 });
   
       //验证AddElement的调用次数是否为1-3
       Mock.Verify(paintMock);
   }

• It
  It用于对参数进行限制，可以指定参数必须是什么类型，必须满足特定的正则，必须处于某个范围等，具体可参见API
  
  

至此，Moq的基本API就完结了，是否很简单呢？

除了上面的部分，Moq还提供了一些功能，但是使用方法都跟上面的类似

Setup+Callbase（调用基类的方法）

SetupGet（获取属性）

SetupSet（设置属性）

...

 

Moq的限制

Moq的机制是对于Mock的接口，生成一个实现类，这个实现类里的方法都没有具体的实现，而是根据用户的设置直接返回。

由此我们可以得出Moq的限制：

• 必须是可以被继承的对象才能被mock
• 必须是可以被重写的方法才能被mock