[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 來節省手刻 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 了一陣子,發現 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 方法時,參數設定的注意事項。

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 禮拜天

結論

比起 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 吧。(笑)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容