使用go-vcr实现HTTP交互录制与回放测试

go-vcr是一个优秀的Golang测试库，它可以记录和回放HTTP交互，非常适合用于测试需要与外部API交互的代码。下面我将详细介绍go-vcr的使用方法和示例。

go-vcr的核心概念

go-vcr通过拦截HTTP请求，将第一次请求的真实响应记录下来，后续测试中直接使用记录的响应，从而实现：

1. 测试不依赖网络连接
2. 测试运行速度更快
3. 测试结果可重现
4. 避免向真实API发送过多请求

安装go-vcr

go get github.com/dnaeon/go-vcr/v3/recorder

基本使用示例

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"

	"github.com/dnaeon/go-vcr/v3/recorder"
)

func main() {
	// 启动一个记录器，模式为录制模式
	r, err := recorder.New("fixtures/example")
	if err != nil {
		panic(err)
	}
	defer r.Stop() // 确保记录器停止并保存数据

	// 创建一个使用记录器作为传输的HTTP客户端
	client := &http.Client{
		Transport: r, // 注入我们的记录器
	}

	// 发出HTTP请求
	resp, err := client.Get("https://httpbin.org/get")
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	// 读取响应体
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}

	fmt.Println(string(body))
}

测试中使用go-vcr

下面是一个完整的测试示例：

package main

import (
	"net/http"
	"testing"

	"github.com/dnaeon/go-vcr/v3/recorder"
	"github.com/stretchr/testify/assert"
)

func TestHTTPClient(t *testing.T) {
	// 启动记录器，模式为录制模式
	// 第一次运行会创建fixture文件，之后运行会使用它
	r, err := recorder.New("fixtures/httpbin")
	if err != nil {
		t.Fatal(err)
	}
	defer r.Stop()

	// 创建使用记录器的HTTP客户端
	client := &http.Client{
		Transport: r,
	}

	// 执行请求
	resp, err := client.Get("https://httpbin.org/get")
	if err != nil {
		t.Fatalf("Failed to make request: %v", err)
	}
	defer resp.Body.Close()

	// 验证响应
	assert.Equal(t, http.StatusOK, resp.StatusCode)
	assert.Equal(t, "application/json", resp.Header.Get("Content-Type"))
}

记录器模式

go-vcr有几种工作模式：

// 模式设置示例
r, err := recorder.New("fixtures/example")
if err != nil {
    panic(err)
}

// 设置模式
r.SetMode(recorder.ModeRecordOnce) // 只录制一次，之后回放
// r.SetMode(recorder.ModeReplayOnly) // 只回放，不录制
// r.SetMode(recorder.ModePassthrough) // 直接传递请求，不录制
// r.SetMode(recorder.ModeDisabled) // 完全禁用

高级功能

1. 过滤敏感信息

r, err := recorder.New("fixtures/example")
if err != nil {
    panic(err)
}

// 添加过滤器来移除敏感信息
r.AddFilter(func(i *cassette.Interaction) error {
    delete(i.Request.Headers, "Authorization")
    return nil
})

2. 自定义匹配器

默认情况下，go-vcr根据方法、URL和正文匹配请求。你可以自定义匹配逻辑：

r, err := recorder.New("fixtures/example")
if err != nil {
    panic(err)
}

// 添加自定义匹配器
r.AddMatcher(func(r *http.Request, i cassette.Request) bool {
    return r.URL.Path == i.URL
})

3. 禁用压缩

有些API返回压缩的响应，你可能想禁用压缩以便更容易检查fixture文件：

r, err := recorder.New("fixtures/example")
if err != nil {
    panic(err)
}

r.DisableCompression = true

实际测试示例

func TestGitHubAPI(t *testing.T) {
    // 设置记录器
    r, err := recorder.New("fixtures/github")
    if err != nil {
        t.Fatal(err)
    }
    defer r.Stop()
    
    // 设置模式为录制一次
    r.SetMode(recorder.ModeRecordOnce)
    
    // 创建客户端
    client := github.NewClient(&http.Client{Transport: r})
    
    // 调用API
    repos, _, err := client.Repositories.List(context.Background(), "octocat", nil)
    if err != nil {
        t.Fatalf("Failed to get repositories: %v", err)
    }
    
    // 验证结果
    if len(repos) == 0 {
        t.Error("Expected some repositories, got none")
    }
}

最佳实践

1. 将fixture文件(.yml)加入版本控制
2. 为不同的测试用例使用不同的fixture文件
3. 定期更新fixture文件以确保它们不过时
4. 在CI环境中使用ModeReplayOnly模式
5. 过滤掉敏感信息如API密钥、认证令牌等

go-vcr是一个强大的工具，可以显著提高依赖外部HTTP服务的测试的可靠性和速度。通过合理使用，你可以创建既快速又可靠的测试套件。