添加测试
现在您的代码已经稳定(做得很好!),请添加一个测试。在开发过程中测试代码可以暴露您在更改时引入的 bug。在本主题中,您将为 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.Errorf(`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.Errorf(`Hello("") = %q, %v, want "", error`, msg, err) } }
在此代码中,您
- 在与您要测试的代码相同的包中实现测试函数。
- 创建两个测试函数来测试
greetings.Hello
函数。测试函数名采用TestName
的形式,其中 Name 描述了具体测试的内容。此外,测试函数接受一个指向testing
包的testing.T
类型的指针作为参数。您可以使用此参数的方法从测试中报告和记录信息。 - 实现两个测试
- 在 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
函数参数指定的 name 的返回值。要查看失败的测试结果,请修改greetings.Hello
函数,使其不再包含 name。在 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
在下一个(也是最后一个)主题中,您将学习如何编译和安装代码以在本地运行它。