Go单元测试实践

　　单元测试通常用来在日常开发中检查代码中存在的问题，是提升代码质量一种有效手段。在保证代码功能没有问题的同时，可以得到预期结果。Golang有许多优秀的框架支持UT，下面列举日常开发中不同框架对应的UT情况，以便后来人实践UT。

　　1、Goland提供的简单UT模板

　　用途：对其中一个函数、方法生成UT

　　介绍：在新手不知道如何写UT，按照什么规范去编写UT的时候，不妨采用Goland自带的模板。

　　tips：在Goland选中要测试的方法、函数--“generate”--"Test for selection"，然后在// TODO: Add test cases中加入自己的测试用例数据即可。

　　缺点：通用性一般，适合逻辑简单的函数。

      2、Convey

　　用途：较为好用的UT框架，断言多样，提供UT的web界面，较为常用

　　官方文档：link

　　tips：Testify: 断言库，断言功能丰富，简单易用，通常和其他框架搭配使用

　　code example:

　　

// TestFunc
func CheckVal(val string) bool {
    valList := []string{"AAA", "BBB"}
    for index := range valList {
        if valList[index] == val {
            return true
        }
    }
    return false
}


// Convey特点：断言函数丰富，提供UT的web界面，较为常用
// Convey website: https://github.com/smartystreets/goconvey/wiki/Documentation

// Testify: 断言库，多用它提供的丰富的断言功能
func TestCheckVal(t *testing.T) {
    convey.Convey("TestCheckVal happy path", t, func(){
        res := CheckVal("AAA")
        convey.So(res, convey.ShouldBeTrue)
        assert.True(t, res)
    })

    convey.Convey("TestCheckVal unhappy path", t, func(){
        res := CheckVal("CCC")
        convey.So(res, convey.ShouldBeFalse)
        assert.False(t, res)
    })
}

 

 

　　3、Gomonkey

　　tips：

　　　　mac电脑在用Gomonkey打桩的时候时常会遇到syscall的问题，是该框架的一个bug，需要配置插件来解决这个问题，具体可以参照国外作者的配置 link

　　code example:

　　

// Gomonkey: 十分常用的打桩工具,是在monkey框架基础上个人改进的一款UT框架，比较好奇公司喜欢用这类个人库而不是monkey这种偏官方的库写UT
// Gomonkey支持多种打桩特性，但在平常开发中多用来对全局变量打桩；对函数打桩；对方法打桩；对函数变量进行打桩

// 1、为函数打桩 ApplyFunc(origin func, stub func)
func CalVal(a, b int) int {
    return a + b
}

func TestCalVal(t *testing.T) {
    convey.Convey("happy path", t, func() {
        patch := gomonkey.ApplyFunc(CalVal, func(a, b int) int {
            return 3
        })
        defer patch.Reset()

        res := CalVal(1, 2)
        convey.So(res, convey.ShouldEqual, 3) // or use assert
    })
}

// 2、为全局变量打桩 ApplyGlobalVar（&var, stubvalue)

var temp = 10
func TestGlobal(t *testing.T) {
    convey.Convey("happy path", t, func() {
        patch := gomonkey.ApplyGlobalVar(&temp, 15)
        defer patch.Reset()
        convey.So(temp, convey.ShouldEqual, 15)
    })
}

// 3、对函数变量打桩 ApplyFuncVar (&func, stubfunc)   equal to ApplyFunc, but it is the address of func var

// 4、对方法打桩 ApplyMethod（reflect.TypeOf, methodName, stubfunc)

type User struct {
    money int
}

func(u *User) AddMoney(temp int) int{
    u.money += temp
    return u.money
}

func TestAddMoney(t *testing.T) {
    temp := User{}
    patch := gomonkey.ApplyMethod(reflect.TypeOf(&temp), "AddMoney", func(_ *User, temp int) int{
        return 100
    })
    defer patch.Reset()

    convey.Convey("happy path", t, func() {
        Bob := &User{
            money: 20,
        }
        convey.So(Bob.AddMoney(80),convey.ShouldEqual, 100)
    })

}

 

 

　　4、Gomock

　　用途：对接口进行mock，提前定义好返回内容

　　介绍：go官方提供的框架，同时还可以使用mockGen工具来生成接口的mock代码

　　tips：

　　　　使用mockgen生成接口的mock代码

　　　　mockgen -source= A.go -destination= A_mock.go -package=main     

　　code example:    

　　

// gomock 多用于接口打桩，结合mockgen工具自动生成打桩代码，方便调用

type Repo interface {
    GetName(id int) string
}

func TestGetName(t *testing.T) {
    // new mockController
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()

    // mock Repo interface
    mock := mock_go_UT_learn.NewMockRepo(ctrl)
    mock.EXPECT().GetName(gomock.Eq(1)).Return("JD_1")
    if val := mock.GetName(1); val != "JD_1" {
        t.Fatal("expected JD_1, but got", val)
    } else {
        fmt.Println("the result is ", val)
    }

}

//go:generate mockgen -source=./gomock_test.go -destination=./mock/mocktest_mock.go

 

 

　　5、SqlMock

　　用途：模拟数据库请求，无需关注数据库连接

　　介绍：实际遇到的情况是SqlMock和GORM的的测试

　　tips： mock.ExpectQuery("content").WillReturnRows(sqlmock.NewRows([]string{"id"}))   在WillReturnRows里不addRow就可以返回空行了

　　code example:

　　

type Goods struct {
    name string
}
type Repository struct {
    db *gorm.DB
}


func(p *Repository)ListAll()([]*Goods, error) {
    var goods []*Goods
    err := p.db.Find(&goods).Error
    return goods, err
}


func TestSql(t *testing.T) {
    // 使用 sqlmock.New() 创建 *sql.DB 的模拟实例和模拟控制器
    db, mock, err := sqlmock.New()
    if nil != err {
        log.Fatalf("Init sqlmock failed, err %v", err)
    }
    // create gorm link with sqlmock
    dbLink, err := gorm.Open(mysql.New(mysql.Config{
        SkipInitializeWithVersion: true,
        Conn: db,
    }), &gorm.Config{})
    if nil != err {
        log.Fatalf("Init DB with sqlmock failed, err %v", err)
    }

    repo := Repository{
        db: dbLink,
    }

    // create mock record
    const sqlSelectAll = `SELECT * FROM "blogs"`
    mock.ExpectQuery(sqlSelectAll).WillReturnRows(sqlmock.NewRows(nil))

    goods, err := repo.ListAll()
    assert.Nil(t, err)
    assert.Nil(t, goods)
}

 

 

　　所有UT代码地址：this