matchers

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AndMatcher

type AndMatcher struct {
	Matchers []SyverMatcher
	// contains filtered or unexported fields
}

func (*AndMatcher) FailureMessage

func (m *AndMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*AndMatcher) FailureResult

func (m *AndMatcher) FailureResult(actual interface{}) MatcherResult

func (*AndMatcher) MarshalJSON

func (m *AndMatcher) MarshalJSON() ([]byte, error)

func (*AndMatcher) Match

func (m *AndMatcher) Match(actual interface{}) (success bool, err error)

func (*AndMatcher) NegatedFailureMessage

func (m *AndMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*AndMatcher) NegatedFailureResult

func (m *AndMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type BeNumericallyMatcher

type BeNumericallyMatcher struct {
	Comparator string
	CompareTo  []interface{}
	// contains filtered or unexported fields
}

func (*BeNumericallyMatcher) FailureMessage

func (m *BeNumericallyMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*BeNumericallyMatcher) FailureResult

func (m *BeNumericallyMatcher) FailureResult(actual interface{}) MatcherResult

func (*BeNumericallyMatcher) MarshalJSON

func (m *BeNumericallyMatcher) MarshalJSON() ([]byte, error)

func (*BeNumericallyMatcher) Match

func (m *BeNumericallyMatcher) Match(actual interface{}) (success bool, err error)

func (*BeNumericallyMatcher) NegatedFailureMessage

func (m *BeNumericallyMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*BeNumericallyMatcher) NegatedFailureResult

func (m *BeNumericallyMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type BeSemverConstraintMatcher

type BeSemverConstraintMatcher struct {
	Constraint any
	// contains filtered or unexported fields
}

func (*BeSemverConstraintMatcher) FailureMessage

func (m *BeSemverConstraintMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*BeSemverConstraintMatcher) FailureResult

func (m *BeSemverConstraintMatcher) FailureResult(actual any) MatcherResult

func (*BeSemverConstraintMatcher) MarshalJSON

func (m *BeSemverConstraintMatcher) MarshalJSON() ([]byte, error)

func (*BeSemverConstraintMatcher) Match

func (m *BeSemverConstraintMatcher) Match(actual any) (success bool, err error)

func (*BeSemverConstraintMatcher) NegatedFailureMessage

func (m *BeSemverConstraintMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*BeSemverConstraintMatcher) NegatedFailureResult

func (m *BeSemverConstraintMatcher) NegatedFailureResult(actual any) MatcherResult

type ConsistOfMatcher

type ConsistOfMatcher struct {
	matchers.ConsistOfMatcher
}

func (*ConsistOfMatcher) FailureResult

func (m *ConsistOfMatcher) FailureResult(actual interface{}) MatcherResult

func (*ConsistOfMatcher) MarshalJSON

func (m *ConsistOfMatcher) MarshalJSON() ([]byte, error)

func (*ConsistOfMatcher) NegatedFailureResult

func (m *ConsistOfMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type ContainElementMatcher

type ContainElementMatcher struct {
	matchers.ContainElementMatcher
}

func (*ContainElementMatcher) FailureResult

func (m *ContainElementMatcher) FailureResult(actual interface{}) MatcherResult

func (*ContainElementMatcher) MarshalJSON

func (m *ContainElementMatcher) MarshalJSON() ([]byte, error)

func (*ContainElementMatcher) NegatedFailureResult

func (m *ContainElementMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type ContainElementsMatcher

type ContainElementsMatcher struct {
	matchers.ContainElementsMatcher
}

func (*ContainElementsMatcher) FailureResult

func (m *ContainElementsMatcher) FailureResult(actual interface{}) MatcherResult

func (*ContainElementsMatcher) MarshalJSON

func (m *ContainElementsMatcher) MarshalJSON() ([]byte, error)

func (*ContainElementsMatcher) Match

func (m *ContainElementsMatcher) Match(actual any) (success bool, err error)

func (*ContainElementsMatcher) NegatedFailureResult

func (m *ContainElementsMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type ContainSubstringMatcher

type ContainSubstringMatcher struct {
	matchers.ContainSubstringMatcher
}

func (*ContainSubstringMatcher) FailureResult

func (m *ContainSubstringMatcher) FailureResult(actual interface{}) MatcherResult

func (*ContainSubstringMatcher) MarshalJSON

func (m *ContainSubstringMatcher) MarshalJSON() ([]byte, error)

func (*ContainSubstringMatcher) NegatedFailureResult

func (m *ContainSubstringMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type EqualMatcher

type EqualMatcher struct {
	matchers.EqualMatcher
}

func (*EqualMatcher) FailureResult

func (m *EqualMatcher) FailureResult(actual interface{}) MatcherResult

func (*EqualMatcher) MarshalJSON

func (m *EqualMatcher) MarshalJSON() ([]byte, error)

func (*EqualMatcher) NegatedFailureResult

func (m *EqualMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type Gjson

type Gjson struct {
	Path string
}

func (Gjson) MarshalJSON

func (g Gjson) MarshalJSON() ([]byte, error)

func (Gjson) Transform

func (g Gjson) Transform(i interface{}) (interface{}, error)

type HaveKeyMatcher

type HaveKeyMatcher struct {
	matchers.HaveKeyMatcher
}

func (*HaveKeyMatcher) FailureResult

func (m *HaveKeyMatcher) FailureResult(actual interface{}) MatcherResult

func (*HaveKeyMatcher) MarshalJSON

func (m *HaveKeyMatcher) MarshalJSON() ([]byte, error)

func (*HaveKeyMatcher) NegatedFailureResult

func (m *HaveKeyMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type HaveLenMatcher

type HaveLenMatcher struct {
	matchers.HaveLenMatcher
}

func (*HaveLenMatcher) FailureResult

func (m *HaveLenMatcher) FailureResult(actual interface{}) MatcherResult

func (*HaveLenMatcher) MarshalJSON

func (m *HaveLenMatcher) MarshalJSON() ([]byte, error)

func (*HaveLenMatcher) NegatedFailureResult

func (m *HaveLenMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type HavePatternsMatcher

type HavePatternsMatcher struct {
	Elements interface{}
	// contains filtered or unexported fields
}

func (*HavePatternsMatcher) FailureMessage

func (m *HavePatternsMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*HavePatternsMatcher) FailureResult

func (m *HavePatternsMatcher) FailureResult(actual interface{}) MatcherResult

func (*HavePatternsMatcher) MarshalJSON

func (matcher *HavePatternsMatcher) MarshalJSON() ([]byte, error)

func (*HavePatternsMatcher) Match

func (m *HavePatternsMatcher) Match(actual interface{}) (success bool, err error)

func (*HavePatternsMatcher) NegatedFailureMessage

func (m *HavePatternsMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*HavePatternsMatcher) NegatedFailureResult

func (m *HavePatternsMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type HavePrefixMatcher

type HavePrefixMatcher struct {
	matchers.HavePrefixMatcher
}

func (*HavePrefixMatcher) FailureResult

func (m *HavePrefixMatcher) FailureResult(actual interface{}) MatcherResult

func (*HavePrefixMatcher) MarshalJSON

func (m *HavePrefixMatcher) MarshalJSON() ([]byte, error)

func (*HavePrefixMatcher) NegatedFailureResult

func (m *HavePrefixMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type HaveSuffixMatcher

type HaveSuffixMatcher struct {
	matchers.HaveSuffixMatcher
}

func (*HaveSuffixMatcher) FailureResult

func (m *HaveSuffixMatcher) FailureResult(actual interface{}) MatcherResult

func (*HaveSuffixMatcher) MarshalJSON

func (m *HaveSuffixMatcher) MarshalJSON() ([]byte, error)

func (*HaveSuffixMatcher) NegatedFailureResult

func (m *HaveSuffixMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type MatchRegexpMatcher

type MatchRegexpMatcher struct {
	matchers.MatchRegexpMatcher
}

func (*MatchRegexpMatcher) FailureResult

func (m *MatchRegexpMatcher) FailureResult(actual interface{}) MatcherResult

func (*MatchRegexpMatcher) MarshalJSON

func (m *MatchRegexpMatcher) MarshalJSON() ([]byte, error)

func (*MatchRegexpMatcher) NegatedFailureResult

func (m *MatchRegexpMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type MatcherResult

type MatcherResult struct {
	Actual             interface{}   `json:"actual"`
	Message            string        `json:"message"`
	Expected           interface{}   `json:"expected"`
	MissingElements    interface{}   `json:"missing-elements"`
	FoundElements      interface{}   `json:"found-elements"`
	ExtraElements      interface{}   `json:"extra-elements"`
	TransformerChain   []Transformer `json:"transform-chain"`
	UntransformedValue interface{}   `json:"untransformed-value"`
}

type NotMatcher

type NotMatcher struct {
	Matcher SyverMatcher
	// contains filtered or unexported fields
}

func (*NotMatcher) FailureMessage

func (m *NotMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*NotMatcher) FailureResult

func (m *NotMatcher) FailureResult(actual interface{}) MatcherResult

func (*NotMatcher) MarshalJSON

func (m *NotMatcher) MarshalJSON() ([]byte, error)

func (*NotMatcher) Match

func (m *NotMatcher) Match(actual interface{}) (bool, error)

func (*NotMatcher) NegatedFailureMessage

func (m *NotMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*NotMatcher) NegatedFailureResult

func (m *NotMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type OrMatcher

type OrMatcher struct {
	Matchers []SyverMatcher
	// contains filtered or unexported fields
}

func (*OrMatcher) FailureMessage

func (m *OrMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*OrMatcher) FailureResult

func (m *OrMatcher) FailureResult(actual interface{}) MatcherResult

func (*OrMatcher) MarshalJSON

func (m *OrMatcher) MarshalJSON() ([]byte, error)

func (*OrMatcher) Match

func (m *OrMatcher) Match(actual interface{}) (success bool, err error)

func (*OrMatcher) NegatedFailureMessage

func (m *OrMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*OrMatcher) NegatedFailureResult

func (m *OrMatcher) NegatedFailureResult(actual interface{}) MatcherResult

type ReaderToString

type ReaderToString struct{}

func (ReaderToString) Transform

func (t ReaderToString) Transform(i interface{}) (interface{}, error)

type SyverMatcher

type SyverMatcher interface {
	// This is needed due to oMegaMatcher test in some of the GomegaMatcher logic
	types.GomegaMatcher
	//Match(actual interface{}) (success bool, err error)
	FailureResult(actual interface{}) MatcherResult
	NegatedFailureResult(actual interface{}) MatcherResult
	// This doesn't seem to make a difference, maybe not needed
	json.Marshaler
}

func And

func And(ms ...SyverMatcher) SyverMatcher

func BeNumerically

func BeNumerically(comparator string, compareTo ...interface{}) SyverMatcher

func BeSemverConstraint

func BeSemverConstraint(constraint any) SyverMatcher

func ConsistOf

func ConsistOf(elements ...interface{}) SyverMatcher

func ContainElement

func ContainElement(element interface{}) SyverMatcher

func ContainElements

func ContainElements(elements ...interface{}) SyverMatcher

func ContainSubstring

func ContainSubstring(substr string, args ...interface{}) SyverMatcher

func Equal

func Equal(element interface{}) SyverMatcher

func HaveKey

func HaveKey(key interface{}) SyverMatcher

func HaveLen

func HaveLen(count int) SyverMatcher

func HavePatterns

func HavePatterns(elements interface{}) SyverMatcher

func HavePrefix

func HavePrefix(prefix string, args ...interface{}) SyverMatcher

func HaveSuffix

func HaveSuffix(prefix string, args ...interface{}) SyverMatcher

func MatchRegexp

func MatchRegexp(regexp string, args ...interface{}) SyverMatcher

func Not

func Not(matcher SyverMatcher) SyverMatcher

func Or

func Or(ms ...SyverMatcher) SyverMatcher

func WithSafeTransform

func WithSafeTransform(transform Transformer, matcher SyverMatcher) SyverMatcher

type ToArray

type ToArray struct{}

func (ToArray) MarshalJSON

func (matcher ToArray) MarshalJSON() ([]byte, error)

func (ToArray) Transform

func (t ToArray) Transform(i interface{}) (interface{}, error)

type ToNumeric

type ToNumeric struct{}

func (ToNumeric) MarshalJSON

func (t ToNumeric) MarshalJSON() ([]byte, error)

func (ToNumeric) Transform

func (t ToNumeric) Transform(e interface{}) (interface{}, error)

type ToString

type ToString struct{}

func (ToString) MarshalJSON

func (t ToString) MarshalJSON() ([]byte, error)

func (ToString) Transform

func (t ToString) Transform(e interface{}) (interface{}, error)

type Transformer

type Transformer interface {
	Transform(interface{}) (interface{}, error)
}

type WithSafeTransformMatcher

type WithSafeTransformMatcher struct {

	// input
	Transform Transformer // must be a function of one parameter that returns one value
	Matcher   SyverMatcher
	// contains filtered or unexported fields
}

func (*WithSafeTransformMatcher) FailureMessage

func (m *WithSafeTransformMatcher) FailureMessage(_ interface{}) (message string)

FailureMessage is a stub to honor omegaMatcher interface

func (*WithSafeTransformMatcher) FailureResult

func (m *WithSafeTransformMatcher) FailureResult(actual interface{}) MatcherResult

func (*WithSafeTransformMatcher) MarshalJSON

func (m *WithSafeTransformMatcher) MarshalJSON() ([]byte, error)

func (*WithSafeTransformMatcher) Match

func (m *WithSafeTransformMatcher) Match(actual interface{}) (bool, error)

func (*WithSafeTransformMatcher) NegatedFailureMessage

func (m *WithSafeTransformMatcher) NegatedFailureMessage(_ interface{}) (message string)

NegatedFailureMessage is a stub to honor omegaMatcher interface

func (*WithSafeTransformMatcher) NegatedFailureResult

func (m *WithSafeTransformMatcher) NegatedFailureResult(actual interface{}) MatcherResult

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL