GoMock实践指南：通过接口模拟Go语言函数

// sample/sample.go
package sample

import (
    "fmt"
    "net/http"
    "io/ioutil" // 用于读取响应体
)

// 定义一个服务接口，它包含我们希望模拟的方法
type ExternalService interface {
    GetResponse(path, employeeID string) (string, error)
}

// RealService 是 ExternalService 接口的一个具体实现
type RealService struct{}

// GetResponse 方法实现了 ExternalService 接口
func (s *RealService) GetResponse(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()

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

// Process 函数现在接受一个 ExternalService 接口作为依赖
func Process(service ExternalService, path, employeeID string) (string, error) {
    return service.GetResponse(path, employeeID)
}

// 如果需要在应用中直接使用RealService，可以提供一个工厂函数或直接实例化
func NewRealService() *RealService {
    return &RealService{}
}

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

mockgen -source=sample/sample.go -destination=sample/mock_sample/mock_sample.go -package=mock_sample ExternalService

// sample/sample_test.go
package sample_test

import (
    "errors"
    "testing"

    "github.com/golang/mock/gomock"
    "myproject/sample" // 替换为你的项目路径
    "myproject/sample/mock_sample" // 导入生成的mock包
)

func TestProcessWithMockSuccess(t *testing.T) {
    // 1. 创建GoMock控制器
    // gomock.NewController(t) 返回一个控制器，它管理所有mock对象的生命周期和期望。
    // defer ctrl.Finish() 确保在测试结束时检查所有期望是否满足。
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()

    // 2. 创建一个MockExternalService实例
    // NewMockExternalService 是由 mockgen 工具根据 ExternalService 接口生成的函数。
    mockService := mock_sample.NewMockExternalService(ctrl)

    // 3. 设置期望行为
    // mockService.EXPECT() 返回一个 Expecter 对象，用于设置对方法调用的期望。
    // GetResponse("path", "employeeID") 指定了期望调用的方法及其参数。
    // Return("abc", nil) 定义了当方法被调用时应该返回的值。
    // Times(1) 指定期望该方法被调用一次。
    mockService.EXPECT().GetResponse("path", "employeeID").Return("abc", nil).Times(1)

    // 4. 调用被测函数
    // 将模拟服务实例传入 Process 函数，而不是真实的 RealService。
    result, err := sample.Process(mockService, "path", "employeeID")

    // 5. 断言结果
    if err != nil {
        t.Fatalf("Process returned an unexpected error: %v", err)
    }
    expected := "abc"
    if result != expected {
        t.Errorf("Expected result %q, but got %q", expected, result)
    }
}

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

    mockService := mock_sample.NewMockExternalService(ctrl)

    // 模拟 GetResponse 返回一个错误
    mockError := errors.New("network error")
    mockService.EXPECT().GetResponse("error_path", "employeeID").Return("", mockError).Times(1)

    result, err := sample.Process(mockService, "error_path", "employeeID")

    if err == nil {
        t.Fatalf("Expected an error, but got nil")
    }
    if !errors.Is(err, mockError) {
        t.Errorf("Expected error %v, but got %v", mockError, err)
    }
    if result != "" {
        t.Errorf("Expected empty result on error, but got %q", result)
    }
}

go test ./sample/...