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

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

  1. 支持测试与数据库交互,每个单元测试用例的数据库环境必须都是要干净的
  2. 支持断言
  3. 简单的在测试中生成数据
【go|go 用testify搭建完整易用的测试环境】为了达成这些目标,我们可以使用一些现成的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
总结
有了这些库,在加上适当的封装,就赶快开始愉快的写测试吧!

    推荐阅读