Go单元测试 -- 对GORM进行Mock测试

lsekfe

　在 Go 单元测试这个系列的第二部分 数据库的Mock测试 中我们介绍了用 go-sqlmock 给数据库的 CRUD 操作做Mock 测试的方法，不过里面只是讲解了一下怎么对原生的database/sql执行的 SQL 进行 Mock 测试。
　　前言
　　真实的开发场景下我们的项目一般都会使用 ORM ，而不是原生的database/sql来完成数据库操作。在很多使用ORM工具的场景下，也可以使用go-sqlmock库 Mock数据库操作进行测试，今天这篇内容我就以 GORM 为例，讲解怎么给项目中的 ORM 数据库操作做单元测试。
　　项目准备
　　为了场景足够真实，我用 2020 年我更新的 「Go Web 编程入门」项目中的例子给大家演示怎么为使用了 GORM 的 DAO 层逻辑做 Mock 测试。

1. 　　这里使用的GORM版本为 1.x，有可能在2.x版本下不兼容

复制代码

在这个例子中我们有一个与 users 表：

1. type User struct {
   
2. 　　Id        int64     `gorm:"column:id;primary_key"`
   
3. 　　UserName  string    `gorm:"column:username"`
   
4. 　　Secret    string    `gorm:"column:secret;type:varchar(1000)"`
   
5. 　　CreatedAt time.Time `gorm:"column:created_at"`
   
6. 　　UpdatedAt time.Time `gorm:"column:updated_at"`
   
7. 　　}
   
8. 　　func (m *User) TableName() string {
   
9. 　　return "users"
   
10. 　　}

复制代码

　以及几个使用 User 的 DAO 函数：

1. var _DB *gorm.DB
   
2. 　　func DB() *gorm.DB {
   
3. 　　return _DB
   
4. 　　}
   
5. 　　func init() {
   
6. 　　  //这里逻辑省略，就是初始化 GORM 的DB对象，
   
7. 　　  // 设置连接数据库的配置
   
8. 　　  // 真实代码可以公众号回复【gohttp15】获得
   
9. 　　_DB = initDB()
   
10. 　　}
    
11. 　　func CreateUser(user *table.User) (err error) {
    
12. 　　err = DB().Create(user).Error
    
13. 　　return
    
14. 　　}
    
15. 　　func GetUserByNameAndPassword(name, password string) (user *table.User, err error) {
    
16. 　　user = new(table.User)
    
17. 　　err = DB().Where("username = ? AND secret = ?", name, password).
    
18. 　　First(&user).Error
    
19. 　　return
    
20. 　　}
    
21. 　　func UpdateUserNameById(userName string, userId int64) (err error) {
    
22. 　　user := new(table.User)
    
23. 　　updated := map[string]interface{}{
    
24. 　　"username": userName,
    
25. 　　}
    
26. 　　err = DB().Model(user).Where("id = ?", userId).Updates(updated).Error
    
27. 　　return
    
28. 　　}

复制代码

接下来我们就用 go-sqlmock 工具给这几个 DAO 函数做一下 Mock 测试。
　　初始化测试工作
　　首先我们需要做一下测试的初始化工作，主要是设置Mock的DB连接，因为要给三个方法做Mock测试，最简单的办法是在三个方法里每次都初始化一遍 Mock 的 DB 连接，不过这么做实在是显得有点蠢，这里给大家再介绍一个小技巧。
　　Go 的测试支持在包内优先执行一个 TestMain(m *testing.M) 函数，可以在这里为 package 下所有测试做一些初始化的工作。
　　下面是我们为本次测试做的初始化工作。

1. // 给公众号「网管叨bi叨」发私信
   
2. 　　// gohttp15 获得源码
   
3. 　　var (
   
4. 　　mock sqlmock.Sqlmock
   
5. 　　err  error
   
6. 　　db   *sql.DB
   
7. 　　)
   
8. 　　// TestMain是在当前package下，最先运行的一个函数，常用于初始化
   
9. 　　func TestMain(m *testing.M) {
   
10. 　　  //把匹配器设置成相等匹配器，不设置默认使用正则匹配
    
11. 　　db, mock, err = sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
    
12. 　　if err != nil {
    
13. 　　panic(err)
    
14. 　　}
    
15. 　　_DB, err = gorm.Open("mysql", db)
    
16. 　　// m.Run 是调用包下面各个Test函数的入口
    
17. 　　os.Exit(m.Run())
    
18. 　　}

复制代码

·在这个初始化函数里我们创建一个 sqlmock 的数据库连接 db 和 mock对象，mock对象管理 db 预期要执行的SQL。
　　· 让sqlmock 使用 QueryMatcherEqual 匹配器，该匹配器把mock.ExpectQuery 和 mock.ExpectExec 的参数作为预期要执行的SQL语句跟实际要执行的SQL进行相等比较。
　　· m.Run 是调用包下面各个Test函数的入口。
　　准备工作做好了，下面正式对 DAO 操作进行Mock测试。
　　对Create进行Mock测试
　　首先对 GORM 的Create 方法进行Mock测试。

1. // 给公众号「网管叨bi叨」发私信
   
2. 　　// gohttp15 获得源码
   
3. 　　func TestCreateUserMock(t *testing.T) {
   
4. 　　user := &table.User{
   
5. 　　UserName:  "Kevin",
   
6. 　　Secret:    "123456",
   
7. 　　CreatedAt: time.Now(),
   
8. 　　UpdatedAt: time.Now(),
   
9. 　　}
   
10. 　　mock.ExpectBegin()
    
11. 　　mock.ExpectExec("INSERT INTO `users` (`username`,`secret`,`created_at`,`updated_at`) VALUES (?,?,?,?)").
    
12. 　　WithArgs(user.UserName, user.Secret, user.CreatedAt, user.UpdatedAt).
    
13. 　　WillReturnResult(sqlmock.NewResult(1, 1))
    
14. 　　mock.ExpectCommit()
    
15. 　　err := CreateUser(user)
    
16. 　　assert.Nil(t, err)
    
17. 　　}

复制代码

因为 sqlmock 使用的是 QueryMatcherEqual 匹配器，所以，预期会执行的 SQL 语句必须精确匹配要执行的SQL（包括符号和空格）。
　　这个SQL怎么获取呢？其实我们先随便写一个SQL，执行一次测试，在报错信息里就会告知CreateUser 操作在写表时 GORM 真正要执行的 SQL 啦， 也可以通过GORM提供的Debug()方法获取到。
　　比如运行一下下面这个设置了Debug()的创建用户操作，GORM就会打印出执行的语句。

1. 　func CreateUser(user *table.User) (err error) {
   
2. 　　// 打印出要执行的SQL语句 ，记得改回去
   
3. 　　  err = DB().Debug().Create(user).Error
   
4. 　　// err = DB().Create(user).Error
   
5. 　　return
   
6. 　　}

复制代码

　我们执行下这个测试：

1. 　 go test -v -run TestCreateUserMock
   
2. 　　--------
   
3. 　　=== RUN   TestCreateUserMock
   
4. 　　--- PASS: TestCreateUserMock (0.00s)
   
5. 　　PASS
   
6. 　　ok      golang-unit-test-demo/sqlmock_gorm_demo 0.301s

复制代码

可以看到，测试函数执行成功，我们还可以故意把SQL改成，做一下反向测试，这个就留给你们自己联系啦，结合上表格测试分别做一下正向和反向单元测试。
　　Get 操作的Mock测试
　　GORM 的查询操作的Mock测试跟Create类似。

1. // 给公众号「网管叨bi叨」发私信
   
2. 　　// gohttp15 获得源码
   
3. 　　func TestGetUserByNameAndPasswordMock(t *testing.T) {
   
4. 　　user := &User{
   
5. 　　Id:        1,
   
6. 　　UserName:  "Kevin",
   
7. 　　Secret:    "123456",
   
8. 　　CreatedAt: time.Now(),
   
9. 　　UpdatedAt: time.Now(),
   
10. 　　}
    
11. 　　mock.ExpectQuery("SELECT * FROM `users`  WHERE (username = ? AND secret = ?) "+
    
12. 　　"ORDER BY `users`.`id` ASC LIMIT 1").
    
13. 　　WithArgs(user.UserName, user.Secret).
    
14. 　　WillReturnRows(
    
15. 　　// 这里要跟结果集包含的列匹配，因为查询是 SELECT * 所以表的字段都要列出来
    
16. 　　sqlmock.NewRows([]string{"id", "username", "secret", "created_at", "updated_at"}).
    
17. 　　AddRow(1, user.UserName, user.Secret, user.CreatedAt, user.UpdatedAt))
    
18. 　　res, err := GetUserByNameAndPassword(user.UserName, user.Secret)
    
19. 　　assert.Nil(t, err)
    
20. 　　assert.Equal(t, user, res)
    
21. 　　}

复制代码

这里就不在文章里运行演示啦，有兴趣的自己把代码拿下来试一下。
　　Update 操作的Mock测试
　　GORM的Update操作我没有测试成功，我这里发出来原因：

1. func TestUpdateUserNameByIdMock(t *testing.T) {
   
2. 　　newName := "Kev"
   
3. 　　var userId int64 = 1
   
4. 　　mock.ExpectBegin()
   
5. 　　mock.ExpectExec("UPDATE `users` SET `updated_at` = ?, `username` = ?  WHERE (id = ?)").
   
6. 　　WithArgs(time.Now(), newName, userId).
   
7. 　　WillReturnResult(sqlmock.NewResult(1, 1))
   
8. 　　mock.ExpectCommit()
   
9. 　　err := UpdateUserNameById(newName, userId)
   
10. 　　assert.Nil(t, err)
    
11. 　　}

复制代码

运行测试后，会有下面的报错信息：

1. 　　ExecQuery 'UPDATE `users` SET `updated_at` = ?, `username` = ?  WHERE (id = ?)', arguments do not match: argument 0 expected [time.Time - 2022-05-08 18:13:08.23323 +0800 CST m=+0.003082084] does not match actual [time.Time - 2022-05-08 18:13:08.234134 +0800 CST m=+0.003986334]

复制代码

GORM 在UPDATE 的时候会自动更新updated_at 字段为当前时间，与这里withArgs传递的 time.Now() 参数不一致（毫秒级的差距也不行）。
　　目前没有办法 Mock 测试 GORM 的UPDATE，除非用 GORM 的 Exec 方法直接执行要更新的SQL，不过那就失去使用ORM的意义了，所以这个先跳过，如果有这方面经验的大佬，可以在留言里指导一下。
　　总结
　　这篇内容我们把ORM的 Mock 测试做了一个讲解，这个也是我在学习 Go 单元测试时自己的思考，希望学习到的这些技能能在项目中真实用到。