安利一个好用的Golang单元测试框架：gocheck

Golang下如何写单元测试？官方提供的testing package略显简陋，不过好在我们有Gocheck。

什么是好的单元测试？

在进入正题前，先来温习下前人总结的单元测试几条原则：
http://www.atatech.org/articles/2523

1   单元测试应该在最低的功能/参数上验证程序的正确性
...
3    单元测试过后，机器状态保持不变
...
6    独立性，单元测试的运行/通过/失败不依赖于别的测试，可以人为构造数据，以保持单元测试的独立性。

好的单元测试，应该遵循上面的原则；好的单元测试框架，应该为我们践行这些原则提供方便。

gocheck，简单好用

gocheck官网：http://labix.org/gocheck

Golang官方的testing package算是很弱的了：居然连assert都不支持。Gocheck在testing库之上，丰富了很多功能，带我们脱离Golang官方测试框架下无尽的“if…else…"苦海。尤其好用的特性包括：

assert断言 + 丰富的判断动词: deep multi-type 对比, 字符串比较(甚至支持正则匹配！)。
按suite组织测试用例，支持suite级别的setup()和teardown()。
创建、删除临时文件/目录。

示例1：文件操作相关的单元测试

“单元测试过后，机器状态保持不变”的原则告诉我们，如果单元测试要读写文件，单元测试结束后要清理创建的临时文件。

gocheck可以创建一个临时目录，在测试结束时自动删除它，省去了手动清理的步骤。

示例：

package hello_testimport ("testing""io/ioutil""io". "gopkg.in/check.v1"
)const txt = "adfagaggafaf"// Hook up gocheck into the "go test" runner.
func Test(t *testing.T) { TestingT(t) }type MySuite struct {dir string   // 测试用的临时目录f   string   // 测试用的临时文件
}var _ = Suite(&MySuite{})// Setupsuite 准备测试用的临时文件
func (s *MySuite) SetUpSuite(c *C) {dir := c.MkDir()    // Suite结束后会自动销毁c.MkDir()创建的目录tmpfile, err := ioutil.TempFile(dir, "")if err != nil {c.Errorf("Fail to create test file: %v\n", tmpfile.Name(), err)}err = WriteFile(tmpfile.Name(), txt)if err != nil {c.Errorf("Fail to prepare test file.%v\n", tmpfile.Name(), err)}s.dir = dirs.f = tmpfile.Name()
}func (s *MySuite) TestFoo(c *C) {// ... 实际测试代码c.Assert(bkpName, Matches, s.f+".ops_agent_bkp.+")
}

示例2：Mock web api相关的单元测试

“独立性”的原则告诉我们，对于需要调用外部api的功能，最好mock数据。利用gocheck的SetUpSuite()和TearDownSuite()方法，可以新建一个http test server，结束时关闭它。

示例：

package hello_testimport ("fmt""net/http""net/http/httptest""testing". "gopkg.in/check.v1"
)const (resp1 = `{"data" : {"cluster" : "*****","hostname" : "xxxxx"},"err_code" : 0,"err_msg" : ""
}
`resp2 = `{"data" : [{"hostname" : "e18h13551.XXX","ip" : "100.22.33.44","state" : "GOOD"},{"hostname" : "dddd","ip" : "101.14.12.55","state" : "GOOD"}],"err_code" : 0,"err_msg" : ""
}
`
)// Hook up gocheck into the "go test" runner.
func Test(t *testing.T) { TestingT(t) }type MySuite struct {ts *httptest.Server
}func (s *MySuite) SetUpSuite(c *C) {h := http.NewServeMux()h.HandleFunc("/machine", func(w http.ResponseWriter, r *http.Request) {fmt.Fprintln(w, resp1)})h.HandleFunc("/batch", func(w http.ResponseWriter, r *http.Request) {fmt.Fprintln(w, resp2)})s.ts = httptest.NewServer(h)
}func (s *MySuite) TearDownSuite(c *C) {s.ts.Close()
}var _ = Suite(&MySuite{})func (s *MySuite) TestFoo(c *C) {// 实际测试代码....clusterName, err := getClusterName(s.ts.URL, "/machine")c.Assert(err, IsNil)c.Assert(clusterName, Equals, "MiniLVSCluster-5e87-2384205713506559")
}

其他

Gocheck其他好用的特性，比如强大的checker 就不在此列举。可以在官网上翻翻，让写单元测试更简单。