go 用testify搭建完整易用的测试环境

单元测试

单元测试在大型应用开发中是非常重要的一环。go 自身提供了单元测试框架,但是原生单元测试框架提供的功能太弱了,所以这里分享下最近研究搭建的单元测试环境

目标

  1. 支持测试与数据库交互,每个单元测试用例的数据库环境必须都是要干净的

  2. 支持断言

  3. 简单的在测试中生成数据

为了达成这些目标,我们可以使用一些现成的go第三方包来帮我们

testify

https://github.com/stretchr/testify
testify用go实现的一个assert风格的测试框架,这个包提供了我们需要的断言的功能,提供了非常丰富的断言方法。

assert.Equal(t, 123, 123, "they should be equal")
assert.NotNil(ret, "")

同时testify也提供了如mock这种的功能,如果有童鞋需要,可以自己去翻阅文档https://godoc.org/github.com/stretchr/testify/mock

重点来了

testify提供了suite包提供了类似rails minitest中可以给每个测试用例进行前置操作和后置操作的功能,这个方便的功能,在前置操作和后置操作中去初始化和清空数据库,就可以帮助我们实现第一个目标。
同时,还可以声明在这个测试用例周期内都有效的全局变量

type ExampleTestSuite struct {
    suite.Suite
    VariableThatShouldStartAtFive int
}

// 每个测试用例执行前都会调用
func (suite *ExampleTestSuite) SetupTest() {
    test_helpers.Init(config.Cfg)
}

//其中一个测试用例
func (suite *ExampleTestSuite) TestExample() {
    assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
}

// In order for 'go test' to run this suite, we need to create
// a normal test function and pass our suite to suite.Run
func TestExampleTestSuite(t *testing.T) {
    suite.Run(t, new(ExampleTestSuite))
}

// 每个测试用例执行后都会调用
func (suite *ExecutorTestSuite) TearDownTest() {
    test_helpers.CleanTables()
}

dbcleaner

https://github.com/khaiql/dbcleaner
有了前置操作和后置操作,我们就可以想办法来保证每个用例的数据库状态都是干净的。最简单的办法,就是在SetupTest方法中声明数据库,然后用例操作完数据库玩后,在TearDownTest()方法中truncate数据库。

但是,go test的时候,是多个协程一起跑的,如果简单这样做,有可能导致测试时数据库出错, dbcleaner可以帮助我们避免这个问题,这个包是模仿ruby中的database_cleaner的功能。使用方法如下
在测试中有可能用到的表,先声明加锁

Cleaner.Acquire("users")

然后在用例结束后

Cleaner.Clean("users")

配合suite,就可以保证数据状态的干净。
同时建议,为了减轻些测试的心智,最好全局定义有可能用到的所有的表,然后在每个测试用例,同意调用一个封装好的函数

factory

https://github.com/nauyey/factory
有了上面两个库,已经完成我们第一和第二个目标了,第三个目标同样非常重要,测试用例中,生成数据是非常重要的,如果,每次都调用model层的方法来生成数据,非常繁琐,因为生成的测试数据,有很多字段,并不是我们关注的,但是用model去生成,有很多时候,必须遵循验证规则,不得不去声明一些字段,所以factory就非常重要了,同时factory也是各种测试体系中不可或缺的一部分.
factory这个库,参考的是ruby中factory_bot这个库,使用ruby写测试过的同学,绝对都使用过这个库,go中的factory库,实现了大部分功能

userFactory := def.NewFactory(User{}, "db_table_users",
    def.SequenceField("ID", 1, func(n int64) interface{} {
        return n
    }),
    def.DynamicField("Name", func(user interface{}) (interface{}, error) {
        return fmt.Sprintf("User Name %d", user.(*User).ID), nil
    }),
    def.Trait("boy",
        def.Field("Gender", "male"),
    ),
)

定义好了factory后,使用就非常简单了

user := &User{}
Create(userFactory, WithTraits("boy")).To(user2) // saved to database

这样,在测试用例中,非常的方便,能减轻很多工作量。
把factory定义在全局的某个地方,就可以配置一次,然后在多个测试用例中使用

go-randomdata

https://github.com/Pallinder/go-randomdata
这个库可以生成一些随机的假数据,就是测试里常说faker

总结

有了这些库,在加上适当的封装,就赶快开始愉快的写测试吧!🎉

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容