在*_test.go文件中,有三種類型的函數:測試函數、基準測試(benchmark)函數、示例函數。一個測試函數是以Test為函數名前綴的函數,用于測試程序的一些邏輯行為是否正確;go test命令會調用這些測試函數并報告測試結果是PASS或FAIL。基準測試函數是以Benchmark為函數名前綴的函數,它們用于衡量一些函數的性能;go test命令會多次運行基準測試函數以計算一個平均的執行時間。示例函數是以Example為函數名前綴的函數,提供一個由編譯器保證正確性的示例文檔。
測試函數
- 測試文件必須以“_test.go”結尾
- 導入testing包
- 測試函數名必須以Test開頭,且簽名必須接收一個指向testing.T類型的指針,并無返回值,如TestDownload(t *testing.T)
- t.Log用來輸出測試消息,t.Logf可格式化消息;t.Fatal(t.Fatalf)測試失敗,只退出該測試函數;t.Error(t.Errorf)測試失敗,但不會退出該測試函數,可繼續向下執行
基準測試函數
- 測試文件必須以“_test.go”結尾
- 導入testing包
- 測試函數名必須以Benchmark開頭,且簽名必須接收一個指向testing.B類型的指針,并無返回值,如BenchmarkDownload(b *testing.B)
- 循環上限為b.N
特殊用法
- t.SkipNow()寫在測試函數內容第一行,可以跳過此測試函數
- 可以使用t.Run來執行subtest,做到控制test輸出以及順序
- 使用TestMain作為初始化test,做一些初始化的操作,如數據庫連接,文件打開等,然后使用m.Run()來調用tests,如果沒有在TestMain里調用m.Run(),則除了TestMain外其余tests(包括Benchmark)都不會被執行
func TestP(t *testing.T) {
t.SkipNow() // 跳過此測試
res := Print1to20()
fmt.Println(res)
if res != 200 {
t.Error("Wrong result")
}
}
func testPrint(t *testing.T) {
res := Print1to20()
fmt.Println(res)
if res != 190 {
t.Error("Wrong result")
}
}
func testPrint2(t *testing.T) {
res := Print1to20()
fmt.Println(res)
if res != 190 {
t.Error("Wrong result")
}
}
func TestAll(t *testing.T) {
t.Run("TestPrint", testPrint)
t.Run("TestPrint2", testPrint2)
}
func TestMain(m *testing.M) {
fmt.Println("some init")
m.Run()
}
命令行
- go test [-v] 目錄下全部文件內的全部單元測試函數[-v顯示詳情]
- go test xxx_test.go [-v] 目錄下指定文件內的全部單元測試函數
- go test -run TestXXX [-v] 目錄下指定單元測試函數
- go test -bench=".*" [-v] 目錄下全部單元測試和基準測試
- go test -run="none" -bench=".*" 目錄下全部基準測試函數(不跑單元測試)(參數-run對應一個正則表達式)
- go test -run="none" -bench="BenchmarkXXX" 目錄下指定基準測試函數
- -benchtime="3s",指定運行時間,默認不小于1s;-benchmem可顯示每次操作分配內存的次數(allocs/op),字節數(B/op)
- go tool cover查看測試覆蓋率的使用
測試分類
一種測試分類的方法是基于測試者是否需要了解被測試對象的內部工作原理。黑盒測試只需要測試包公開的文檔和API行為,內部實現對測試代碼是透明的。相反,白盒測試有訪問包內部函數和數據結構的權限,因此可以做到一些普通客戶端無法實現的測試。例如,一個白盒測試可以在每個操作之后檢測不變量的數據類型。(白盒測試只是一個傳統的名稱,其實稱為clear box測試會更準確。)
黑盒和白盒這兩種測試方法是互補的。黑盒測試一般更健壯,隨著軟件實現的完善測試代碼很少需要更新。它們可以幫助測試者了解真實客戶的需求,也可以幫助發現API設計的一些不足之處。相反,白盒測試則可以對內部一些棘手的實現提供更多的測試覆蓋。
基準測試剖析
Go語言支持多種類型的剖析性能分析,每一種關注不同的方面,但它們都涉及到每個采樣記錄的感興趣的一系列事件消息,每個事件都包含函數調用時函數調用堆棧的信息。內建的go test工具對幾種分析方式都提供了支持。
CPU剖析數據標識了最耗CPU時間的函數。在每個CPU上運行的線程在每隔幾毫秒都會遇到操作系統的中斷事件,每次中斷時都會記錄一個剖析數據然后恢復正常的運行。
堆剖析則標識了最耗內存的語句。剖析庫會記錄調用內部內存分配的操作,平均每512KB的內存申請會觸發一個剖析數據。
阻塞剖析則記錄阻塞goroutine最久的操作,例如系統調用、管道發送和接收,還有獲取鎖等。每當goroutine被這些操作阻塞時,剖析庫都會記錄相應的事件。
只需要開啟下面其中一個標志參數就可以生成各種分析文件。當同時使用多個標志參數時需要當心,因為一項分析操作可能會影響其他項的分析結果。
go test -cpuprofile=cpu.out
go test -blockprofile=block.out
go test -memprofile=mem.out
一旦我們已經收集到了用于分析的采樣數據,我們就可以使用pprof來分析這些數據。這是Go工具箱自帶的一個工具,但并不是一個日常工具,它對應go tool pprof命令。該命令有許多特性和選項,但是最基本的是兩個參數:生成這個概要文件的可執行程序和對應的剖析數據。
為了提高分析效率和減少空間,分析日志本身并不包含函數的名字;它只包含函數對應的地址。也就是說pprof需要對應的可執行程序來解讀剖析數據。雖然go test通常在測試完成后就丟棄臨時用的測試程序,但是在啟用分析的時候會將測試程序保存為foo.test文件,其中foo部分對應待測包的名字。
下面的命令演示了如何收集并展示一個CPU分析文件。我們選擇net/http包的一個基準測試為例。通常最好是對業務關鍵代碼的部分設計專門的基準測試。因為簡單的基準測試幾乎沒法代表業務場景,因此我們用-run=NONE參數禁止那些簡單測試。
$ go test -run=NONE -bench=ClientServerParallelTLS64 \
-cpuprofile=cpu.log net/http
PASS
BenchmarkClientServerParallelTLS64-8 1000
3141325 ns/op 143010 B/op 1747 allocs/op
ok net/http 3.395s
$ go tool pprof -text -nodecount=10 ./http.test cpu.log
2570ms of 3590ms total (71.59%)
Dropped 129 nodes (cum <= 17.95ms)
Showing top 10 nodes out of 166 (cum >= 60ms)
flat flat% sum% cum cum%
1730ms 48.19% 48.19% 1750ms 48.75% crypto/elliptic.p256ReduceDegree
230ms 6.41% 54.60% 250ms 6.96% crypto/elliptic.p256Diff
120ms 3.34% 57.94% 120ms 3.34% math/big.addMulVVW
110ms 3.06% 61.00% 110ms 3.06% syscall.Syscall
90ms 2.51% 63.51% 1130ms 31.48% crypto/elliptic.p256Square
70ms 1.95% 65.46% 120ms 3.34% runtime.scanobject
60ms 1.67% 67.13% 830ms 23.12% crypto/elliptic.p256Mul
60ms 1.67% 68.80% 190ms 5.29% math/big.nat.montgomery
50ms 1.39% 70.19% 50ms 1.39% crypto/elliptic.p256ReduceCarry
50ms 1.39% 71.59% 60ms 1.67% crypto/elliptic.p256Sum
參數-text用于指定輸出格式,在這里每行是一個函數,根據使用CPU的時間長短來排序。其中-nodecount=10參數限制了只輸出前10行的結果。對于嚴重的性能問題,這個文本格式基本可以幫助查明原因了。
這個概要文件告訴我們,HTTPS基準測試中crypto/elliptic.p256ReduceDegree函數占用了將近一半的CPU資源,對性能占很大比重。相比之下,如果一個概要文件中主要是runtime包的內存分配的函數,那么減少內存消耗可能是一個值得嘗試的優化策略。
對于一些更微妙的問題,你可能需要使用pprof的圖形顯示功能。這個需要安裝GraphViz工具,可以從 http://www.graphviz.org 下載。參數-web用于生成函數的有向圖,標注有CPU的使用和最熱點的函數等信息。
如果想了解更多,可以閱讀Go官方博客的“Profiling Go Programs”一文。
示例函數
以Example為函數名開頭。示例函數沒有函數參數和返回值。下面是IsPalindrome函數對應的示例函數:
func ExampleIsPalindrome() {
fmt.Println(IsPalindrome("A man, a plan, a canal: Panama"))
fmt.Println(IsPalindrome("palindrome"))
// Output:
// true
// false
}
示例函數有三個用處。最主要的一個是作為文檔:一個包的例子可以更簡潔直觀的方式來演示函數的用法,比文字描述更直接易懂,特別是作為一個提醒或快速參考時。一個示例函數也可以方便展示屬于同一個接口的幾種類型或函數之間的關系,所有的文檔都必須關聯到一個地方,就像一個類型或函數聲明都統一到包一樣。同時,示例函數和注釋并不一樣,示例函數是真實的Go代碼,需要接受編譯器的編譯時檢查,這樣可以保證源代碼更新時,示例代碼不會脫節。
根據示例函數的后綴名部分,godoc這個web文檔服務器會將示例函數關聯到某個具體函數或包本身,因此ExampleIsPalindrome示例函數將是IsPalindrome函數文檔的一部分,Example示例函數將是包文檔的一部分。
示例函數的第二個用處是,在go test執行測試的時候也會運行示例函數測試。如果示例函數內含有類似上面例子中的// Output:格式的注釋,那么測試工具會執行這個示例函數,然后檢查示例函數的標準輸出與注釋是否匹配。