[UnitTest] NUnit 參數測試 - 使用 TestCase、TestCaseSource ~ m@rcus 學習筆記

前言
上一篇 NUnit 入門教學簡單介紹如何使用 NUnit 撰寫單元測試，但在實務上在寫單元測試時不會那麼單純，舉例來說如果要針對某個 method 進行種不同情境的測試，僅差在不同的參數來多次驗證結果，
在 NUnit 官方文件中有提供很多好用的方法像是 TestCase、TestCaseSource 等方式可以解決此問題，以下會簡單分享小小研究後的說明與差異性，依據適合的情境使用相對應的方法

解決方案
要驗證的 sample Code 如下，Example 類別有個 Reverse 方法內容為將輸入的字串反轉

public class Example
{
    public string Reverse(string input)
    {
        char[] charArray = input.ToCharArray();
        Array.Reverse(charArray);
        return new string(charArray);
    }
}

為了驗證該方法是否正確，因此準備多種情境的參數來進行單元測試，預計測試資料如下

input : abc | output : cba
input : marcus | output : sucram
input : apple | output : elppa

撰寫多個 Method
如果沒有使用參數化進行測試時，預估會根據每個要驗證的內容撰寫一個 method 來對應，為了在 Test Explorer 在眾多 Test cases 好識別，建議定義命名規則 ReverseTest_Input_輸入參數_Return_回傳參數，sample code 如下

using NUnit.Framework;
 
namespace ConsoleApp2.Tests
{
    [TestFixture()]
    public class ExampleTests
    {
        [Test()]
        public void ReverseTest_Input_abc_Return_cba()
        {
            //Arrange
            var ex = new Example();
            var input = "abc";
            
            //Act
            var actual = ex.Reverse(input);
 
            //Assert
            Assert.AreEqual("cba", actual);
        }
        [Test()]
        public void ReverseTest_Input_marcus_Return_sucram()
        {
            //Arrange
            var ex = new Example();
            var input = "marcus";
 
            //Act
            var actual = ex.Reverse(input);
 
            //Assert
            Assert.AreEqual("sucram", actual);
        }
        [Test()]
        public void ReverseTest_Input_apple_Return_elppa()
        {
            //Arrange
            var ex = new Example();
            var input = "apple";
 
            //Act
            var actual = ex.Reverse(input);
 
            //Assert
            Assert.AreEqual("elppa", actual);
        }
    }
}

缺點會如果測試案例很多的化會有很多重複的 Code，避免重複可能會自己寫一個類別用集合跟迴圈來解決重複 Code的問題

使用 TestCase
在 NUnit 中提供 TestCase Attribute 來透過不同數據來測試，首先改寫 ReverseTest 方法將輸入值跟預期結果當作參數，接著在要測試的方法上掛 TestCase attribute 並定義要測試的參數資料，看起來 Code 比較乾淨沒有重複的代碼，sample code 如下

using NUnit.Framework;
 
namespace ConsoleApp2.Tests
{
    [TestFixture()]
    public class ExampleCaseTests
    {
        [Test()]
        [TestCase("abc", "cba")]
        [TestCase("marcus", "sucram")]
        [TestCase("apple", "elppa")]
        public void ReverseTest(string input, string output)
        {
            var ex = new Example();
            var actual = ex.Reverse(input);
            Assert.AreEqual(input, actual);
        }
    }
}

使用 TestCaseSource
NUnit 另外也提供 TestCaseSource 測試不同數據，在 ReverseTest 方法使用 TestCaseSource 定義要測試的集合名稱 TestDataCases，另外在 TestDataCases 定義要測試的數據內容集合，sample code 如下

using NUnit.Framework;
using System.Collections;
 
namespace ConsoleApp2.Tests
{
    [TestFixture()]
    public class ExampleCaseDataTests
    {
        [Test, TestCaseSource("TestDataCases")]
        public void ReverseTest(string input, string output)
        {
            var ex = new Example();
            var actual = ex.Reverse(input);
            Assert.AreEqual(output, actual);
        }
 
        public static IEnumerable TestDataCases
        {
            get
            {
                yield return new TestCaseData("abc","cba");
                yield return new TestCaseData("marcus","sucram");
                yield return new TestCaseData("apple","elppa");
            }
        }
    }
}

TestCaseData 提供 returns 方法，如果要測試的方法是有回傳值時，可以在 return 方法加上參數來驗證回傳值是否正確

Test Explore 可讀性
三種方式都可以解決問題(~~第一種有點來亂的?~~)，但可讀性也是蠻重要的一個環節，可以比對三者在 Test Explore 呈現的結果，以這 sample code 簡單的測試案例來說 TestCase 與 TestCaseSource 可讀性來看是較好的，測試代碼上亦是如此，但如果在較為複雜的測試案例上或許有不同結果，各位可以在實作時自己斟酌使用適合的方式

參考
NUnit
Test Generator NUnit extension
TestCase Attribute

[UnitTest] Refactoring 好幫手 - Refactoring.Guru前言過去還在菜鳥時期很常遇過一種情境，就是當看到一段既有的代碼或是專案裡的 Code，看起來有些怪異的地方但又說不出來怪的點是哪一點，想改又不知道從何下手的情境，如果遇到這問題想要得到解答的話，可以試試看到 refactoring.guru，這網站透過漫畫的方式介紹兩項開發者在 Coding 時的必修課程，重構 ( Refacting ) 與設計模式 ( Design Pattern )；以下就針對這兩項目做簡單說明 Re… Read More
[UnitTest] 如何測試目標方法中 Guid 型別的代碼 ?情境如果要產生一個亂數時很常會想到 Guid 方法解決，在 C# 使用 Guid 的方式相當簡單僅要透過 Guid.NewGuid 靜態方法產生一組 Guid 使用，在目前公司很常看到使用 Guid 作為識別碼，今天在重構舊代碼時忽然想到如果遇到 Guid 該如何進行加上單元測試，以下就目前想到的解法進行測試與說明，如果各位高手們有更好的方法歡迎高抬貴手一起討論研究。解決方案寫個簡單的 Sa… Read More
[UnitTest] 使用 Fluent Assertions 增加單元測試碼可讀性前言過去在撰寫單元測試代碼時都是使用 NUnit 內建的 Assert.AreEqual 來驗證是否符合預期，雖然早已聽過 Fluent Assertions 盛名但並未實際使用過，直到最近在與同事討論時同事大推發現真的很不錯，讓戴碼的可能性增加不少，想起之前上 91 Training 時不斷強調測試代碼可讀性的重要性，這一篇就來簡單介紹 Flnent Asserentions 的安裝與使用，若有問題或是錯誤的地方歡迎各位高手給予指導。 … Read More
[UnitTest] ASP.NET Core 2.2 測試專案中的版本衝突問題這幾天專案某項功能接近尾聲，要替其核心 ASP.NET Core 專案加上單元測試專案，加入後按下建置發現跳出 Error 錯誤訊息 "CS1705 Assembly 'xxxx, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' uses 'Microsoft.Extensions.Logging.Abstractions, Version=2.… Read More
[UnitTest] Visual Studio 2017 按右鍵無法建立單元測試 ? 問題最近心血來潮使用家中舊電腦小白寫 Code，在練習測試中發現竟然有點怪異，在要測試的 method 按下右鍵沒有建立單元測試 Create Unit Test 選項，但相同練習專案拿到公司筆電就是正常的，經比對後發現舊筆電 Visual Studio 版本少安裝測試功能，以下簡單紀錄解決問題的過程解決方案在 Visual Studio 2017 早期版本這是已知問題，有開發者在 vs community 回報給開… Read More

m@rcus 學習筆記

只有累積，沒有奇蹟

2019年1月20日星期日