Ginkgo：一款 BDD 的 Go 語言框架

單元測試關注點是程式碼邏輯單元，一般是一個物件或一個具體函數。我們可以編寫足夠的單元測試來確保程式碼的質量，當功能修改或程式碼重構時，充分的單元測試案例能夠給予我們足夠的信心。

單元測試之上是開發規格。在敏捷軟體開發中，有兩位常客：測試驅動開發（Test-Driven Development，TDD）和行為驅動開發（Behavior-driven development，BDD）。它們是實踐與技術，同時也是設計方法論。

TDD

TDD 的基本想法就是透過測試來推動整個開發的進行，原則就是在開發功能程式碼之前，先寫單元測試用例。包含以下五個步驟：

• #開發者先寫一些測試案例
• ##運行這些測試，但這些測試明顯都會失敗，因為測試案例中的業務邏輯還沒實作
• 實作程式碼細節
• 如果開發者順利實作程式碼的話，執行所有測試就會透過
• #對業務程式碼及時重構，如果新程式碼功能不正確的話，對應的測試檔案也會失敗

#當需要開發新功能時，重複上述步驟。流程如下圖所示

tdd-flowchart

有一個Github 倉庫比較有趣：learn-go-with-tests ，該倉庫旨在透過Go 學習TDD 。

BDD

TDD 重點偏向開發，透過測試案例來規範約束開發者寫出更高品質、bug更少的程​​式碼。而BDD則更著重設計，其要求在設計測試案例時對系統進行定義，倡導使用通用的語言將系統的行為描述出來，將系統設計和測試案例結合起來，以此為驅動進行開發工作。

BDD 衍生於 TDD，主要差異就是在於測試的描述上。 BDD 使用一種更簡單易懂的文字來描述測試案例，更關注需求的功能，而不是實際結果。

BDD 賦予的像閱讀句子一樣閱讀測驗的能力帶來對測驗認知上的轉變，有助於我們去考慮如何更好寫測驗。

Ginkgo

Ginkgo 是一個Go 語言的BDD 測試框架，旨在幫助開發者撰寫富有表現力的全方位測試。

Ginkgo 整合了Go 原生的<span style="font-size: 15px;">testing</span> 函式庫，這表示你可以透過<span style="font-size: 15px;">go test</span> 來執行Ginkgo 測試套件。同時，它與斷言和 mock 套件 testify 、富測試集 go-check 同樣相容。但 Ginkgo 建議的是搭配 gomega 函式庫一起使用。

下面，我們使用 Ginkgo 來感受一下 BDD 模式的測試程式碼。

下載

使用 <span style="font-size: 15px;">go get</span> 取得

#########

$ go get github.com/onsi/ginkgo/ginkgo
$ go get github.com/onsi/gomega/...

該指令取得ginkgo 並安裝<span style="font-size: 15px;">ginkgo</span> 可執行檔到##$GOPATH/bin<span style="font-size: 15px;"></span> 。

建立套件

建立gopher 函式庫#

$ cd path-to-package/gopher

在gopher.go<span style="font-size: 15px;"></span> 檔案中，有Gopher<span style="font-size: 15px;"></span># 結構體與校驗方法Validate<span style="font-size: 15px;"> </span> 如下

package gopher

import (
 "errors"
 "unicode/utf8"
)

type Gopher struct {
 Name   string
 Gender string
 Age    int
}

func Validate(g Gopher) error {
 if utf8.RuneCountInString(g.Name) < 3 {
  return errors.New("名字太短，不能小于3")
 }

 if g.Gender != "男" {
  return errors.New("只要男的")
 }

 if g.Age < 18 {
  return errors.New("岁数太小，不能小于18")
 }
 return nil
}

我們透過ginkgo bootstrap<span style="font-size: 15px;"></span> 指令，來初始化一個Ginkgo 測試套件。

$ ginkgo bootstrap
Generating ginkgo test suite bootstrap for gopher in:
        gopher_suite_test.go

此時在gopher.go<span style="font-size: 15px;"></span>## 同級目錄中，產生了 gopher_suite_test.go<span style="font-size: 15px;"></span> 文件，內容如下#

package gopher_test

import (
 "testing"

 . "github.com/onsi/ginkgo"
 . "github.com/onsi/gomega"
)

func TestGopher(t *testing.T) {
 RegisterFailHandler(Fail)
 RunSpecs(t, "Gopher Suite")
}

此时，我们就可以运行测试套件了，通过命令 <span style="font-size: 15px;">go test</span> 或 <span style="font-size: 15px;">ginkgo</span> 均可。

 $ go test
Running Suite: Gopher Suite
===========================
Random Seed: 1629621653
Will run 0 of 0 specs


Ran 0 of 0 Specs in 0.000 seconds
SUCCESS! -- 0 Passed | 0 Failed | 0 Pending | 0 Skipped
PASS
ok      ginkgo/gopher   0.018s

当然，空测试套件没有什么价值，我们需要在此套件下编写测试（Spec）用例。

我们可以在 <span style="font-size: 15px;">gopher_suite_test.go</span> 中编写测试，但是推荐分离到独立的文件中，特别是包中有多个需要被测试的源文件的情况下。

创建 Spec

执行 <span style="font-size: 15px;">ginkgo generate gopher</span>  可以生成一个 <span style="font-size: 15px;">gopher_test.go</span> 测试文件。

 $ ginkgo generate gopher
Generating ginkgo test for Gopher in:
  gopher_test.go

此时测试文件中的内容如下

package gopher_test

import (
 . "github.com/onsi/ginkgo"
)

var _ = Describe("Gopher", func() {

})

编写 Spec

我们基于此测试文件撰写实际的测试用例

package gopher_test

import (
 "ginkgo/gopher"
 . "github.com/onsi/ginkgo"
 "github.com/onsi/gomega"
)

func mockInputData() ([]gopher.Gopher, error) {
 inputData := []gopher.Gopher{
  {
   Name:   "菜刀",
   Gender: "男",
   Age:    18,
  },
  {
   Name:   "小西瓜",
   Gender: "女",
   Age:    19,
  },
  {
   Name:   "机器铃砍菜刀",
   Gender: "男",
   Age:    17,
  },
  {
   Name:   "小菜刀",
   Gender: "男",
   Age:    20,
  },
 }
 return inputData, nil
}

var _ = Describe("Gopher", func() {

 BeforeEach(func() {
  By("当测试不通过时，我会在这里打印一个消息 【BeforeEach】")
 })

 inputData, err := mockInputData()

 Describe("校验输入数据", func() {

  Context("当获取数据没有错误发生时", func() {
   It("它应该是接收数据成功了的", func() {
    gomega.Expect(err).Should(gomega.BeNil())
   })
  })

  Context("当获取的数据校验失败时", func() {
   It("当数据校验返回错误为：名字太短，不能小于3 时", func() {
    gomega.Expect(gopher.Validate(inputData[0])).Should(gomega.MatchError("名字太短，不能小于3"))
   })

   It("当数据校验返回错误为：只要男的 时", func() {
    gomega.Expect(gopher.Validate(inputData[1])).Should(gomega.MatchError("只要男的"))
   })

   It("当数据校验返回错误为：岁数太小，不能小于18 时", func() {
    gomega.Expect(gopher.Validate(inputData[2])).Should(gomega.MatchError("岁数太小，不能小于18"))
   })
  })

  Context("当获取的数据校验成功时", func() {
   It("通过了数据校验", func() {
    gomega.Expect(gopher.Validate(inputData[3])).Should(gomega.BeNil())
   })
  })
 })

 AfterEach(func() {
  By("当测试不通过时，我会在这里打印一个消息 【AfterEach】")
 })
})

可以看到，BDD 风格的测试案例在代码中就被描述地非常清晰。由于我们的测试用例与预期相符，执行 <span style="font-size: 15px;">go test</span> 执行测试套件会校验通过。

 $ go test
Running Suite: Gopher Suite
===========================
Random Seed: 1629625854
Will run 5 of 5 specs

•••••
Ran 5 of 5 Specs in 0.000 seconds
SUCCESS! -- 5 Passed | 0 Failed | 0 Pending | 0 Skipped
PASS
ok      ginkgo/gopher   0.013s

读者可自行更改数据致测试不通过，你会看到 Ginkgo 将打印出堆栈与错误描述性信息。

總結

TDD 和 BDD 是敏捷開發中常被提及的方法論。與TDD相比，BDD 透過編寫 行為和規範 來驅動軟體開發。這些行為和規範在程式碼中體現於更 」繁瑣「 的描述資訊。

關於 BDD 的本質，有另一個表達方式：BDD 幫助開發人員設計軟體，TDD 幫助開發人員測試軟體。

Ginkgo 是 Go 語言中非常優秀的 BDD 框架，它透過 DSL 語法（Describe/Context/It）有效地幫助開發者組織與編排測試案例。本文只是展示了 Ginkgo 非常簡單的用例，權當是拋磚引玉。

讀者在使用Ginkgo 過程中，需要理解它的執行生命週期， 重點包括 <span style="font-size: 15px;">It、Context、Describe、BeforeEach、AfterEach、JustBeforeEach、 BeforeSuite、AfterSuite、By、Fail</span>  這些模組的執行順序與語意邏輯。

Ginkgo 有許多的功能本文並未涉及，例如非同步測試、基準測試、持續整合等強大的支援。其倉庫位於 https://github.com/onsi/ginkgo ，同時提供了英文版與中文版使用文檔，讀者可以藉此了解更多 Ginkgo 資訊。

最後，K8s 專案中也使用了Ginkgo 框架，用於編寫其端對端(End to End，E2E) 測試用例，值得借鏡學習。

以上是Ginkgo：一款 BDD 的 Go 語言框架的詳細內容。更多資訊請關注PHP中文網其他相關文章！