Golang使用Mock库进行单元测试示例

stretchr/testify/mock

stretchr/testify/mock

UserService

UserService

UserRepository

package service

import "errors"

// User 代表一个简单的用户模型
type User struct {
    ID   string
    Name string
}

// UserRepository 定义了用户数据操作的接口
type UserRepository interface {
    GetUserByID(id string) (*User, error)
    // 如果有其他操作，比如 SaveUser, DeleteUser，也在这里定义
}

// UserService 依赖于 UserRepository
type UserService struct {
    Repo UserRepository
}

// GetUserDetails 通过仓库获取用户详情
func (s *UserService) GetUserDetails(id string) (*User, error) {
    if id == "" {
        return nil, errors.New("用户ID不能为空")
    }
    user, err := s.Repo.GetUserByID(id)
    if err != nil {
        return nil, err // 传播仓库层错误
    }
    if user == nil {
        return nil, errors.New("用户未找到")
    }
    // 这里可以添加其他业务逻辑
    return user, nil
}

testify

go get github.com/stretchr/testify

service_test

service.UserRepository

mock.Mock

package service_test // 假设你的服务在 'service' 包，测试在 'service_test' 包

import (
    "github.com/stretchr/testify/mock"
    "your_module/service" // 替换为你的实际模块路径
)

// MockUserRepository 是 service.UserRepository 接口的模拟实现
type MockUserRepository struct {
    mock.Mock
}

// GetUserByID 模拟了 service.UserRepository 的 GetUserByID 方法
func (m *MockUserRepository) GetUserByID(id string) (*service.User, error) {
    // m.Called(id) 记录了 GetUserByID 被调用时传入的参数
    args := m.Called(id)
    var user *service.User
    // args.Get(0) 获取第一个返回值，我们断言它是一个 *service.User
    if args.Get(0) != nil {
        user = args.Get(0).(*service.User)
    }
    // args.Error(1) 获取第二个返回值，我们断言它是一个 error
    return user, args.Error(1)
}

UserService

MockUserRepository

package service_test

import (
    "errors"
    "testing"

    "github.com/stretchr/testify/assert"
    "your_module/service" // 替换为你的实际模块路径
)

func TestUserService_GetUserDetails(t *testing.T) {
    t.Run("成功获取用户详情", func(t *testing.T) {
        mockRepo := new(MockUserRepository)
        expectedUser := &service.User{ID: "123", Name: "张三"}

        // 设置期望：当 GetUserByID 被调用时，传入 "123"，返回 expectedUser 和 nil 错误
        mockRepo.On("GetUserByID", "123").Return(expectedUser, nil)

        userService := &service.UserService{Repo: mockRepo}

        user, err := userService.GetUserDetails("123")

        assert.Nil(t, err)
        assert.Equal(t, expectedUser, user)
        // 验证所有期望是否都被满足（即 GetUserByID 是否被调用，参数是否正确）
        mockRepo.AssertExpectations(t)
    })

    t.Run("用户未找到", func(t *testing.T) {
        mockRepo := new(MockUserRepository)

        // 设置期望：当 GetUserByID 被调用时，传入 "456"，返回 nil 用户和 nil 错误（模拟仓库层未找到用户）
        mockRepo.On("GetUserByID", "456").Return(nil, nil)

        userService := &service.UserService{Repo: mockRepo}

        user, err := userService.GetUserDetails("456")

        assert.NotNil(t, err)
        assert.Contains(t, err.Error(), "用户未找到")
        assert.Nil(t, user)
        mockRepo.AssertExpectations(t)
    })

    t.Run("仓库层返回错误", func(t *testing.T) {
        mockRepo := new(MockUserRepository)
        repoError := errors.New("数据库连接失败")

        // 设置期望：当 GetUserByID 被调用时，传入 "789"，返回 nil 用户和 repoError
        mockRepo.On("GetUserByID", "789").Return(nil, repoError)

        userService := &service.UserService{Repo: mockRepo}

        user, err := userService.GetUserDetails("789")

        assert.NotNil(t, err)
        assert.Contains(t, err.Error(), "数据库连接失败")
        assert.Nil(t, user)
        mockRepo.AssertExpectations(t)
    })

    t.Run("用户ID为空", func(t *testing.T) {
        mockRepo := new(MockUserRepository) // 在此场景下，仓库方法不会被调用，无需设置期望

        userService := &service.UserService{Repo: mockRepo}

        user, err := userService.GetUserDetails("")

        assert.NotNil(t, err)
        assert.Contains(t, err.Error(), "用户ID不能为空")
        assert.Nil(t, user)
        // 验证 GetUserByID 方法没有被调用
        mockRepo.AssertNotCalled(t, "GetUserByID")
    })
}

UserService