Golang中如何实现Mock测试以及处理0%覆盖率问题？

你的测试覆盖率为0%是因为测试代码没有调用实际的 githubClient 方法，而是调用了模拟对象的方法。覆盖率工具只统计实际代码的执行情况，而你的测试完全运行在模拟环境中。

问题分析

1. 测试中使用的都是模拟对象：mockgithubClient 是模拟对象，不会执行 githubClient 的实际方法
2. 全局变量 GithubClient 未被替换：在 main() 函数中仍然使用原始的 GithubClient 实现
3. 测试与生产代码分离：测试没有触发任何生产代码的执行

解决方案

方案1：使用依赖注入替换全局变量

修改 main.go，使其支持依赖注入：

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/google/go-github/v30/github"
	"golang.org/x/oauth2"
)

type githubClientInterface interface {
	Authenticated(env string) *github.Client
	GetUserRepo(client *github.Client, user string) (*github.Repository, error)
}

type githubClient struct{}

func (c *githubClient) Authenticated(env string) *github.Client {
	token := oauth2.Token{
		AccessToken: os.Getenv(env),
	}
	tokenSource := oauth2.StaticTokenSource(&token)
	tc := oauth2.NewClient(context.Background(), tokenSource)
	client := github.NewClient(tc)
	return client
}

func (c *githubClient) GetUserRepo(client *github.Client, user string) (*github.Repository, error) {
	repo, _, err := client.Repositories.Get(context.Background(), user, "ghostfish")
	if err != nil {
		return nil, err
	}
	return repo, err
}

// 主逻辑函数，接受接口作为参数
func run(githubClient githubClientInterface) error {
	client := githubClient.Authenticated("GHTOKEN")
	repo, err := githubClient.GetUserRepo(client, "drpaneas")
	if err != nil {
		return err
	}
	fmt.Println(repo.GetDescription())
	return nil
}

func main() {
	client := &githubClient{}
	if err := run(client); err != nil {
		log.Fatal(err)
	}
}

修改 main_test.go：

package main

import (
	"testing"

	"github.com/golang/mock/gomock"
	"github.com/google/go-github/v30/github"
)

func TestRun(t *testing.T) {
	mockCtrl := gomock.NewController(t)
	defer mockCtrl.Finish()

	mockClient := NewMockgithubClientInterface(mockCtrl)
	
	// 设置模拟期望
	expectedClient := &github.Client{}
	mockClient.EXPECT().Authenticated("GHTOKEN").Return(expectedClient)
	
	expectedRepo := &github.Repository{}
	expectedDescription := "Test Repository"
	expectedRepo.Description = &expectedDescription
	
	mockClient.EXPECT().GetUserRepo(expectedClient, "drpaneas").Return(expectedRepo, nil)
	
	// 调用实际逻辑函数，传入模拟对象
	err := run(mockClient)
	if err != nil {
		t.Errorf("run() error = %v", err)
	}
}

// 测试实际实现
func TestGithubClient_Authenticated(t *testing.T) {
	// 设置环境变量
	t.Setenv("GHTOKEN", "test-token")
	
	client := &githubClient{}
	result := client.Authenticated("GHTOKEN")
	
	if result == nil {
		t.Error("Authenticated() returned nil client")
	}
}

func TestGithubClient_GetUserRepo(t *testing.T) {
	// 这个测试需要真正的GitHub客户端，可以跳过或使用集成测试
	t.Skip("需要真正的GitHub客户端，跳过单元测试")
}

方案2：使用可替换的全局变量（更接近你原来的设计）

修改 main.go：

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/google/go-github/v30/github"
	"golang.org/x/oauth2"
)

// 可替换的全局变量
var GithubClient githubClientInterface = &githubClient{}

type githubClientInterface interface {
	Authenticated(env string) *github.Client
	GetUserRepo(client *github.Client, user string) (*github.Repository, error)
}

type githubClient struct{}

func main() {
	client := GithubClient.Authenticated("GHTOKEN")
	repo, err := GithubClient.GetUserRepo(client, "drpaneas")
	if err != nil {
		fmt.Println("Error")
		log.Fatal(err)
	}
	fmt.Println(repo.GetDescription())
}

func (c *githubClient) Authenticated(env string) *github.Client {
	token := oauth2.Token{
		AccessToken: os.Getenv(env),
	}
	tokenSource := oauth2.StaticTokenSource(&token)
	tc := oauth2.NewClient(context.Background(), tokenSource)
	client := github.NewClient(tc)
	return client
}

func (c *githubClient) GetUserRepo(client *github.Client, user string) (*github.Repository, error) {
	repo, _, err := client.Repositories.Get(context.Background(), user, "ghostfish")
	if err != nil {
		return nil, err
	}
	return repo, err
}

修改 main_test.go：

package main

import (
	"testing"

	"github.com/golang/mock/gomock"
	"github.com/google/go-github/v30/github"
)

func TestMainWithMock(t *testing.T) {
	mockCtrl := gomock.NewController(t)
	defer mockCtrl.Finish()
	
	// 保存原始实现
	originalClient := GithubClient
	
	// 创建模拟对象
	mockClient := NewMockgithubClientInterface(mockCtrl)
	
	// 替换全局变量
	GithubClient = mockClient
	
	// 测试完成后恢复
	defer func() {
		GithubClient = originalClient
	}()
	
	// 设置模拟期望
	expectedClient := &github.Client{}
	mockClient.EXPECT().Authenticated("GHTOKEN").Return(expectedClient)
	
	expectedRepo := &github.Repository{}
	expectedDescription := "Test Repository Description"
	expectedRepo.Description = &expectedDescription
	
	mockClient.EXPECT().GetUserRepo(expectedClient, "drpaneas").Return(expectedRepo, nil)
	
	// 由于main()会退出程序，我们需要测试实际的方法
	client := GithubClient.Authenticated("GHTOKEN")
	repo, err := GithubClient.GetUserRepo(client, "drpaneas")
	
	if err != nil {
		t.Errorf("GetUserRepo() error = %v", err)
	}
	
	if repo.GetDescription() != expectedDescription {
		t.Errorf("GetDescription() = %v, want %v", repo.GetDescription(), expectedDescription)
	}
}

// 测试实际实现
func TestGithubClient_Authenticated(t *testing.T) {
	t.Setenv("GHTOKEN", "test-token-123")
	
	client := &githubClient{}
	result := client.Authenticated("GHTOKEN")
	
	if result == nil {
		t.Error("Authenticated() returned nil")
	}
}

生成模拟文件的命令

确保使用正确的包名：

mockgen -source=main.go -destination=mocks/mock_githubClient.go -package=main

运行测试和覆盖率

# 运行测试
go test -v ./...

# 生成覆盖率报告
go test -coverprofile=cover.out ./...

# 查看覆盖率
go tool cover -func cover.out

# 查看HTML覆盖率报告
go tool cover -html=cover.out

这样修改后，你的测试将：

1. 实际调用 githubClient 的方法（在测试实际实现时）
2. 使用模拟对象测试业务逻辑
3. 获得正确的覆盖率统计