Go 单元测试

本节代码样例见code/utest文件夹

在日常开发中,我们通常需要针对现有的功能进行单元测试,以验证开发的正确性。 在go标准库中有一个叫做testing的测试框架,可以进行单元测试,命令是go test xxx

测试文件通常是以xx_test.go命名,放在同一包下面。

1 初探Go单元测试

现在假设现在需求是:完成两个复数相加,我们只需要一个函数便可以完成该任务。

在开发中,我们需要对该函数进行功能测试,如何快速进行单元测试呢?

鼠标放在函数上右键,选择GO:Generate Unit Tests For Function即可生成file_test.go文件。

看下面动画:

演示动画

随后在测试文件中完成测试功能即可,可以进入code/utest里面的complex_test进行单元测试。

1.1 单测要点

第一:单元测试的时候,如果有一些打印log信息,我们运行xxx_test.go是输出不出来的,此时需要使用:

go test xxx_test.go -v

使用-v参数可以帮助我们解决此问题。

第二:单测覆盖率,覆盖率可以简单理解为进行单元测试mock的时候,能够覆盖的代码行数占总代码行数的比率,当然是高一点要好些。可以通过-cover指定

go test xxx_test -v -cover

第三:在上述提到的测试方法中我们使用的是(table-driven tests)表格驱动型测试,我们看一下代码:

tests := []struct {
    name string
    args args
    want *Complex
}{
    // TODO: Add test cases.
    {
        name: "",
        args: args{
            a: Complex{
                Real: 1.0,
                Imag: 2.0,
            },
            b: Complex{
                Real: 1.0,
                Imag: 1.0,
            },
        },
        want: &Complex{
            Real: 2.0,
            Imag: 3.0,
        },
    },
}

在TODO里面我们可以填写很多单元测试样例。

2 基准测试

基准测试函数名字必须以Benchmark开头,代码在xxx_test.go中。具体如下:

func BenchmarkComplex(t *testing.B) {
    for i := 0; i < t.N; i++ {
        fmt.Sprintf("hello")
    }
}

运行:

go test -benchmem -run=. -bench=.
输出:
goos: linux
goarch: amd64
BenchmarkComplex-8      20542494            58.9 ns/op         5 B/op          1 allocs/op
PASS
ok      _/home/light/go_dev/go-talent/code/utest    1.272s

20542494表示for循环的测试,58.9表示每次需要花费58.9纳秒。 -benchmem可以提供每次操作分配内存的次数,以及每次操作分配的字节数。 allocs/op 表示每次操作从堆上分配内存的次数。B/op 表示每次操作分配的字节数。

3 mock/stub测试

gomock是官方提供的mock框架,同时有mockgen工具来辅助生成测试代码。

https://github.com/golang/mock

需要自己先安装一下:

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

下面以DB为例,有如下接口:

type DB interface {
    Get(key int) (string, error)
}

我们想通过Get接口返回对应value。于是写出了下面这个函数:

func GetValue(db DB, key int) (string, error) {
    value, err := db.Get(key)
    if err != nil {
        return "", errors.New("fail")
    }
    return value, nil
}

我们现在比较关心的是当前我们写的函数是否正确,而中间调用了Get接口,该接口我们可以进行mock,首先使用下面命令:

mockgen -source=db.go -destination=db_mock.go -package=db

随后在单元测试文件中进行go mock即可。

func TestGetValue(t *testing.T) {
    ctrl := gomock.NewController(t)
  defer ctrl.Finish()

    m := NewMockDB(ctrl)
    m.EXPECT().Get(gomock.Eq(1)).Return("我是1的value", nil)

    if v, err := GetValue(m, 1); err != nil {
        t.Error(err)
    } else {
        t.Log(v)
    }
}

其中比较重要的是打桩(stubs):

m.EXPECT().Get(gomock.Eq(1)).Return("我是1的value", nil)

这一行我们mock掉了Get接口,假设其返回字符串(我是1的value)与nil,随后进行逻辑测试。

这种方式的好处是不直接依赖的实例,而是使用依赖注入降低耦合性。

4 直接替换

在1.4中我们是需要进行打桩并使用mockgen才可以完成一些复杂api的测试的,那有没有更简单的方法呢,例如:直接替换函数为想要的函数,在github上有monkey库为我们使用。

输入下面命令进行安装:

go get github.com/bouk/monkey

假设有Get接口的实现者是Handler,那么我们直接使用monkey进行方法替换,把Get方法替换为我们自己的,仅此一步搞定单元测试,非常方便。

func TestGetValue1(t *testing.T) {
    var h *Handler
    monkey.PatchInstanceMethod(reflect.TypeOf(h), "Get", func(handler *Handler, key int) (string, error) {
        return "我是1的value", nil
    })
    if v, err := GetValue(h, 1); err != nil {
        t.Error(err)
    } else {
        t.Log(v)
    }
}

5 浏览器实时测试

接下来引入一个比较方便的单元测试框架,可以在浏览器进行实时查看单元测试结果。只需要三步即可。

第一步:

go get github.com/smartystreets/goconvey

第二步:

$GOPATH/bin/goconvey

第三步:

http://localhost:8080

此时在页面可以看到下面这个。


浏览器实时测试

除此之外,我们看到使用vscode生成的单元测试(table-driven tests)贼丑,那么我们可以使用convey进行单测。

func TestSpec(t *testing.T) {
    // Only pass t into top-level Convey calls
    Convey("Given some integer with a starting value", t, func() {
        x := 1
        Convey("When the integer is incremented", func() {
            x++
            Convey("The value should be greater by one", func() {
                So(x, ShouldEqual, 2)
            })
        })
    })
}

使用convey进行包裹起来好看的一匹。

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

推荐阅读更多精彩内容

  • 本文说明go语言自带的测试框架未提供或者未方便地提供的测试方案,主要是用于解决写单元测试中比较头痛的依赖问题。也就...
    茶浅呀阅读 410评论 0 1
  • 大家好,我叫谢伟,是一名程序员。 最近更新不是很频繁,主要是我手头有好些事需要解决,比如更换环境,比如出去见识人,...
    谢小路阅读 2,211评论 2 8
  • Go怎么写测试用例 开发程序其中很重要的一点就是测试,我们如何保证代码质量,如何保证每个函数都是可运行的,运行结果...
    Carrism阅读 6,416评论 0 3
  • 在*_test.go文件中,有三种类型的函数:测试函数、基准测试(benchmark)函数、示例函数。一个测试函数...
    一斗阅读 1,680评论 0 0
  • 最近在学go的api,但是我觉得我不能学个api把整个项目build一次,特地去搜了一把Go的单元测试 单元测试规...
    MicoCube阅读 929评论 0 1