Go 语言 Unit Testing 单元测试

关于 Go 的基本语法,参见:半天时间 Go 语言的基本实践

单元测试

Go 中提供了 testing 这个 package 和 go test 这个命令来进行单元测试。

假设我们要创建一个数学运算的 package,名字叫 algo,提供了加法运算 add() 和减法运算 sub()
首先我们创建一个 algo 的文件夹,在里面创建一个 add.go 文件和 sub.go 文件,分别如下:

package algo

func add(x int, y int) int {
   return x + y
}
package algo

func sub(x int, y int) int {
    return x - y
}

现在我们要对 add()sub() 方法进行单元测试,需要有如下几步:

  • 创建一个测试文件,文件名以 XXX_test.go 结尾,例如 algo_test.go
    • 该测试文件放在被测试文件相同的 package 中:package algo
    • Go doesn't ship your tests。该测试文件不会会编译器放到编译后的 Binary 中
  • 导入 testing 这个 package:import "testing"
  • 创建方法 func TestXxx(t *testing.T),在这里面定义测试:
    • func TestAdd(t *testing.T)
    • func TestSub(t *testing.T)
  • 使用 t.Errort.Fail 等方法来标记测试错误
    • 可以使用 t. Errorf 来打印详情
    • 可以使用 t.Log 来打印日志文件
  • 最后使用 go test 命令来执行单元测试

我们创建 algo_test.go 测试文件如下:

package algo

import "testing"

func TestAdd(t *testing.T) {
        want := 3
        got := add(1, 2)
        if got != want {
                t.Errorf("add was incorrect, got: %d, want: %d.", got, want)
        }
}

func TestSub(t *testing.T) {
        want := -1
        got := sub(1, 2)
        if got != want {
                t.Errorf("sub was incorrect, got: %d, want: %d.", got, want)
        }
}

最后使用 go test 命令来执行单元测试:

go test

如果我们故意把 sub 方法写错,go test 命令会标记测试错误:

go test

如何创建多个测试用例?

在上述的代码中,我们为 add() 方法只创建了一个测试用例 add(1, 2) = 3
我们可以通过 Go 中的 slice 来创建多个测试用例:

func TestAdd(t *testing.T) {
        cases := []struct {
                p1 int
                p2 int
                want int
        } {
                {p1: 1, p2: 2, want: 3},
                {p1: 3, p2: 4, want: 7},
                {p1: 5, p2: 6, want: 11},
        }

        for _, tc := range cases {
                got := add(tc.p1, tc.p2)
                if got != tc.want {
                        t.Errorf("add was incorrect, got: %d, want: %d.", got, tc.want)
                }
        }
}

如何得到语句覆盖率

使用 go test -cover 命令:

go test -cover

Mockup 依赖

假设我们的 add() 方法在返回 x + y 的时候,需要再乘以一个系数,这个系数通过一个服务得到。

  • 这个服务对应的接口叫做 ParamServiceInterface
  • 这个服务的真正实现叫做 ParamServiceImpl
package algo

type ParamServiceInterface interface {
    getParam() int
}

type ParamServiceImpl struct {
    // 依赖的一些其他 service
}

func (impl ParamServiceImpl) getParam() int {
    // 复杂的计算逻辑
    // return ....
    return 1
}

func add(x int, y int, paramService ParamServiceInterface) int {
   return paramService.getParam() * (x + y)
}

我们在做单元测试的时候,无法得到实现类 ParamServiceImpl 来传入 add() 方法。
因此可以 Mock 出一个服务,代码如下:

type ParamServiceFake struct {
    param int
}

func (fake ParamServiceFake) getParam() int {
    return fake.param
}

func TestAdd(t *testing.T) {
        cases := []struct {
        p1 int
        p2 int
        fake ParamServiceFake
        want int
    } {
        {p1: 1, p2: 2, fake: ParamServiceFake{1}, want: 3},
        {p1: 3, p2: 4, fake: ParamServiceFake{2}, want: 14},
        {p1: 5, p2: 6, fake: ParamServiceFake{3}, want: 33},
    }

    for _, tc := range cases {
        got := add(tc.p1, tc.p2, tc.fake)
        if got != tc.want {
                    t.Errorf("add was incorrect, got: %d, want: %d.", got, tc.want)
            }
    }
}

引用:
testing - The Go Programming Language

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

推荐阅读更多精彩内容