testutil

Documentation

Index

• Variables
• func CleanRVAndTypeMeta(r runtime.Object)
• func CompareWithFixture(t *testing.T, output interface{}, opts ...option)
• func MarshalYamlAndDiff(a, b runtime.Object, t *testing.T) string
• func MatchExpected(expected any, opts ...cmp.Option) types.GomegaMatcher
• func WithExtension(extension string) option

Variables

var RuntimeObjectIgnoreRvTypeMeta = cmp.Comparer(func(x, y runtime.Object) bool {
	xCopy := x.DeepCopyObject()
	yCopy := y.DeepCopyObject()
	CleanRVAndTypeMeta(xCopy)
	CleanRVAndTypeMeta(yCopy)
	return cmp.Diff(xCopy, yCopy) == ""
})

RuntimeObjectIgnoreRvTypeMeta compares two kubernetes objects, ignoring their resource version and TypeMeta. It is what you want 99% of the time.

Functions

func CleanRVAndTypeMeta

func CleanRVAndTypeMeta(r runtime.Object)

func CompareWithFixture

func CompareWithFixture(t *testing.T, output interface{}, opts ...option)

CompareWithFixture will compare output with a test fixture and allows to automatically update them by setting the UPDATE env var. If output is not a []byte or string, it will get serialized as yaml prior to the comparison. The fixtures are stored in $PWD/testdata/prefix${testName}.yaml

func MarshalYamlAndDiff

func MarshalYamlAndDiff(a, b runtime.Object, t *testing.T) string

MarshalYamlAndDiff diffs the yaml representation of two runtime.Objects, useful for getting a human-readable diff for bigger objects.

func MatchExpected

func MatchExpected(expected any, opts ...cmp.Option) types.GomegaMatcher

MatchExpected ensures that `cmp.Diff(actual, expected)` returns nothing. Usage looks like:

Expect(actual).To(MatchExpected(expected))

func WithExtension

func WithExtension(extension string) option