foo.go
[java]
// CopyRight 2013 The Go Author. All Right reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE fifle.

/*
Package foo implements a set of simple mathematical functions. These comments are for
demonstration purpose only. Nothing more.

If you have any questions,please don’t hesitate to add yourself to
golang-uns@googlegroups.com.

you can alse visit golang.org for full Go documentation.
*/

package foo

import (
"fmt"
)

// Foo compares the two input values and retrens the larger
// Value, If the two values are equal, return 0.
func Foo(a, b int) (ret int, err error) {
if a > b {
return a, nil
} else {
return b, nil
}

return 0, nil
}

// BUG(jack): #1: i’m sorry but this code has an issue to be solved.

// BUG(tom): #2: An issue assigned to anothoer person.

[/java]
生成文档摘要
[java]go doc foo.go[/java]
[java]PACKAGE DOCUMENTATION

package foo
import "D:\gotest\src"

FUNCTIONS

func Foo(a, b int) (ret int, err error)
Foo compares the two input values and retrens the larger Value, If the
two values are equal, return 0.

BUGS

#1: i’m sorry but this code has an issue to be solved.

#2: An issue assigned to anothoer person.
[/java]
为了方便查看，也可以通过浏览器查看
[java]godoc -http=:9090[/java]
然后输入 http://localhost:9090/pkg/foo　即可

Go本身提供了一套轻量级的测试框架．符合规则的测试代码会在运行测试时被自动识别并执行．单元测试源文件的命名规则如平衡点：在需要测试的包下面创建以”_test”结尾的go文件,开如[^.]*_test.go

Go单元测试函数分为两在类．功能测试函数和性能测试函数，分别以Test和Benchmark为函数名前缀并以*testing.T 和 *testing.B 为单一参数的函数。

func TestAdd1(t *testing.T)
func BenchmarkAdd1(t *testing.T)

测试工具会根据函数中的实际执行动作得到不同的测试结果。

功能测试函数会根据测试代码执行过程中是否发生错误来反馈结果；
性能测试函数仅仅打印出来测试所花费时间，用来判断程序性能；

准备

新建一个文件，命名为 go_test.go

package go_test

import "testing"

func Add(a, b int) int {
    return a + b
}

功能测试

在go_test.go文件里添加以下代码

func TestAdd1(t *testing.T) {
    r := Add(1, 2)
    if r != 2 { //这里为了测试，写成2
        t.Errorf("Add(1,2) failed. Got %d, expected 3.", r)
    }
}

执行功能单元测试非常的简单，直接执行

go test

输出以下内容

--- FAIL: TestAdd1 (0.00s)
go_test.go:12: Add(1,2) failed. Got 3, expected 3.
FAIL
exit status 1
FAIL gotest 0.130s

可以看到输出具体出错的位置为第12行，控制台并打印出了用户定义的错误信息。最后的FAIL表示测试未通过，如果为 ok 的话，则为通过。我们修正问题后再次执行结果为

PASS
ok gotest 0.146s

如果你在同一个文件里添加了多个测试函数的话，直接执行 go test，发现只要有一个函数未通过，则打印结果只有一个FAIL，对用户不太友好，这时可以使用 -v 参数 go test -v，表示输出每个功能函数的详情的信息。

=== RUN TestAdd1
--- FAIL: TestAdd1 (0.00s)
go_test.go:12: Add(1,2) failed. Got 3, expected 3.
FAIL
exit status 1
FAIL gotest 0.208s

=== RUN 行表示执行的函数
— FAIL 行表示上行执行的函数结果，如果测试通过则为 PASS
第三行 表示FAIL后的打印错误信息，如果函数测试通过是没有这一行的
第四行 表示本次测试的结果，只要有一个函数未通过，就为FAIL
如果有多个函数的话，则重复打印前两行。

*testing.T 中有一个 t.Errorf() 函数打印一些错误信息后中止测试。

说明：

对于 go test 命令如果一个文件中有一个方法未通过，则直接输出 FAIL，如果想知道具体哪个方法未通过，需要使用 -v 参数来定位。

性能测试

上面我们介绍了功能测试，再来看下性能测试。可以与功能测试在同一个文件中，默认情况下go test 并不会执行Benchmark测试，必须使用参数 ” -bench <pattern>” 指定性能测试函数。在go_test.go文件中添加以下函数。(记得先修正功能测试未通过的问题)

func BenchmarkAdd1(b *testing.B) {
for i := 0; i < b.N; i++ {
    Add(1, 2)
}
}

我们可以看出，性能测试与功能测试代码相比，最大的区别在于代码里的这个for循环，循环b.N次．写这个for循环的原因是为了能够让测试运行足够长的时间便于进行平均运行时间的计算．如果测试代码中一些准备工作的时间太长，我们也可以这样处理以明确排除这些准备工作所花费时间对于性能测试的时间影响：

func BenchmarkAdd1(b *testing.B) {
    b.StopTimer()
    DoPreparation()
    b.StartTimer()

    for i := 0; i < b.N; i++ { //b.N，测试循环次数 
Add(1, 2) 
} 
}

性能单元的执行与功能测试一样简单，只不过调用时需要-test.bench参数而已,具体代码如下所示：

$go test -bench=".*"
goos: darwin
goarch: amd64
pkg: gotest
BenchmarkAdd1-4         1000000000               0.367 ns/op
PASS
ok      gotest  0.698s

结果解释

goos: darwin 表示平台系统，这里是mac
goarch: amd64 表示64位系统
pkg: 表示包名
BenchmarkAdd1-4: 表示测试的函数名称，-后面的数字表示cpu个数
1000000000: 表示共执行了 1000000000 次
0.367 ns/op: 表示每次执行耗时0.267纳秒，这里肯定是越小越好

另外对性能测试还支持一些其它的参数

• benchmem：输出内存分配统计
• benchtime：指定测试时间
• cpu：指定GOMAXPROCS
• timeout：超时限制

$ go test -v -bench=. -cpu=2 -benchtime="3s" -timeout="5s" -benchmem
=== RUN TestAdd1
--- PASS: TestAdd1 (0.00s)
goos: darwin
goarch: amd64
pkg: gotest
BenchmarkAdd1-2 1000000000 0.325 ns/op 0 B/op 0 allocs/op
PASS
ok gotest 0.460s

结果解释

BenchmarkAdd1-2: 测试函数名称，后面的2表示2个cpu线程
0 B/op:表示每次执行分配的内存（字节）
0 allocs/op：表示每次执行分配了多少次对象

从上面可以看出对于功能测试的命令为 go test,而对于性能测试则是 go test-test.bench add.go (在调用的时候添加 -test.bench参数而已)

go test 的两种运行模式：

目录模式：当没有指定包参数时，如go test 或者 go test -v, 则在用户当前所在目录查找单元测试文件并执行，最后打印结果。这种模式下缓存功能是禁用的。

包列表板式：显示指定了包名，如(‘go test math’, ‘go test ./…’, and even ‘go test .’)

-run regex：指定要执行的测试函数

$go test simplemath
PASS
ok simplemath 0.013s

性能分析工具pprof

对于性能测试结果只是程序的最终性能报告，但对于系统中性能瓶颈在哪个地方却无法给出，所以就引出另一个问题，如何对性能进行精确定位。这就需要用到go tool了

这里可以使用　go test -v -bench=”.*” -cpuprofile=cpu.prof -c`　(参考：http://www.cnblogs.com/yjf512/archive/2013/01/18/2865915.html)

cpuprofile是表示生成的cpu profile文件

-c是生成可执行的二进制文件，这个是生成状态图必须的，它会在本目录下生成可执行文件mymysql.test

然后使用go tool pprof工具

go tool pprof mymysql.test cpu.prof

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

文件mymath.go

package mymath

func Add(a, b int) int {
	return a + b
}
func Max(a, b int) (ret int) {
	ret = a
	if b < a {
		ret = b
	}
	return
}

测试文件 mymath_test.go（所有测试文件都必须以*_test.go结尾） Continue reading →