expect

Documentation

Index

• type FailedPredicateError
  • func CompareValues(expected, actual any, exactJSON bool) []*FailedPredicateError
  • func (e *FailedPredicateError) Error() string
  • func (e *FailedPredicateError) FieldString() string
  • func (e *FailedPredicateError) PushField(field string)
  • func (e *FailedPredicateError) Unwrap() error
• type Predicate
  • func Bool(expected ...bool) Predicate
  • func Float(expected ...float64) Predicate
  • func Int(expected ...int64) Predicate
  • func Map(expected ...map[string]any) Predicate
  • func Pattern(regex string) Predicate
  • func Regex(regex *regexp.Regexp) Predicate
  • func Slice(expected ...[]any) Predicate
  • func String(expected ...string) Predicate
  • func (p Predicate) And(next Predicate) Predicate
  • func (p Predicate) Or(next Predicate) Predicate
  • func (p Predicate) Then(next Predicate) Predicate

Types

type FailedPredicateError

type FailedPredicateError struct {
	// The underlying error.
	Cause error
	// Stack of JSON field names that lead to the current expectation.
	FieldStack []string
}

A FailedPredicateError indicates that a predicate failed.

func CompareValues

func CompareValues(expected, actual any, exactJSON bool) []*FailedPredicateError

CompareValues compares an expected value to an actual value.

func (*FailedPredicateError) Error

func (e *FailedPredicateError) Error() string

func (*FailedPredicateError) FieldString

func (e *FailedPredicateError) FieldString() string

FieldString returns a dot-delimited string representation of the field stack.

func (*FailedPredicateError) PushField

func (e *FailedPredicateError) PushField(field string)

PushField pushes a field name onto the field stack.

func (*FailedPredicateError) Unwrap

func (e *FailedPredicateError) Unwrap() error

type Predicate

type Predicate func(any) error

A Predicate is a function that takes a test result value and possibly returns an error.

func Bool

func Bool(expected ...bool) Predicate

Bool creates a predicate requiring a value to be a bool, optionally matching against a set of values.

func Float

func Float(expected ...float64) Predicate

Float creates a predicate requiring a value to be an floating point number, optionally matching against a set of values.

func Int

func Int(expected ...int64) Predicate

Int creates a predicate requiring a value to be an integer, optionally matching against a set of values.

func Map

func Map(expected ...map[string]any) Predicate

Map creates a predicate requiring a value to be a map, optionally matching against a set of values.

func Pattern

func Pattern(regex string) Predicate

Pattern creates a predicate requiring a value to be a string that matches a regular expression, optionally matching against a set of values.

func Regex

func Regex(regex *regexp.Regexp) Predicate

Regex creates a predicate requiring a value to be a string that matches a regular expression, optionally matching against a set of values.

func Slice

func Slice(expected ...[]any) Predicate

Slice creates a predicate requiring a value to be a slice, optionally matching against a set of values.

func String

func String(expected ...string) Predicate

String creates a predicate requiring a value to be a string, optionally matching against a set of values.

func (Predicate) And

func (p Predicate) And(next Predicate) Predicate

And chains a new Predicate to run after the current Predicate if the current Predicate succeeds.

func (Predicate) Or

func (p Predicate) Or(next Predicate) Predicate

Or chains a new Predicate to run after the current Predicate if the current Predicate fails.

func (Predicate) Then

func (p Predicate) Then(next Predicate) Predicate

Then chains a new Predicate to run after the current Predicate.