『No11:Go 單元測(cè)試』

12.png
golang-11.png

大家好缴渊,我叫謝偉,是一名程序員鱼炒。

最近更新不是很頻繁疟暖,主要是我手頭有好些事需要解決,比如更換環(huán)境,比如出去見(jiàn)識(shí)人俐巴,以便更好的認(rèn)識(shí)自己,知道自己的短板在哪硬爆。

很早之前我就意識(shí)到:每隔半年需要出去走走欣舵,哪怕不是真的更換工作,你也應(yīng)該出去走走缀磕,去市場(chǎng)檢驗(yàn)一下自己是否在對(duì)應(yīng)的崗位有競(jìng)爭(zhēng)力缘圈,你的市場(chǎng)價(jià)位是多少。

好袜蚕,本節(jié)的主題是:?jiǎn)卧獪y(cè)試糟把。

測(cè)試其實(shí)分很多種,就我在企業(yè)中的認(rèn)識(shí)牲剃,一般稱為測(cè)試工程師遣疯,從事的應(yīng)該是所謂的集成測(cè)試(或者說(shuō)是 AC測(cè)試(Acceptance Criteria,驗(yàn)收準(zhǔn)則))凿傅。這一類的測(cè)試是從用戶層面進(jìn)行的測(cè)試缠犀。

比如你需要測(cè)試一個(gè) PaaS 安裝部署的功能。集成測(cè)試會(huì)怎么做聪舒?即完全按照用戶的角度進(jìn)行操作辨液,比如部署之前的參數(shù)設(shè)置,參數(shù)設(shè)置完進(jìn)行執(zhí)行命令箱残,部署完成查詢一些參數(shù)等滔迈。

那AC 測(cè)試如何完全枚舉這些用戶行為呢?有各種各樣的框架被辑,比如MFQ 燎悍,這套框架本質(zhì)是對(duì)金字塔原理的詮釋,即:完全窮盡敷待、相互獨(dú)立间涵。

還有一類測(cè)試稱為FT(Functional Test) 即功能測(cè)試。我講其中的一種吧榜揖。比如微服務(wù)領(lǐng)域勾哩,大多數(shù)服務(wù)其實(shí)是RESTful API 的形式。如何進(jìn)行功能測(cè)試举哟?大多數(shù)使用的是契約測(cè)試思劳,即也是使用框架,對(duì)生產(chǎn)者和消費(fèi)者獨(dú)立測(cè)試妨猩,消費(fèi)者和生產(chǎn)者相互獨(dú)立潜叛,相互解耦,調(diào)用API,和預(yù)期的結(jié)果對(duì)比威兜。

今天我們的主題是:?jiǎn)卧獪y(cè)試(UT)

即完成的是對(duì)函數(shù)級(jí)的測(cè)試销斟,測(cè)試是保證代碼質(zhì)量重要的一環(huán)。大廠一般合入代碼都有一套流水線椒舵,什么意思呢蚂踊。即你提交代碼,自動(dòng)會(huì)觸發(fā)UT, 運(yùn)行程序內(nèi)的單元測(cè)試笔宿,單元測(cè)試之后有一定的質(zhì)量統(tǒng)計(jì)犁钟,比如覆蓋率,一般的大廠的代碼覆蓋了閾值是90%, 即提交代碼泼橘,UT 運(yùn)行之后涝动,代碼的覆蓋率達(dá)到 90% 才可以合入。否則炬灭,先完成代碼覆蓋率醋粟。

編程領(lǐng)域內(nèi)還有一個(gè)重要的思想,叫TDD担败, 即測(cè)試驅(qū)動(dòng)開(kāi)發(fā)昔穴。

編寫一個(gè)測(cè)試,再寫函數(shù)提前,直到測(cè)試通過(guò)吗货,如此循壞。(當(dāng)然實(shí)際上測(cè)試驅(qū)動(dòng)開(kāi)發(fā)狈网,真正實(shí)施還是略微有點(diǎn)困難宙搬,一般的做法都是開(kāi)發(fā)、測(cè)試拓哺,而不是測(cè)試勇垛、開(kāi)發(fā)、測(cè)試士鸥、開(kāi)發(fā))

一般的初學(xué)者闲孤,是不太會(huì)關(guān)注測(cè)試,在沒(méi)有進(jìn)入職場(chǎng)之前烤礁,我甚至完全沒(méi)關(guān)注測(cè)試讼积,直到走入職場(chǎng)...


1. 編寫函數(shù)

這里我們列舉一個(gè)非常簡(jiǎn)單的例子,實(shí)現(xiàn)兩數(shù)相加。

func Add(argOne int, argTwo int) int {
    return argOne + argTwo
}

沒(méi)問(wèn)題吧脚仔。兩數(shù)相加勤众。

2. 編寫測(cè)試

測(cè)試需要有下面這些規(guī)范:

  • 文件名:_test.go 結(jié)尾
  • 函數(shù)名:Test 開(kāi)頭
  • 入?yún)ⅲ?t *testing.T)
  • 內(nèi)置庫(kù):testing
  • 報(bào)錯(cuò)信息:使用 testing 內(nèi)置的方法:Errorf、Error 鲤脏、Fail们颜、Failed吕朵、Fatal、Fatalf窥突、Log努溃、Logf 等

一般的測(cè)試這么寫

func TestAdd2(t *testing.T) {
    var result int
    result = Add(1, 2)
    if result != 3 {
        t.Errorf("wrong: result=%d actual=%d", result, 3)
    }
}

我這邊只是舉了個(gè)特別簡(jiǎn)單的例子,1+2=3波岛, 實(shí)際上一般的測(cè)試?yán)討?yīng)該選一些有代表性的茅坛,比如是否會(huì)越界啊、入?yún)⑹欠裾_啊则拷、等等。

上面的例子存在什么問(wèn)題呢曹鸠?

  • 測(cè)試數(shù)據(jù)和函數(shù)緊密耦合
  • 不利于寫多個(gè)測(cè)試

如何解決這個(gè)問(wèn)題呢煌茬?

  • 表格測(cè)試法:測(cè)試數(shù)據(jù) 和 函數(shù) 低耦合,便于寫出多個(gè)測(cè)試用例
func TestAdd(test *testing.T) {
    tt := []struct {
        argOne int
        argTwo int
        result int
    }{
        {
            argOne: 1,
            argTwo: 2,
            result: 3,
        },
        {
            argOne: -1,
            argTwo: 1,
            result: 0,
        },
        {
            argOne: math.MaxInt8,
            argTwo: 1,
            result: 1 << 7,
        }, {
            argOne: math.MaxInt16,
            argTwo: 1,
            result: 1 << 15,
        },
    }
    for _, t := range tt {
        var result int
        result = Add(t.argOne, t.argTwo)
        if result != t.result {
            test.Errorf("wrong: result=%d actual=%d", result, t.result)
        }
    }
}

先給定一堆測(cè)試數(shù)據(jù)彻桃,再遍歷測(cè)試數(shù)據(jù)坛善,調(diào)用函數(shù),看結(jié)果是否和預(yù)期一致邻眷。遍歷過(guò)程中不知道預(yù)期值眠屎,不重要,調(diào)用下函數(shù)即可肆饶,根據(jù)報(bào)錯(cuò)信息改衩,再進(jìn)行修正。比如 math.MaxInt8 + 1 我可能不知道等于多少驯镊。那么可以 result = 0葫督, 再看報(bào)錯(cuò)信息,糾正 result 即可板惑。

這樣測(cè)試數(shù)據(jù)和函數(shù)隔離橄镜,能寫出更好的測(cè)試用例。

當(dāng)然真實(shí)的情況遠(yuǎn)比這個(gè)例子需要復(fù)雜冯乘,比如:遇到了網(wǎng)絡(luò)連接洽胶、遇到了讀寫文件、遇到了操作數(shù)據(jù)庫(kù)裆馒。

這些一般怎么處理呢姊氓?測(cè)試中有一個(gè)名詞叫 mock , 即打樁,意思是领追,給某個(gè)地方模擬它的值他膳,即給定一個(gè)假的符合要求的值,比如網(wǎng)絡(luò)請(qǐng)求绒窑,需要得到網(wǎng)頁(yè)信息棕孙,那真實(shí)的單元測(cè)試不進(jìn)行真實(shí)的網(wǎng)絡(luò)操作,可以將請(qǐng)求打樁,返回一個(gè)指定的網(wǎng)頁(yè)信息即可蟀俊。

打樁又分給過(guò)程打樁钦铺,給函數(shù)打樁,給變量打樁等肢预。這些問(wèn)題矛洞,下次再補(bǔ)充,今天只講單元測(cè)試烫映。

3. 測(cè)試框架

內(nèi)置的 testing 庫(kù)其實(shí)挺好用的沼本,但遇到復(fù)雜的問(wèn)題,還是需要即用一些成熟的第三方庫(kù)的測(cè)試框架锭沟。

GoConvey是一款針對(duì)Golang的測(cè)試框架抽兆,可以管理和運(yùn)行測(cè)試用例,同時(shí)提供了豐富的斷言函數(shù)族淮,并支持很多 Web 界面特性辫红。

func TestAdd3(t *testing.T) {
    Convey("Testing Add", t, func() {
        tt := []struct {
            a int
            b int
            c int
        }{
            {
                a: 1,
                b: 2,
                c: 3,
            },
            {
                a: 4,
                b: 5,
                c: 9,
            },
        }
        So(Add(tt[0].a, tt[0].b), ShouldEqual, tt[0].c)
        So(Add(tt[1].a, tt[1].b), ShouldEqual, tt[1].c)
    })
}

還支持嵌套,文檔:GoConvey

4. 如何運(yùn)行測(cè)試用例

如果你使用的是Goland , 那么你可以單個(gè)測(cè)試進(jìn)行運(yùn)行祝辣。

go-test.png

也可以終端下運(yùn)行:(測(cè)試文件所在目錄贴妻,比如 add_test.go 所在目錄)

go test 

結(jié)果:

..
2 total assertions

PASS
ok      go-example-for-live/eleven/infra        0.070s

想查看更詳細(xì)的信息:

go test -v
λ go test -v
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
=== RUN   TestAdd2
--- PASS: TestAdd2 (0.00s)
=== RUN   TestAdd3

  Testing Add ..


2 total assertions

--- PASS: TestAdd3 (0.00s)
PASS
ok      go-example-for-live/eleven/infra        0.067s

go test -run=Add -v

支持 正則,即所有以Add 開(kāi)頭的測(cè)試函數(shù)都會(huì)被運(yùn)行蝙斜。

λ go test -run=Add -v
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
=== RUN   TestAdd2
--- PASS: TestAdd2 (0.00s)
=== RUN   TestAdd3

  Testing Add ..


2 total assertions

--- PASS: TestAdd3 (0.00s)
PASS
ok      go-example-for-live/eleven/infra        0.076s

5. 覆蓋率相關(guān)

上文講過(guò)名惩,一般的大廠,代碼的合入有一定的準(zhǔn)則乍炉,覆蓋率是其中的一項(xiàng)绢片,那如何使用 go 自帶的命令行工具進(jìn)行覆蓋率的操作呢?

λ go test  -coverprofile cover.out
..
2 total assertions

PASS
coverage: 100.0% of statements
ok      go-example-for-live/eleven/infra        0.059s

當(dāng)前目錄下一個(gè) cover.out 文件, 上文顯示 Add 函數(shù)的覆蓋率為 100%岛琼。

當(dāng)然這只是一個(gè)文件的操作底循,那如何進(jìn)行整個(gè)項(xiàng)目所有測(cè)試用例的測(cè)試是否通過(guò)呢?

官方?jīng)]給出答案槐瑞,所以可以借助第三方熙涤,或者自己寫,本質(zhì)上進(jìn)行代碼行數(shù)的統(tǒng)計(jì)困檩,和測(cè)試用例覆蓋率的統(tǒng)計(jì)祠挫,再進(jìn)行匯總,得出整個(gè)項(xiàng)目的覆蓋率的統(tǒng)計(jì)悼沿,這樣雖然有可能不太準(zhǔn)確等舔,但至少是一種思路。

6. 總結(jié)

本節(jié)探討了go 中的單元測(cè)試的編寫糟趾,主要是包括:一般單元測(cè)試的編寫慌植、表格驅(qū)動(dòng)的單元測(cè)試的編寫甚牲、第三方庫(kù)框架的單元測(cè)試的編寫。

希望對(duì)你有所啟發(fā)蝶柿。

如果你對(duì)TDD 感興趣丈钙,可以看看 Github 上這個(gè)項(xiàng)目:learn-go-with-tests

再會(huì),我是謝偉交汤。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末雏赦,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子芙扎,更是在濱河造成了極大的恐慌星岗,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,490評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件戒洼,死亡現(xiàn)場(chǎng)離奇詭異伍茄,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)施逾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)例获,“玉大人汉额,你說(shuō)我怎么就攤上這事≌ヌ溃” “怎么了蠕搜?”我有些...
    開(kāi)封第一講書人閱讀 165,830評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)收壕。 經(jīng)常有香客問(wèn)我妓灌,道長(zhǎng),這世上最難降的妖魔是什么蜜宪? 我笑而不...
    開(kāi)封第一講書人閱讀 58,957評(píng)論 1 295
  • 正文 為了忘掉前任虫埂,我火速辦了婚禮,結(jié)果婚禮上圃验,老公的妹妹穿的比我還像新娘掉伏。我一直安慰自己,他們只是感情好澳窑,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評(píng)論 6 393
  • 文/花漫 我一把揭開(kāi)白布斧散。 她就那樣靜靜地躺著,像睡著了一般摊聋。 火紅的嫁衣襯著肌膚如雪鸡捐。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 51,754評(píng)論 1 307
  • 那天麻裁,我揣著相機(jī)與錄音箍镜,去河邊找鬼源祈。 笑死,一個(gè)胖子當(dāng)著我的面吹牛鹿寨,可吹牛的內(nèi)容都是我干的新博。 我是一名探鬼主播,決...
    沈念sama閱讀 40,464評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼脚草,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼赫悄!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起馏慨,我...
    開(kāi)封第一講書人閱讀 39,357評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤埂淮,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后写隶,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體倔撞,經(jīng)...
    沈念sama閱讀 45,847評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評(píng)論 3 338
  • 正文 我和宋清朗相戀三年慕趴,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了痪蝇。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,137評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡冕房,死狀恐怖躏啰,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情耙册,我是刑警寧澤给僵,帶...
    沈念sama閱讀 35,819評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站详拙,受9級(jí)特大地震影響帝际,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜饶辙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評(píng)論 3 331
  • 文/蒙蒙 一蹲诀、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧畸悬,春花似錦侧甫、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 32,023評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至冷冗,卻和暖如春守屉,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蒿辙。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,149評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工拇泛, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留滨巴,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,409評(píng)論 3 373
  • 正文 我出身青樓俺叭,卻偏偏與公主長(zhǎng)得像恭取,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子熄守,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評(píng)論 2 355

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