Golang 单元测试
Golang 中的单元测试是使用标准库 testing 来实现的,编写一个单元测试是很容易的:
- 创建测试文件:在 Go 项目的源代码目录下创建一个新的文件(和被测代码文件在同一个包),以 _test.go 为后缀名。例如,要测试net包中 dial.go 中的方法,在 net 包中创建一个名字为 dial_test.go 文件。
- 导入 testing 包:在测试文件中导入testing包,以使用相关的的函数和工具。
- 编写测试函数:在测试文件中,编写一个以 Test 为前缀的函数,后面跟上一个或多个字符或字符组合来标识测试用例的名称(一般使用被测的函数名称),参数必须是 t *testing.T。
- 编写测试代码:如果认为测试不通过,当被测程序功能与预期不符,调用 t.Error 或 t.Errorf 方法记录错误;如果出现了使测试无法继续进行的错误,调用tFatal 和 t.Fatalf;如果测试函数体正常运行结束,没有异常,则测试通过。
以 json 格式校验工具
https://github.com/luduoxin/json-validator-go 为例,validator包中的 scanner.go 文件中的关键函数 Valid 用于校验给定字符串是否 json 格式,对应的单元测试文件为 scanner_test.go,里面的测试函数为 TestValid。scanner_test.go 的源代码如下:
package validator
import "testing"
var validTests = []struct {
data string
ok bool
}{
{`foo`, false},
{`}{`, false},
{`{]`, false},
{`123`, false},
{`123.5`, false},
{`0.5`, false},
{`true`, false},
{`false`, false},
{`null`, false},
{`[1,2,3]`, false},
{`["a","b","c"]`, false},
{`{"foo":bar}`, false},
{`[{"foo":"bar"},]`, false},
{`{}`, true},
{`[]`, true},
{`[{}]`, true},
{`{"foo":"bar"}`, true},
{`{"foo":"bar","bar":{"baz":["qux"]}}`, true},
{`[{"a":"[\"c\":\"d\"]"}]`, true},
{`[{"a":[]}]`, true},
{` {"a":"b"}`, true},
{` {"a":"b"} `, true},
{`{"a":"b"} `, true},
{`{"a": "b"} `, true},
}
func TestValid(t *testing.T) {
for _, tt := range validTests {
if ok := Valid([]byte(tt.data)); ok != tt.ok {
t.Errorf("Valid(%#q) = %v, want %v", tt.data, ok, tt.ok)
}
}
}
这个源代码相关来说比较复杂,因为测试的数据种类比较多,如果是只想简单测试一下,代码如下:
package validator
import "testing"
func TestValid(t *testing.T) {
str := `{"a": "b"}`
if ok := Valid([]byte(str)); !ok {
t.Errorf("Valid(%#q) = %v, want %v", str, ok, true)
}
}
运行单元测试用例
使用 go test 命令可以运行单元测试用例,使用方法如下:
# 执行当前目录下的全部测试用例,不递归子目录中的测试用例
go test .
# 执行当前目录下的全部测试用例,递归子目录中的测试用例
go test ./...
# 执行当前目录下的全部测试用例并显示测试过程中的日志内容,不递归子目录中的测试用例
go test -v .
# 执行当前目录下的全部测试用例并显示测试过程中的日志内容,递归子目录中的测试用例
go test -v ./...
# 执行指定的测试用例
go test -v . -test.run '^TestValid$'
启动命令行,切换到 json-validator-go 项目的 validator 文件夹下,运行全部测试用例:
$ go test -v .
=== RUN TestValid
--- PASS: TestValid (0.00s)
PASS
ok github.com/luduoxin/json-validator-go/validator
运行指定测试用例 TestValid :
$ go test -v . -test.run '^TestValid$'
=== RUN TestValid
--- PASS: TestValid (0.00s)
PASS
ok github.com/luduoxin/json-validator-go/validator