創建用於確保不變性的單元測試

Question

我設計了一個immutable class，因爲我想爲它創造價值語義。我寫了一個提示進級

// "This class is immutable, don't change this when adding new features to it."

但我知道，有時候這些評論是由其他團隊成員忽視的評論部分，所以我想創建單元測試作爲額外的保障。任何想法如何做到這一點？我們可以通過反射來檢查一個類，以確保只有構造函數改變它的內部狀態嗎？

（使用C＃2.0和NUnit，如果這對任何人都很重要）。

Answer 1

舉例說明如何使用FieldInfo.IsInitOnly以遞歸方式測試不可變性。

可能還有更多的特殊情況需要考慮，比如我如何處理string，但它只會給出我認爲是錯誤的否定結果，即會告訴你一些事情是可變的，而不是相反。

邏輯是，每個字段必須是readonly並且本身是不可變的類型。請注意，它不會處理自引用類型或循環引用。

using System; 
using System.Linq; 
using System.Reflection; 
using Microsoft.VisualStudio.TestTools.UnitTesting; 

namespace ImmutableTests 
{ 
    [TestClass] 
    public class AssertImmutableTests 
    { 
     [TestMethod] 
     public void Is_int_immutable() 
     { 
      Assert.IsTrue(Immutable<int>()); 
     } 

     [TestMethod] 
     public void Is_string_immutable() 
     { 
      Assert.IsTrue(Immutable<string>()); 
     } 

     [TestMethod] 
     public void Is_custom_immutable() 
     { 
      Assert.IsTrue(Immutable<MyImmutableClass>()); 
     } 

     [TestMethod] 
     public void Is_custom_mutable() 
     { 
      Assert.IsFalse(Immutable<MyMutableClass>()); 
     } 

     [TestMethod] 
     public void Is_custom_deep_mutable() 
     { 
      Assert.IsFalse(Immutable<MyDeepMutableClass>()); 
     } 

     [TestMethod] 
     public void Is_custom_deep_immutable() 
     { 
      Assert.IsTrue(Immutable<MyDeepImmutableClass>()); 
     } 

     [TestMethod] 
     public void Is_propertied_class_mutable() 
     { 
      Assert.IsFalse(Immutable<MyMutableClassWithProperty>()); 
     } 

     private static bool Immutable<T>() 
     { 
      return Immutable(typeof(T)); 
     } 

     private static bool Immutable(Type type) 
     { 
      if (type.IsPrimitive) return true; 
      if (type == typeof(string)) return true; 
      var fieldInfos = type.GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); 
      var isShallowImmutable = fieldInfos.All(f => f.IsInitOnly); 
      if (!isShallowImmutable) return false; 
      var isDeepImmutable = fieldInfos.All(f => Immutable(f.FieldType)); 
      return isDeepImmutable; 
     } 
    } 

    public class MyMutableClass 
    { 
     private string _field; 
    } 

    public class MyImmutableClass 
    { 
     private readonly string _field; 
    } 

    public class MyDeepMutableClass 
    { 
     private readonly MyMutableClass _field; 
    } 

    public class MyDeepImmutableClass 
    { 
     private readonly MyImmutableClass _field; 
    } 

    public class MyMutableClassWithProperty 
    { 
     public string Prop { get; set; } 
    } 
} 

Answer 2

這篇文章有一些想法。雖然，似乎沒有確定的方法。

How do I find out if a class is immutable in C#

Answer 3

你可以檢查這個類是密封的，並且使用反射的支票，每個字段（使用FieldInfo.IsInitOnly）只讀。

當然，這既保證了淺永恆 - 它不會從投入有一個List<int>字段，然後更改列表的內容阻止別人。

Answer 4

不知道你是否聽說過NDepend，但是這個工具可以讓你「反省」你的源代碼和編譯後的程序集，並且執行各種魔法，包括依賴性檢查等等。

一個這樣的檢查是對不變性的檢查。舉例來說，我有一個IImmutable標記接口，和NDepend的失敗，我的生成，如果任何類型都有這個接口，但是是可變的，使用下面的查詢：

WARN IF Count > 0 IN SELECT TYPES WHERE 
    Implement "MyCompany.MyAssemblies.Dto.IImmutable" AND 
    !IsImmutable 

您還可以配置它產生違規報告，以及失敗的構建。

顯然這實際上不是一個單元測試。但是，它可以作爲構建的一部分進行集成，並且可以像單元測試一樣使構建失敗，所以我想我會提及它！

有關更多信息，請參閱here它的實際功能和方式。