internal

Documentation

Index

• Constants
• Variables
• func AssertCompareHelper(t testRunner, object any, option int, msg ...any)
• func AssertDirEmptyHelper(t testRunner, dir string) bool
• func AssertRegexpHelper(t testRunner, regex any, txt any, shouldMatch bool, msg ...any)
• func CompareTwoValuesInASlice(a reflect.Value, compareFunc func(a, b reflect.Value) bool) (ret bool)
• func CompletesIn(duration time.Duration, f func()) bool
• func DoesContain(object, element any) bool
• func DoesImplement(interfaceObject, object any) bool
• func Fail(t testRunner, message string, objects Objects, args ...any)
• func FailS(message string, objects Objects, args ...any) string
• func GetCurrentScriptDirectory() string
• func GetDifference(a, b any, raw ...bool) string
• func GetTest(t testRunner) *testing.T
• func HasEqualValues(expected any, actual any) bool
• func HasSameElements(expected any, actual any) bool
• func IsEqual(expected any, actual any) bool
• func IsKind(expectedKind reflect.Kind, value any) bool
• func IsList(list any) bool
• func IsNil(object any) bool
• func IsNumber(value any) bool
• func IsSubset(t testRunner, list any, subset any) bool
• func IsZero(value any) bool
• func ModifyWrappedText(text, wrappingString string, modifier func(wrappedText string) string) string
• type Object
  • func NewDiffObject(expected, actual any, raw ...bool) Object
• type Objects
  • func NewObjectsExpectedActual(expected, actual any) Objects
  • func NewObjectsExpectedActualWithDiff(expected, actual any) Objects
  • func NewObjectsSingleNamed(name string, obj any) Objects
  • func NewObjectsSingleUnknown(obj any) Objects
  • func NewObjectsUnknown(objs ...any) Objects

Constants

const (
	ErrCanNotRunIfNotBuiltinTesting = "This test is only supported on types of *testing.T"
)

Variables

var DiffContextLines = 2

var Highlight = pterm.NewStyle(pterm.FgLightRed).Sprint

var LineNumbersEnabled = true

LineNumbersEnabled controls if line numbers should be printed in the fail printer.

Functions

func AssertCompareHelper

func AssertCompareHelper(t testRunner, object any, option int, msg ...any)

AssertCompareHelper option: 1 = increasing, 0 = equal, -1 = decreasing

func AssertDirEmptyHelper

func AssertDirEmptyHelper(t testRunner, dir string) bool

AssertDirEmptyHelper checks for io.EOF to determine if directory empty or not

func AssertRegexpHelper

func AssertRegexpHelper(t testRunner, regex any, txt any, shouldMatch bool, msg ...any)

func CompareTwoValuesInASlice

func CompareTwoValuesInASlice(a reflect.Value, compareFunc func(a, b reflect.Value) bool) (ret bool)

CompareTwoValuesInASlice is a helper function.

func CompletesIn

func CompletesIn(duration time.Duration, f func()) bool

CompletesIn returns if a function completes in a specific time.

func DoesContain

func DoesContain(object, element any) bool

DoesContain checks that ab objects contains an element.

func DoesImplement

func DoesImplement(interfaceObject, object any) bool

DoesImplement checks if an objects implements an interface.

func Fail

func Fail(t testRunner, message string, objects Objects, args ...any)

func FailS

func FailS(message string, objects Objects, args ...any) string

func GetCurrentScriptDirectory

func GetCurrentScriptDirectory() string

GetCurrentScriptDirectory returns the directory of the current Go file.

func GetDifference

func GetDifference(a, b any, raw ...bool) string

GetDifference returns the diff for two projects.

func GetTest

func GetTest(t testRunner) *testing.T

GetTest converts to *testing.T.

func HasEqualValues

func HasEqualValues(expected any, actual any) bool

HasEqualValues checks if two objects have equal values.

func HasSameElements

func HasSameElements(expected any, actual any) bool

func IsEqual

func IsEqual(expected any, actual any) bool

IsEqual checks if two objects are equal.

func IsKind

func IsKind(expectedKind reflect.Kind, value any) bool

IsKind returns if an object is kind of a specific kind.

func IsList

func IsList(list any) bool

func IsNil

func IsNil(object any) bool

IsNil checks if an object is nil.

func IsNumber

func IsNumber(value any) bool

IsNumber checks if the value is of a numeric kind.

func IsSubset

func IsSubset(t testRunner, list any, subset any) bool

func IsZero

func IsZero(value any) bool

IsZero checks if a value is the zero value of its type.

func ModifyWrappedText

func ModifyWrappedText(text, wrappingString string, modifier func(wrappedText string) string) string

Types

type Object

type Object struct {
	Name      string
	NameStyle *pterm.Style
	Data      any
	DataStyle *pterm.Style
	Raw       bool
}

func NewDiffObject

func NewDiffObject(expected, actual any, raw ...bool) Object

type Objects

type Objects []Object

func NewObjectsExpectedActual

func NewObjectsExpectedActual(expected, actual any) Objects

func NewObjectsExpectedActualWithDiff

func NewObjectsExpectedActualWithDiff(expected, actual any) Objects

func NewObjectsSingleNamed

func NewObjectsSingleNamed(name string, obj any) Objects

func NewObjectsSingleUnknown

func NewObjectsSingleUnknown(obj any) Objects

func NewObjectsUnknown

func NewObjectsUnknown(objs ...any) Objects