Chapar - Go语言HTTP/gRPC API测试工具库

Chapar是一个用于Go语言的HTTP和gRPC API测试工具库，它提供了简洁的API来构建和发送HTTP/gRPC请求，并验证响应结果。

安装

go get github.com/reddec/chapar

基本使用

HTTP测试示例

package main

import (
	"context"
	"fmt"
	"net/http"
	"testing"
	"time"

	"github.com/reddec/chapar"
	"github.com/reddec/chapar/expect"
)

func TestHTTPAPI(t *testing.T) {
	// 创建Chapar实例
	client := chapar.New()

	// 构建HTTP请求
	req := chapar.Request{
		Method: http.MethodGet,
		URL:    "https://jsonplaceholder.typicode.com/posts/1",
		Headers: map[string]string{
			"Accept": "application/json",
		},
		Timeout: 5 * time.Second,
	}

	// 发送请求并验证响应
	resp, err := client.Do(context.Background(), req,
		expect.StatusCode(http.StatusOK),
		expect.JSONPathEqual("$.userId", float64(1)), // JSONPath匹配
		expect.HeaderExists("Content-Type"),
	)

	if err != nil {
		t.Fatalf("Request failed: %v", err)
	}

	fmt.Printf("Response: %+v\n", resp)
}

gRPC测试示例

package main

import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/reddec/chapar"
	"github.com/reddec/chapar/expect"
	"google.golang.org/grpc"
	"google.golang.org/grpc/examples/helloworld/helloworld"
)

func TestGRPCAPI(t *testing.T) {
	// 创建Chapar实例
	client := chapar.New()

	// 构建gRPC请求
	req := chapar.GRPCRequest{
		Address: "localhost:50051",
		Service: "helloworld.Greeter",
		Method:  "SayHello",
		Payload: map[string]interface{}{
			"name": "World",
		},
		Timeout: 5 * time.Second,
		Options: []grpc.DialOption{grpc.WithInsecure()},
	}

	// 发送请求并验证响应
	resp, err := client.Call(context.Background(), req,
		expect.GRPCPayloadFieldEqual("message", "Hello World"),
	)

	if err != nil {
		t.Fatalf("gRPC call failed: %v", err)
	}

	fmt.Printf("gRPC Response: %+v\n", resp)
}

高级特性

自定义验证器

// 自定义响应验证器
func expectCustomValidator(expected string) chapar.Validator {
	return func(resp *chapar.Response) error {
		if resp.BodyString() != expected {
			return fmt.Errorf("expected body %q, got %q", expected, resp.BodyString())
		}
		return nil
	}
}

func TestCustomValidator(t *testing.T) {
	client := chapar.New()
	
	req := chapar.Request{
		Method: http.MethodGet,
		URL:    "http://example.com",
	}

	_, err := client.Do(context.Background(), req, expectCustomValidator("expected content"))
	if err != nil {
		t.Fatal(err)
	}
}

请求管道

func TestRequestPipeline(t *testing.T) {
	client := chapar.New()

	// 第一个请求获取token
	loginResp, err := client.Do(context.Background(), chapar.Request{
		Method: http.MethodPost,
		URL:    "https://api.example.com/login",
		Body:   []byte(`{"username":"test","password":"test"}`),
		Headers: map[string]string{
			"Content-Type": "application/json",
		},
	}, expect.StatusCode(http.StatusOK))

	if err != nil {
		t.Fatal(err)
	}

	// 从登录响应中提取token
	token := loginResp.JSON().Get("token").String()

	// 使用token进行授权请求
	_, err = client.Do(context.Background(), chapar.Request{
		Method: http.MethodGet,
		URL:    "https://api.example.com/protected",
		Headers: map[string]string{
			"Authorization": "Bearer " + token,
		},
	}, expect.StatusCode(http.StatusOK))

	if err != nil {
		t.Fatal(err)
	}
}

内置验证器

Chapar提供了一些内置的验证器：

• expect.StatusCode(code int) - 验证HTTP状态码
• expect.HeaderExists(key string) - 验证头是否存在
• expect.HeaderEqual(key, value string) - 验证头值
• expect.JSONPathEqual(path string, expected interface{}) - 验证JSON路径值
• expect.BodyEqual(expected string) - 验证响应体
• expect.GRPCPayloadFieldEqual(field string, expected interface{}) - 验证gRPC响应字段

总结

Chapar是一个功能强大且灵活的Go语言API测试库，支持HTTP和gRPC协议。它的主要特点包括：

1. 简洁的API设计
2. 内置常用验证器
3. 支持自定义验证逻辑
4. 支持请求管道和依赖关系
5. 同时支持HTTP和gRPC测试

通过使用Chapar，开发者可以更轻松地编写API测试代码，提高测试覆盖率和代码质量。