使用go-sqlmock进行GORM单元测试的实践指南

在Go语言开发中，数据库操作的单元测试是一个常见需求。本文将以一个实际案例为基础，深入分析如何使用go-sqlmock工具对基于GORM的数据库操作进行单元测试。

问题背景

在测试GORM实现的ArticleRepo时，开发者遇到了一个典型错误："all expectations were already fulfilled, call to database transaction Begin was not expected"。这个错误表明测试中的mock数据库配置存在问题，未能正确模拟GORM的实际行为。

核心问题分析

1. GORM的事务特性

GORM在执行写操作(Create/Update/Delete)时会自动开启事务，而测试中的mock实现没有正确模拟这一行为。当GORM尝试开启事务时，mock数据库没有相应的预期设置，导致测试失败。

2. Mock数据库配置不足

当前的MockDatabaseProvider只是简单地创建了一个空的sqlmock连接，没有设置任何预期的SQL查询或事务行为。对于写操作测试，需要明确mock以下内容：

• 事务开始(BEGIN)
• 具体的SQL执行预期
• 事务提交(COMMIT)或回滚(ROLLBACK)

解决方案

1. 完善Mock数据库配置

func TestArticleRepo_Create(t *testing.T) {
    // 创建sqlmock数据库连接
    db, mock, err := sqlmock.New()
    require.NoError(t, err)
    
    // 使用mock数据库创建GORM实例
    gormDB, err := gorm.Open(postgres.New(postgres.Config{
        Conn: db,
    }), &gorm.Config{})
    require.NoError(t, err)
    
    // 设置事务预期
    mock.ExpectBegin()
    // 设置INSERT操作预期
    mock.ExpectExec(`INSERT INTO "articles"`).
        WillReturnResult(sqlmock.NewResult(1, 1))
    mock.ExpectCommit()
    
    // 创建测试对象
    repo := &articleRepo{db: &MockDatabaseProvider{db: gormDB}}
    testArticle := &entity.Article{Title: "Test", Author: "Author"}
    
    // 执行测试
    err = repo.Create(testArticle)
    assert.NoError(t, err)
    
    // 验证所有预期是否满足
    assert.NoError(t, mock.ExpectationsWereMet())
}

2. 重构MockDatabaseProvider

type MockDatabaseProvider struct {
    db *gorm.DB
}

func (m *MockDatabaseProvider) GetDBSlave() *gorm.DB {
    return m.db
}

func (m *MockDatabaseProvider) GetDBMain() *gorm.DB {
    return m.db
}

关键实践要点

1. 事务模拟：必须为写操作设置BEGIN和COMMIT的预期
2. SQL匹配：使用正则表达式匹配预期的SQL语句
3. 结果模拟：使用sqlmock.NewResult模拟数据库返回结果
4. 预期验证：最后必须调用ExpectationsWereMet验证所有预期是否满足

扩展建议

1. 表驱动测试：对于不同测试用例，可以使用表驱动的方式组织测试数据
2. 错误场景测试：专门测试数据库返回错误的情况
3. 查询测试：对于读操作，需要设置ExpectQuery和相应的行数据

通过以上方法，可以构建出健壮的数据库操作单元测试，确保代码质量的同时也提高了开发效率。记住，好的单元测试应该既验证正常流程，也覆盖各种边界和异常情况。