如何使用 GoMock 高效模拟 Go 语言中的接口行为

// myproject/sample/data_fetcher.go
package sample

import (
    "fmt"
    "net/http" // 假设实际实现会用到
    "io/ioutil" // 假设实际实现会用到
)

// DataFetcher 接口定义了从外部获取数据的方法
type DataFetcher interface {
    FetchResponse(path, employeeID string) (string, error)
}

// RealDataFetcher 是 DataFetcher 接口的一个具体实现，模拟真实的网络请求
type RealDataFetcher struct{}

func (r *RealDataFetcher) FetchResponse(path, employeeID string) (string, error) {
    url := fmt.Sprintf("http://example.com/%s/%s", path, employeeID)
    // 实际的网络请求逻辑
    resp, err := http.Get(url)
    if err != nil {
        return "", fmt.Errorf("failed to make HTTP request: %w", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        return "", fmt.Errorf("unexpected status code: %d", resp.StatusCode)
    }

    bodyBytes, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        return "", fmt.Errorf("failed to read response body: %w", err)
    }
    return string(bodyBytes), nil
}

// Process 函数现在依赖于 DataFetcher 接口
// 而不是直接调用具体的 GetResponse 函数
func Process(fetcher DataFetcher, path, employeeID string) (string, error) {
    return fetcher.FetchResponse(path, employeeID)
}

go install github.com/golang/mock/mockgen@latest

myproject/
├── go.mod
├── go.sum
└── sample/
    └── data_fetcher.go

mockgen -source=./sample/data_fetcher.go -destination=./mock_sample/mock_datafetcher.go -package=mock_sample DataFetcher

// myproject/sample/data_fetcher_test.go
package sample_test

import (
    "errors"
    "testing"

    "github.com/golang/mock/gomock"
    "myproject/mock_sample" // 导入生成的 mock 包
    "myproject/sample"     // 导入被测包
)

func TestProcessWithMock(t *testing.T) {
    ctrl := gomock.NewController(t)
    defer ctrl.Finish() // 确保在测试结束时调用 Finish，以验证所有预期都被满足

    // 1. 实例化生成的 mock 对象
    // NewMockDataFetcher 是由 mockgen 生成的构造函数
    mockFetcher := mock_sample.NewMockDataFetcher(ctrl)

    // 2. 设置预期行为 (Expectation)
    // 当 mockFetcher 的 FetchResponse 方法被调用时，我们期望它接收 "path" 和 "employeeID"
    // 并返回 "mocked_abc" 和 nil 错误。
    mockFetcher.EXPECT().FetchResponse("path", "employeeID").Return("mocked_abc", nil).Times(1)

    // 3. 调用被测函数，传入 mock 对象
    // Process 函数现在接受一个 DataFetcher 接口
    v, err := sample.Process(mockFetcher, "path", "employeeID")

    // 4. 断言结果
    if err != nil {
        t.Errorf("Expected no error, got %v", err)
    }
    if v != "mocked_abc" {
        t.Errorf("Expected 'mocked_abc', got '%s'", v)
    }
}

func TestProcessWithErrorFromFetcher(t *testing.T) {
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()

    mockFetcher := mock_sample.NewMockDataFetcher(ctrl)
    expectedErr := errors.New("network error")

    // 模拟 FetchResponse 返回一个错误
    mockFetcher.EXPECT().FetchResponse("path", "employeeID").Return("", expectedErr).Times(1)

    v, err := sample.Process(mockFetcher, "path", "employeeID")

    if err == nil {
        t.Errorf("Expected an error, got nil")
    }
    if !errors.Is(err, expectedErr) {
        t.Errorf("Expected error '%v', got '%v'", expectedErr, err)
    }
    if v != "" {
        t.Errorf("Expected empty string, got '%s'", v)
    }
}

// 示例：如何测试 RealDataFetcher (这通常是集成测试或端到端测试的一部分)
// 这里的测试会发起实际的网络请求，所以它不是严格意义上的单元测试
func TestRealProcess(t *testing.T) {
    // 注意：这里我们使用真实的 RealDataFetcher，所以会产生实际的网络请求
    realFetcher := &sample.RealDataFetcher{}
    // 假设 example.com 返回 "Hello, World!"
    v, err := sample.Process(realFetcher, "test", "user123")
    if err != nil {
        t.Logf("Warning: Real network call failed: %v. This might be expected in some environments.", err)
        // t.Fatal(err) // 如果你期望网络请求总是成功，可以使用 Fatal
    }
    // 这里可以根据 example.com 实际返回的内容进行断言
    // 例如：if !strings.Contains(v, "Example Domain") { t.Errorf("Unexpected real data: %s", v) }
    t.Logf("Real data fetched (might be empty if example.com is down or blocked): %s", v)
}

go test ./sample/...