Golang 行为驱动开发(BDD)测试框架 testcase 使用指南

testcase 是一个轻量级的 Golang BDD 测试框架，它提供了行为驱动开发的测试风格，同时保持了 Go 测试工具链的兼容性。

安装 testcase

go get github.com/adamluzsi/testcase

基本使用示例

简单测试案例

package example

import (
	"testing"
	"github.com/adamluzsi/testcase"
)

func TestAddition(t *testing.T) {
	s := testcase.NewSpec(t)

	s.Describe("Addition", func(s *testcase.Spec) {
		var (
			a = s.Let("a", func(t *testcase.T) interface{} { return 0 })
			b = s.Let("b", func(t *testcase.T) interface{} { return 0 })
		)

		act := func(t *testcase.T) int {
			return a.Get(t).(int) + b.Get(t).(int)
		}

		s.When("a is 1 and b is 2", func(s *testcase.Spec) {
			a.Let(s, func(t *testcase.T) interface{} { return 1 })
			b.Let(s, func(t *testcase.T) interface{} { return 2 })

			s.Then("it should return 3", func(t *testcase.T) {
				t.Must.Equal(3, act(t))
			})
		})

		s.When("a is 0 and b is 0", func(s *testcase.Spec) {
			s.Then("it should return 0", func(t *testcase.T) {
				t.Must.Equal(0, act(t))
			})
		})
	})
}

更复杂的 BDD 示例

package user_test

import (
	"testing"
	"github.com/adamluzsi/testcase"
)

type User struct {
	Name string
	Age  int
}

func TestUserValidation(t *testing.T) {
	s := testcase.NewSpec(t)

	s.Describe("User validation", func(s *testcase.Spec) {
		var (
			user = s.Let("user", func(t *testcase.T) interface{} {
				return &User{
					Name: t.Random.String(),
					Age:  t.Random.IntBetween(18, 99),
				}
			})
			getUser = func(t *testcase.T) *User {
				return user.Get(t).(*User)
			}
		)

		validate := func(t *testcase.T) error {
			u := getUser(t)
			if u.Name == "" {
				return errors.New("name cannot be empty")
			}
			if u.Age < 18 {
				return errors.New("age must be at least 18")
			}
			return nil
		}

		s.When("user is valid", func(s *testcase.Spec) {
			s.Then("it should pass validation", func(t *testcase.T) {
				t.Must.Nil(validate(t))
			})
		})

		s.When("name is empty", func(s *testcase.Spec) {
			user.Let(s, func(t *testcase.T) interface{} {
				u := getUser(t)
				u.Name = ""
				return u
			})

			s.Then("it should fail validation", func(t *testcase.T) {
				t.Must.NotNil(validate(t))
				t.Must.Contain(validate(t).Error(), "name cannot be empty")
			})
		})

		s.When("age is under 18", func(s *testcase.Spec) {
			user.Let(s, func(t *testcase.T) interface{} {
				u := getUser(t)
				u.Age = 17
				return u
			})

			s.Then("it should fail validation", func(t *testcase.T) {
				t.Must.NotNil(validate(t))
				t.Must.Contain(validate(t).Error(), "age must be at least 18")
			})
		})
	})
}

testcase 主要特性

1. Let 和 LetValue：用于定义测试变量，支持惰性求值

   var count = s.Let("count", func(t *testcase.T) interface{} { return 0 })
   var name = s.LetValue("name", "Alice")
   

2. Before 和 After 钩子：测试前后的准备和清理工作

   s.Before(func(t *testcase.T) {
       // 测试前准备工作
   })
   
   s.After(func(t *testcase.T) {
       // 测试后清理工作
   })
   

3. 随机测试数据生成：

   t.Random.String() // 随机字符串
   t.Random.Int()    // 随机整数
   t.Random.ElementFromSlice([]string{"a", "b", "c"}) // 从切片中随机选择
   

4. 并行测试支持：

   s := testcase.NewSpec(t)
   s.Test("parallel test", func(t *testcase.T) {
       t.Parallel()
       // 测试代码
   })
   

5. 表格驱动测试：

   s.TestTable("addition cases", func(t *testcase.T) {
       type TestCase struct {
           A, B, Expected int
       }
       return []TestCase{
           {A: 1, B: 2, Expected: 3},
           {A: 0, B: 0, Expected: 0},
           {A: -1, B: 1, Expected: 0},
       }
   }, func(t *testcase.T, tc TestCase) {
       t.Must.Equal(tc.Expected, tc.A+tc.B)
   })
   

最佳实践

1. 使用 Describe/When/Then 结构组织测试，使测试意图更清晰
2. 使用 Let 定义测试变量，避免测试间的状态污染
3. 为测试案例和断言编写清晰的描述
4. 利用随机测试数据提高测试覆盖率
5. 合理使用 Before/After 钩子管理测试资源

testcase 框架结合了 BDD 的清晰表达能力和 Go 测试工具链的高效性，是 Go 项目中实施行为驱动开发的优秀选择。