Go語言開發（十九）、GoConvey測試框架

Go語言開發（十九）、GoConvey測試框架

一、GoConvey簡介

1、GoConvey簡介

GoConvey是一款針對Golang的測試框架，可以管理和運行測試用例，同時提供了豐富的斷言函數，并支持多種Web界面特性。
官方地址：
https://github.com/smartystreets/goconvey
安裝：
go get github.com/smartystreets/goconvey

2、GoConvey的特點

GoConvey支持 go test，可直接在終端窗口和瀏覽器上使用。GoConvey特點如下：
A、直接集成go test
B、巨大的回歸測試套件
C、可讀性強的色彩控制臺輸出
D、完全自動化的Web UI
E、測試代碼生成器

二、GoConvey測試用例編寫

1、GoConvey標準斷言

官方文檔：
https://github.com/smartystreets/goconvey/wiki
GoConvey自帶大量的標準斷言函數，可以通過So()使用。
（1）通用相等比較
So(thing1, ShouldEqual, thing2)
So(thing1, ShouldNotEqual, thing2)
So(thing1, ShouldResemble, thing2)
用于數組、切片、map和結構體的深度比較
So(thing1, ShouldNotResemble, thing2)
So(thing1, ShouldPointTo, thing2)
So(thing1, ShouldNotPointTo, thing2)
So(thing1, ShouldBeNil)
So(thing1, ShouldNotBeNil)
So(thing1, ShouldBeTrue)
So(thing1, ShouldBeFalse)
So(thing1, ShouldBeZeroValue)
（2）數值比較
So(1, ShouldBeGreaterThan, 0)
So(1, ShouldBeGreaterThanOrEqualTo, 0)
So(1, ShouldBeLessThan, 2)
So(1, ShouldBeLessThanOrEqualTo, 2)
So(1.1, ShouldBeBetween, .8, 1.2)
So(1.1, ShouldNotBeBetween, 2, 3)
So(1.1, ShouldBeBetweenOrEqual, .9, 1.1)
So(1.1, ShouldNotBeBetweenOrEqual, 1000, 2000)
So(1.0, ShouldAlmostEqual, 0.99999999, .0001)
帶容差比較，默認容差為0.0000000001
So(1.0, ShouldNotAlmostEqual, 0.9, .0001)
（3）數據集合比較
So([]int{2, 4, 6}, ShouldContain, 4)
So([]int{2, 4, 6}, ShouldNotContain, 5)
So(4, ShouldBeIn, ...[]int{2, 4, 6})
So(4, ShouldNotBeIn, ...[]int{1, 3, 5})
So([]int{}, ShouldBeEmpty)
So([]int{1}, ShouldNotBeEmpty)
So(map[string]string{"a": "b"}, ShouldContainKey, "a")
So(map[string]string{"a": "b"}, ShouldNotContainKey, "b")
So(map[string]string{"a": "b"}, ShouldNotBeEmpty)
So(map[string]string{}, ShouldBeEmpty)
So(map[string]string{"a": "b"}, ShouldHaveLength, 1)
支持map、切片、通道、字符串
（4）字符串比較
So("asdf", ShouldStartWith, "as")
So("asdf", ShouldNotStartWith, "df")
So("asdf", ShouldEndWith, "df")
So("asdf", ShouldNotEndWith, "df")
So("asdf", ShouldContainSubstring, "sd")
So("asdf", ShouldNotContainSubstring, "er")
So("adsf", ShouldBeBlank)
So("asdf", ShouldNotBeBlank)
（5）異常比較
So(func(), ShouldPanic)
So(func(), ShouldNotPanic)
So(func(), ShouldPanicWith, "") // or errors.New("something")
So(func(), ShouldNotPanicWith, "") // or errors.New("something")
（6）類型檢查
So(1, ShouldHaveSameTypeAs, 0)
So(1, ShouldNotHaveSameTypeAs, "asdf")
（7）時間比較
So(time.Now(), ShouldHappenBefore, time.Now())
So(time.Now(), ShouldHappenOnOrBefore, time.Now())
So(time.Now(), ShouldHappenAfter, time.Now())
So(time.Now(), ShouldHappenOnOrAfter, time.Now())
So(time.Now(), ShouldHappenBetween, time.Now(), time.Now())
So(time.Now(), ShouldHappenOnOrBetween, time.Now(), time.Now())
So(time.Now(), ShouldNotHappenOnOrBetween, time.Now(), time.Now())
So(time.Now(), ShouldHappenWithin, duration, time.Now())
So(time.Now(), ShouldNotHappenWithin, duration, time.Now())

2、測試用例編寫

官方推薦使用導入GoConvey的輔助包以減少冗余的代碼：
. "github.com/smartystreets/goconvey/convey"
GoConvey包導入在工程代碼中如下：

import (
   "testing"

   . "github.com/smartystreets/goconvey/convey"
)

每個單元測試的名稱需以?Test?開頭，并需要接收一個類型為?*testing.T?的參數。
每個測試用例需要使用Convey函數包裹起來，第一個參數為string類型的測試用例描述；第二個參數一般為?*testing.T；第三個參數為不接收任何參數也不返回任何值的函數（通常以閉包的形式書寫）。
Convey語句可以無限嵌套，以體現各個測試用例之間的關系，只有最外層的?Convey?需要傳入*testing.T類型變量，內層嵌套的Convey不需要傳入。

func TestAdd(t *testing.T) {
   Convey("將兩數相加", t, func() {
      So(Add(1, 2), ShouldEqual, 3)
   })
}

GoConvey提供了Convey/So的Skip宏，用于想忽略某些斷言操作但不想刪除或注釋的場景。
SkipConvey：表明相應的閉包函數將不被執行。
SkipSo：表明相應的斷言將不被執行。
當存在SkipConvey或SkipSo時，測試日志中會顯式打上"skipped"形式的標記：
當測試代碼中存在SkipConvey時，相應閉包函數中不管是否為SkipSo，都將被忽略，測試日志中對應的符號僅為一個"?"
當測試代碼Convey語句中存在SkipSo時，測試日志中每個So對應一個"?"或"?"，每個SkipSo對應一個"?"，按實際順序排列
不管存在SkipConvey還是SkipSo時，測試日志中都有字符串"{n} total assertions (one or more sections skipped)"，其中{n}表示測試中實際已運行的斷言語句數。

3、測試用例示例

Operator.go文件：

package Operator

import (
   "errors"
)

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

func Subtract(a, b int) int {
   return a - b
}

func Multiply(a, b int) int {
   return a * b
}

func Division(a, b int) (int, error) {
   if b == 0 {
      return 0, errors.New("Divisor is  0")
   }
   return a / b, nil
}

Operator_test.go文件：

package Operator

import (
   "testing"

   . "github.com/smartystreets/goconvey/convey"
)

func TestAdd(t *testing.T) {
   Convey("將兩數相加", t, func() {
      So(Add(1, 2), ShouldEqual, 3)
   })
}

func TestSubtract(t *testing.T) {
   Convey("將兩數相減", t, func() {
      So(Subtract(1, 2), ShouldEqual, -1)
   })
}

func TestMultiply(t *testing.T) {
   Convey("將兩數相乘", t, func() {
      So(Multiply(3, 2), ShouldEqual, 6)
   })
}

func TestDivision(t *testing.T) {
   Convey("將兩數相除", t, func() {

      Convey("除以非 0 數", func() {
         num, err := Division(10, 2)
         So(err, ShouldBeNil)
         So(num, ShouldEqual, 5)
      })

      Convey("除以 0", func() {
         _, err := Division(10, 0)
         So(err, ShouldNotBeNil)
      })
   })
}

4、定制斷言函數

So的函數原型如下：

func So(actual interface{}, assert assertion, expected ...interface{})
type assertion func(actual interface{}, expected ...interface{}) string

當assertion的返回值為""時表示斷言成功，否則表示失敗，GoConvey框架中的相關代碼為：

const (
   success                = ""
   needExactValues        = "This assertion requires exactly %d comparison values (you provided %d)."
   needNonEmptyCollection = "This assertion requires at least 1 comparison value (you provided 0)."
)

定制斷言函數如下：

func ShouldSummerBeComming(actual interface{}, expected ...interface{}) string {
   if actual == "summer" && expected[0] == "comming" {
      return ""
   } else {
      return "summer is not comming!"
   }
}

單元測試如下：

func TestSummer(t *testing.T) {
   Convey("TestSummer", t, func() {
      So("summer", ShouldSummerBeComming, "comming")
      So("winter", ShouldSummerBeComming, "comming")
   })
}

根據ShouldSummerBeComming的實現，閉包中第一個So將斷言成功，第二個So將斷言失敗。

三、測試結果查看

1、命令行測試結果查看

GoConvey兼容Go原生的單元測試，可以直接使用Go命令來執行測試。
在測試代碼目錄下運行go test命令：
?go test -v?
測試執行結果如下：

=== RUN   TestAdd

將兩數相加 ?

1 total assertion

--- PASS: TestAdd (0.00s)
=== RUN   TestSubtract

將兩數相減 ?

2 total assertions

--- PASS: TestSubtract (0.00s)
=== RUN   TestMultiply

將兩數相乘 ?

3 total assertions

--- PASS: TestMultiply (0.00s)
=== RUN   TestDivision

將兩數相除
除以非 0 數 ??
除以 0 ?

6 total assertions

--- PASS: TestDivision (0.00s)
PASS
ok     GoExample/GoConvey 0.002s

2、Web界面測試結果查看

查看goconvey用法
goconvey -h
-cover：開啟覆蓋率統計功能
-depth int：掃描目錄的深度，-1：掃描無窮深度，0：掃描當前目錄
-excludedDirs string：將某些目錄排除在掃描外，多個目錄使用逗號分割
-host string：指定開啟HTTP服務的主機
-launchBrowser：觸發自動開啟瀏覽器，默認為true
-port int：指定HTTP服務的端口
-workDir string：指定工作目錄，默認為當前目錄
在測試用例源碼目錄下運行goconvey：
goconvey -port 8081
在瀏覽器打開：
http://localhost:8081
結果如下：