每一個程序都應該學會寫測試在去寫代碼
上面這句話雖然有點誇張,但是也是有一定的道理的。對於新手來說,都是在寫一個簡單的代碼,一般調試後運行都沒有多大問題。但是當寫的一個項目的代碼很多的時候,雖然當時編譯通過了,並且能夠順利運行起來了。但是,可能一個小小的邊角錯誤,就會導致系統的整體崩潰。好比我們在刷leetcode,信心滿滿的將代碼寫好,並且自己寫了幾個例子測試完,沒問題,一提交發現還是有那麼幾個邊邊角角的例子被我們遺漏了。
好了來看看怎麼寫測試代碼吧。
如何編寫測試用例
由於go test命令只能在一個相應的目錄下執行所有文件,所以我們接下來新建一個項目目錄gotest,這樣我們所有的代碼和測試代碼都在這個目錄下。
接下來我們在該目錄下面創建兩個文件:gotest.go
和gotest_test.go
gotest.go
:這個文件裏面我們是創建了一個包,裏面有一個函數實現了除法運算:
package gotest
import (
"errors"
)
func Division(a, b float64) (float64, error) {
if b == 0 {
return 0, errors.New("除數不能爲0")
}
return a / b, nil
}
1.gotest_test.go:這是我們的單元測試文件,但是記住下面的這些原則:
- 文件名必須是_test.go結尾的,這樣在執行go test的時候纔會執行到相應的代碼
- 你必須import testing這個包
- 所有的測試用例函數必須是Test開頭
- 測試用例會按照源代碼中寫的順序依次執行
- 測試函數TestXxx()的參數是testing.T,我們可以使用該類型來記錄錯誤或者是測試狀態
- 測試格式:func TestXxx (t *testing.T),Xxx部分可以爲任意的字母數字的- 組合,但是首字母不能是小寫字母[a-z],例如Testintdiv是錯誤的函數名。
- 函數中通過調用testing.T的Error, Errorf, FailNow, Fatal, FatalIf方法,說明測試不通過,調用Log方法用來記錄測試的信息。
下面是我們的測試用例的代碼:
package gotest
import (
"testing"
)
func TestDivision1(t *testing.T) {
if i, e := Division(6, 2); i != 3 || e != nil { //try a unit test on function
t.Error("除法函數測試沒通過") // 如果不是如預期的那麼就報錯
} else {
t.Log("第一個測試通過了") //記錄一些你期望記錄的信息
}
}
func TestDivision2(t *testing.T) {
t.Error("就是不通過")
}
我們在項目目錄下面執行go test
,就會顯示如下信息:
--- FAIL: Test_Division_2 (0.00 seconds)
gotest_test.go:16: 就是不通過
FAIL
exit status 1
FAIL gotest 0.013s
從這個結果顯示測試沒有通過,因爲在第二個測試函數中我們寫死了測試不通過的代碼t.Error
,那麼我們的第一個函數執行的情況怎麼樣呢?默認情況下執行go test
是不會顯示測試通過的信息的,我們需要帶上參數go test -v
,這樣就會顯示如下信息:
=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00 seconds)
gotest_test.go:11: 第一個測試通過了
=== RUN Test_Division_2
--- FAIL: Test_Division_2 (0.00 seconds)
gotest_test.go:16: 就是不通過
FAIL
exit status 1
FAIL gotest 0.012s
上面的輸出詳細的展示了這個測試的過程,我們看到測試函數1Test_Division_1
測試通過,而測試函數2Test_Division_2
測試失敗了,最後得出結論測試不通過。接下來我們把測試函數2修改成如下代碼:
func TestDivision1(t *testing.T) {
if i, e := Division(6, 0); i != 3 || e != nil { //try a unit test on function
t.Error("除法函數測試沒通過", e) // 如果不是如預期的那麼就報錯
} else {
t.Log("第一個測試通過了") //記錄一些你期望記錄的信息
}
}
然後我們執行go test -v
,就顯示如下信息,測試通過了:
D:\data\code\studygo\test\test>go test -v
=== RUN Test_Division_1
Test_Division_1: example_test.go:9: 除法函數測試沒通過 除數不能爲0
--- FAIL: Test_Division_1 (0.00s)
=== RUN Test_Division_2
Test_Division_2: example_test.go:16: 就是不通過
--- FAIL: Test_Division_2 (0.00s)
FAIL
exit status 1
FAIL test/test 1.906s
如何編寫壓力測試(基準測試)
壓力測試用來檢測函數(方法)的性能,和編寫單元功能測試的方法類似,此處不再贅述,但需要注意以下幾點:
- 壓力測試用例必須遵循如下格式,其中XXX可以是任意字母數字的組合,但是首字母不能是小寫字母
func BenchmarkXXX(b *testing.B) { ... }
go test
不會默認執行壓力測試的函數,如果要執行壓力測試需要帶上參數-test.bench
,語法:-test.bench="test_name_regex"
,例如go test -test.bench=".*"
表示測試全部的壓力測試函數- 在壓力測試用例中,請記得在循環體內使用
testing.B.N
,以使測試可以正常的運行 - 文件名也必須以
_test.go
結尾
下面我們新建一個壓力測試文件webbench_test.go
,代碼如下所示:
package gotest
import (
"testing"
)
func BenchmarkDivision(b *testing.B) {
for i := 0; i < b.N; i++ { //use b.N for looping
Division(4, 5)
}
}
func BenchmarkTimeConsumingFunction(b *testing.B) {
b.StopTimer() //調用該函數停止壓力測試的時間計數
//做一些初始化的工作,例如讀取文件數據,數據庫連接之類的,
//這樣這些時間不影響我們測試函數本身的性能
b.StartTimer() //重新開始時間
for i := 0; i < b.N; i++ {
Division(4, 5)
}
}
執行:go test -run="none" -v -bench=.
D:\data\code\studygo\test\test>go test -run="none" -v -bench=.
goos: windows
goarch: amd64
pkg: test/test
BenchmarkDivision
BenchmarkDivision-8 1000000000 0.293 ns/op
BenchmarkTimeConsumingFunction
BenchmarkTimeConsumingFunction-8 1000000000 0.287 ns/op
PASS
ok test/test 3.119s
-run="none"
是保證在運行制訂的基準(壓力)測試函數之前沒有單元測試會被運行。如果不加這句就會執行同目錄下的gotest_test.go
的測試用例。
-bench=.
表示執行所有的壓力測試代碼。假如我們只想執行一個測試單元比如執行BenchmarkDivision
可以寫成-bench="BenchmarkDivision"
如果想測試的時間更長一些可以使用-benchtime="4s"
如果想提供每次操作分配內存的次數,以及總共分配內存的字節數-benmem
執行-benmem
結果:
BenchmarkDivision
BenchmarkDivision-8 1000000000 0.291 ns/op 0 B/op 0 allocs/op
BenchmarkTimeConsumingFunction
BenchmarkTimeConsumingFunction-8 1000000000 0.285 ns/op 0 B/op 0 allocs/op
這次輸出的結果會多出兩組新的數值:一組數值的單位是B/op
,另一組的單位是allocs/op
。單位爲allocs/op
的值表示每次操作從堆上分配內存的次數。單位爲B/op
的值表示每次操作分配的字節數。
參考文獻:
《go web 編程》
《Go語言實戰》
撩我?
搜索我的公衆號:Kyda