go單元測試進階篇

本文轉載自查看原文 2017-04-01 09:53 3440 偽造模式/ 對象/ 測試/ 工具/ go語言

作者介紹:熊訓德（英文名：Sundy），16年畢業於四川大學大學並加入騰訊。目前在騰訊雲從事hadoop生態相關的雲存儲和計算等后台開發，喜歡並專注於研究大數據、虛擬化和人工智能等相關技術。

本文檔說明go語言自帶的測試框架未提供或者未方便地提供的測試方案，主要是用於解決寫單元測試中比較頭痛的依賴問題。也就是偽造模式，經典的偽造模式有樁對象(stub),模擬對象(mock)和偽對象(fake)。比較幸運的是，社區有豐富的第三方測試框架支持支持。下面就對筆者親身試用並實踐到項目中的幾個框架做介紹：

1.gomock

https://godoc.org/github.com/golang/mock/gomock

gomock模擬對象的方式是讓用戶聲明一個接口，然后使用gomock提供的mockgen工具生成mock對象代碼。要模擬(mock)被測試代碼的依賴對象時候，即可使用mock出來的對象來模擬和記錄依賴對象的各種行為：比如最常用的返回值，調用次數等等。文字敘述有點抽象，直接上代碼：

dick.go中DickFunc依賴外部對象OutterObj，本示例就是說明如何使用gomock框架控制所依賴的對象。

func DickFunc( outterObj MockInterface,para int)(result int){ fmt.Println("This init DickFunc") fmt.Println("call outter.func:") return outterObj.OutterFunc(para) }

mockgen工具命令是：

mockgen -source {source_file}.go -destination {dest_file}.go

比如，本示例即是：

mockgen -source src_mock.go -destination dst_mock.go

執行完后，可在同目錄下找到生成的dst_mock.go文件，可以看到mockgen工具也實現了接口：

接下來就可以使用mockgen工具生成的NewMockInterFace來生產mock對象，使用這個mock對象。OutterFunc()這個函數，gomock在控制mock類時支持鏈式編程的方式，其原理和其他鏈式編程類似一直維持了一個Call對象，把需要控制的方法名，入參，出參，調用次數以及前置和后置動作等，最后使用反射來調用方法，所以這個Call對象是mock對象的代理。jmockit的早期版本也是jdk自帶的java.reflect.Proxy動態代理實現的(最近的版本是動態Instrumentation配合代理模式)。

在本示例中只簡單的更改了返回值，拋磚引玉：

func TestDickFunc(t *testing.T ){ mockCtrl := gomock.NewController(t) //defer mockCtrl.Finish() mockObj := dick.NewMockMockInterface(mockCtrl) mockObj.EXPECT().OutterFunc(3).Return(10) result :=dick.DickFunc(mockObj,3) t.Log("resutl:",result) }

使用go test命令執行這個單測

從結果看：本來應該輸出3，最后輸出就是10，和其他語言mock框架相似，生產出來的Mock對象不用自己去重定義這么麻煩。

更多示例可以查看官網一個囊括gomock幾乎所有功能的例子：

https://godoc.org/github.com/golang/mock/sample

2.httpexcept

由於go在網絡架構上的優秀封裝，使得go在很多網絡場景被廣泛使用，而http協議是其中重要部分，在面對http請求的時候，可以對http的client進行測試，算是mock的特殊應用場景。

看一個簡單的示例就輕松的看懂了：

func TestHttp(t *testing.T) { handler := FruitServer() server := httptest.NewServer(handler) defer server.Close() e := httpexpect.New(t, server.URL) e.GET("/fruits"). Expect(). Status(http.StatusOK).JSON().Array().Empty() }

其中還支持對不同方法(包括Header,Post等)的構造以及返回值Json的自定義，更多細節查看其官網

3.testify

還有一個testify使用起來可以說兼容了《一》中的gocheck和gomock，但是其mock使用稍微有點煩雜，使用繼承tetify.Mock(匿名組合)重新實現需要Mock的接口，在這個接口里使用者自己使用Called(反射實現)被Mock的接口。

《單元測試的藝術》中認為stub和mock最大的區別就依賴對象是否和被測對象有交互，而從結果看就是樁對象不會使測試失敗，它只是為被測對象提供依賴的對象，並不改變測試結果，而mock則會根據不同的交互測試要求，很可能會更改測試的結果。說了這么多理論，但其實這兩種方法都不是割裂的，所以gomock框架除了像其名字一樣可以模擬對象以外，還提供了樁對象的功能(stub)。以其實現來說，更像是一個樁對象的注入。但是因為兼容了多個有用的功能，所以其在社區最為火爆。

具體用法可參考其github主頁

4.go-sqlmock

還有一種比較常見的場景就是和數據庫的交互場景，go-sqlmock是sql模擬（Mock）驅動器，主要用於測試數據庫的交互，go-sqlmock提供了完整的事務的執行測試框架，最新的版本(16.11.02)還支持prepare參數化提交和執行的Mock方案。

比如有這樣的被測函數：

func recordStats(db *sql.DB, userID, productID int64) (err error) {
    tx, err := db.Begin()
    if err != nil { return } defer func() { switch err { case nil: err = tx.Commit() default: tx.Rollback() } }() if _, err = tx.Exec("UPDATE products SET views = views + 1"); err != nil { return } if _, err = tx.Exec("INSERT INTO product_viewers (user_id, product_id) VALUES (?, ?)", userID, productID); err != nil { return } return } func main() { db, err := sql.Open("mysql", "root@/root") if err != nil { panic(err) } defer db.Close() if err = recordStats(db, 1 , 5 ); err != nil { panic(err) } }

單測時：

func TestShouldUpdateStats(t *testing.T) {
    db, mock, err := sqlmock.New()
    if err != nil { t.Fatalf("mock error: '%s' ", err) } defer db.Close() mock.ExpectBegin() mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1)) mock.ExpectExec("INSERT INTO product_viewers") .WithArgs(2, 3) .WillReturnResult(sqlmock.NewResult(1, 1)) mock.ExpectCommit() if err = recordStats(db, 2, 3); err != nil { t.Errorf("exe error: %s", err) } if err := mock.ExpectationsWereMet(); err != nil { t.Errorf("not implements: %s", err) } } //測試回滾 func TestShouldRollbackStatUpdatesOnFailure(t *testing.T) { db, mock, err := sqlmock.New() if err != nil { t.Fatalf("mock error: '%s'", err) } defer db.Close() mock.ExpectBegin() mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1)) mock.ExpectExec("INSERT INTO product_viewers") .WithArgs(2, 3) .WillReturnError(fmt.Errorf("some error")) mock.ExpectRollback() // 執行被測方法,有錯 if err = recordStats(db, 2, 3); err == nil { t.Errorf("not error") } // 執行被測方法，mock對象 if err := mock.ExpectationsWereMet(); err != nil { t.Errorf("not implements: %s", err) } }

更多例子和詳情，請查看官網:

https://github.com/DATA-DOG/go-sqlmock

介紹了這么多框架，最后需要說明的也可能最重要的是寫代碼時就應該考慮代碼是可被測試的。要使得單元測試容易寫，或者說代碼容易被測，其實很重要的一個部分就是被測代碼本身是容易被測的，也就是說在設計和編寫代碼的時候就應該先想到相好如何單元測試，甚至有人提出可以先寫單元測試，再寫具體被測代碼。因為一個接口(或者稱為單元)在被設計好后，它實現就確定了，實際效果也確定了。這種方式被稱作測試驅動開發(Test-Driven Development, TDD)。而對於已經寫好的代碼，很大程度上不好測試，有一種方式是測試性重構，就是為了更好的測試而進行重構。這些一定程度上來說並了解這些框架更重要，有意向可以，可以查閱有關兩本書《單元測試的藝術(第2版)》《xUnit測試模式》

參考： http://codethoughts.info/go/2015/04/05/how-to-test-go-code/

https://nathany.com/go-testing-toolbox/

http://shinley.com/index.html

《單元測試的藝術》

《xUnit測試模式》