資料驅動的測試

開啟PlayerCharacterShould.cs

新增幾個Fact測試方法:

        [Fact]
        public void TakeZeroDamage()
        {
            _sut.TakeDamage(0);
            Assert.Equal(100, _sut.Health);
        }

        [Fact]
        public void TakeSmallDamage()
        {
            _sut.TakeDamage(
 
1);
            Assert.Equal(99, _sut.Health);
        }
        
        [Fact]
        public void TakeMediumDamage()
        {
            _sut.TakeDamage(50);
            Assert.Equal(50, _sut.Health);
        }

        [Fact]
        public void TakeMinimum1Damage()
        {
            _sut.TakeDamage(
 
101);
            Assert.Equal(1, _sut.Health);
        }

Build, Run tests. 都Pass了.

仔細看下這4個方法, 他們其實是做了同樣的事情, 只不過輸入的資料和期待的結果不同而已. 

所以我們應該重構一下這段程式碼.

Theory:

針對上述情況, 我們就不再使用Fact屬性標籤了, 而是需要使用Theory.

Theory標籤會告訴xUnit, 它下面的測試方法會被執行多次, 而每次執行必須為這個方法提供必要的測試資料. 

如何為其新增測試資料呢? 首先要為測試方法新增引數, 使用引數來代替具體的數值:

        [Theory]
        public void TakeDamage(int damage, int expectedHealth)
        {
            _sut.TakeDamage(damage);
            Assert.Equal(expectedHealth, _sut.Health);
        }

然後我們需要告訴xUnit這個測試方法的引數來自哪裡.

1. 最簡單的辦法是使用InlineData屬性標籤:

        [Theory]
        [InlineData(0, 100)]
        [InlineData(1, 99)]
        [InlineData(50, 50)]
        [InlineData(101, 1)]
        public void TakeDamage(int damage, int expectedHealth)
        {
            _sut.TakeDamage(damage);
            Assert.Equal(expectedHealth, _sut.Health);
        }

上面我添加了四組測試資料, 每對資料按順序對應測試方法的兩個引數. (InlineData的引數型別是params object[])

然後Build, 檢視Test Explorer:

會發現這裡面多出來了4個測試, 分別對應那4個InlineData.

Run Tests, 都會Pass的.

現在就可以把那四個Fact測試方法刪除了.

儘管InlineData使用起來還是很方便, 但是在某些情境下還是靈活性欠佳, 請您檢視NonPlayerCharacterShould.cs裡面的程式碼. 取消裡面的註釋:

namespace Game.Tests
{
    public class NonPlayerCharacterShould
    {
        [Theory]
        [InlineData(0, 100)]
        [InlineData(1, 99)]
        [InlineData(50, 50)]
        [InlineData(101, 1)]
        public void TakeDamage(int damage, int expectedHealth)
        {
            NonPlayerCharacter sut = new NonPlayerCharacter();

            sut.TakeDamage(damage);

            Assert.Equal(expectedHealth, sut.Health);
        }
    }
}

首先Build, Run Tests, 都Pass.

這個Theory的四組引數和上面的是一樣的.

2.為了共享這幾組測試資料, 可以使用MemberData屬性標籤, 首先建立一個類InternalHealthDamageTestData.cs:

namespace Game.Tests
{
    public class InternalHealthDamageTestData
    {
        private static readonly List<object[]> Data = new List<object[]>
        {
            new object[] {0, 100},
            new object[] {1, 99},
            new object[] {50, 50},
            new object[] {101, 1}
        };

        public static IEnumerable<object[]> TestData => Data;
    }
}

這裡面的資料和之前的那四組資料是一樣的.

然後修改NonPlayerCharacterShould裡面的程式碼, 把InlineData都去掉:

namespace Game.Tests
{
    public class NonPlayerCharacterShould
    {
        [Theory]
        [MemberData(nameof(InternalHealthDamageTestData.TestData), MemberType = typeof(InternalHealthDamageTestData))]
        public void TakeDamage(int damage, int expectedHealth)
        {
            NonPlayerCharacter sut = new NonPlayerCharacter();

            sut.TakeDamage(damage);

            Assert.Equal(expectedHealth, sut.Health);
        }
    }
}

這裡改成了MemberData, 它的引數很多, 第一個引數是資料提供類的屬性名字, 這個屬性型別要求是IEnumberable的, 所以這裡應該寫"TestData", 不過最好還是使用nameof, 這樣如果更改了資料類的屬性名稱, 那麼編譯時就會報錯, 而不會導致測試失敗.

然後還需要設定MemberType屬性, 表明資料提供類的型別.

Clean Solution, Build, 可以看到還是有4個測試, Run Tests, 都會Pass的.

針對PlayerCharacterShould, 也這樣修改. 這樣測試資料就得到了共享.

3. 外部資料.

檢視一下專案裡面的TestData.csv: 裡面還是這四組資料:

0, 100
1, 99
50, 50
101, 1

再建立一個類ExternalHealthDamageTestData.cs來取出csv中的資料:

namespace Game.Tests
{
    public class ExternalHealthDamageTestData
    {
        public static IEnumerable<object[]> TestData
        {
            get
            {
                string[] csvLines = File.ReadAllLines("TestData.csv");
                var testCases = new List<object[]>();
                foreach (var csvLine in csvLines)
                {
                    IEnumerable<int> values = csvLine.Split(',').Select(int.Parse);
                    object[] testCase = values.Cast<object>().ToArray();
                    testCases.Add(testCase);
                }
                return testCases;
            }
        }
    }
}

修改一下NonPlayerCharacterShould和PlayerCharacterShould相關測試方法的屬性標籤:

namespace Game.Tests
{
    public class NonPlayerCharacterShould
    {
        [Theory]
        [MemberData(nameof(ExternalHealthDamageTestData.TestData), MemberType = typeof(ExternalHealthDamageTestData))]
        public void TakeDamage(int damage, int expectedHealth)
        {
            NonPlayerCharacter sut = new NonPlayerCharacter();

            sut.TakeDamage(damage);

            Assert.Equal(expectedHealth, sut.Health);
        }
    }
}

        [Theory]
        [MemberData(nameof(ExternalHealthDamageTestData.TestData), MemberType = typeof(ExternalHealthDamageTestData))]
        public void TakeDamage(int damage, int expectedHealth)
        {
            _sut.TakeDamage(damage);
            Assert.Equal(expectedHealth, _sut.Health);
        }

Build, 檢視Test Explorer:

針對他們中的任意一個類, 只能發現一個相關的測試, 而不是四個測試.

Run Tests的話, 會報錯:

它找不到TestData.csv, 這是因為我們需要更改一下csv檔案的屬性, 把它改成Copy always:

然後選擇Rebuild Solution, 這樣才能保證csv檔案被copy到正確的位置.

再檢視Test Explorer:

這時就會看到4組測試了, Run Tests, 都會Pass的.

如果再新增一組資料, 還是需要Rebuild Solution的, 然後新的測試會出現在Test Explorer裡面.

4.CustomDataAttribute 自定義資料屬性標籤.

使用自定義的標籤可以把測試資料在test case和class之間共享, 而且會提高測試的可讀性.

建立一個類 HealthDamageDataAttribute.cs:

namespace Game.Tests
{
    public class HealthDamageDataAttribute : DataAttribute
    {
        public override IEnumerable<object[]> GetData(MethodInfo testMethod)
        {
            yield return new object[] { 0, 100 };
            yield return new object[] { 1, 99 };
            yield return new object[] { 50, 50 };
            yield return new object[] { 101, 1 };
        }
    }
}

這裡需要實現xUnit的DataAttribute這個抽象類.

修改NonPlayerCharacterShould和PlayerCharacterShould的相關方法, 把上面的自定義標籤寫上去:

namespace Game.Tests
{
    public class NonPlayerCharacterShould
    {
        [Theory]
        [HealthDamageData]
        public void TakeDamage(int damage, int expectedHealth)
        {
            NonPlayerCharacter sut = new NonPlayerCharacter();

            sut.TakeDamage(damage);

            Assert.Equal(expectedHealth, sut.Health);
        }
    }
}

Build, 然後再Test Explorer還是可以看到四組測試, 如果再想新增一組測試, 只需重新Build即可.

測試同樣都會Pass的.

同樣自定義標籤可以整合外部資料, 這個很簡單, 您自己來寫一下吧.

這個xUnit簡介就到此為止了, 想要深入瞭解的話, 還是看官方文件吧.