Golang快速扩展断言功能减少样板代码插件库trial的使用

Trial是一个简单的Go断言库，可以帮助减少测试代码中的样板代码量。它提供了基本的断言功能，并允许开发者轻松扩展自定义断言。

基本用法

简单相等断言

import "github.com/jgroeneveld/trial/assert"

func TestExample(t *testing.T) {
    assert.Equal(t, 1, 2) // 当不相等时会输出详细的错误信息
}

// 输出示例:
// unit_test.go:42: Not equal:
//         Expected: 1
//           Actual: 2

带自定义消息的断言

assert.Equal(t, 1, 2, "numbers dont match for %q", "my param")

// 输出示例:
// unit_test.go:42: numbers dont match for "my param":
//         Expected: 1
//           Actual: 2

类型检查

assert.Equal(t, 1, int64(1))

// 输出示例:
// unit_test.go:42: Not equal:
//         Expected: 1
//           Actual: 1
//            Types: Expected:int, Actual:int64

支持的断言方法

基本断言

Equal(expected, actual, msgf...)
MustBeEqual(expected, actual, msgf...)
NotEqual(expected, actual, msgf...)
MustNotBeEqual(expected, actual, msgf...)
DeepEqual(expected, actual, msgf...)
MustBeDeepEqual(expected, actual, msgf...)
True(expression bool, msgf...)
MustBeTrue(expression bool, msgf...)
False(expression bool, msgf...)
MustBeFalse(expression bool, msgf...)
Nil(expression, msgf...)
MustBeNil(expression, msgf...)
NotNil(expression, msgf...)
MustNotBeNil(expression, msgf...)

JSON Schema断言

JSONSchema(reader, matcher, msgf...)
MustMatchJSONSchema(reader, matcher, msgf...)

自定义断言示例

你可以使用th.Error()函数轻松创建自己的断言函数：

import (
    "testing"
    "io"
    "github.com/jgroeneveld/trial/th"
    "github.com/jgroeneveld/schema"
)

// 自定义JSON Schema验证断言
func AssertJSONSchema(t *testing.T, matcher schema.Matcher, r io.Reader) {
    err := schema.MatchJSON(matcher, r)
    if err != nil {
        th.Error(t, 1, err.Error()) // skip=1表示跳过一层调用栈
    }
}

// 必须匹配JSON Schema的严格版本
func MustMatchJSONSchema(t *testing.T, matcher schema.Matcher, r io.Reader) {
    err := schema.MatchJSON(matcher, r)
    if err != nil {
        th.Error(t, 1, err.Error())
        t.FailNow() // 立即终止测试
    }
}

完整示例Demo

package main_test

import (
    "testing"
    "github.com/jgroeneveld/trial/assert"
)

func TestStringEquality(t *testing.T) {
    expected := "hello"
    actual := "world"
    assert.Equal(t, expected, actual, "字符串不匹配")
}

func TestNumberComparison(t *testing.T) {
    a := 10
    b := 20
    assert.True(t, a < b, "%d 应该小于 %d", a, b)
}

func TestNilCheck(t *testing.T) {
    var ptr *int
    assert.Nil(t, ptr, "指针应该为nil")
    
    obj := struct{}{}
    assert.NotNil(t, obj, "对象不应该为nil")
}

func TestTypeComparison(t *testing.T) {
    var i int = 10
    var i64 int64 = 10
    assert.Equal(t, i, i64) // 这会失败，因为类型不同
}

Trial库通过提供简洁的API和可扩展的设计，帮助Go开发者减少测试代码中的样板代码，同时提供清晰的错误信息。