Golang HTTP响应模拟测试插件库mockhttp使用指南

mockhttp是一个用于Go语言HTTP测试的模拟响应库，它可以帮助开发者在不依赖真实HTTP服务的情况下进行测试。下面我将详细介绍mockhttp的使用方法。

安装mockhttp

首先安装mockhttp库：

go get github.com/yourusername/mockhttp

基本使用方法

1. 创建模拟服务器

package main

import (
	"fmt"
	"net/http"
	"github.com/yourusername/mockhttp"
)

func main() {
	// 创建模拟服务器
	mockServer := mockhttp.NewServer()
	defer mockServer.Close()

	// 设置模拟响应
	mockServer.When("GET", "/users").
		RespondWith(http.StatusOK, `{"id": 123, "name": "John Doe"}`).
		SetHeader("Content-Type", "application/json")

	// 使用模拟服务器的URL进行测试
	resp, err := http.Get(mockServer.URL + "/users")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	defer resp.Body.Close()

	// 处理响应...
}

2. 验证请求

func TestUserAPI(t *testing.T) {
	mockServer := mockhttp.NewServer()
	defer mockServer.Close()

	// 设置期望的请求和响应
	mockServer.When("POST", "/users").
		WithBody(`{"name":"Alice"}`).
		RespondWith(http.StatusCreated, `{"id":456,"name":"Alice"}`)

	// 发送请求
	reqBody := strings.NewReader(`{"name":"Alice"}`)
	resp, err := http.Post(mockServer.URL+"/users", "application/json", reqBody)
	if err != nil {
		t.Fatal(err)
	}
	defer resp.Body.Close()

	// 验证请求是否被正确接收
	if !mockServer.Received("POST", "/users") {
		t.Error("Expected POST /users request was not received")
	}
}

3. 动态响应

func TestDynamicResponse(t *testing.T) {
	mockServer := mockhttp.NewServer()
	defer mockServer.Close()

	// 使用回调函数生成动态响应
	mockServer.When("GET", "/dynamic").
		RespondWithFunc(func(r *http.Request) (int, string) {
			name := r.URL.Query().Get("name")
			return http.StatusOK, fmt.Sprintf(`{"greeting":"Hello, %s!"}`, name)
		})

	// 测试动态响应
	resp, err := http.Get(mockServer.URL + "/dynamic?name=Bob")
	if err != nil {
		t.Fatal(err)
	}
	defer resp.Body.Close()

	// 验证响应内容...
}

高级功能

1. 延迟响应

mockServer.When("GET", "/slow").
	RespondWith(http.StatusOK, `{"status":"ok"}`).
	WithDelay(2 * time.Second) // 延迟2秒响应

2. 顺序响应

mockServer.When("GET", "/sequence").
	RespondInOrder(
		mockhttp.NewResponse(http.StatusOK, `{"step":1}`),
		mockhttp.NewResponse(http.StatusOK, `{"step":2}`),
		mockhttp.NewResponse(http.StatusOK, `{"step":3}`),
	)

3. 错误模拟

// 模拟连接错误
mockServer.When("GET", "/error").
	RespondWithError("connection refused")

// 模拟超时
mockServer.When("GET", "/timeout").
	RespondWithTimeout(5 * time.Second)

完整测试示例

package main_test

import (
	"encoding/json"
	"net/http"
	"testing"
	"github.com/yourusername/mockhttp"
)

func TestUserAPI(t *testing.T) {
	// 1. 创建模拟服务器
	mockServer := mockhttp.NewServer()
	defer mockServer.Close()

	// 2. 设置模拟响应
	mockServer.When("GET", "/users/123").
		RespondWith(http.StatusOK, `{
			"id": 123,
			"name": "John Doe",
			"email": "john@example.com"
		}`).
		SetHeader("Content-Type", "application/json")

	// 3. 测试客户端代码
	client := &http.Client{}
	req, err := http.NewRequest("GET", mockServer.URL+"/users/123", nil)
	if err != nil {
		t.Fatal(err)
	}

	resp, err := client.Do(req)
	if err != nil {
		t.Fatal(err)
	}
	defer resp.Body.Close()

	// 4. 验证响应
	if resp.StatusCode != http.StatusOK {
		t.Errorf("Expected status 200, got %d", resp.StatusCode)
	}

	var user struct {
		ID    int    `json:"id"`
		Name  string `json:"name"`
		Email string `json:"email"`
	}
	if err := json.NewDecoder(resp.Body).Decode(&user); err != nil {
		t.Fatal(err)
	}

	if user.Name != "John Doe" {
		t.Errorf("Expected name 'John Doe', got '%s'", user.Name)
	}

	// 5. 验证请求是否被接收
	if !mockServer.Received("GET", "/users/123") {
		t.Error("Expected GET /users/123 request was not received")
	}
}

总结

mockhttp库提供了以下主要功能：

1. 简单易用的API设置模拟响应
2. 请求验证功能
3. 动态响应生成
4. 延迟响应和错误模拟
5. 顺序响应支持

使用mockhttp可以大大提高HTTP相关代码的测试效率和可靠性，避免了依赖真实网络服务带来的不稳定性和复杂性。