fakes

Documentation

Overview

Package fakes defines methods for instantiating objects which act like resources on a Kubernetes cluster, but are not intended to actually be instantiated on a real, production cluster.

The primary purpose of these objects is to aid writing tests, but that is not this package's only purpose. These objects are also used in debugging logic which is compiled in to production code.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func ConstraintFor(kind string) *unstructured.Unstructured
• func DenyAllConstraint() *unstructured.Unstructured
• func DenyAllRegoTemplate() *templates.ConstraintTemplate
• func GetTestScheme() *runtime.Scheme
• func Pod(opts ...Opt) *corev1.Pod
• func ScopedConstraintFor(ep string) *unstructured.Unstructured
• func SyncSetFor(name string, kinds []schema.GroupVersionKind) *syncsetv1alpha1.SyncSet
• func UnstructuredFor(gvk schema.GroupVersionKind, namespace, name string) *unstructured.Unstructured
• type CfDataKey
  • func KeyFor(obj interface{}) (CfDataKey, error)
• type FailureInjector
  • func NewFailureInjector() *FailureInjector
  • func (f *FailureInjector) CheckFailures(kind string) bool
  • func (f *FailureInjector) SetFailures(kind string, failures int)
• type FakeCfClient
  • func (f *FakeCfClient) AddData(_ context.Context, data interface{}) (*constraintTypes.Responses, error)
  • func (f *FakeCfClient) Contains(expected map[CfDataKey]interface{}) bool
  • func (f *FakeCfClient) ContainsGVKs(gvks []schema.GroupVersionKind) bool
  • func (f *FakeCfClient) GetData(key CfDataKey) interface{}
  • func (f *FakeCfClient) HasGVK(gvk schema.GroupVersionKind) bool
  • func (f *FakeCfClient) Len() int
  • func (f *FakeCfClient) RemoveData(_ context.Context, data interface{}) (*constraintTypes.Responses, error)
  • func (f *FakeCfClient) SetErroring(enabled bool)
• type Opt
  • func WithLabels(labels map[string]string) Opt
  • func WithName(name string) Opt
  • func WithNamespace(namespace string) Opt
  • func WithUID(uid types.UID) Opt
• type SpyReader
  • func (r SpyReader) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error

Constants

const (
	// Name is the default name given to fake objects.
	Name = "foo"

	// Namespace is the default namespace given to fake namespace-scoped objects.
	Namespace = "bar"

	// UID is the default UID given to fake objects.
	UID = "abcd"
)

const (
	// ExternalDataProviderName is the name of the fake external data provider.
	ExternalDataProviderName = "test-provider"
)

Variables

var ExternalDataProviderCache = frameworksexternaldata.NewCache()

ExternalDataProviderCache is the cache of external data providers.

Functions

func ConstraintFor

func ConstraintFor(kind string) *unstructured.Unstructured

func DenyAllConstraint

func DenyAllConstraint() *unstructured.Unstructured

func DenyAllRegoTemplate

func DenyAllRegoTemplate() *templates.ConstraintTemplate

func GetTestScheme

func GetTestScheme() *runtime.Scheme

func Pod

func Pod(opts ...Opt) *corev1.Pod

Pod creates a Pod for use in testing or debugging logic.

func ScopedConstraintFor

func ScopedConstraintFor(ep string) *unstructured.Unstructured

func SyncSetFor

func SyncSetFor(name string, kinds []schema.GroupVersionKind) *syncsetv1alpha1.SyncSet

SyncSetFor returns a syncset resource with the given name for the requested set of resources.

func UnstructuredFor

func UnstructuredFor(gvk schema.GroupVersionKind, namespace, name string) *unstructured.Unstructured

Types

type CfDataKey

type CfDataKey struct {
	Gvk schema.GroupVersionKind
	Key string
}

func KeyFor

func KeyFor(obj interface{}) (CfDataKey, error)

KeyFor returns a CfDataKey for the provided resource. Returns error if the resource is not a runtime.Object w/ metadata.

type FailureInjector

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

FailureInjector can be used in combination with the SpyReader to simulate transient failures for network calls.

func NewFailureInjector

func NewFailureInjector() *FailureInjector

func (*FailureInjector) CheckFailures

func (f *FailureInjector) CheckFailures(kind string) bool

CheckFailures looks at the count of failures and returns true if there are still failures for the kind to consume, false otherwise.

func (*FailureInjector) SetFailures

func (f *FailureInjector) SetFailures(kind string, failures int)

type FakeCfClient

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

FakeCfClient is an CfDataClient for testing.

func (*FakeCfClient) AddData

func (f *FakeCfClient) AddData(_ context.Context, data interface{}) (*constraintTypes.Responses, error)

func (*FakeCfClient) Contains

func (f *FakeCfClient) Contains(expected map[CfDataKey]interface{}) bool

Contains returns true if all expected resources are in the cache.

func (*FakeCfClient) ContainsGVKs

func (f *FakeCfClient) ContainsGVKs(gvks []schema.GroupVersionKind) bool

ContainsGVKs returns true if the cache has data for the gvks given and those gvks only.

func (*FakeCfClient) GetData

func (f *FakeCfClient) GetData(key CfDataKey) interface{}

GetData returns data for a CfDataKey. It assumes that the key is present in the FakeCfClient. Also the data returned is not copied and it's meant only for assertions not modifications.

func (*FakeCfClient) HasGVK

func (f *FakeCfClient) HasGVK(gvk schema.GroupVersionKind) bool

HasGVK returns true if the cache has any data of the requested kind.

func (*FakeCfClient) Len

func (f *FakeCfClient) Len() int

Len returns the number of items in the cache.

func (*FakeCfClient) RemoveData

func (f *FakeCfClient) RemoveData(_ context.Context, data interface{}) (*constraintTypes.Responses, error)

func (*FakeCfClient) SetErroring

func (f *FakeCfClient) SetErroring(enabled bool)

SetErroring will error out on AddObject or RemoveObject.

type Opt

type Opt func(client.Object)

Opt modifies a client.Object during object instantiation. Generally, if there are conflicting opts (such as two WithName calls), the latter should win. This allows objects to have defaults which can easily be overridden.

func WithLabels

func WithLabels(labels map[string]string) Opt

WithLabels sets the metadata.labels of the object. Overwrites any existing labels on the object.

func WithName

func WithName(name string) Opt

WithName sets the metadata.name of the object.

func WithNamespace

func WithNamespace(namespace string) Opt

WithNamespace sets the metadata.namespace of the object.

func WithUID

func WithUID(uid types.UID) Opt

WithUID sets the metadata.uid of the object.

type SpyReader

type SpyReader struct {
	client.Reader
	ListFunc func(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
}

func (SpyReader) List

func (r SpyReader) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error