建站
咨詢
售后
建站咨詢
新聞中心
前言
項(xiàng)目準(zhǔn)備
為了場(chǎng)景足夠真實(shí)，我用 2020 年我更新的 「Go Web 編程入門(mén)」項(xiàng)目中的例子給大家演示怎么為使用了 GORM 的 DAO 層邏輯做 Mock 測(cè)試。
這里使用的GORM版本為 1.x，有可能在2.x版本下不兼容。
在這個(gè)例子中我們有一個(gè)與 users 表：
type User struct {
Id int64 `gorm:"column:id;primary_key"`
UserName string `gorm:"column:username"`
Secret string `gorm:"column:secret;type:varchar(1000)"`
CreatedAt time.Time `gorm:"column:created_at"`
UpdatedAt time.Time `gorm:"column:updated_at"`
}
func (m *User) TableName() string {
return "users"
}以及幾個(gè)使用 User 的 DAO 函數(shù)：
var _DB *gorm.DB
func DB() *gorm.DB {
return _DB
}
func init() {
//這里邏輯省略，就是初始化 GORM 的DB對(duì)象，
// 設(shè)置連接數(shù)據(jù)庫(kù)的配置
// 真實(shí)代碼可以公眾號(hào)回復(fù)【gohttp15】獲得
_DB = initDB()
}
func CreateUser(user *table.User) (err error) {
err = DB().Create(user).Error
return
}
func GetUserByNameAndPassword(name, password string) (user *table.User, err error) {
user = new(table.User)
err = DB().Where("username = ? AND secret = ?", name, password).
First(&user).Error
return
}
func UpdateUserNameById(userName string, userId int64) (err error) {
user := new(table.User)
updated := map[string]interface{}{
"username": userName,
}
err = DB().Model(user).Where("id = ?", userId).Updates(updated).Error
return
}
接下來(lái)我們就用 go-sqlmock 工具給這幾個(gè) DAO 函數(shù)做一下 Mock 測(cè)試。
初始化測(cè)試工作
首先我們需要做一下測(cè)試的初始化工作，主要是設(shè)置Mock的DB連接，因?yàn)橐o三個(gè)方法做Mock測(cè)試，最簡(jiǎn)單的辦法是在三個(gè)方法里每次都初始化一遍 Mock 的 DB 連接，不過(guò)這么做實(shí)在是顯得有點(diǎn)蠢，這里給大家再介紹一個(gè)小技巧。
Go 的測(cè)試支持在包內(nèi)優(yōu)先執(zhí)行一個(gè) TestMain(m *testing.M) 函數(shù)，可以在這里為 package 下所有測(cè)試做一些初始化的工作。
下面是我們?yōu)楸敬螠y(cè)試做的初始化工作。
// 給公眾號(hào)「網(wǎng)管叨bi叨」發(fā)私信
// gohttp15 獲得源碼
var (
mock sqlmock.Sqlmock
err error
db *sql.DB
)
// TestMain是在當(dāng)前package下，最先運(yùn)行的一個(gè)函數(shù)，常用于初始化
func TestMain(m *testing.M) {
//把匹配器設(shè)置成相等匹配器，不設(shè)置默認(rèn)使用正則匹配
db, mock, err = sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
if err != nil {
panic(err)
}
_DB, err = gorm.Open("mysql", db)
// m.Run 是調(diào)用包下面各個(gè)Test函數(shù)的入口
os.Exit(m.Run())
}
- 在這個(gè)初始化函數(shù)里我們創(chuàng)建一個(gè) sqlmock 的數(shù)據(jù)庫(kù)連接 db 和 mock對(duì)象，mock對(duì)象管理 db 預(yù)期要執(zhí)行的SQL。
- 讓sqlmock 使用 QueryMatcherEqual 匹配器，該匹配器把mock.ExpectQuery 和 mock.ExpectExec 的參數(shù)作為預(yù)期要執(zhí)行的SQL語(yǔ)句跟實(shí)際要執(zhí)行的SQL進(jìn)行相等比較。
- m.Run 是調(diào)用包下面各個(gè)Test函數(shù)的入口。
準(zhǔn)備工作做好了，下面正式對(duì) DAO 操作進(jìn)行Mock測(cè)試。
對(duì)Create進(jìn)行Mock測(cè)試
首先對(duì) GORM 的Create 方法進(jìn)行Mock測(cè)試。
// 給公眾號(hào)「網(wǎng)管叨bi叨」發(fā)私信
// gohttp15 獲得源碼
func TestCreateUserMock(t *testing.T) {
user := &table.User{
UserName: "Kevin",
Secret: "123456",
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
}
mock.ExpectBegin()
mock.ExpectExec("INSERT INTO `users` (`username`,`secret`,`created_at`,`updated_at`) VALUES (?,?,?,?)").
WithArgs(user.UserName, user.Secret, user.CreatedAt, user.UpdatedAt).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
err := CreateUser(user)
assert.Nil(t, err)
}
因?yàn)?sqlmock 使用的是 QueryMatcherEqual 匹配器，所以，預(yù)期會(huì)執(zhí)行的 SQL 語(yǔ)句必須精確匹配要執(zhí)行的SQL(包括符號(hào)和空格)。
這個(gè)SQL怎么獲取呢?其實(shí)我們先隨便寫(xiě)一個(gè)SQL，執(zhí)行一次測(cè)試，在報(bào)錯(cuò)信息里就會(huì)告知CreateUser操作在寫(xiě)表時(shí) GORM 真正要執(zhí)行的 SQL 啦。還有一種方法是通過(guò)GORM提供的Debug()方法獲取到。
比如運(yùn)行一下下面這個(gè)設(shè)置了Debug()的創(chuàng)建用戶操作，GORM就會(huì)打印出執(zhí)行的語(yǔ)句。
func CreateUser(user *table.User) (err error) {
// 打印出要執(zhí)行的SQL語(yǔ)句 ，記得改回去
err = DB().Debug().Create(user).Error
// err = DB().Create(user).Error
return
}我們執(zhí)行下這個(gè)測(cè)試
go test -v -run TestCreateUserMock
--------
=== RUN TestCreateUserMock
--- PASS: TestCreateUserMock (0.00s)
PASS
ok golang-unit-test-demo/sqlmock_gorm_demo 0.301s
可以看到，測(cè)試函數(shù)執(zhí)行成功，我們還可以故意把SQL改錯(cuò)，做一下反向測(cè)試。這個(gè)就留給你們自己練習(xí)啦，結(jié)合上表格測(cè)試分別做一下正向和反向單元測(cè)試。
Get 操作的Mock測(cè)試
GORM 的查詢操作的Mock測(cè)試跟Create類(lèi)似。
// 給公眾號(hào)「網(wǎng)管叨bi叨」發(fā)私信
// gohttp15 獲得源碼
func TestGetUserByNameAndPasswordMock(t *testing.T) {
user := &User{
Id: 1,
UserName: "Kevin",
Secret: "123456",
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
}
mock.ExpectQuery("SELECT * FROM `users` WHERE (username = ? AND secret = ?) "+
"ORDER BY `users`.`id` ASC LIMIT 1").
WithArgs(user.UserName, user.Secret).
WillReturnRows(
// 這里要跟結(jié)果集包含的列匹配，因?yàn)椴樵兪?SELECT * 所以表的字段都要列出來(lái)
sqlmock.NewRows([]string{"id", "username", "secret", "created_at", "updated_at"}).
AddRow(1, user.UserName, user.Secret, user.CreatedAt, user.UpdatedAt))
res, err := GetUserByNameAndPassword(user.UserName, user.Secret)
assert.Nil(t, err)
assert.Equal(t, user, res)
}
這里就不在文章里運(yùn)行演示啦，有興趣的自己把代碼拿下來(lái)試一下。
Update 操作的Mock測(cè)試
GORM的Update操作我沒(méi)有測(cè)試成功，我這里發(fā)出來(lái)，大家看一下原因。
func TestUpdateUserNameByIdMock(t *testing.T) {
newName := "Kev"
var userId int64 = 1
mock.ExpectBegin()
mock.ExpectExec("UPDATE `users` SET `updated_at` = ?, `username` = ? WHERE (id = ?)").
WithArgs(time.Now(), newName, userId).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
err := UpdateUserNameById(newName, userId)
assert.Nil(t, err)
}運(yùn)行測(cè)試后，會(huì)有下面的報(bào)錯(cuò)信息：
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 的時(shí)候會(huì)自動(dòng)更新updated_at 字段為當(dāng)前時(shí)間，與這里withArgs傳遞的 time.Now() 參數(shù)不一致(毫秒級(jí)的差距也不行)。
目前沒(méi)有辦法 Mock 測(cè)試 GORM 的UPDATE，除非用 GORM 的 Exec 方法直接執(zhí)行要更新的SQL，不過(guò)那就失去使用ORM的意義了，所以這個(gè)先跳過(guò)，如果有這方面經(jīng)驗(yàn)的大佬，可以在留言里指導(dǎo)一下。
總結(jié)
這篇內(nèi)容我們把ORM的 Mock 測(cè)試做了一個(gè)講解，這個(gè)也是我在學(xué)習(xí) Go 單元測(cè)試時(shí)自己的思考，希望學(xué)習(xí)到的這些技能能在項(xiàng)目中真實(shí)用到。
因?yàn)槲恼轮械氖纠?，是以我之前的Go Web 編程教程里的項(xiàng)目里做的測(cè)試，源碼我也打包更新到了Go Web 編程的項(xiàng)目中啦，公眾號(hào)私信 gohttp15 就能獲得。
如果你覺(jué)得有用，可以點(diǎn)贊、在看、分享給更多人，謝謝各位的支持，后面會(huì)與時(shí)俱進(jìn)再搞一篇 Go 1.18 Fuzing 測(cè)試的使用介紹。
分享文章：在項(xiàng)目里怎么給GORM做單元測(cè)試
網(wǎng)址分享：http://m.5511xx.com/article/codghso.html
