Golang中如何进行Mock测试

在Go中进行Mock测试的关键是使用接口进行依赖注入。你遇到的问题是因为github.Client的结构比较复杂，直接为其定义接口比较困难。更好的做法是为你自己的业务逻辑定义接口。

解决方案

1. 定义业务接口

首先，为你的仓库操作定义一个接口：

// repository.go
package main

import (
    "context"
    "github.com/google/go-github/v30/github"
)

// RepositoryService 定义你需要的仓库操作接口
type RepositoryService interface {
    Get(ctx context.Context, owner, repo string) (*github.Repository, *github.Response, error)
}

// RepositoryGetter 包装github.Client的Repositories服务
type RepositoryGetter struct {
    Repositories RepositoryService
}

// GetRepo 使用接口获取仓库
func (rg *RepositoryGetter) GetRepo(ctx context.Context, owner, repo string) (*github.Repository, error) {
    repository, _, err := rg.Repositories.Get(ctx, owner, repo)
    return repository, err
}

2. 修改业务函数使用接口

// main.go
package main

import (
    "context"
    "fmt"
    "github.com/google/go-github/v30/github"
    "golang.org/x/oauth2"
    "log"
    "os"
)

func main() {
    client := NewGithubClient()
    // 创建RepositoryGetter，注入真实的github.Client
    getter := &RepositoryGetter{
        Repositories: client.Repositories,
    }
    
    repo, err := GetUserRepo(getter, "drpaneas")
    if err != nil {
        fmt.Println("错误")
        log.Fatal(err)
    }
    fmt.Println(repo.GetDescription())
}

func NewGithubClient() *github.Client {
    token := oauth2.Token{
        AccessToken: os.Getenv("GHTOKEN"),
    }
    tokenSource := oauth2.StaticTokenSource(&token)
    tc := oauth2.NewClient(context.Background(), tokenSource)
    return github.NewClient(tc)
}

// GetUserRepo 现在接受RepositoryGetter接口
func GetUserRepo(getter *RepositoryGetter, user string) (*github.Repository, error) {
    return getter.GetRepo(context.Background(), user, "ghostfish")
}

3. 创建Mock实现

// mock_repository.go
package main

import (
    "context"
    "github.com/google/go-github/v30/github"
)

// MockRepositoryService 模拟的RepositoryService实现
type MockRepositoryService struct {
    GetFunc func(ctx context.Context, owner, repo string) (*github.Repository, *github.Response, error)
}

// Get 实现RepositoryService接口
func (m *MockRepositoryService) Get(ctx context.Context, owner, repo string) (*github.Repository, *github.Response, error) {
    if m.GetFunc != nil {
        return m.GetFunc(ctx, owner, repo)
    }
    // 默认返回一个模拟的仓库
    return &github.Repository{
        Description: github.String("用Go编写的TCP扫描器"),
    }, &github.Response{}, nil
}

4. 编写测试

// main_test.go
package main

import (
    "context"
    "github.com/google/go-github/v30/github"
    "testing"
)

func TestGetUserRepo(t *testing.T) {
    // 创建Mock
    mockRepoService := &MockRepositoryService{
        GetFunc: func(ctx context.Context, owner, repo string) (*github.Repository, *github.Response, error) {
            // 验证参数
            if owner != "drpaneas" {
                t.Errorf("期望owner为'drpaneas', 得到 %s", owner)
            }
            if repo != "ghostfish" {
                t.Errorf("期望repo为'ghostfish', 得到 %s", repo)
            }
            
            // 返回模拟数据
            return &github.Repository{
                Description: github.String("用Go编写的TCP扫描器"),
            }, &github.Response{}, nil
        },
    }
    
    // 创建RepositoryGetter并注入Mock
    getter := &RepositoryGetter{
        Repositories: mockRepoService,
    }
    
    // 执行测试
    repo, err := GetUserRepo(getter, "drpaneas")
    if err != nil {
        t.Errorf("期望错误为nil, 得到 %v", err)
    }
    
    expectedDesc := "用Go编写的TCP扫描器"
    if repo.GetDescription() != expectedDesc {
        t.Errorf("期望描述为 '%s', 得到 '%s'", expectedDesc, repo.GetDescription())
    }
}

func TestGetUserRepo_ErrorCase(t *testing.T) {
    mockRepoService := &MockRepositoryService{
        GetFunc: func(ctx context.Context, owner, repo string) (*github.Repository, *github.Response, error) {
            return nil, &github.Response{}, fmt.Errorf("模拟错误")
        },
    }
    
    getter := &RepositoryGetter{
        Repositories: mockRepoService,
    }
    
    _, err := GetUserRepo(getter, "drpaneas")
    if err == nil {
        t.Error("期望返回错误, 但得到nil")
    }
}

5. 使用gomock或mockery（可选）

对于更复杂的场景，可以使用代码生成工具：

# 安装mockery
go install github.com/vektra/mockery/v2@latest

# 为接口生成mock
mockery --name=RepositoryService --output=mocks --dir=.

或者使用gomock：

// 使用gomock的示例
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

mockRepoService := NewMockRepositoryService(mockCtrl)
mockRepoService.EXPECT().
    Get(gomock.Any(), "drpaneas", "ghostfish").
    Return(&github.Repository{
        Description: github.String("用Go编写的TCP扫描器"),
    }, &github.Response{}, nil)

关键点

1. 定义你自己的接口：不要尝试为第三方库定义接口，而是为你自己的业务逻辑定义接口
2. 依赖注入：通过接口将依赖注入到函数中
3. 接口隔离：只定义你需要的方法，保持接口简洁
4. 手动Mock：对于简单场景，手动创建Mock结构体
5. 工具辅助：对于复杂场景，使用gomock或mockery生成Mock代码

这种模式使得测试更加简单，不需要真实的GitHub API调用，同时保持了代码的可测试性和可维护性。