使用 Microsoft Fakes 進行單元測試

本文為 Dennis Gao 原創技術文章，發表於博客園博客，未經作者本人允許禁止任何形式的轉載。

在編寫單元測試時，我們會遇到不同的外部依賴項，大體上可以分為兩類：

• 依賴於接口或抽象類
• 依賴於具體類

我們將使用 Microsoft Fakes 分別對兩種條件下的依賴項進行隔離。

依賴於接口或抽象類

首先，我們來定義被測試代碼。

  public interface IEmailSender
  {
    bool SendEmail(string content);
  }

  public class Customer
  {
    public string Name { get; set; }
    public override string ToString()
    {
      return Name;
    }
  }

  public interface ICustomerRepository
  {
    Customer Add(Customer customer);
  }

  public class CustomerRepository : ICustomerRepository
  {
    private IEmailSender _emailSender;

    public CustomerRepository(IEmailSender emailSender)
    {
      _emailSender = emailSender;
    }

    public Customer Add(Customer customer)
    {
      _emailSender.SendEmail(customer.ToString());
      return customer;
    }
  }

在上面的代碼中，CustomerRepostory 依賴於 IEmailSender 接口。

當在 CustomerRepostory 中調用 Add 方法添加 Customer 時，將調用 IEmailSender 的 SendEmail 方法來發送一個郵件。

我們將如何為 Add 方法添加單元測試呢？

    [TestMethod]
    public void TestCustomerRepositoryWhenAddCustomerThenShouldSendEmail()
    {
      // Arrange
      IEmailSender stubEmailSender = new EmailSender();

      // Act
      CustomerRepository repository = new CustomerRepository(emailSender);
      Customer customer = new Customer() { Name = "Dennis Gao" };
      repository.Add(customer);

      // Assert
      Assert.IsTrue(isEmailSent);
    }

在這里，我們肯定不會使用這種直接實例化 EmailSender 的方法，因為這樣就依賴了具體的類了。

IEmailSender stubEmailSender = new EmailSender();

現在，我們使用 Microsoft Fakes 中的 Stub 功能來幫助測試。

在測試工程的引用列表中，在被測試程序集上點擊右鍵，選擇 "Add Fakes Assembly"。

然后會新增一個 Fakes 目錄，並生成一個帶 .Fakes 的文件。

下一步，在測試類中添加 {被測試工程名稱}.Fakes 名空間。

using ConsoleApplication17_TestFakes;
using ConsoleApplication17_TestFakes.Fakes;

當在代碼中輸入 Stub 時，智能提示會顯示出已經自動生成的 Stub 類了。

現在，我們就可以使用 Stub 功能來模擬 IEmailSender 接口了。

    [TestMethod]
    public void TestCustomerRepositoryWhenAddCustomerThenShouldSendEmail()
    {
      // Arrange
      bool isEmailSent = false;
      IEmailSender stubEmailSender = new StubIEmailSender()
      {
        SendEmailString = (content) =>
        {
          isEmailSent = true;
          return true;
        },
      };

      // Act
      CustomerRepository repository = new CustomerRepository(stubEmailSender);
      Customer customer = new Customer() { Name = "Dennis Gao" };
      repository.Add(customer);

      // Assert
      Assert.IsTrue(isEmailSent);
    }

依賴於具體類

生活不總是那么美好，當然不是所有代碼都會遵循控制反轉的原則。很多時候，我們仍然需要使用具體類。

比如，在如下的代碼中，OrderRepository 中的 Add 方法直接構建一個 EmailSender ，然后調用其 SendEmail 方法來發送郵件。

  public class Order
  {
    public long Id { get; set; }
    public override string ToString()
    {
      return Id.ToString();
    }
  }

  public interface IOrderRepository
  {
    Order Add(Order order);
  }

  public class EmailSender : IEmailSender
  {
    public bool SendEmail(string content)
    {
      return true;
    }
  }

  public class OrderRepository : IOrderRepository
  {
    public OrderRepository()
    {
    }

    public Order Add(Order order)
    {
      IEmailSender emailSender = new EmailSender();
      emailSender.SendEmail(order.ToString());
      return order;
    }
  }

現在，我們已經沒有接口或者抽象類可用於模擬了，所以 Stub 在此種條件下也失去了作用。此時，Shim 上場了。Shim 是運行時方法攔截器，功能更加強大。通過 Shim 我們可以為任意類的方法或屬性提供我們自己的實現。

    [TestMethod]
    public void TestOrderRepositoryWhenAddOrderThenShouldSendEmail()
    {
      // Arrange
      bool isEmailSent = false;

      using (ShimsContext.Create())
      {
        ShimEmailSender.AllInstances.SendEmailString = (@this, content) =>
        {
          isEmailSent = true;
          return true;
        };

        // Act
        OrderRepository repository = new OrderRepository();
        Order order = new Order() { Id = 123 };
        repository.Add(order);
      }

      // Assert
      Assert.IsTrue(isEmailSent);
    }

使用 Shim 時，需要先為其指定上下文范圍，通過 ShimsContext.Create() 來創建。

通常，如果遇到使用 Shim 的情況，則說明代碼或許寫的有些問題，沒有遵循控制反轉原則等。

使用 Shim 來控制系統類

假設我們需要一個判斷當天是否是全年最后一天的方法，我們把它定義在 DateTimeHelper 靜態類中。

  public static class DateTimeHelper
  {
    public static bool IsTodayLastDateOfYear()
    {
      DateTime today = DateTime.Now;
      if (today.Month == 12 && today.Day == 31)
        return true;
      else
        return false;
    }
  }

我們來為這個方法編寫測試，顯然需要兩種條件。

    [TestMethod]
    public void TestTodayIsLastDateOfYear()
    {
      // Arrange

      // Act
      bool result = DateTimeHelper.IsTodayLastDateOfYear();

      // Assert
      Assert.IsTrue(result);
    }

    [TestMethod]
    public void TestTodayIsNotLastDateOfYear()
    {
      // Arrange

      // Act
      bool result = DateTimeHelper.IsTodayLastDateOfYear();

      // Assert
      Assert.IsFalse(result);
    }

這么看來，在運行這兩條單元測試時，肯定是一個是通過，一個是不通過。

為了解決這個問題，我們需要為系統類 System.DateTime 添加 Shim 類。

同樣在程序集的引用列表中，在 System 上點擊右鍵 "Add Fakes Assembly"。

然后會生成 System.Fakes 文件。

在測試代碼中添加名空間 System.Fakes。

using System.Fakes;

現在，我們來修改代碼，使用 Shim 來完成測試。

    [TestMethod]
    public void TestTodayIsLastDateOfYear()
    {
      // Arrange

      // Act
      bool result = false;
      using (ShimsContext.Create())
      {
        ShimDateTime.NowGet = () => new DateTime(2013, 12, 31);
        result = DateTimeHelper.IsTodayLastDateOfYear();
      }

      // Assert
      Assert.IsTrue(result);
    }

    [TestMethod]
    public void TestTodayIsNotLastDateOfYear()
    {
      // Arrange

      // Act
      bool result = false;
      using (ShimsContext.Create())
      {
        ShimDateTime.NowGet = () => new DateTime(2013, 12, 9);
        result = DateTimeHelper.IsTodayLastDateOfYear();
      }

      // Assert
      Assert.IsFalse(result);
    }

直接為 ShimDateTime 的 Now 屬性 Get 來指定 Lambda 表達式函數。

ShimDateTime.NowGet = () => new DateTime(2013, 12, 31);

通過 Debug 我們可以看到，DateTime.Now 已經被成功的替換為指定的時間。

參考資料

• Isolating Code Under Test with Microsoft Fakes
• Better Unit Testing with Microsoft Fakes
• Visual studio 2012 Fakes
• Using shims to isolate your application from other assemblies for unit testing

本文為 Dennis Gao 原創技術文章，發表於博客園博客，未經作者本人允許禁止任何形式的轉載。