Go语言单元测试

1. 概述

单元测试(unit testing) 是指对软件 中的 最小可测试单元进行检查和验证

Go语言自身提供了一套轻量级的单元测试和性能测试系统,符合规则的测试代码会在运行测试时被自动识别执行

2. 基础测试

看看一个基本的测试案例是怎么写的

文件结构如下

|
|_main.go
|_utils
|___func1.go
|___func1_test.go
|___sham_test.go

func1.go

package utils

func AddTwoNums(x, y int) (sum int) {
    sum = x + y
    return
}

func AddUp(x int) int {
    if x < 2 {
        return x
    }
    sum := 0
    for i := 0; i <= x; i++ {
        sum += i
    }
    return sum
}

main.go

package main

import (
    "utils"
    "fmt"
)

func main(){
     // 调用函数AddtwoNums
    sum := utils.AddTwoNums(9,8)
    fmt.Println(sum) // 17
    // 调用函数AddUp
    sum1 := utils.AddUp(100)
    fmt.Println(sum1) // 5050
}

接下来我们看看测试用例怎么写

func1_test.go

package utils

import (
    "testing" // 导入testing包
)

// AddTwoNums的测试用例1
// 测试AddTwoNums函数 结果正确
func TestAddTwoNums1(t *testing.T) {
    sum := AddTwoNums(9,8)
    if sum != 17{
        t.Error("AddTwoNums is failed",sum)
    }
}
// AddTwoNums的测试用例2
// 测试AddTwoNums函数 结果错误
func TestAddTwoNums2(t *testing.T) {
    sum := AddTwoNums(100,100)
    if sum != 2000{
        t.Error("AddTwoNums is failed",sum)
    }
}
// AddUp的测试用例
// 测试AddUp函数
func TestAddUp(t *testing.T) {
    sum := AddUp(100)
    if sum != 5050{
        t.Error("AddUp is failed",sum)
    }
}

sham_test.go

package utils

import "testing"

func TestFunc1(t *testing.T) {
    t.Log("TestFunc1 run")
}
func TestFunc2(t *testing.T) {
    info := "TestFunc12 run"
    t.Log(info + "===test log the method name `Log`")
    t.Logf("output : %s", info+"===test log the method name `Logf`")
    t.Error(info + "===test log the method name `Error`")
    t.Errorf("output : %s", info+"===test log the method name `Errorf`")
    t.Fatal(info + "===test log the method name `Fatal`")
    t.Fatalf("output : %s", info+"===test log the method name `Fatalf`")
}

我们启动单元测试

使用的命令是 go test

PS:要查看这个命令这么使用 ,可以查看帮助文档 在命令行中执行 go help testflag

执行该目录下的所有测试用例

-v 显示详细的流程

go test -v

=== RUN   TestAddTwoNums1
--- PASS: TestAddTwoNums1 (0.00s)
=== RUN   TestAddTwoNums2
--- FAIL: TestAddTwoNums2 (0.00s)
    func1_test.go:20: AddTwoNums is failed 200
=== RUN   TestAddUp
--- PASS: TestAddUp (0.00s)
=== RUN   TestFunc1
--- PASS: TestFunc1 (0.00s)
    sham_test.go:6: TestFunc1 run
=== RUN   TestFunc2
--- PASS: TestFunc2 (0.00s)
    sham_test.go:9: TestFunc12 run
FAIL
exit status 1
FAIL    GoNote/chapter10/demo3/utils    0.386s

执行指定的单元测试用例

-run 运行需要单独执行的测试用例

go test -v -run TestAddUp

=== RUN   TestAddUp
--- PASS: TestAddUp (0.00s)
PASS
ok      GoNote/chapter10/demo3/utils    0.392s

执行测试文件中的所有测试用例

go test -v sham.go

=== RUN   TestFunc1
--- PASS: TestFunc1 (0.00s)
    sham_test.go:6: TestFunc1 run
=== RUN   TestFunc2
--- FAIL: TestFunc2 (0.00s)
    sham_test.go:10: TestFunc12 run===test log the method name `Log`
    sham_test.go:11: output : TestFunc12 run===test log the method name `Logf`
    sham_test.go:12: TestFunc12 run===test log the method name `Error`
    sham_test.go:13: output : TestFunc12 run===test log the method name `Errorf`
    sham_test.go:14: TestFunc12 run===test log the method name `Fatal`
FAIL
FAIL    command-line-arguments  0.383s

通过上面的例子,总结如下

  • 测试用例文件名必须以 _test 结尾
  • 测试用例函数名必须以 Test开头
  • 测试用例函数的形参必须是 *testing.T 类型
  • 单个测试文件中可以有多个测试用例
  • 可以使用多个测试用例测试同一个内容
  • 测试用例函数不需要放在 main 函数也能执行
  • PASS 表示测试用例运行成功 , FAIL 表示测试用例运行失败

单元测试框架提供的日志方法

方法名 含义
Log 打印日志
Logf 格式化打印日志
Error 打印错误日志, 将测试函数标记为失败,但是继续运行
Errorf 格式化打印错误日志 ,将测试函数标记为失败,但是继续运行
Fatal 打印致命错误日志,将测试函数标记为失败并停止执行
Fatalf 格式化打印致命错误日志,将测试函数标记为失败并停止执行

2.1 提示 build failed ?

PS : 在执行测试文件的时候可能会出现类似下面的情况

$ go test func1_test.go
# command-line-arguments [command-line-arguments.test]
.\func1_test.go:10:9: undefined: AddTwoNums
.\func1_test.go:19:9: undefined: AddTwoNums
.\func1_test.go:28:9: undefined: AddUp
FAIL    command-line-arguments [build failed]

我们测试的两个函数 AddTwoNumsAddUp 提示未定义, 最后提示 命令行参数处理 构建失败

如何解决呢?

执行测试命令带上原文件即可

$ go test -v func1_test.go func1.go
=== RUN   TestAddTwoNums1
--- PASS: TestAddTwoNums1 (0.00s)
=== RUN   TestAddTwoNums2
--- FAIL: TestAddTwoNums2 (0.00s)
   func1_test.go:21: AddTwoNums is failed 200
=== RUN   TestAddUp
--- PASS: TestAddUp (0.00s)
FAIL
FAIL    command-line-arguments  0.336s

3. 基准测试

基准测可以测试一段程序的运行性能及耗费CPU的程度

写法上和测试用例的类似

package utils

import (
    "fmt"
    "testing"
)

// 基准测试 demo
func BenchmarkDemo1(b *testing.B) {
    var n int
    // b.N 是测试框架提供
    for i := 0; i < b.N; i++ {
        n++
    }

}
func BenchmarkDemo2(b *testing.B) {

}

// 基准测试 测试函数AddTwoNums
func BenchmarkAddTwoNums(b *testing.B) {
    for i := 0; i < b.N; i++ {
        sum := AddTwoNums(i, i)
        fmt.Sprintf("%d",sum)
    }
}

执行测试文件

$ go test -v -bench=. -benchmem -benchtime=10s bm_test.go func1.go
goos: windows
goarch: amd64
BenchmarkDemo1-4                10000000000              0.28 ns/op            0 B/op          0 allocs/op
BenchmarkDemo2-4                10000000000              0.00 ns/op            0 B/op          0 allocs/op
BenchmarkAddTwoNums-4           100000000              112 ns/op              20 B/op          2 allocs/op
PASS
ok      command-line-arguments  14.575s

命令说明

-bench=. 参数表示运行 bm_test.go 文件中所有的基准测试 ,如果想单独运行某个基准测试带上对应的名称即可,例如 -bench=BenchmarkAddTwoNums

-benchmem 参数表示显示内存分配情况

-benchtime= 参数表示自定义测试时间

测试结果说明

-4 表示4个CPU线程执行

ns/op 表示每一个操作消耗多少时间,单位是 纳秒ns

B/op 表示每一次操作需要分配的字节数

allocs/op 表示每次执行分配了多少次

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

推荐阅读更多精彩内容