Golang模拟HTTP服务器与消费者驱动契约测试：mockingjay

模拟HTTP服务器

在Golang中，我们可以使用标准库net/http/httptest来轻松创建模拟HTTP服务器：

package main

import (
	"fmt"
	"net/http"
	"net/http/httptest"
)

func main() {
	// 创建模拟服务器
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		switch r.URL.Path {
		case "/api/users":
			if r.Method == "GET" {
				w.Header().Set("Content-Type", "application/json")
				w.WriteHeader(http.StatusOK)
				fmt.Fprintln(w, `[{"id":1,"name":"John"},{"id":2,"name":"Jane"}]`)
			} else {
				w.WriteHeader(http.StatusMethodNotAllowed)
			}
		case "/api/orders":
			w.Header().Set("Content-Type", "application/json")
			w.WriteHeader(http.StatusOK)
			fmt.Fprintln(w, `{"orderId":"12345","status":"processing"}`)
		default:
			w.WriteHeader(http.StatusNotFound)
			fmt.Fprintln(w, `{"error":"not found"}`)
		}
	}))
	defer server.Close()

	fmt.Println("Mock server running at:", server.URL)
	
	// 这里可以添加客户端代码来测试这个模拟服务器
	// 例如使用http.Get(server.URL + "/api/users")
}

使用mockingjay进行消费者驱动契约测试

mockingjay是一个Go库，用于创建基于契约的模拟服务器。它允许你定义预期的请求和响应，并验证实际调用是否符合契约。

安装mockingjay

go get github.com/quii/mockingjay-server

基本使用示例

package main

import (
	"fmt"
	"github.com/quii/mockingjay-server/mockingjay"
	"net/http"
)

func main() {
	// 定义契约端点
	endpoints := []mockingjay.FakeEndpoint{
		{
			Name: "Get user by ID",
			CDCDisabled: false,
			Request: mockingjay.Request{
				Method: "GET",
				Path:   "/users/123",
				Headers: map[string]string{
					"Accept": "application/json",
				},
			},
			Response: mockingjay.Response{
				Code: http.StatusOK,
				Body: `{"id":123,"name":"John Doe"}`,
				Headers: map[string]string{
					"Content-Type": "application/json",
				},
			},
		},
		{
			Name: "Create user",
			CDCDisabled: false,
			Request: mockingjay.Request{
				Method: "POST",
				Path:   "/users",
				Headers: map[string]string{
					"Content-Type": "application/json",
				},
				Body: `{"name":"New User"}`,
			},
			Response: mockingjay.Response{
				Code: http.StatusCreated,
				Body: `{"id":456,"name":"New User"}`,
				Headers: map[string]string{
					"Content-Type": "application/json",
				},
			},
		},
	}

	// 创建模拟服务器
	server := mockingjay.NewServer(endpoints)
	
	fmt.Println("Mockingjay server running on", server.URL)
	
	// 保持服务器运行
	select {}
}

验证契约

mockingjay不仅可以模拟服务，还可以验证实际服务是否符合契约：

func TestRealServiceAgainstContract(t *testing.T) {
	endpoints := []mockingjay.FakeEndpoint{
		// 定义你的契约端点...
	}
	
	realServiceURL := "http://real-service:8080"
	
	// 创建验证器
	validator := mockingjay.NewValidator(endpoints, realServiceURL)
	
	// 运行验证
	results := validator.Validate()
	
	if !results.Valid() {
		t.Errorf("Real service failed contract tests: %v", results)
	}
}

高级特性

1. 匹配器：可以使用正则表达式或自定义匹配器来匹配请求

   Request: mockingjay.Request{
       Method: "GET",
       Path:   "/users/[0-9]+",
       Headers: map[string]string{
           "Accept": "application/json",
       },
   },
   

2. 延迟响应：模拟网络延迟

   Response: mockingjay.Response{
       Code:    http.StatusOK,
       Body:    `{"status":"ok"}`,
       Delay:   200 * time.Millisecond, // 200ms延迟
   },
   

3. 动态响应：基于请求生成响应

   Response: mockingjay.Response{
       Code: http.StatusOK,
       BodyFunc: func(r *http.Request) string {
           return fmt.Sprintf(`{"requestedPath":"%s"}`, r.URL.Path)
       },
   },
   

实际应用建议

1. 在CI/CD管道中：将契约测试作为持续集成的一部分
2. 微服务开发：在服务消费者和提供者之间建立明确的契约
3. 前端开发：在后端API完成前，使用模拟服务器进行前端开发
4. 测试隔离：在单元测试中隔离外部依赖

通过使用这些技术，你可以创建更可靠、更可维护的API服务，并确保服务提供者和消费者之间的契约得到遵守。