添加测试
既然您已经将代码放到了一个稳定的地方(顺便说一句,做得很好),请添加一个测试。在开发期间测试您的代码可能会暴露在您进行更改时发现的错误。在本主题中,您将为Hello
函数添加一个测试.
Go 对单元测试的内置支持使您可以更轻松地进行测试。具体来说,使用命名约定、Go 的testing
包和go test
命令,您可以快速编写和执行测试.
-
在 greetings 目录中,创建一个名为 greetings_test.go 的文件.
以 _test.go 结尾的文件名告诉
go test
命令该文件包含测试函数 -
在 greetings_test.go 中,粘贴以下代码并保存文件.
package greetings import ( "testing" "regexp" ) // TestHelloName 用一个名字调用 greetings.Hello, // 检查有效的返回值. func TestHelloName(t *testing.T) { name := "Gladys" want := regexp.MustCompile(`\b`+name+`\b`) msg, err := Hello("Gladys") if !want.MatchString(msg) || err != nil { t.Fatalf(`Hello("Gladys") = %q, %v, want match for %#q, nil`, msg, err, want) } } // TestHelloEmpty 使用空字符串调用 greetings.Hello, // 检查错误. func TestHelloEmpty(t *testing.T) { msg, err := Hello("") if msg != "" || err == nil { t.Fatalf(`Hello("") = %q, %v, want "", error`, msg, err) } }
在此代码中,您:
- 在与要测试的代码相同的包中实现测试函数.
-
创建两个测试函数来测试
greetings.Hello
函数。测试函数名称的格式为TestName
,其中 Name 表示有关特定测试的内容。此外,测试函数会获取指针指向testing
包的testing.T
类型作为参数。使用此参数的方法从测试中报告和记录. -
实现两个测试:
-
TestHelloName
调用Hello
函数,传递一个name
值,该函数应该能够使用该值返回有效的响应消息。如果调用返回错误或意外响应消息(不包含您传入的名称),则使用t
参数的Fatalf
方法 将消息打印到控制台并结束执行. -
TestHelloEmpty
使用空字符串调用Hello
函数。此测试旨在确认错误处理是否正常工作。如果调用返回非空字符串或无错误,则使用t
参数的Fatalf
方法将消息打印到控制台并结束执行.
-
-
在greetings目录下的命令行,运行
go test
命令执行测试.go test
命令在测试文件(其名称以 _test.go 结尾)中执行测试函数(其名称以Test
开头)。您可以添加-v
标志以获取列出所有测试及其结果的详细输出。测试应该通过.
$ go test PASS ok example.com/greetings 0.364s $ go test -v === RUN TestHelloName --- PASS: TestHelloName (0.00s) === RUN TestHelloEmpty --- PASS: TestHelloEmpty (0.00s) PASS ok example.com/greetings 0.372s
-
中断
greetings.Hello
函数以查看失败的测试.TestHelloName
测试函数检查您指定为Hello
函数参数的名称的返回值。若要查看失败的测试结果,请更改greetings.Hello
函数,以便它不再包含名称.在 greetings/greetings.go 中,粘贴以下代码来代替
Hello
函数。请注意,突出显示的行会更改函数返回的值,就好像name
参数被意外删除一样.// Hello 为指定的人返回问候语. func Hello(name string) (string, error) { // 如果没有给出名字,返回一个带有消息的错误. if name == "" { return name, errors.New("empty name") } // 使用随机格式创建消息. // message := fmt.Sprintf(randomFormat(), name) message := fmt.Sprint(randomFormat()) return message, nil }
-
在greetings目录下的命令行,运行
go test
执行测试.这一次,在没有
-v
标志的情况下运行go test
。输出将仅包括失败的测试的结果,这在您有很多测试时非常有用。TestHelloName
测试应该失败 --TestHelloEmpty
仍然通过.$ go test --- FAIL: TestHelloName (0.00s) greetings_test.go:15: Hello("Gladys") = "Hail, %v! Well met!", <nil>, want match for `\bGladys\b`, nil FAIL exit status 1 FAIL example.com/greetings 0.182s
在下一个(也是最后一个)主题中,您将看到如何编译和安装代码以在本地运行它.