gentest

type Client ¶

type Client interface {
	Create(namespace string, obj *v1.Pod, opts ...CreateOption) (*v1.Pod, error)
	Update(namespace string, obj *v1.Pod, opts ...UpdateOption) (*v1.Pod, error)
	Transform(namespace string, name string, transformer Mutator) (*v1.Pod, error)
	Get(namespace string, name string, opts ...GetOption) (*v1.Pod, error)
	Delete(namespace string, name string, opts ...DeleteOption) error
	List(namespace string, opts ...ListOption) ([]v1.Pod, error)
	Upsert(namespace string, newObj *v1.Pod, merge Merger) (*v1.Pod, error)
	WaitFor(ctx context.Context, namespace string, name string, interval time.Duration, condition Predicate) (*v1.Pod, error)
	WaitForE(ctx context.Context, namespace string, name string, interval time.Duration, condition ConditionFuncE) (*v1.Pod, error)

	// Utility functions
	WaitForDeletion(ctx context.Context, namespace string, name string, interval time.Duration) (*v1.Pod, error)
	WaitForConditionReadyTrue(ctx context.Context, namespace string, name string, interval time.Duration) (*v1.Pod, error)
	WaitForConditionInitializedTrue(ctx context.Context, namespace string, name string, interval time.Duration) (*v1.Pod, error)

	// ClientExtension can be used by the developer to extend the client.
	ClientExtension
}

Client is the interface for interacting with v1.Pod types as OperatorConfig CF style objects.

func NewExampleClient(mockK8s v1.PodsGetter) Client

type ClientExtension ¶

type ClientExtension interface {
}

type ConditionFuncE ¶

type ConditionFuncE func(instance *v1.Pod, apiErr error) (done bool, err error)

ConditionFuncE is a callback used by WaitForE. Done should be set to true once the condition succeeds and shouldn't be called anymore. The error will be passed back to the user.

This function MAY retrieve a nil instance and an apiErr. It's up to the function to decide how to handle the apiErr.

type CreateOption ¶

type CreateOption func(*createConfig)

CreateOption is a single option for configuring a createConfig

type CreateOptions ¶

type CreateOptions []CreateOption

CreateOptions is a configuration set defining a createConfig

func CreateOptionDefaults() CreateOptions

func (opts CreateOptions) Extend(other CreateOptions) CreateOptions

type DeleteOption ¶

type DeleteOption func(*deleteConfig)

DeleteOption is a single option for configuring a deleteConfig

func WithDeleteForegroundDeletion(val bool) DeleteOption

type DeleteOptions ¶

type DeleteOptions []DeleteOption

DeleteOptions is a configuration set defining a deleteConfig

func DeleteOptionDefaults() DeleteOptions

func (opts DeleteOptions) Extend(other DeleteOptions) DeleteOptions

func (opts DeleteOptions) ForegroundDeletion() bool

type GetOption ¶

type GetOption func(*getConfig)

GetOption is a single option for configuring a getConfig

type GetOptions ¶

type GetOptions []GetOption

GetOptions is a configuration set defining a getConfig

func GetOptionDefaults() GetOptions

func (opts GetOptions) Extend(other GetOptions) GetOptions

type List ¶

type List []v1.Pod

List represents a collection of v1.Pod.

func (list List) Filter(filter Predicate) (out List)

first := v1.Pod{}
first.Name = "ok"

second := v1.Pod{}
second.Name = "name-too-long-to-pass"

list := List{first, second}

filtered := list.Filter(func(s *v1.Pod) bool {
	return len(s.Name) < 8
})

fmt.Println("Results")
for _, v := range filtered {
	fmt.Println("-", v.Name)
}

Output:

Results
- ok

type ListOption ¶

type ListOption func(*listConfig)

ListOption is a single option for configuring a listConfig

func WithListFieldSelector(val map[string]string) ListOption

func WithListFilter(val Predicate) ListOption

type ListOptions ¶

type ListOptions []ListOption

ListOptions is a configuration set defining a listConfig

func ListOptionDefaults() ListOptions

func (opts ListOptions) Extend(other ListOptions) ListOptions

type Merger ¶

type Merger func(newObj, oldObj *v1.Pod) *v1.Pod

Merger is a type to merge an existing value with a new one.

type Mutator ¶

type Mutator func(*v1.Pod) error

Mutator is a function that changes v1.Pod.

func DiffWrapper(w io.Writer, mutator Mutator) Mutator

obj := &v1.Pod{}
obj.Spec.Hostname = "opaque"

contents := &bytes.Buffer{}
wrapper := DiffWrapper(contents, func(obj *v1.Pod) error {
	obj.Spec.Hostname = "docker-creds"
	return nil
})

fmt.Println("Error:", wrapper(obj))
firstLine := strings.Split(contents.String(), "\n")[0]
fmt.Println("First line:", firstLine)

Output:

Error: <nil>
First line: OperatorConfig Diff (-old +new):

obj := &v1.Pod{}

wrapper := DiffWrapper(os.Stdout, func(_ *v1.Pod) error {
	return errors.New("some-error")
})

fmt.Println(wrapper(obj))

Output:

some-error

obj := &v1.Pod{}

wrapper := DiffWrapper(os.Stdout, func(s *v1.Pod) error {
	// don't mutate the object
	return nil
})

wrapper(obj)

Output:

No changes

func LabelSetMutator(labels map[string]string) Mutator

out := &v1.Pod{}
managedAdder := LabelSetMutator(map[string]string{"managed-by": "kf"})

managedAdder(out)
fmt.Printf("Labels: %v", out.Labels)

Output:

Labels: map[managed-by:kf]

type Predicate ¶

type Predicate func(*v1.Pod) bool

Predicate is a boolean function for a v1.Pod.

type UpdateOption ¶

type UpdateOption func(*updateConfig)

UpdateOption is a single option for configuring a updateConfig

type UpdateOptions ¶

type UpdateOptions []UpdateOption

UpdateOptions is a configuration set defining a updateConfig

func UpdateOptionDefaults() UpdateOptions

func (opts UpdateOptions) Extend(other UpdateOptions) UpdateOptions