本節(jié)代碼樣例見(jiàn)code/utest文件夾
在日常開(kāi)發(fā)中,我們通常需要針對(duì)現(xiàn)有的功能進(jìn)行單元測(cè)試,以驗(yàn)證開(kāi)發(fā)的正確性。 在go標(biāo)準(zhǔn)庫(kù)中有一個(gè)叫做testing的測(cè)試框架,可以進(jìn)行單元測(cè)試,命令是go test xxx。
測(cè)試文件通常是以xx_test.go命名,放在同一包下面。
1 初探Go單元測(cè)試
現(xiàn)在假設(shè)現(xiàn)在需求是:完成兩個(gè)復(fù)數(shù)相加,我們只需要一個(gè)函數(shù)便可以完成該任務(wù)。
在開(kāi)發(fā)中,我們需要對(duì)該函數(shù)進(jìn)行功能測(cè)試,如何快速進(jìn)行單元測(cè)試呢?
鼠標(biāo)放在函數(shù)上右鍵,選擇GO:Generate Unit Tests For Function即可生成file_test.go文件。
看下面動(dòng)畫:

隨后在測(cè)試文件中完成測(cè)試功能即可,可以進(jìn)入code/utest里面的complex_test進(jìn)行單元測(cè)試。
1.1 單測(cè)要點(diǎn)
第一:?jiǎn)卧獪y(cè)試的時(shí)候,如果有一些打印log信息,我們運(yùn)行xxx_test.go是輸出不出來(lái)的,此時(shí)需要使用:
go test xxx_test.go -v
使用-v參數(shù)可以幫助我們解決此問(wèn)題。
第二:?jiǎn)螠y(cè)覆蓋率,覆蓋率可以簡(jiǎn)單理解為進(jìn)行單元測(cè)試mock的時(shí)候,能夠覆蓋的代碼行數(shù)占總代碼行數(shù)的比率,當(dāng)然是高一點(diǎn)要好些??梢酝ㄟ^(guò)-cover指定
go test xxx_test -v -cover
第三:在上述提到的測(cè)試方法中我們使用的是(table-driven tests)表格驅(qū)動(dòng)型測(cè)試,我們看一下代碼:
tests := []struct {
name string
args args
want *Complex
}{
// TODO: Add test cases.
{
name: "",
args: args{
a: Complex{
Real: 1.0,
Imag: 2.0,
},
b: Complex{
Real: 1.0,
Imag: 1.0,
},
},
want: &Complex{
Real: 2.0,
Imag: 3.0,
},
},
}
在TODO里面我們可以填寫很多單元測(cè)試樣例。
2 基準(zhǔn)測(cè)試
基準(zhǔn)測(cè)試函數(shù)名字必須以Benchmark開(kāi)頭,代碼在xxx_test.go中。具體如下:
func BenchmarkComplex(t *testing.B) {
for i := 0; i < t.N; i++ {
fmt.Sprintf("hello")
}
}
運(yùn)行:
go test -benchmem -run=. -bench=.
輸出:
goos: linux
goarch: amd64
BenchmarkComplex-8 20542494 58.9 ns/op 5 B/op 1 allocs/op
PASS
ok _/home/light/go_dev/go-talent/code/utest 1.272s
20542494表示for循環(huán)的測(cè)試,58.9表示每次需要花費(fèi)58.9納秒。 -benchmem可以提供每次操作分配內(nèi)存的次數(shù),以及每次操作分配的字節(jié)數(shù)。 allocs/op 表示每次操作從堆上分配內(nèi)存的次數(shù)。B/op 表示每次操作分配的字節(jié)數(shù)。
3 mock/stub測(cè)試
gomock是官方提供的mock框架,同時(shí)有mockgen工具來(lái)輔助生成測(cè)試代碼。
需要自己先安裝一下:
go get -u github.com/golang/mock/gomock
go get -u github.com/golang/mock/mockgen
下面以DB為例,有如下接口:
type DB interface {
Get(key int) (string, error)
}
我們想通過(guò)Get接口返回對(duì)應(yīng)value。于是寫出了下面這個(gè)函數(shù):
func GetValue(db DB, key int) (string, error) {
value, err := db.Get(key)
if err != nil {
return "", errors.New("fail")
}
return value, nil
}
我們現(xiàn)在比較關(guān)心的是當(dāng)前我們寫的函數(shù)是否正確,而中間調(diào)用了Get接口,該接口我們可以進(jìn)行mock,首先使用下面命令:
mockgen -source=db.go -destination=db_mock.go -package=db
隨后在單元測(cè)試文件中進(jìn)行g(shù)o mock即可。
func TestGetValue(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
m := NewMockDB(ctrl)
m.EXPECT().Get(gomock.Eq(1)).Return("我是1的value", nil)
if v, err := GetValue(m, 1); err != nil {
t.Error(err)
} else {
t.Log(v)
}
}
其中比較重要的是打樁(stubs):
m.EXPECT().Get(gomock.Eq(1)).Return("我是1的value", nil)
這一行我們mock掉了Get接口,假設(shè)其返回字符串(我是1的value)與nil,隨后進(jìn)行邏輯測(cè)試。
這種方式的好處是不直接依賴的實(shí)例,而是使用依賴注入降低耦合性。
4 直接替換
在1.4中我們是需要進(jìn)行打樁并使用mockgen才可以完成一些復(fù)雜api的測(cè)試的,那有沒(méi)有更簡(jiǎn)單的方法呢,例如:直接替換函數(shù)為想要的函數(shù),在github上有monkey庫(kù)為我們使用。
輸入下面命令進(jìn)行安裝:
go get github.com/bouk/monkey
假設(shè)有Get接口的實(shí)現(xiàn)者是Handler,那么我們直接使用monkey進(jìn)行方法替換,把Get方法替換為我們自己的,僅此一步搞定單元測(cè)試,非常方便。
func TestGetValue1(t *testing.T) {
var h *Handler
monkey.PatchInstanceMethod(reflect.TypeOf(h), "Get", func(handler *Handler, key int) (string, error) {
return "我是1的value", nil
})
if v, err := GetValue(h, 1); err != nil {
t.Error(err)
} else {
t.Log(v)
}
}
5 瀏覽器實(shí)時(shí)測(cè)試
接下來(lái)引入一個(gè)比較方便的單元測(cè)試框架,可以在瀏覽器進(jìn)行實(shí)時(shí)查看單元測(cè)試結(jié)果。只需要三步即可。
第一步:
go get github.com/smartystreets/goconvey
第二步:
$GOPATH/bin/goconvey
第三步:
http://localhost:8080
此時(shí)在頁(yè)面可以看到下面這個(gè)。

除此之外,我們看到使用vscode生成的單元測(cè)試(table-driven tests)賊丑,那么我們可以使用convey進(jìn)行單測(cè)。
func TestSpec(t *testing.T) {
// Only pass t into top-level Convey calls
Convey("Given some integer with a starting value", t, func() {
x := 1
Convey("When the integer is incremented", func() {
x++
Convey("The value should be greater by one", func() {
So(x, ShouldEqual, 2)
})
})
})
}
使用convey進(jìn)行包裹起來(lái)好看的一匹。