使用go優雅地撰寫單元測試

Adamhahaha發表於2020-09-06
Go

背景

剛剛加入一個年輕的小組，程式碼中的單元測試還沒有來得及寫，leader希望我通過單元測試來熟悉專案的業務邏輯。但是，程式碼量實在有點多，高效的完成單元測試成為首要目標。

實現原理

單元測試測用的是testify的測試框架，使用起來非常方便，具體的基礎使用方法可以參考中文testify部落格以及官方文件。

專案中的應用

初始化單元測試

在一個複雜的Web專案中，測試某一模組的功能往往需要先對這一模組所使用到的服務進行初始化，我們將初始化函式以及初始化函式所使用到的引數都放在同一個單元測試包下，例如對MySQL的初始化如下：

package unitTest

func InitMySQL() error{
    return db.Init(constant.MySQLDSN,
    constant.MaxIdleConns,
    constant.MaxOpenConns, 
    time.Duration(constant.ConnMaxLifetime)*time.Second,
    constant.EnableSqlLog)//其他包中已經封裝了初始化函式，在測試包的初始化函式中呼叫即可
}
func CloseDB() error{
    return db.Close()
}

我們在另一個contant包下存放對應的引數：

package constant
constant(
    MySQLDSN = "username:password@addresss/db?timeout=5000ms&readTimeout=5s&charset=utf8mb4"
    MaxIdleConns = 20
    MaxOpenConns = 20
    ConnMaxLifetime = 60
    EnableSqlLog = true
    MerchantID = 6666
    SheetID = "SZSWIMTEST"
    Operator = "XXXX@XXXX"
)

進行單元測試

以下以對資料庫的操作為例
單元測試主要由三部分組成：
第一部分為固定寫法

type ActionLogRepo struct {
    basetest.BaseSuite
}

第二部分為對Register進行初始化，Register函式可以傳入四個引數fun1,fun2,fun3,fun4
fun1：在該測試檔案中的最開始執行一次。
fun2：在每個單元測試前都執行一次。
fun3：在每個單元測試後都執行一次。
fun4：在該測試檔案中的最終執行一次。
根據需求，我們需要在所有單元測試開始前執行一次初始化資料庫操作，以及在最後關閉資料庫。

func TestActionLogRepo(t *testing.T) {
    AgentSuite := new(ActionLogRepo)
    var err error
    AgentSuite.Register(
        func() {
            err = unitTest.InitMySQL()
        },
        nil,
        nil,
        func() {
            err = unitTest.CloseDB()
        })
    assert.Nil(t,err)
    suite.Run(t, AgentSuite)
}

第三部分，進行單元測試，我們先在資料庫中建立對應的資料，然後呼叫需要單元測試的函式進行對該資料的操作，之後使用assert對該結果進行驗證，最後要記得刪除掉單元測試的記錄。

func (suite *ActionLogRepo) TestActionLog() {
    repo := repository.NewRepository()//獲取資料庫
    actionLog := &model.ActionLogTab{XXXXXX}
    err := CreateActionLog(actionLog)//建立測試的資料記錄
    assert.Nil(suite.T(),err)
    logs,count,err := FetchActionLogs(repo,repo.MerchantID,actionLog.SheetID,actionLog.SheetType,1,1)//需要測試的函式
    assert.Nil(suite.T(),err)
    assert.Equal(suite.T(),logs[0].OperationTime,actionLog.OperationTime)//驗證函式的正確性

    err = repo.MerchantDB().Delete(actionLog).Error//刪除掉測試的資料庫記錄
    assert.Nil(suite.T(),err)
}

最終的測試檔案結構如下：

package test

type ActionLogRepo struct {
    basetest.BaseSuite
}

func TestActionLogRepo(t *testing.T) {
    AgentSuite := new(ActionLogRepo)
    var err error
    AgentSuite.Register(
        func() {
            err = unitTest.InitMySQL()
        },
        nil,
        nil,
        func() {
            err = unitTest.CloseDB()
        })
    assert.Nil(t,err)
    suite.Run(t, AgentSuite)
}

func (suite *ActionLogRepo) TestActionLog() {
    repo := repository.NewRepository()//獲取資料庫
    actionLog := &model.ActionLogTab{XXXXXX}
    err := CreateActionLog(actionLog)//建立測試的資料記錄
    assert.Nil(suite.T(),err)
    logs,count,err := FetchActionLogs(repo,repo.MerchantID,actionLog.SheetID,actionLog.SheetType,1,1)//需要測試的函式
    assert.Nil(suite.T(),err)
    assert.Equal(suite.T(),logs[0].OperationTime,actionLog.OperationTime)//驗證函式的正確性

    err = repo.MerchantDB().Delete(actionLog).Error//刪除掉測試的資料庫記錄
    assert.Nil(suite.T(),err)
}
本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章