使用gogiven实现YATSPEC风格的BDD测试

gogiven是一个Go语言的BDD测试框架，它采用了类似YATSPEC的Given-When-Then风格来编写测试用例。下面我将介绍如何使用gogiven框架编写行为驱动开发(BDD)风格的测试。

安装gogiven

首先安装gogiven包：

go get github.com/corbym/gogiven

基本用法示例

下面是一个简单的gogiven测试示例：

package example

import (
	"testing"
	"github.com/corbym/gogiven"
	. "github.com/corbym/gogiven/base"
)

func TestAddition(t *testing.T) {
	gogiven.Given(t, someTestContextSetup).
		When(func(testContext TestContext, when When) {
			// 执行操作
			result := add(2, 3)
			when.Result = result
		}).
		Then(func(testContext TestContext, then Then) {
			// 验证结果
			then.Expect("result should be 5").
				ThatInt(testContext.Result().(int)).
				IsEqualTo(5)
		})
}

func someTestContextSetup(testContext TestContext) {
	// 测试前的初始化设置
	testContext.Title("Addition Test")
}

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

关键组件说明

1. Given: 设置测试的初始状态和上下文
2. When: 执行被测操作
3. Then: 验证结果是否符合预期

更复杂的示例

下面是一个更完整的示例，展示更多gogiven的功能：

package shoppingcart

import (
	"testing"
	"github.com/corbym/gogiven"
	. "github.com/corbym/gogiven/base"
)

type ShoppingCart struct {
	items map[string]int
	total int
}

func TestShoppingCart(t *testing.T) {
	gogiven.Given(t, func(testContext TestContext) {
		testContext.Title("Shopping Cart Test")
		testContext.Given("an empty shopping cart", func(given Given) {
			cart := &ShoppingCart{
				items: make(map[string]int),
				total: 0,
			}
			given.Value("cart", cart)
		})
	}).
	When(func(testContext TestContext, when When) {
		cart := testContext.Value("cart").(*ShoppingCart)
		cart.items["apple"] = 2
		cart.items["banana"] = 3
		cart.total = 5
	}).
	Then(func(testContext TestContext, then Then) {
		cart := testContext.Value("cart").(*ShoppingCart)
		
		then.Expect("cart should have 2 apples").
			ThatInt(cart.items["apple"]).
			IsEqualTo(2)
			
		then.Expect("cart should have 3 bananas").
			ThatInt(cart.items["banana"]).
			IsEqualTo(3)
			
		then.Expect("total items should be 5").
			ThatInt(cart.total).
			IsEqualTo(5)
	})
}

高级特性

1. 表格驱动测试:

func TestTableDrivenAddition(t *testing.T) {
	testCases := []struct {
		a, b, expected int
	}{
		{1, 1, 2},
		{2, 3, 5},
		{0, 0, 0},
		{-1, 1, 0},
	}

	for _, tc := range testCases {
		gogiven.Given(t, func(testContext TestContext) {
			testContext.Title("Addition of %d and %d", tc.a, tc.b)
		}).
		When(func(testContext TestContext, when When) {
			when.Result = add(tc.a, tc.b)
		}).
		Then(func(testContext TestContext, then Then) {
			then.Expect("result should be %d", tc.expected).
				ThatInt(testContext.Result().(int)).
				IsEqualTo(tc.expected)
		})
	}
}

1. 异步测试:

func TestAsyncOperation(t *testing.T) {
	gogiven.Given(t, nil).
		When(func(testContext TestContext, when When) {
			done := make(chan bool)
			
			go func() {
				// 模拟异步操作
				time.Sleep(100 * time.Millisecond)
				when.Result = 42
				done <- true
			}()
			
			<-done
		}).
		Then(func(testContext TestContext, then Then) {
			then.Expect("async result should be 42").
				ThatInt(testContext.Result().(int)).
				IsEqualTo(42)
		})
}

生成HTML报告

gogiven可以生成漂亮的HTML测试报告：

func TestMain(m *testing.M) {
	// 配置HTML报告生成
	gogiven.GenerateTestOutput()
	os.Exit(m.Run())
}

运行测试后，会在目录下生成testoutput文件夹，包含HTML格式的测试报告。

最佳实践

1. 保持Given-When-Then各部分职责单一
2. 使用有意义的测试标题和期望描述
3. 对于复杂场景，可以拆分多个Given块
4. 利用表格驱动测试覆盖多种情况
5. 合理使用HTML报告分析测试结果

gogiven框架通过其YATSPEC风格的语法，使得Go语言测试代码更加易读和易于维护，特别适合团队协作和复杂业务逻辑的测试。