Testify - Go测试增强库

Testify 是一个流行的 Go 测试增强库，它扩展了标准库 testing 的功能，提供了更强大的断言、mock 功能和测试套件支持。下面我将详细介绍 Testify 的主要组件和使用方法。

1. 安装 Testify

go get github.com/stretchr/testify

2. 主要组件

2.1 assert 包 - 强大的断言

assert 包提供了丰富的断言方法，比标准库的 t.Fail 和 t.Error 更易用。

import (
    "testing"
    "github.com/stretchr/testify/assert"
)

func TestAdd(t *testing.T) {
    result := Add(1, 2)
    
    // 基本断言
    assert.Equal(t, 3, result, "they should be equal")
    assert.NotEqual(t, 4, result, "they should not be equal")
    assert.Nil(t, err)
    assert.NotNil(t, obj)
    
    // 布尔断言
    assert.True(t, isValid)
    assert.False(t, hasError)
    
    // 集合断言
    assert.Contains(t, "Hello World", "World")
    assert.Len(t, slice, 3)
    assert.ElementsMatch(t, []int{1,2,3}, []int{3,2,1})
    
    // 错误处理
    assert.NoError(t, err)
    assert.Error(t, err)
    assert.ErrorIs(t, err, io.EOF)
}

2.2 require 包 - 致命断言

require 包与 assert 类似，但在断言失败时会立即终止测试（调用 t.FailNow()）。

import (
    "testing"
    "github.com/stretchr/testify/require"
)

func TestDivide(t *testing.T) {
    result, err := Divide(10, 2)
    require.NoError(t, err)  // 如果出错，立即终止测试
    require.Equal(t, 5, result)
}

2.3 suite 包 - 测试套件

suite 包提供了类似 xUnit 风格的测试套件功能，可以共享 setup 和 teardown 逻辑。

import (
    "testing"
    "github.com/stretchr/testify/suite"
)

type ExampleTestSuite struct {
    suite.Suite
    Value int
}

// 在每个测试前运行
func (suite *ExampleTestSuite) SetupTest() {
    suite.Value = 5
}

// 测试示例
func (suite *ExampleTestSuite) TestExample() {
    suite.Equal(5, suite.Value)
}

// 让go test运行这个测试套件
func TestExampleTestSuite(t *testing.T) {
    suite.Run(t, new(ExampleTestSuite))
}

2.4 mock 包 - 模拟对象

mock 包提供了创建模拟对象的能力，非常适合单元测试。

import (
    "testing"
    "github.com/stretchr/testify/mock"
)

// 定义模拟对象
type MyMockedObject struct {
    mock.Mock
}

// 模拟方法
func (m *MyMockedObject) DoSomething(number int) (bool, error) {
    args := m.Called(number)
    return args.Bool(0), args.Error(1)
}

func TestSomething(t *testing.T) {
    // 创建模拟对象
    testObj := new(MyMockedObject)
    
    // 设置期望
    testObj.On("DoSomething", 123).Return(true, nil)
    
    // 调用被测代码
    result, err := testObj.DoSomething(123)
    
    // 断言
    assert.True(t, result)
    assert.Nil(t, err)
    
    // 验证期望是否满足
    testObj.AssertExpectations(t)
}

3. 高级用法

3.1 自定义断言消息

func TestCustomMessage(t *testing.T) {
    assert.Equal(t, 2, 1+1, "Math is broken!")
}

3.2 使用 assert.New 创建断言实例

func TestWithAssertInstance(t *testing.T) {
    assert := assert.New(t)
    
    // 现在可以省略第一个参数
    assert.Equal(3, Add(1, 2))
    assert.NotEqual(4, Add(1, 2))
}

3.3 HTTP 测试

func TestHTTPHandler(t *testing.T) {
    req := httptest.NewRequest("GET", "/hello", nil)
    w := httptest.NewRecorder()
    
    HelloHandler(w, req)
    
    resp := w.Result()
    assert.Equal(t, http.StatusOK, resp.StatusCode)
    
    body, _ := io.ReadAll(resp.Body)
    assert.Equal(t, "Hello, World!", string(body))
}

4. 最佳实践

1. 对于需要继续执行的检查使用 assert，对于必须成功的检查使用 require
2. 使用测试套件组织相关测试，共享 setup/teardown 逻辑
3. 为 mock 对象设置清晰的期望，并验证它们是否被满足
4. 保持断言消息简洁但信息丰富
5. 考虑使用 assert.New(t) 简化大量断言的测试代码

Testify 通过提供这些强大的工具，使得 Go 的单元测试更加简洁、可读和强大。它已经成为 Go 生态系统中最受欢迎的测试辅助库之一。