Go怎么写测试用例
- 开发程序其中很重要的一点就是测试,我们如何保证代码质量,如何保证每个函数都是可运行的,运行结果是正确的,又如何保证写出来的代码性能是好的,我们知道单元测试的重点在于发现程序设计或实现的逻辑错误,使问题及早暴露,便于问题的定位解决,而性能测试的重点在于发现程序设计的一些问题,让线上的程序能够高并发的情况下还能够保持稳定。
- Go语言中自带又一个轻量级的测试框架testing和自带的go test命令来实现单元测试和性能测试,testing框架及其他语言的中的测试框架类似,你可以给予这个框架写真对相应函数的测试用例,也可以基于该框架写相应的压力测试用例
如何编写测试用例
- 由于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
}
- gotest_test.go是我们的单元测试文件,单元测试文件必须遵守下面原则:
- 文件名必须是_test.go结尾,这样执行go test的时候才会执行到相应的代码
- 必须import testing这个包
- 所有测试函数必须是Test开头
- 测试用例会按照源代码中写的顺序依次执行
- 测试函数的参数是testing.T,我们可以使用该类型来记录错误或者是测试状态
- 测试函数格式:*func TestXxx(t testing.T),Xxx部分可以任意字母数字的组合,但是首字母不能是小写
- 函数中通过调用testing.T 的Error,Errorf,FailNow,Fatal,FatalIf方法,说明测试不通过,调用Log方法来记录测试信息
package gotest
import (
"testing"
)
func Test_Division_1(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 Test_Division_2(t *testing.T) {
t.Error("就是不通过")
}
当我们进入到gotest目录后执行go test会答应以下信息
--- FAIL: Test_Division_2 (0.00s)
gotest_test.go:16: 就是不通过
FAIL
exit status 1
FAIL web/gotest 0.006s
由于第二个函数我们直接写死了t.Error,所以测试不通过。第一个函数没有打印信息是因为默认情况下go test不会显示测试通过的信息,我们可以使用带参数go test -v,这样就会显示如下信息:
=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00s)
gotest_test.go:11: 第一个测试通过了
=== RUN Test_Division_2
--- FAIL: Test_Division_2 (0.00s)
gotest_test.go:16: 就是不通过
FAIL
exit status 1
FAIL web/gotest 0.006s
- 我们将第二个函数做如下修改
func Test_Division_2(t *testing.T) {
if _, e := Division(6, 0); e == nil { //try a unit test on function
t.Error("Division did not work as expected.") // 如果不是如预期的那么就报错
} else {
t.Log("one test passed.", e) //记录一些你期望记录的信息
}
}
再执行go test -v,就会显示:
=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00 seconds)
gotest_test.go:11: 第一个测试通过了
=== RUN Test_Division_2
--- PASS: Test_Division_2 (0.00 seconds)
gotest_test.go:20: one test passed. 除数不能为0
PASS
ok gotest 0.013s
如何编写压力测试
压力测试用来检测函数的性能的,和编写单元功能的测试的方法类似,压力测试必须注意以下几点:
- 压力测试用例必须遵循如下格式,其中XXX可以是任意字母数字组合,但是首字母不能是小写字母
func BenchmarkXXX(b *testing.B) { ... }
- go test不会默认执行压力测试的函数,如果要执行压力测试需要带上参数-test.bench,语法:-test.bench="test_name_regex",例如go test.bench="."* 表示测试全部的压力测试函数
- 在压力测试用例中,请记得在循环体内使用testing.B.N,以使测试可以正常运行
- 文件名也必须是以_test.go结尾
新建压力测试文件webbench_test.go,代码如下所示:
func Benchmark_Division(b *testing.B) {
for i := 0; i < b.N; i++ { //use b.N for looping
Division(4, 5)
}
}
func Benchmark_TimeConsumingFunction(b *testing.B) {
b.StopTimer() //调用该函数停止压力测试的时间计数
//做一些初始化的工作,例如读取文件数据,数据库连接之类的,
//这样这些时间不影响我们测试函数本身的性能
b.StartTimer() //重新开始时间
for i := 0; i < b.N; i++ {
Division(4, 5)
}
}
执行命令go test -run="webbench_test.go" -test.bench="."*进行webbench_test.go文件的全部压力测试,可以得到以下结果:
goarch: amd64
pkg: web/gotest
Benchmark_Division-4 2000000000 0.36 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.36 ns/op
PASS
ok web/gotest 1.500s
上面结果显示了我们只执行了压力测试函数,其中函数Benchmark_Division我们执行了2000000000次,每次执行平均时间为0.36ns,函数Benchmark_TimeConsumingFunction我们执行了2000000000次,每次执行平均时间为0.36ns,总共时间花了1.5s
执行命令:go test -run="webbench_test.go" -test.bench="Benchmark_TimeConsumingFunction"用于单独压力测试函数Benchmark_TimeConsumingFunction,得到以下结果:
goos: darwin
goarch: amd64
pkg: web/gotest
Benchmark_TimeConsumingFunction-4 2000000000 0.35 ns/op
PASS
ok web/gotest 0.737s
显示该函数执行了2000000000次,平均每次执行时间为0.35ns,总共执行时间为0.737s