consul golang_Golang 单元测试实践

每个严谨的项目都应该有单元测试，发现程序中的问题，保障程序现在和未来的正确性。我们新加入一个项目时，常被要求给现有代码加一些单元测试；自己的代码写到一定程度后，也希望加一些单元测试看看有没有问题。这时往往发现没法在不改动现有代码的情况下添加单元测试，这就引出一个很尴尬的问题~~ 不是所有代码都可以方便测试的~~

比如这个例子：

func AddPerson(name string) error {
    
    db, _ := sqlx.Open("mysql", "...dsn...")
    _, err := db.Exec("INSERT INTO person (name) VALUES (?)", name)
    return err
}

在函数中写死了 MySQL 的连接方式，硬要写单元测试的话，会污染生产环境的数据库。

还有其它一些情况，比如从很多外部依赖获取数据并处理，输入和结果过于复杂。

一般来说，没法测试的代码都是不太好的代码，它们往往没有合理组织，不灵活，甚至错误百出。直接说明怎样的代码可方便测试有点难，但我们可以通过看看各种情况下怎样合理地测试，反推怎样写出方便测试的代码。

本文主要说明 Golang 单元测试用到的工具以及一些方法，包括：

• 使用 Table Driven 的方式写测试代码
• 使用 testify/assert 简化条件判断
• 使用 testify/mock 隔离第三方依赖或者复杂调用
• mock http request
• stub redis
• stub MySQL

使用 Table Driven 的方式写测试代码

测试一个 routine 分几个步骤：准备数据，调用 routine，判断返回。还要测试不同的情况。如果每种情况都手工写一次代码的话，会很繁琐，使用 Table Driven 的方式能让测试代码看起来简洁易懂不少。

比如要测试一个取模运算的 routine：

func Mod(a, b int) (r int, err error) {
    
    if b == 0 {
    
        return 0, fmt.Errorf("mod by zero")
    }
    return a%b, nil
}

可以这样测试：

func TestMod(t *testing.T) {
    
    tests := []struct {
    
        a int
        b int
        r int
        hasErr bool
    }{
    
        {
    a: 42, b: 9, r: 6, hasErr: false},
        {
    a: -1, b: 9, r: 8, hasErr: false},
        {
    a: -1, b: -9, r: -1, hasErr: false},
        {
    a: 42, b: 0, r: 0, hasErr: true},
    }

    for row, test := range tests {
    
        r, err := Mod(test.a, test.b)
        if test.hasError {
    
            if err == nil {
    
                t.Errorf("should have error, row: %d", row)
            }
            continue
        }
        if err != nil {
    
            t.Errorf("should not have error, row: %d", row)
        }
        if r != test.r {
    
            t.Errorf("r is expected to be %d but now %d, row: %d", test.r, r, row)
        }
    }
}

以后有新的边缘情况，也可以很方便地添加到测试用例。

使用 testify/assert 简化条件判断

上面例子中很多 if