添加测试
现在您已将代码稳定下来(顺便说一句,做得很好),请添加一个测试。在开发过程中测试您的代码可以发现您在进行更改时出现的错误。在本主题中,您将为 Hello
函数添加一个测试。
Go 内置的单元测试支持使您可以更轻松地随时进行测试。具体来说,使用命名约定、Go 的 testing
软件包和 go test
命令,您可以快速编写和执行测试。
-
在 greetings 目录中,创建一个名为 greetings_test.go 的文件。
以 _test.go 结尾的文件名告诉
go test
命令此文件包含测试函数。 -
在 greetings_test.go 中,粘贴以下代码并保存文件。
package greetings import ( "testing" "regexp" ) // TestHelloName calls greetings.Hello with a name, checking // for a valid return value. 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 calls greetings.Hello with an empty string, // checking for an error. 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
开头)在测试文件中(其名称以 _test.go 结尾)。您可以添加-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 returns a greeting for the named person. func Hello(name string) (string, error) { // If no name was given, return an error with a message. if name == "" { return name, errors.New("empty name") } // Create a message using a random format. // 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
在下一个(也是最后一个)主题中,您将看到如何编译和安装代码以在本地运行它。