如何正确Mock Golang GORM DB实例进行单元测试？

直接传入&gorm.DB{}会触发空指针panic，原因是GORM的DB结构体内部包含未初始化的字段（比如Config），调用Session或WithContext等方法时会访问这些空字段导致崩溃。以下是几种可行的解决方法：

方法一：用内存数据库生成合法DB实例 #

GORM支持连接SQLite内存数据库，生成一个真实的*gorm.DB实例，完全避免空指针问题，还能模拟真实DB操作：

import (
  "gorm.io/driver/sqlite"
  "gorm.io/gorm"
  "testing"
)

func TestNewService(t *testing.T) {
  // 创建内存SQLite连接
  db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
  if err != nil {
    t.Fatalf("创建内存数据库失败: %v", err)
  }

  // 正常传入服务
  svc := package.NewService(db)
  // 编写后续测试逻辑
}

这种方式适合需要验证DB操作正确性的场景，接近真实运行环境。

方法二：Mock Repo接口而非DB结构体 #

直接Mock*gorm.DB结构体太复杂，推荐给Repo层定义接口，服务依赖接口而非具体DB实现，这样测试时只需Mock接口：

步骤1：定义Repo接口 #

// ReactionRepo 定义Repo层的操作接口
type ReactionRepo interface {
  CreateReaction(ctx context.Context, reaction *Reaction) error
  // 其他需要的DB操作方法
}

// 真实Repo实现
type reactionRepo struct {
  db *gorm.DB
}

func newReactionRepo(db *gorm.DB) ReactionRepo {
  return &reactionRepo{db: db}
}

步骤2：修改服务依赖为接口 #

type service struct {
  repo ReactionRepo // 依赖接口而非具体结构体
}

// NewService 现在接收Repo接口作为参数
func NewService(repo ReactionRepo) Service {
  return &service{repo: repo}
}

步骤3：测试时Mock接口 #

用testify/mock库（或Go内置mock工具）实现Mock：

import (
  "testing"
  "github.com/stretchr/testify/mock"
)

// MockReactionRepo 是ReactionRepo的Mock实现
type MockReactionRepo struct {
  mock.Mock
}

func (m *MockReactionRepo) CreateReaction(ctx context.Context, reaction *Reaction) error {
  args := m.Called(ctx, reaction)
  return args.Error(0)
}

func TestNewService(t *testing.T) {
  mockRepo := new(MockReactionRepo)
  svc := package.NewService(mockRepo)
  
  // 设置Mock预期行为，比如调用CreateReaction时返回nil
  mockRepo.On("CreateReaction", mock.Anything, mock.Anything).Return(nil)
  
  // 编写测试逻辑
}

这种方式严格隔离了服务逻辑和DB实现，是单元测试的最佳实践。

方法三：手动初始化DB必要字段（不推荐） #

如果一定要直接Mock*gorm.DB，至少要初始化内部的Config字段避免空指针：

mockDB := &gorm.DB{
  Config: &gorm.Config{},
}

但这种方式风险高，GORM内部结构体可能随版本变动，后续容易出现新的空指针问题，仅适用于非常简单的测试场景。

内容的提问来源于stack exchange，提问作者Viraj24Gupta