使用gocrest构建Hamcrest风格的Golang断言

gocrest是一个Golang的断言匹配库，它采用了类似Hamcrest的可组合匹配器风格，提供了更富有表现力的断言方式。下面我将介绍gocrest的核心用法和示例代码。

安装gocrest

go get github.com/corbym/gocrest

基本用法

简单断言

package main

import (
	"testing"
	"github.com/corbym/gocrest/has"
	"github.com/corbym/gocrest/is"
	"github.com/corbym/gocrest/then"
)

func TestSimpleAssertions(t *testing.T) {
	// 相等断言
	then.AssertThat(t, 42, is.EqualTo(42))
	
	// 不相等断言
	then.AssertThat(t, "hello", is.Not(is.EqualTo("world")))

	// 包含断言
	then.AssertThat(t, []int{1, 2, 3}, has.Item(is.EqualTo(2)))
	
	// 长度断言
	then.AssertThat(t, "golang", has.Length(is.GreaterThan(4)))
}

常用匹配器

基本匹配器

func TestBasicMatchers(t *testing.T) {
	// 空值检查
	var nilSlice []int
	then.AssertThat(t, nilSlice, is.Nil())
	
	// 非空检查
	then.AssertThat(t, "not empty", is.Not(is.Nil()))
	
	// 布尔检查
	then.AssertThat(t, true, is.True())
	then.AssertThat(t, false, is.False())
	
	// 类型检查
	then.AssertThat(t, 3.14, is.AllOf(
		is.Not(is.Nil()),
		is.InstanceOf(float64(0)),
	))
}

数值匹配器

func TestNumberMatchers(t *testing.T) {
	// 大于
	then.AssertThat(t, 10, is.GreaterThan(5))
	
	// 小于等于
	then.AssertThat(t, 3.14, is.LessThanOrEqualTo(3.14))
	
	// 在范围内
	then.AssertThat(t, 7, is.AllOf(
		is.GreaterThan(5),
		is.LessThan(10),
	))
}

字符串匹配器

func TestStringMatchers(t *testing.T) {
	// 包含子串
	then.AssertThat(t, "hello world", contains.String("world"))
	
	// 匹配正则
	then.AssertThat(t, "test@example.com", matches.Pattern(`^.+@.+\..+$`))
	
	// 以...开头
	then.AssertThat(t, "golang", starts.With("go"))
}

集合匹配器

func TestCollectionMatchers(t *testing.T) {
	slice := []int{1, 2, 3, 4, 5}
	
	// 包含特定元素
	then.AssertThat(t, slice, has.Item(is.EqualTo(3)))
	
	// 所有元素满足条件
	then.AssertThat(t, slice, has.All(
		is.GreaterThan(0),
		is.LessThan(10),
	))
	
	// 长度检查
	then.AssertThat(t, slice, has.Length(is.EqualTo(5)))
	
	// 映射检查
	m := map[string]int{"a": 1, "b": 2}
	then.AssertThat(t, m, has.Key(is.EqualTo("a")))
	then.AssertThat(t, m, has.Value(is.EqualTo(2)))
}

组合匹配器

gocrest的强大之处在于可以组合多个匹配器：

func TestCombinedMatchers(t *testing.T) {
	value := "Golang is awesome"
	
	then.AssertThat(t, value, is.AllOf(
		contains.String("awesome"),
		has.Length(is.GreaterThan(10)),
		starts.With("Golang"),
		is.Not(contains.String("terrible")),
	))
}

自定义匹配器

你可以创建自己的匹配器：

func isEven() *is.Matcher {
	return &is.Matcher{
		Describe: "even number",
		Matches: func(actual interface{}) bool {
			if num, ok := actual.(int); ok {
				return num%2 == 0
			}
			return false
		},
	}
}

func TestCustomMatcher(t *testing.T) {
	then.AssertThat(t, 42, isEven())
}

错误消息

当断言失败时，gocrest会提供详细的错误信息：

func TestErrorMessage(t *testing.T) {
	// 失败时会输出:
	// Expected: value equal to <42>
	//      but: <43> was not equal to <42>
	then.AssertThat(t, 43, is.EqualTo(42))
}

与标准testing包的比较

相比标准库的if x != y { t.Error() }模式，gocrest提供了：

1. 更可读的断言语法
2. 更详细的错误信息
3. 可组合的匹配器
4. 丰富的内置匹配器集合

总结

gocrest为Golang测试提供了Hamcrest风格的断言方式，通过可组合的匹配器使测试代码更清晰、更富有表现力。它特别适合需要复杂断言的场景，能够显著提高测试代码的可读性和维护性。

对于简单的测试用例，标准库可能更直接，但对于复杂的断言逻辑，gocrest能提供更好的表达能力和错误信息。