進度條

我們在找人喔!進度條徵兼職「WordPress與PHP開發者」

有興趣參加進度條的新專案嗎?進度條誠徵「初階 - 遠端兼職」WordPress與PHP開發者。詳情可參考這個連結(請點我)。

[C#][Unit Test] 04. Mock (仿製資料)

本文利用C#與Visual Studio平台,來探討時下最夯的Unit Test。

作者: Toyo 更新日期:

此系列文轉自我們的好朋友Toyo大大網誌(原文連結),在Windows業界耕耘了多年,累積了不少實戰經驗。此為他專門設計為新人的單元測試教學,進度條獲授權轉載。

原文標題:  【Unit Test】Day 4 - Mock

 

Demo檔案 : Git傳送門
因為程式是昨天的延續,所以是同一個Repository切出UnitTest_Day4的Branch

 

讓繼續我們之前的議題,節錄之前最後的結論

 

...這個方法也不是百分之百沒有缺點,你應該也可以觀察到其中一段在這單元測試中無法被涵蓋到,
那就是組API Url那段,在這種透過繼承解耦合的方式中,因為回傳結果是自己設定的,
實際上組成的URL正確與否我們並不知道,換句話說,如果我們今天這樣寫測試可能會過,
但上線後才會發現錯誤,檢查之下發現原來是在串Url的時候錯字之類的。 

 

身為一位專業有責任感的工程師,你一定想著「爾等豈能如此苟且偷生便宜行事草率」,所以今天就來談談另一種方法,Mock

 

何謂Mock。
當測試時你關注與外部相依物件互動時其狀態的變化,並且驗證它,則此就是Mock物件。

 

很抽象對吧,沒關係讓我們來改改昨天的實作,從中瞭解StubMock的差異。

 

首先先將呼叫API的地方徹底隔離出去,開一個NetTool的資料夾,建立一個IRestSharp的介面。

 


該介面定義出呼叫API該傳入Url,回傳得到的結果。

 

 

實做這個介面。

 

 


修改PTX的程式。

 

 

修改Program.cs

 

 

執行後結果是對的!!

 

 

單元測試


到目前為止都沒有解釋太多為何要這樣改,不過這跟物件導向設計比較有關,即所謂的外部注入即依賴介面,但這比較偏設計的範疇這邊就不特別討論,不過之後應該會漸漸的發現,如果單元測試要能寫,很多地方都會必須要有物件導向的設計方式才有辦法。

 

讓我們回頭看單元測試,首先昨天做的PTXStub就沒用了,因為目前的PTX沒有將呼叫API封裝起來,也就沒有可以override的CallAPI方法了,把它砍掉了。

 

這時就會看到昨天的單元測試壞掉了,因為找不到PTXStub。

 

 

開始做我們的假物件MyRestSharpMock

 

 

 

 

這邊特別注意一下if那邊,依據昨天的單元測試,最後網址應該要組成這樣才是正確的,所以我們MyRestSharpMock特地加上這段判斷,已經不像昨天override一樣,不關心它組的網址為何,一律依照我們設定的結果回傳,即便你其實Url組的是錯誤的。

 

 

修改PTXTest.cs

 

 


我們注入的是自己Mock的物件,他不會實際去呼叫API,但它關注我們傳入的值對不對,執行單元測試看看結果。

 

 

我們注入的是自己Mock的物件,他不會實際去呼叫API,但它關注我們傳入的值對不對,執行單元測試看看結果。

 

可能到這邊會有一個疑問是,「廢話,Mock的物件是我們自己做的,我們想怎麼樣都馬可以!!」,一開始學到這段的時候也有這個疑問,所以容我解釋一下,還記得先前提到的觀念嗎?

 

 

單元測試關注本身的邏輯,而非外部的關聯

 

如果今天上線後發現錯誤,而發生錯誤的地方是在呼叫API的程式,那該修改的是誰?當然是MyRestSharp.cs,也絕對不是PTX這支程式,因為它職責掌管的邏輯全部都是正確的。而我們現在單元測試以及MyRestSharpMock都是在做什麼? 都是在輔助我們驗證PTX所有包含到的邏輯,我們並不關注外部其他程式到底幹了什麼,退一萬步說(好啦其實退一步就可以了)(你好煩)今天IRestSharp這個Interface你的夥伴忘記去實作導致程式上線壞了,那也不會是改你的PTX吧,要改可以,over my dead body先,所以希望這囉說的補充可以幫助釐清這件事情。

 

好的,上面這邊如果沒問題的話,那下一步應該心裡就會冒出一個OS :我的好天鵝啊!! 如果外部相依的物件很多,每個都自己做Mock物件,做完都老了,單元測試沒寫完Deadline就到了,搞毛啊...


看官稍安勿躁,你的心聲有人聽到了,所以接下來介紹一個可以省略掉剛剛一堆繁瑣的動作,登登登登,為您隆重介紹NSubstitute,怎麼用呢?讓我們在UnitTestDay3Tests這個專案透過Nuget安裝這個套件。

 

 

怎麼用呢?先Using。

 


然後... 

 

 

因為NSubstitute Mock出來實作IRestSharp的物件也會有Get的方法,他還可以設定帶入參數為何才回傳值,如果比對的Url不符合預期,則就會回傳String的預設值Null,是不是超方便的!!

 

當然如果你的方法是要回傳物件,一樣往Returns擺進去就對了,且它驗證參數的方法還有很多種而且很彈性,例如帶入如果是數字,你可以說大於100才回傳結果之類的,因為太多有需要的話還是直接參考他的文件比較快。

 

那今天的部分就談到這邊,能幫助我們做到Mock的套件還有很多,這邊只是其中一種我使用的而已,不一定要一樣,但只要了解原來Mock是這麼回事即可。

 

上一篇:[C#][Unit Test] 03. 專注於邏輯,隔離與外部的關聯

下一篇:[C#][Unit Test] 05. 透過InternalsVisibleTo來達成單元測試的外部注入

 


最後,如果你喜歡我們的文章,別忘了到我們的FB粉絲團按讚喔!!

Medium 0

Toyo

年過30在軟體業載浮載沉的工程師, 期望靠著一點一滴累積與努力, 讓自己墊起腳能勾到一點點的夢想