testutils

Documentation

Index

• func Equal[V comparable](tt TestingIface, want, got V, msgAndArgs ...any) bool
• func EqualAny(tt TestingIface, want, got any, msgAndArgs ...any) bool
• func EqualAnyf(tt TestingIface, want, got any, msg string, args ...any) bool
• func Error(tt TestingIface, err error, msgAndArgs ...any) bool
• func ErrorIs(tt TestingIface, err, target error, msgAndArgs ...any) bool
• func False(tt TestingIface, value bool, msgAndArgs ...any) bool
• func HasPrefix(tt TestingIface, s, prefix string, msgAndArgs ...any) bool
• func HasSuffix(tt TestingIface, s, suffix string, msgAndArgs ...any) bool
• func KeyValErrorMsg(key string, val any) string
• func Nil(tt TestingIface, value any, msgAndArgs ...any) bool
• func NoError(ti TestingIface, err error, msgAndArgs ...any) bool
• func NotEqual[V comparable](tt TestingIface, want, got V, msgAndArgs ...any) bool
• func NotNil(tt TestingIface, value any, msgAndArgs ...any) bool
• func ObjectsAreEqual(expected, actual interface{}) bool
• func True(tt TestingIface, value bool, msgAndArgs ...any) bool
• type Data
• type Result
• type Results
  • func NewResults[T comparable]() Results[T]
  • func (td *Results[T]) Add(name string, want, got T)
  • func (td Results[T]) Test(ti TestingIface)
• type TestingIface

Functions

func Equal

func Equal[V comparable](tt TestingIface, want, got V, msgAndArgs ...any) bool

Equal asserts comparables.

testutils.Equal(t, "hello", "hello")

func EqualAny

func EqualAny(tt TestingIface, want, got any, msgAndArgs ...any) bool

func EqualAnyf

func EqualAnyf(tt TestingIface, want, got any, msg string, args ...any) bool

func Error

func Error(tt TestingIface, err error, msgAndArgs ...any) bool

Error assert that err != nil

func ErrorIs

func ErrorIs(tt TestingIface, err, target error, msgAndArgs ...any) bool

ErrorIs asserts errors.Is(err, target)

func False

func False(tt TestingIface, value bool, msgAndArgs ...any) bool

False asserts that the specified value is false.

testutils.False(t, myBool)

func HasPrefix

func HasPrefix(tt TestingIface, s, prefix string, msgAndArgs ...any) bool

func HasSuffix

func HasSuffix(tt TestingIface, s, suffix string, msgAndArgs ...any) bool

func KeyValErrorMsg

func KeyValErrorMsg(key string, val any) string

func Nil

func Nil(tt TestingIface, value any, msgAndArgs ...any) bool

Nil asserts that the specified value is nil.

func NoError

func NoError(ti TestingIface, err error, msgAndArgs ...any) bool

NoError asserts that a function returned no error (i.e. `nil`).

  actualObj, err := SomeFunction()
  if testutils.NoError(t, err) {
	   testutils.Equal(t, expectedObj, actualObj)
  }

func NotEqual

func NotEqual[V comparable](tt TestingIface, want, got V, msgAndArgs ...any) bool

func NotNil

func NotNil(tt TestingIface, value any, msgAndArgs ...any) bool

NotNil asserts that the specified value is not nil.

testutils.NotNil(t, &val)

func ObjectsAreEqual

func ObjectsAreEqual(expected, actual interface{}) bool

ObjectsAreEqual determines if two objects are considered equal.

This function does no assertion of any kind.

func True

func True(tt TestingIface, value bool, msgAndArgs ...any) bool

True asserts that the specified value is true.

testutils.True(t, myBool)

Types

type Data

type Data[IN, WANT any] []struct {
	Name string
	In   IN
	Want WANT
}

type Result

type Result[T comparable] struct {
	Title string
	Want  T
	Got   T
}

type Results

type Results[T comparable] []Result[T]

func NewResults

func NewResults[T comparable]() Results[T]

func (*Results[T]) Add

func (td *Results[T]) Add(name string, want, got T)

func (Results[T]) Test

func (td Results[T]) Test(ti TestingIface)

type TestingIface

type TestingIface interface {
	Errorf(format string, args ...any)
	Name() string
	Helper()
}

TestingIface is an interface wrapper for *testing.T, *testing.B, *testing.F