[Unit Test Tricks]Extract and Override Protected Function with Moq

之前介紹了 Extract and Override 的技巧班缎,使得不需改變 production code 對外的 API,也仍然可以在測試專案中建立一個 SUT 的替身揣非,覆寫想要 isolated 的 dependency 就可以針對 SUT 做 isolated unit test 抡医。
但手刻 SUT 的替身總是不如 mock framework 看起來便利,這篇文章要介紹使用 moq 來節(jié)省手刻 SUT 替身的 effort, 直接透過 moq 來 stub SUT protected virtual 的方法早敬。

前言

[Unit Test Tricks] Extract and Override 這篇文章中介紹的手法忌傻,可以輕鬆地將測試目標需要 isolated 的 dependency 部分擷取到 protected virtual 方法後,在測試專案中手動刻一個測試目標的 proxy class 搞监,使得既可覆寫掉需要 isolated 的 dependency 部分芯勘,對這個替身進行測試,又與測試目標的行為幾近完全相同腺逛。
但手刻替身物件這件事,就像一般 mock framework 想要解決手刻 Stub 物件的困擾一樣,手刻總是顯得愚笨棍矛、不美麗安疗、浪費時間。

但因為測試目標的 protected 方法够委,並不會暴露給外界看到荐类,也因此一般的 mock framework 即使想要 stub protected 方法的回傳值,也無計可施茁帽,因為 stub 物件仍然看不見 protected function玉罐。

Survey 了一陣子,發(fā)現(xiàn) NSub 有一個 API 叫 Partial Sub 潘拨,貌似就是用來解決這問題吊输,但很可惜的是,他也只能針對 public virtual 進行覆寫铁追,而非 protected virtual 季蚂。

Moq 辦到了,透過 ProtectedMock
來改變 protected virtual function 的行為琅束。

Sample Code

情境:當今天是星期日的時候扭屁,就應該是爸爸做家事。如果不是星期日涩禀,就是媽媽做家事料滥。

    public class HouseWork
    {
        public string WhoShouldWork()
        {
            var today = GetToday("whoCares");
            if (today.DayOfWeek == DayOfWeek.Sunday)
            {
                return "Dad";
            }
            else
            {
                return "Mom";
            }
        }

        protected virtual DateTime GetToday(string whoCares)
        {
            return DateTime.Today;
        }
    }

原本的程式碼,會因為直接相依於 DateTime.Today 而不具備可測試性艾船,所以透過 extract and override 的手法葵腹,將 DateTime.Today 搬到 protected virtual 的方法中,供測試專案的類別進行覆寫丽声,供測試程式注入礁蔗。

注意:這邊 GetToday() 之所以傳了一個用不到的 string ,只是為了帶出來 moq 在覆寫 protected 方法時雁社,參數(shù)設定的注意事項浴井。

Isolated Unit Test with Moq

使用 Moq 撰寫的測試程式如下:

        [TestMethod]
        public void Test_WhoShouldWork_TodayIsNotSunday_Should_Be_Mom()
        {
            //var target = new HouseWork();
            var target = new Mock<HouseWork>();
            target.Protected()
                .Setup<DateTime>("GetToday", ItExpr.IsAny<string>())
                .Returns(new DateTime(2016, 4, 16));

            //var actual = target.WhoShouldWork();
            var actual = target.Object.WhoShouldWork();

            var expected = "Mom";
            Assert.AreEqual(expected, actual);
        }

        [TestMethod]
        public void Test_WhoShouldWork_TodayIsSunday_Should_Be_Dad()
        {
            //var target = new HouseWork();
            var target = new Mock<HouseWork>();
            target.Protected()
                .Setup<DateTime>("GetToday", ItExpr.IsAny<string>())
                .Returns(new DateTime(2016, 4, 17));

            //var actual = target.WhoShouldWork();
            var actual = target.Object.WhoShouldWork();

            var expected = "Dad";
            Assert.AreEqual(expected, actual);
        }

可以看到註解的地方,是最原始測試程式的寫法霉撵,但這樣會因為 DateTime.Today 而不具備可測試性磺浙。

透過 moq 的 Proected() ,就可以針對 GetToday() 這個 protected 方法進行 Setup() 徒坡,因為方法可能是多載的撕氧,所以得透過 argument matching 來告訴 moq ,我們想要覆寫的究竟是哪一個 protected 方法喇完。所以必須傳入 ItExpr 的 argument伦泥。

記得 using Moq.Protected;

接著,當呼叫 HouseWork 的 mock 物件的 WhoShouldWork() 時,裡面所呼叫到的 GetToday() 就會回傳剛剛 Setup() 所設定 Returns() 的日期不脯。

當跑 Today Is Sunday 的 scenario 時府怯,protected GetToday() 就會回傳 2016/4/17 ,如下圖所示防楷。

2016/4/17 禮拜天

結(jié)論

比起 NSub 的 Partial Sub 只能針對 public virtual 進行覆寫牺丙,moq 實用多了。因為透過 extract and override 通常就是期望不要改變 production code 對外的 API 與封裝性复局。

然後對比 Microsoft.Fakes 那樣的黑魔法冲簿,我還是更傾向 moq 的方式。原因是 moq 只是透過一些方式幫忙省掉手刻替身物件的工亿昏,但仍遵循著只覆寫 protected virtual function峦剔,而且相比 Microsoft.Fakes 仍是輕量化許多。

最後龙优,就是我有點陷入了兩難羊异。因為我實在喜歡 NSub 的簡潔,但實務上我又用了許多 extract and override 的技巧彤断∫安埃或許,我可能會同時參考 NSub 與 moq 兩個 package 吧宰衙。(笑)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末平道,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子供炼,更是在濱河造成了極大的恐慌一屋,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件袋哼,死亡現(xiàn)場離奇詭異冀墨,居然都是意外死亡,警方通過查閱死者的電腦和手機涛贯,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進店門诽嘉,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人弟翘,你說我怎么就攤上這事虫腋。” “怎么了稀余?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵悦冀,是天一觀的道長。 經(jīng)常有香客問我睛琳,道長盒蟆,這世上最難降的妖魔是什么踏烙? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮历等,結(jié)果婚禮上宙帝,老公的妹妹穿的比我還像新娘。我一直安慰自己募闲,他們只是感情好,可當我...
    茶點故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布愿待。 她就那樣靜靜地躺著浩螺,像睡著了一般。 火紅的嫁衣襯著肌膚如雪仍侥。 梳的紋絲不亂的頭發(fā)上要出,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天,我揣著相機與錄音农渊,去河邊找鬼患蹂。 笑死,一個胖子當著我的面吹牛砸紊,可吹牛的內(nèi)容都是我干的传于。 我是一名探鬼主播,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼醉顽,長吁一口氣:“原來是場噩夢啊……” “哼沼溜!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起游添,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤系草,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后唆涝,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體找都,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年廊酣,在試婚紗的時候發(fā)現(xiàn)自己被綠了能耻。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,137評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡啰扛,死狀恐怖嚎京,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情隐解,我是刑警寧澤鞍帝,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站煞茫,受9級特大地震影響帕涌,放射性物質(zhì)發(fā)生泄漏摄凡。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一蚓曼、第九天 我趴在偏房一處隱蔽的房頂上張望亲澡。 院中可真熱鬧,春花似錦纫版、人聲如沸床绪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽癞己。三九已至,卻和暖如春梭伐,著一層夾襖步出監(jiān)牢的瞬間痹雅,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工糊识, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留绩社,地道東北人。 一個月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓赂苗,卻偏偏與公主長得像愉耙,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子哑梳,可洞房花燭夜當晚...
    茶點故事閱讀 45,086評論 2 355

推薦閱讀更多精彩內(nèi)容