test

Documentation

Index

• func CEventually(ctx context.Context, actual interface{}) AsyncAssertion
• func EXPECTPatch(ctx interface{}, c *mockclient.MockClient, ...) *gomock.Call
• func EXPECTPatchWithOptimisticLock(ctx interface{}, c *mockclient.MockClient, ...) *gomock.Call
• func EnsureTestResources(ctx context.Context, c client.Client, namespaceName, path string) ([]client.Object, error)
• func HasObjectKeyOf(expected client.Object) gomock.Matcher
• func NewClientWithFieldSelectorSupport[T any](c client.Client, toSelectableFieldsFunc func(t *T) fields.Set) client.Client
• func ReadTestResources(scheme *runtime.Scheme, namespaceName, path string) ([]client.Object, error)
• func WithEnvVar(key, value string) func()
• func WithFeatureGate(gate featuregate.FeatureGate, f featuregate.Feature, value bool) func()
• func WithTempFile(dir, pattern string, content []byte, fileName *string) func()
• func WithVar(dst, src interface{}) func()
• func WithVars(dstsAndSrcs ...interface{}) func()
• func WithWd(path string) func()
• type Command
  • func (c *Command) Slice() []string
  • func (c *Command) String() string
• type CommandBuilder
  • func NewCommandBuilder(name string) *CommandBuilder
  • func (c *CommandBuilder) Args(args ...string) *CommandBuilder
  • func (c *CommandBuilder) Command() *Command
  • func (c *CommandBuilder) Flags(flags ...Flag) *CommandBuilder
• type FakeManager
  • func (f FakeManager) GetAPIReader() client.Reader
  • func (f FakeManager) GetCache() cache.Cache
  • func (f FakeManager) GetClient() client.Client
  • func (f FakeManager) GetEventRecorderFor(name string) record.EventRecorder
• type Flag
  • func BoolFlag(key string, value bool) Flag
  • func IntFlag(key string, value int) Flag
  • func StringFlag(key, value string) Flag
  • func StringSliceFlag(key string, value ...string) Flag

Functions

func CEventually

func CEventually(ctx context.Context, actual interface{}) AsyncAssertion

CEventually is like gomega.Eventually but with a context.Context. When it has a deadline then the gomega.Eventually call with be configured with a the respective timeout.

func EXPECTPatch

func EXPECTPatch(ctx interface{}, c *mockclient.MockClient, expectedObj, mergeFrom client.Object, patchType types.PatchType, rets ...interface{}) *gomock.Call

EXPECTPatch is a helper function for a GoMock call expecting a patch with the mock client.

func EXPECTPatchWithOptimisticLock

func EXPECTPatchWithOptimisticLock(ctx interface{}, c *mockclient.MockClient, expectedObj, mergeFrom client.Object, patchType types.PatchType, rets ...interface{}) *gomock.Call

EXPECTPatchWithOptimisticLock is a helper function for a GoMock call with the mock client expecting a merge patch with optimistic lock.

func EnsureTestResources

func EnsureTestResources(ctx context.Context, c client.Client, namespaceName, path string) ([]client.Object, error)

EnsureTestResources reads test resources from path, applies them using the given client and returns the created objects.

func HasObjectKeyOf

func HasObjectKeyOf(expected client.Object) gomock.Matcher

HasObjectKeyOf returns a gomock.Matcher that matches if actual is a client.Object that has the same ObjectKey as expected.

func NewClientWithFieldSelectorSupport

func NewClientWithFieldSelectorSupport[T any](c client.Client, toSelectableFieldsFunc func(t *T) fields.Set) client.Client

NewClientWithFieldSelectorSupport takes a fake client and a function that returns selectable fields for the type T and adds support for field selectors to the client. TODO(plkokanov): remove this once the controller-runtime fake client supports field selectors.

func ReadTestResources

func ReadTestResources(scheme *runtime.Scheme, namespaceName, path string) ([]client.Object, error)

ReadTestResources reads test resources from path, decodes them using the given scheme and returns the parsed objects. Objects are values of the proper API types, if registered in the given scheme, and *unstructured.Unstructured otherwise.

func WithEnvVar

func WithEnvVar(key, value string) func()

WithEnvVar sets the env variable to the given environment variable and returns a function to revert. If the value is empty, the environment variable will be unset.

func WithFeatureGate

func WithFeatureGate(gate featuregate.FeatureGate, f featuregate.Feature, value bool) func()

WithFeatureGate sets the specified gate to the specified value, and returns a function that restores the original value. Failures to set or restore cause the test to fail. Example use:

defer WithFeatureGate(utilfeature.DefaultFeatureGate, features.<FeatureName>, true)()

func WithTempFile

func WithTempFile(dir, pattern string, content []byte, fileName *string) func()

WithTempFile creates a temporary file with the given dir and pattern, writes the given content to it, and returns a function to delete it. Failures to create, open, close, or delete the file case the test to fail.

The filename is generated by taking pattern and adding a random string to the end. If pattern includes a "*", the random string replaces the last "*". If dir is the empty string, WriteTempFile uses the default directory for temporary files (see ioutil.TempFile). The caller can use the value of fileName to find the pathname of the file.

Example usage:

var fileName string
defer WithTempFile("", "test", []byte("test file content"), &fileName)()

func WithVar

func WithVar(dst, src interface{}) func()

WithVar sets the given var to the src value and returns a function to revert to the original state. The type of `dst` has to be a settable pointer. The value of `src` has to be assignable to the type of `dst`.

Example usage:

v := "foo"
defer WithVar(&v, "bar")()

func WithVars

func WithVars(dstsAndSrcs ...interface{}) func()

WithVars sets the given vars to the given values and returns a function to revert back. dstsAndSrcs have to appear in pairs of 2, otherwise there will be a runtime panic.

Example usage:

defer WithVars(&v, "foo", &x, "bar")()

func WithWd

func WithWd(path string) func()

WithWd sets the working directory and returns a function to revert to the previous one.

Types

type Command

type Command struct {
	Name  string
	Flags []Flag
	Args  []string
}

Command is a command that has a name, a list of flags, and a list of arguments.

func (*Command) Slice

func (c *Command) Slice() []string

Slice returns a representation of this Command as a slice of strings.

func (*Command) String

func (c *Command) String() string

String returns a representation of this Command as a string.

type CommandBuilder

type CommandBuilder struct {
	// contains filtered or unexported fields
}

CommandBuilder is a builder for Command objects.

func NewCommandBuilder

func NewCommandBuilder(name string) *CommandBuilder

NewCommandBuilder creates and returns a new CommandBuilder with the given name.

func (*CommandBuilder) Args

func (c *CommandBuilder) Args(args ...string) *CommandBuilder

Args appends the given arguments to this CommandBuilder.

func (*CommandBuilder) Command

func (c *CommandBuilder) Command() *Command

Command returns the Command that has been built by this CommandBuilder.

func (*CommandBuilder) Flags

func (c *CommandBuilder) Flags(flags ...Flag) *CommandBuilder

Flags appends the given flags to this CommandBuilder.

type FakeManager

type FakeManager struct {
	manager.Manager

	Client        client.Client
	Cache         cache.Cache
	EventRecorder record.EventRecorder
	APIReader     client.Reader
}

FakeManager fakes a manager.Manager.

func (FakeManager) GetAPIReader

func (f FakeManager) GetAPIReader() client.Reader

GetAPIReader returns the given apiReader.

func (FakeManager) GetCache

func (f FakeManager) GetCache() cache.Cache

GetCache returns the given cache.

func (FakeManager) GetClient

func (f FakeManager) GetClient() client.Client

GetClient returns the given client.

func (FakeManager) GetEventRecorderFor

func (f FakeManager) GetEventRecorderFor(name string) record.EventRecorder

GetEventRecorderFor returns the given eventRecorder.

type Flag

type Flag interface {
	// Slice returns a representation of this Flag as a slice of strings.
	Slice() []string
}

Flag is a flag that can be represented as a slice of strings.

func BoolFlag

func BoolFlag(key string, value bool) Flag

BoolFlag returns a Flag with the given key and boolean value.

func IntFlag

func IntFlag(key string, value int) Flag

IntFlag returns a Flag with the given key and integer value.

func StringFlag

func StringFlag(key, value string) Flag

StringFlag returns a Flag with the given key and string value.

func StringSliceFlag

func StringSliceFlag(key string, value ...string) Flag

StringSliceFlag returns a flag with the given key and string slice value.