山猫's Blog

Go语言快速入门：单元测试(4)

Go 共 3448 字，约 10 分钟

这篇文章主要是给go代码添加测试, go语言的单元测试是内置的。接着上篇文章，这篇文章是对我们的greetings.go文件进行测试，进入到greetings文件夹，创建greetings_test.go文件。测试文件的命名以下划线 _test这种方式结尾是golang语言中的约定语法，go自带的运行时环境会检测并发现这是一个测试文件，并且这个后缀里面的方法也有一个约定，那就是必须以Test开头，在执行测试的时候，golang的内置环境会检测并且遍历所有后缀为_test的方法，并且这种文件里面写了Test开头的方法。

1.在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)
    }
}

上面这段代码，使用了testing库里面的testing.T这个类型作为一个参数，然后使用这个类型的方法来报告和记录测试得到的数据。代码中实现了两个测试，

TestHelloName这个测试方法是传递一个name值，正常情况下是返回响应值，如果返回的响应值是空或者内部有错误出现，则testing.T的Fatalf方法将消息打印的控制台并结束执行；

TestHelloEmpty这个测试方法是用空字符串调用Hello函数，该测试主要是验证程序对于错误处理是否正常。如果返回空字符或者没有错误，则testing.T的Fatalf方法会将消息打印到控制台。

执行测试

这里执行多次，结果都是测试ok。

➜  greetings go test
PASS
ok  	example.com/greetings	0.011s
➜  greetings go test
PASS
ok  	example.com/greetings	0.008s
➜  greetings

greetings目录下面有greetings.go greetings_test.go两个文件。

在控制台执行go test的时候，命令会自动调用测试程序里面以Test开头的函数，并且是调用目录下面以_test.go结尾的文件里面的Test开头的函数。

可以加上 -v 参数，打印出来更加详细测试数据：

➜  greetings go test -v
=== RUN   TestHelloName
--- PASS: TestHelloName (0.00s)
=== RUN   TestHelloEmpty
--- PASS: TestHelloEmpty (0.00s)
PASS
ok  	example.com/greetings	0.007s

测试失败

把greetings.go中的Hello函数，修改为如下：message := fmt.Sprint(randomFormat()),只返回了问候语，但是没有返回人名，会被测试函数中的 :

want := regexp.MustCompile(`\b`+name+`\b`)

这个正则匹配的时候，发现没有name，那么测试失败。下面这个正则表达式就是false,那么测试失败。

want.MatchString(msg)

// 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
--- FAIL: TestHelloName (0.00s)
    greetings_test.go:15: Hello("Gladys") = "Hail, %!v(MISSING)! Well met!", <nil>, want match for `\bGladys\b`, nil
FAIL
exit status 1
FAIL	example.com/greetings	0.015s
➜  greetings

如果是测试失败，那么无需 -v参数，go的测试程序会告诉用户第几行的代码测试失败了，特别是在测试文件特别多的情况下，这个很管用，方便快速定位到代码所在文件所在行。函数TestHelloName虽然是测试失败了，但是TestHelloEmpty 函数的测试是正常的。

正则表达式语法

go语言的正则表达式用法和其他语言的有点类似，具体的API使用可以查看https://devbits.app/c/148/regular-expressions/go

各种fmt打印格式化

查看fmt这个包的语法。

Go apllication安装

进入到hello目录，执行go build命令，会把hello.go源文件直接编译为二进制可执行文件，但是需要进入到这个二进制文件的目录里面才能执行这个文件。如果通过安装的方式，使得每次不用指定绝对路径就可以执行我们的application呢，需要将go安装目录添加到系统的shell路径。

首先，在hello文件夹中执行如下命令，知道当前应用的安装目录，得到的这个目录在下一步骤中会使用到。

➜  hello go list -f ''
/home/caianhua/go/bin/hello


➜  ~ cd hello
➜  hello export PATH=$PATH:/home/caianhua/go/bin/

上面的代码实为了指定安装目录。

➜  hello ls
go.mod  go.sum  hello.go
➜  hello go build
➜  hello ls
go.mod  go.sum  hello  hello.go
➜  hello go install
➜  hello hello 
map[Darrin:Hi, Darrin. Welcome! Gladys:Great to see you, Gladys! Samantha:Great to see you, Samantha!]
➜  hello cd ~
➜  ~ hello
map[Darrin:Hail, Darrin! Well met! Gladys:Hi, Gladys. Welcome! Samantha:Great to see you, Samantha!]
➜  ~

如果用户不想把自己开发的application安装到那个位置，可以通过如下命令修改，假设用户先把这些自己开发的app安装在$HOME/bin 这个目录，

可以修改安装目录：

go env -w GOBIN=/home/caianhua/bin/

这样子就把hello可以执行文件安装到了 /home/caianhua/bin/ 目录

文档信息

Search

    Table of Contents