乐趣区

关于go:golang-打桩mock-数据怎么玩

jiezi

工作中，很多公司都要求效力，要求自动化测试

理论落地的过程中发现，要做单元测试，自动化测试，可能以后这个服务会依赖其余服务的数据，接口等等

那么单测或者自动化的过程中，就可能会因为其余服务的起因或者环境因素导致测试失败，或者阻塞测试

这是一个问题，必须得解决，咱们能够采纳 golang 自带的 mock 工具来实现，能够在一些必要的中央进行数据打桩，mock 数据

gomock 是什么？

是官网提供的 一个 mock 数据的 框架

官网还提供了 mockgen 工具用来帮忙 咱们 生成测试代码

github 上我的项目地址是：https://github.com/golang/mock

官网是这样介绍 gomock 的：

gomock 是一个用于 Go 编程语言的 mocking 框架。它与 Go 的内置测试包集成得很好，但也能够在其余环境中应用。

如何应用 gomock？

应用 gomock 也是非常简单的，先 go get 对应的 工具 gomock 和 mockgen

go get -u github.com/golang/mock/gomock
go get -u github.com/golang/mock/mockgen

能够写一个 demo 来进行实际

目录构造是这样的

gomock_test
├── go.mod
├── go.sum
├── main.go
└── myfunc
    ├── mock_myfunc.go
    ├── myfunc.go
    ├── myuser.go
    └── myuser_test.go
  • mock_myfunc.go 是应用 mockgen 工具生成的
  • myfunc.go 次要是用于模仿调用的底层实现
  • myuser.go 次要是去调用 myfunc.go 外面的接口
  • myuser_test.go 是 对应的单测文件

myfunc.go

  • 编写一个 接口，外面有一个 GetInfo() string 办法，模仿获取信息
package myfunc

type MyFunc interface {GetInfo() string
}

myuser.go

  • 调用 myfunc.go 中的办法，调用接口获取信息
package myfunc

func getUser(m MyFunc) string {user := m.GetInfo()
    return user
}

mock 文件的生成

mock_myfunc.go

这个文件不是咱们本人写的，是通过 mockgen 工具生成的，生成形式如下:

在 myfunc.go 的同级目录下执行如下语句，填入 source 源文件 和 指标文件即可生成新的 mock 文件

mockgen -source=myfunc.go -destination=mock_myfunc.go

咱们能够看一下 mockgen 的帮忙文档，还有其余的参数供咱们应用

# mockgen
mockgen has two modes of operation: source and reflect.

Source mode generates mock interfaces from a source file.
It is enabled by using the -source flag. Other flags that
may be useful in this mode are -imports and -aux_files.
Example:
        mockgen -source=foo.go [other options]

Reflect mode generates mock interfaces by building a program
that uses reflection to understand interfaces. It is enabled
by passing two non-flag arguments: an import path, and a
comma-separated list of symbols.
Example:
        mockgen database/sql/driver Conn,Driver

  -aux_files string
        (source mode) Comma-separated pkg=path pairs of auxiliary Go source files.
  -build_flags string
        (reflect mode) Additional flags for go build.
  -copyright_file string
        Copyright file used to add copyright header
  -debug_parser
        Print out parser results only.
  -destination string
        Output file; defaults to stdout.
  -exec_only string
        (reflect mode) If set, execute this reflection program.
  -imports string
        (source mode) Comma-separated name=path pairs of explicit imports to use.
  -mock_names string
        Comma-separated interfaceName=mockName pairs of explicit mock names to use. Mock names default to 'Mock'+ interfaceName suffix.
  -package string
        Package of the generated code; defaults to the package of the input with a 'mock_' prefix.
  -prog_only
        (reflect mode) Only generate the reflection program; write it to stdout and exit.
  -self_package string
        The full package import path for the generated code. The purpose of this flag is to prevent import cycles in the generated code by trying to include its own package. This can happen if the mock's package is set to one of its inputs (usually the main one) and the output is stdio so mockgen cannot detect the final output package. Setting this flag will then tell mockgen which import to exclude.
  -source string
        (source mode) Input Go source file; enables source mode.
  -version
        Print version.
  -write_package_comment
        Writes package documentation comment (godoc) if true. (default true)
2021/10/30 16:43:25 Expected exactly two arguments

个别用的比拟多的就是

  • -source 源文件
  • -destination 指标文件
  • -imports 依赖的须要 import 的包
  • -build_flags 传递给 build 工具的参数
  • -aux_files 接口文件不止一个文件时附加文件
  • -package 设置 mock 文件的包名，不设置的话，mock 文件的包名默认是 mock_输出文件的包名

通过上述指令生成的 mock 文件如下：

  • NewMockMyFunc

创立一个新的 mock 实例

  • EXPECT

容许调用者批示预期用处的对象

  • GetInfo

mock 的根底办法，也就是咱们须要 mock 的办法

具体的如何应用

myuser_test.go

  • myuser.go 对应的单测文件，应用了 mock 的形式
package myfunc

import (
    "fmt"
    "testing"
    gomock "github.com/golang/mock/gomock"
)

func Test_getUser(t *testing.T) {mockCtl := gomock.NewController(t)
    mockMyFunc := NewMockMyFunc(mockCtl)
    mockMyFunc.EXPECT().GetInfo().Return("xiaomotong")
    v := getUser(mockMyFunc)
    if v == "xiaomotong" {fmt.Println("get user right!")
    } else {t.Error("get error user")
    }
}

看到上述单测文件，能够还不是特地明确区别，咱们来看看不必 mock 的时候，咱们会是如何去写单测呢

package myfunc

import (
    "fmt"
    "testing"
    gomock "github.com/golang/mock/gomock"
)

func Test_getUser(t *testing.T) {m := myfunc.CreateMyFunc() // 也就是说须要本人创立一个对象
    v := getUser(m)
    if v == "xiaomotong" {fmt.Println("get user right!")
    } else {t.Error("get error user")
    }
}

m := myfunc.CreateMyFunc() 看到上述这一句话，是创立对应的对象，再将该对象作为参数传入到 getUser 函数中，失常状况下这样做单测没有问题

然而如果这个时候创立 MyFunc 对象因为对外部还有依赖导致还没有编码好，可是也不能阻塞咱们的单元测试

这个时候应用最下面的 mock 计划就显得尤为重要，能够应用 mock 的形式，mock 一个 MyFunc 对象，并设置好返回值即可实现，如：

mockCtl := gomock.NewController(t)
mockMyFunc := NewMockMyFunc(mockCtl)
mockMyFunc.EXPECT().GetInfo().Return("xiaomotong")

执行上述代码后果如下：

> go test
get user right!
PASS
ok      mygomock/myfunc 0.427s

感兴趣的敌人能够应用起来，用的多了就会更加相熟

应用 gomock 的益处？

  • gomock 实现了较为残缺的基于 interface 的 Mock 性能，可能与 Golang 内置的 testing 包良好集成，也能用于其它的测试环境中
  • 学习成本低，很快就能上手

工具须要用起来，能力施展他的价值，须要的能够用起来吧

欢送点赞，关注，珍藏

敌人们，你的反对和激励，是我保持分享，提高质量的能源

好了，本次就到这里

常见技术是凋谢的，咱们的心态，更应是凋谢的。拥抱变动，背阴而生，致力向前行。

我是 阿兵云原生，欢送点赞关注珍藏，下次见~

退出移动版