搞定Go单元测试(一)——基础原理

https://juejin.im/post/5ce93447e51d45775746b8b0

单元测试是代码质量的保证。本系列文章将一步步由浅入深展示如何在Go中做单元测试。

Go对单元测试的支持相当友好,标准包中就支持单元测试,在开始本系阅读之前,需要对标准测试包的基本用法有所了解。

现在,我们从单元测试的基本思想和原理入手,一起来看看如何基于Go提供的标准测试包来进行单元测试。

单元测试的难点

1.掌握单元测试粒度

单元测试粒度是让人十分头疼的问题,特别是对于初尝单元测试的程序员。测试粒度做的太细,会耗费大量的开发以及维护时间,每改一个方法,都要改动其对应的测试方法。当发生代码重构的时候那简直就是噩梦(因为你所有的单元测试又都要写一遍了…)。 如单元测试粒度太粗,一个测试方法测试了n多方法,那么单元测试将显的非常臃肿,脱离了单元测试的本意,容易把单元测试写成集成测试

2. 破除外部依赖(mock,stub 技术)

单元测试一般不允许有任何外部依赖(文件依赖,网络依赖,数据库依赖等),我们不会在测试代码中去连接数据库,调用api等。这些外部依赖在执行测试的时候需要被模拟(mock/stub)。在测试的时候,我们使用模拟的对象来模拟真实依赖下的各种行为。如何运用mock/stub来模拟系统真实行为算是单元测试道路上的一只拦路虎。别着急,本文会通过示例来展示如何在Go中使用mock/stub来完成单元测试。

有的时候模拟是有效的方便的。但我们要提防过度的mock/stub,因为其会导致单元测试主要在测模拟对象而不是实际的系统。

Costs and Benefits

在受益于单元测试的好处的同时,也必然增加了代码量以及维护成本(单元测试代码也是要维护的)。下面这张成本/价值象限图很清晰的阐述了在不同性质的系统中单元测试成本价值之间的关系。

1.依赖很少的简单的代码(左下)

对于外部依赖少,代码又简单的代码。自然其成本和价值都是比较低的。举Go官方库里errors包为例,整个包就两个方法 New()Error(),没有任何外部依赖,代码也很简单,所以其单元测试起来也是相当方便。

2. 依赖较多但是很简单的代码(右下)

依赖一多,mock和stub就必然增多,单元测试的成本也就随之增加。但代码又如此简单(比如上述errors包的例子),这个时候写单元测试的成本已经大于其价值,还不如不写单元测试

3. 依赖很少的复杂代码 (左上)

像这一类代码,是最有价值写单元测试的。比如一些独立的复杂算法(银行利息计算,保险费率计算,TCP协议解析等),像这一类代码外部依赖很少,但却很容易出错,如果没有单元测试,几乎不能保证代码质量。

4.依赖很多又很复杂(右上)

这种代码显然是单元测试的噩梦。写单元测试吧,代价高昂;不写单元测试吧,风险太高。像这种代码我们尽量在设计上将其分为两部分:1.处理复杂的逻辑部分 2.处理依赖部分 然后1部分进行单元测试

原文参考:blog.stevensanderson.com/2009/11/04/…

迈出单元测试第一步

1. 识别依赖,抽象成接口

识别系统中的外部依赖,普遍来说,我们遇到最常见的依赖无非下面几种:

  1. 网络依赖——函数执行依赖于网络请求,比如第三方http-api,rpc服务,消息队列等等
  2. 数据库依赖
  3. I/O依赖(文件)

当然,还有可能是依赖还未开发完成的功能模块。但是处理方法都是大同小异的——抽象成接口,通过mock和stub进行模拟测试。

2. 明确需要测什么

当我们开始敲产品代码的时候,我们必然已经过初步的设计,已经了解系统中的外部依赖以及业务复杂的部分,这些部分是要优先考虑写单元测试的。在写每一个方法/结构体的时候同时思考这个方法/结构体需不需要测试?如何测试?对于什么样的方法/结构体需要测试,什么样的可以不做,除了可以从上面的成本/价值象限图中获得答案外,还可以参考以下关于单元测试粒度要做多细问题的回答:

老板为我的代码付报酬,而不是测试,所以,我对此的价值观是——测试越少越好,少到你对你的代码质量达到了某种自信(我觉得这种的自信标准应该要高于业内的标准,当然,这种自信也可能是种自大)。如果我的编码生涯中不会犯这种典型的错误(如:在构造函数中设了个错误的值),那我就不会测试它。我倾向于去对那些有意义的错误做测试,所以,我对一些比较复杂的条件逻辑会异常地小心。当在一个团队中,我会非常小心的测试那些会让团队容易出错的代码coolshell.cn/articles/82…

Mock和Stub怎么做

Mock(模拟)和Stub(桩)是在测试过程中,模拟外部依赖行为的两种常用的技术手段。 通过Mock和Stub我们不仅可以让测试环境没有外部依赖,而且还可以模拟一些异常行为,如数据库服务不可用,没有文件的访问权限等等。

Mock和Stub的区别

在Go语言中,可以这样描述Mock和Stub:

  • Mock:在测试包中创建一个结构体,满足某个外部依赖的接口 interface{}
  • Stub:在测试包中创建一个模拟方法,用于替换生成代码中的方法

还是有点抽象,下面举例说明。

Mock示例

Mock:在测试包中创建一个结构体,满足某个外部依赖的接口 interface{}

生产代码:

  1. //auth.go
  2. //假设我们有一个依赖http请求的鉴权接口
  3. type AuthService interface{
  4. Login(username string,password string) (token string,e error)
  5. Logout(token string) error
  6. }

mock代码:

  1. //auth_test.go
  2. type authService struct {}
  3. func (auth *authService) Login (username string,password string) (string,error){
  4. return "token", nil
  5. }
  6. func (auth *authService) Logout(token string) error{
  7. return nil
  8. }

在这里我们用 authService实现了 AuthService接口,这样测试 Login,Logout就不再需需要依赖网络请求了。而且我们也可以模拟一些错误的情况进行测试:

  1. //auth_test.go
  2. //模拟登录失败
  3. type authLoginErr struct {
  4. auth AuthService //可以使用组合的特性,Logout方法我们不关心,只用“覆盖”Login方法即可
  5. }
  6. func (auth *authLoginErr) Login (username string,password string) (string,error) {
  7. return "", errors.New("用户名密码错误")
  8. }
  9. //模拟api服务器宕机
  10. type authUnavailableErr struct {
  11. }
  12. func (auth *authLoginErr) Login (username string,password string) (string,error) {
  13. return "", errors.New("api服务不可用")
  14. }
  15. func (auth *authLoginErr) Logout(token string) error{
  16. return errors.New("api服务不可用")
  17. }

Stub示例

Stub:在测试包中创建一个模拟方法,用于替换生成代码中的方法。 这是《Go语言圣经》(11.2.3)当中的一个例子: 生产代码:

  1. //storage.go
  2. //发送邮件
  3. var notifyUser = func(username, msg string) { //<--将发送邮件的方法变成一个全局变量
  4. auth := smtp.PlainAuth("", sender, password, hostname)
  5. err := smtp.SendMail(hostname+":587", auth, sender,
  6. []string{username}, []byte(msg))
  7. if err != nil {
  8. log.Printf("smtp.SendEmail(%s) failed: %s", username, err)
  9. }
  10. }
  11. //检查quota,quota不足将发邮件
  12. func CheckQuota(username string) {
  13. used := bytesInUse(username)
  14. const quota = 1000000000 // 1GB
  15. percent := 100 * used / quota
  16. if percent < 90 {
  17. return // OK
  18. }
  19. msg := fmt.Sprintf(template, used, percent)
  20. notifyUser(username, msg) //<---发邮件
  21. }

显然,在跑单元测试的过程中,我们肯定不会真的给用户发邮件。在书中采用了stub的方式来进行测试:

  1. //storage_test.go
  2. func TestCheckQuotaNotifiesUser(t *testing.T) {
  3. var notifiedUser, notifiedMsg string
  4. notifyUser = func(user, msg string) { //<-看这里就够了,在测试中,覆盖了发送邮件的全局变量
  5. notifiedUser, notifiedMsg = user, msg
  6. }
  7. // ...simulate a 980MB-used condition...
  8. const user = "joe@example.org"
  9. CheckQuota(user)
  10. if notifiedUser == "" && notifiedMsg == "" {
  11. t.Fatalf("notifyUser not called")
  12. }
  13. if notifiedUser != user {
  14. t.Errorf("wrong user (%s) notified, want %s",
  15. notifiedUser, user)
  16. }
  17. const wantSubstring = "98% of your quota"
  18. if !strings.Contains(notifiedMsg, wantSubstring) {
  19. t.Errorf("unexpected notification message <<%s>>, "+
  20. "want substring %q", notifiedMsg, wantSubstring)
  21. }
  22. }

可以看到,在Go中,如果要用stub,那将是侵入式的,必须将生产代码设计成可以用stub方法替换的形式。上述例子体现出来的结果就是:为了测试,专门用一个全局变量 notifyUser来保存了具有外部依赖的方法。然而在不提倡使用全局变量的Go语言当中,这显然是不合适的。所以,并不提倡这种Stub方式。

Mock与Stub相结合

既然不提倡Stub方式,那是不是在Go测试当中就可以抛弃Stub了呢?原本我是这么认为的,但直到我读了这篇译文Golang 标准包布局,虽然这篇译文讲的是包的布局,但里面的测试示例很值得学习。

  1. //生产代码 myapp.go
  2. package myapp
  3. type User struct {
  4. ID int
  5. Name string
  6. Address Address
  7. }
  8. //User的一些增删改查
  9. type UserService interface {
  10. User(id int) (*User, error)
  11. Users() ([]*User, error)
  12. CreateUser(u *User) error
  13. DeleteUser(id int) error
  14. }

常规Mock方式:

  1. //测试代码 myapp_test.go
  2. type userService struct{
  3. }
  4. func (u* userService) User(id int) (*User,error) {
  5. return &User{Id:1,Name:"name",Address:"address"},nil
  6. }
  7. //..省略其他实现方法
  8. //模拟user不存在
  9. type userNotFound struct {
  10. u UserService
  11. }
  12. func (u* userNotFound) User(id int) (*User,error) {
  13. return nil,errors.New("not found")
  14. }
  15. //其他...

一般来说,mock结构体内部很少会放变量,针对每一个要模拟的场景(比如上面的user不存在),最政治正确的方法应该是新建一个mock结构体。这样有两个好处:

  1. mock出来的结构体十分简单,不需要进行额外的设置,不容易出错。
  2. mock出来的结构体职责单一,测试代码自说明能力更强,可读性更高。

但在刚才提到的文章中,他是这么做的:

  1. //测试代码
  2. // UserService 代表一个myapp.UserService.的 mock实现
  3. type UserService struct {
  4. UserFn func(id int) (*myapp.User, error)
  5. UserInvoked bool
  6. UsersFn func() ([]*myapp.User, error)
  7. UsersInvoked bool
  8. // 其他接口方法补全..
  9. }
  10. // User调用mock实现, 并标记这个方法为已调用
  11. func (s *UserService) User(id int) (*myapp.User, error) {
  12. s.UserInvoked = true
  13. return s.UserFn(id)
  14. }

这里不仅实现了接口,还通过在结构体内放置与接口方法函数签名一致的方法( UserFnUsersFn...),以及 XxxInvoked是否调用标识符来追踪方法的调用情况。这种做法其实将mock与stub相结合了起来:在mock对象的内部放置了可以被测试函数替换的函数变量UserFn UsersFn…)。我们可以在我们的测试函数中,根据测试的需要,手动更换函数实现。

  1. //mock与stub结合的方式
  2. func TestUserNotFound(t *testing.T) {
  3. userNotFound := &UserService{}
  4. userNotFound.UserFn = func(id int) (*myapp.User, error) { //<--- 设置UserFn的期望返回结果
  5. return nil,errors.New("not found")
  6. }
  7. //后续业务测试代码...
  8. if !userNotFound.UserInvoked {
  9. t.Fatal("没有调用User()方法")
  10. }
  11. }
  12. // 常规mock方式
  13. func TestUserNotFound(t *testing.T) {
  14. userNotFound := &userNotFound{} //<---结构体方法已经决定了返回值
  15. //后续业务测试代码
  16. }

通过将mock与stub结合,不仅能在测试方法中动态的更改实现,还追踪方法的调用情况,上述例子中只是追踪了方法是否被调用,实际中,如果有需要,我们也可以追踪方法的调用次数,甚至是方法的调用顺序:

  1. type UserService struct {
  2. UserFn func(id int) (*myapp.User, error)
  3. UserInvoked bool
  4. UserInvokedTime int //<--追踪调用次数
  5. UsersFn func() ([]*myapp.User, error)
  6. UsersInvoked bool
  7. // 其他接口方法补全..
  8. FnCallStack []string //<---函数名slice,追踪调用顺序
  9. }
  10. // User调用mock实现, 并标记这个方法为已调用
  11. func (s *UserService) User(id int) (*myapp.User, error) {
  12. s.UserInvoked = true
  13. s.UserInvokedTime++ //<--调用发次数
  14. s.FnCallStack = append(s.FnCallStack,"User") //调用顺序
  15. return s.UserFn(id)
  16. }

但同时,我们也会发现我们的mock结构体更复杂了,维护成本也随之增加了。两种mock风格各有各的好处,反正要记得软件工程没有银弹,合适的场景选用合适的方法就行了。 但总体而言,mock与stub相结合的这种方式的确是一种不错的测试思路,尤其是当我们需要追踪函数是否调用,调用次数,调用顺序等信息时,mock+stub将是我们的不二选择。举个例子:

  1. //缓存依赖
  2. type Cache interface{
  3. Get(id int) interface{} //获取某id的缓存
  4. Put(id int,obj interface{}) //放入缓存
  5. }
  6. //数据库依赖
  7. type UserRepository interface{
  8. //....
  9. }
  10. //User结构体
  11. type User struct {
  12. //...
  13. }
  14. //userservice
  15. type UserService interface{
  16. cache Cache
  17. repository UserRepository
  18. }
  19. func (u *UserService) Get(id int) *User {
  20. //先从缓存找,缓存找不到在去repository里面找
  21. }
  22. func main() {
  23. userService := NewUserService(xxx) //注入一些外部依赖
  24. user := userService.Get(2) //获取id = 2的user
  25. }

现在要测试 userService.Get(id)方法的行为:

  1. Cache命中之后是否还查数据库?(不应该再查了)
  2. Cache未命中的情况下是否会查库?
  3. ….

这种测试通过mock+stub结合做起来将会非常方便,作为小练习,可以尝试自己实现一下。

使用依赖注入传递接口

接口需要以依赖注入的方式注入到结构体中,这样才能为测试提供替换接口实现的可能。Why?我们先看一个反面例子,形如下面的写法是无法测试的:

  1. type A interface {
  2. Fun1()
  3. }
  4. func (f *Foo) Bar() {
  5. a := NewInstanceOfA(...参数若干) //生成A接口的某个实现
  6. a.Fun1() //调用接口方法
  7. }

当你辛辛苦苦的将A接口mock出来后,却发现你根本没有办法在Bar()方法中将mock对象替换进去。下面来看看正确的写法:

  1. type A interface {
  2. Fun1()
  3. }
  4. type Foo struct {
  5. a A // A接口
  6. }
  7. func (f *Foo) Bar() {
  8. f.a.Fun1() //调用接口方法
  9. }
  10. // NewFoo, 通过构造函数的方式,将A接口注入
  11. func NewFoo(a A) *Foo {
  12. return &Foo{a: A}
  13. }

在例子中我们使用了构造函数传参的方法来做依赖注入(当然你也可以用setter的方式做)。在测试的时候,就可以通过NewFoo()方法将我们的mock对象传递给*Foo了。

通常我们会在main.go中进行依赖注入

总结一下

长篇大论了一大堆,稍微总结一下单元测试的几个关键步骤:

  1. 识别依赖(网络,文件,未完成的功能等等)
  2. 将依赖抽象成接口
  3. main.go中使用依赖注入方式将接口注入

现在,我们已经对单元测试有了一个基本的认识,如果你能完成文中的小练习,那么恭喜你,你已经理解应当如何做单元测试,并成功迈出第一步了。在下一篇文章中,将介绍gomock测试框架,提高我们的测试效率。

ft_authoradmin  ft_create_time2019-11-19 13:55
 ft_update_time2019-11-19 17:00