使用Keploy自动生成Golang API测试用例和数据模拟

Keploy是一个开源的Golang库，能够自动从API调用中生成测试用例和模拟数据，极大简化了API测试工作。下面我将详细介绍如何使用Keploy。

Keploy核心功能

1. 自动记录API调用：捕获生产或开发环境中的真实API请求/响应
2. 生成测试用例：将记录的交互转换为可执行的测试用例
3. 数据模拟：基于真实数据生成模拟数据
4. 无代码测试：无需手动编写大量测试代码

安装Keploy

go get -u github.com/keploy/go-sdk

基本使用示例

1. 初始化Keploy

package main

import (
	"github.com/keploy/go-sdk/keploy"
	"net/http"
)

func main() {
	// 初始化Keploy
	k := keploy.New(keploy.Config{
		App: keploy.AppConfig{
			Name: "my-api-service",
			Port: "8080",
		},
		Server: keploy.ServerConfig{
			URL: "http://localhost:6789", // Keploy服务器地址
		},
	})
	
	// 你的HTTP处理器
	http.HandleFunc("/api/user", func(w http.ResponseWriter, r *http.Request) {
		// 你的业务逻辑
	})
	
	// 用Keploy包装HTTP服务器
	http.ListenAndServe(":8080", k.HttpHandler(http.DefaultServeMux))
}

2. 记录测试用例

运行你的服务并发送API请求，Keploy会自动记录这些交互：

curl -X GET http://localhost:8080/api/user?id=123

Keploy会在keploy/test-<timestamp>目录下生成测试用例。

3. 回放测试用例

package main

import (
	"github.com/keploy/go-sdk/keploy"
	"testing"
)

func TestAPI(t *testing.T) {
	// 初始化Keploy测试
	kc := keploy.NewTest(keploy.TestConfig{
		App: keploy.AppConfig{
			Name: "my-api-service",
			Port: "8080",
		},
		Mocks: keploy.MockConfig{
			Path: "./keploy/mocks", // 模拟数据路径
		},
	})
	
	// 运行记录的测试用例
	kc.Run(t, func() {
		// 这里可以添加自定义测试逻辑
		// 或者让Keploy自动运行记录的测试
	})
}

高级功能

1. 自定义测试验证

func TestAPIWithValidation(t *testing.T) {
	kc := keploy.NewTest(keploy.TestConfig{
		App: keploy.AppConfig{
			Name: "my-api-service",
		},
	})
	
	kc.Run(t, func() {
		// 自定义HTTP客户端
		client := &http.Client{}
		req, _ := http.NewRequest("GET", "http://localhost:8080/api/user?id=123", nil)
		
		resp, err := client.Do(req)
		if err != nil {
			t.Fatalf("请求失败: %v", err)
		}
		
		// 自定义验证
		if resp.StatusCode != 200 {
			t.Errorf("期望状态码200, 得到 %d", resp.StatusCode)
		}
		
		// 也可以让Keploy自动验证记录的响应
		kc.Assert(resp)
	})
}

2. 模拟外部依赖

Keploy可以记录和模拟外部服务调用：

func TestWithExternalService(t *testing.T) {
	kc := keploy.NewTest(keploy.TestConfig{
		App: keploy.AppConfig{
			Name: "my-api-service",
		},
		Mocks: keploy.MockConfig{
			Path: "./keploy/mocks",
		},
	})
	
	// 模拟HTTP客户端
	mockClient := kc.HTTPClient()
	
	// 这个请求会被Keploy拦截并使用模拟数据
	resp, err := mockClient.Get("http://external-service.com/api/data")
	if err != nil {
		t.Fatal(err)
	}
	
	// 使用模拟数据进行测试
	// ...
}

最佳实践

1. 环境分离：为不同环境(dev/staging/prod)使用不同的Keploy配置
2. 定期更新测试：随着API变化更新记录的测试用例
3. 结合传统测试：将Keploy生成的测试与传统单元测试结合使用
4. 版本控制：将生成的测试用例纳入版本控制

注意事项

1. 敏感数据会被记录，生产环境使用时要注意数据脱敏
2. 复杂的业务逻辑可能需要补充手动测试用例
3. 测试用例依赖于网络交互顺序，有时需要手动调整

Keploy通过自动化API测试的创建和维护，可以显著提高开发效率，特别是在微服务架构中。它减少了手动编写和维护测试用例的工作量，同时确保了测试基于真实的用户行为。