Golang BDD兼容的分支测试框架插件库biff的使用

简介

Biff是一个基于嵌套用例或替代方案的分支框架(BIFurcation Framework)。您可以利用变量作用域使测试更简单、更易读。它是验收和用例测试的良好选择，提供BDD风格的输出。

快速开始

以下是一个完整的biff使用示例：

package main

import (
	"github.com/fulldump/biff"
)

// 示例服务
type MyService struct {
	users map[string]*User
}

type User struct {
	Email    string
	Password string
}

func NewMyService() *MyService {
	return &MyService{
		users: make(map[string]*User),
	}
}

func (s *MyService) RegisterUser(email, password string) *User {
	user := &User{Email: email, Password: password}
	s.users[email] = user
	return user
}

func (s *MyService) Login(email, password string) *User {
	user, exists := s.users[email]
	if !exists || user.Password != password {
		return nil
	}
	return user
}

func main() {
	// Biff测试示例
	biff.Alternative("Instance service", func(a *biff.A) {

		s := NewMyService()

		a.Alternative("Register user", func(a *biff.A) {

			john := s.RegisterUser("john@email.com", "john-123")
			a.AssertNotNil(john)

			a.Alternative("Bad credentials", func(a *biff.A) {
				user := s.Login(john.Email, "bad-password")
				a.AssertNil(user)

			}).Alternative("Login", func(a *biff.A) {
				user := s.Login(john.Email, john.Password)
				a.AssertEqual(user, john)
			})

		})
	})
}

测试输出示例：

=== RUN   TestExample
Case: Instance service
Case: Register user
    john is &example.User{Email:"john@email.com", Password:"john-123"}
Case: Bad credentials
    user is <nil>
-------------------------------
Case: Instance service
Case: Register user
    john is &example.User{Email:"john@email.com", Password:"john-123"}
Case: Login
    user is &example.User{Email:"john@email.com", Password:"john-123"}
-------------------------------
Case: Instance service
Case: Register user
    john is &example.User{Email:"john@email.com", Password:"john-123"}
-------------------------------
Case: Instance service
-------------------------------
--- PASS: TestExample (0.00s)
PASS

错误定位

当出现错误时，Biff会直接定位到出错的行：

Case: Instance service
Case: Register user
    john is &example.User{Email:"john@email.com", Password:"john-123"}
Case: Login
    Expected: &example.User{Email:"maria@email.com", Password:"1234"}
    Obtained: &example.User{Email:"john@email.com", Password:"john-123"}
    at biff/example.TestExample.func1.1.2(0xc420096ac0
    /home/fulldump/workspace/my-project/src/example/users_test.go:84 +0x12

特性

1. 隔离的用例：所有可能的分支都以隔离的方式测试

2. 动态BDD：不需要将测试行为翻译成自然语言。Biff会遍历执行堆栈并解析部分测试代码以漂亮地打印断言

3. 利用Go函数作用域：避免使用测试助手和辅助方法来维护测试之间的状态，利用语言变量作用域本身编写强大、易写易读的测试

支持的断言

最常用的断言已实现：

• AssertEqual
• AssertEqualJson
• AssertNil
• AssertNotNil
• AssertNotEqual
• AssertInArray
• AssertTrue
• AssertFalse

贡献

欢迎fork、修改并向master分支提交pull request。如果您愿意，也可以创建新issue或通过电子邮件联系我获取新功能、问题或其他任何内容。

测试

目前还没有测试，但很快就会有了。

示例项目

该项目包含一个示例项目，包含一些简单的业务逻辑和一些Biff测试。