示例测试

源代码目录结构

我们在gotest包中创建两个文件，目录结构如下所示：

[GoExpert]
|--[src]
   |--[gotest]
      |--example.go
      |--example_test.go

其中example.go为源代码文件，example_test.go为测试文件。

源代码文件

源代码文件example.go中包含SayHello()、SayGoodbye()和PrintNames()三个方法，如下所示：

package gotest

import "fmt"

// SayHello 打印一行字符串
func SayHello() {
    fmt.Println("Hello World")
}

// SayGoodbye 打印两行字符串
func SayGoodbye() {
    fmt.Println("Hello,")
    fmt.Println("goodbye")
}

// PrintNames 打印学生姓名
func PrintNames() {
    students := make(map[int]string, 4)
    students[1] = "Jim"
    students[2] = "Bob"
    students[3] = "Tom"
    students[4] = "Sue"
    for _, value := range students {
        fmt.Println(value)
    }
}

这几个方法打印内容略有不同，分别代表一种典型的场景：

• SayHello()：只有一行打印输出
• SayGoodbye()：有两行打印输出
• PrintNames()：有多行打印输出，且由于Map数据结构的原因，多行打印次序是随机的。

测试文件

测试文件example_test.go中包含3个测试方法，于源代码文件中的3个方法一一对应，测试文件如下所示：

package gotest_test

import "gotest"

// 检测单行输出
func ExampleSayHello() {
    gotest.SayHello()
    // OutPut: Hello World
}

// 检测多行输出
func ExampleSayGoodbye() {
    gotest.SayGoodbye()
    // OutPut:
    // Hello,
    // goodbye
}

// 检测乱序输出
func ExamplePrintNames() {
    gotest.PrintNames()
    // Unordered output:
    // Jim
    // Bob
    // Tom
    // Sue
}

例子测试函数命名规则为”ExampleXxx”，其中”Xxx”为自定义的标识，通常为待测函数名称。

这三个测试函数分别代表三种场景：

• ExampleSayHello()： 待测试函数只有一行输出，使用”// OutPut: “检测。
• ExampleSayGoodbye()：待测试函数有多行输出，使用”// OutPut: “检测，其中期望值也是多行。
• ExamplePrintNames()：待测试函数有多行输出，但输出次序不确定，使用”// Unordered output:”检测。

注：字符串比较时会忽略前后的空白字符。

执行测试

命令行下，使用go test或go test example_test.go命令即可启动测试，如下所示：

E:\OpenSource\GitHub\RainbowMango\GoExpertProgrammingSourceCode\GoExpert\src\gotest>go test example_test.go
ok      command-line-arguments  0.331s

总结

1. 例子测试函数名需要以”Example”开头；
2. 检测单行输出格式为“// Output: <期望字符串>”；
3. 检测多行输出格式为“// Output: \ <期望字符串> \ <期望字符串>”，每个期望字符串占一行；
4. 检测无序输出格式为”// Unordered output: \ <期望字符串> \ <期望字符串>”，每个期望字符串占一行；
5. 测试字符串时会自动忽略字符串前后的空白字符；
6. 如果测试函数中没有“Output”标识，则该测试函数不会被执行；
7. 执行测试可以使用go test，此时该目录下的其他测试文件也会一并执行；
8. 执行测试可以使用go test <xxx_test.go>，此时仅执行特定文件中的测试函数；