common

Documentation

Overview

Package common is a generated GoMock package.

Index

• func NamePartitionKey(obj interface{}) (lockKey string, identifier string, err error)
• func NamespacePartitionKey(obj interface{}) (lockKey string, identifier string, err error)
• func NewEventRecorder(controllerAgentName string, events typedcorev1.EventInterface, ...) record.EventRecorder
• func NewRateLimitedWorkQueue(ctx context.Context, name string) workqueue.RateLimitingInterface
• type Controller
  • func (c *Controller) Enqueue(obj interface{}) (requeued bool, err error)
  • func (c *Controller) HandleObject(ctx context.Context, obj interface{}, ownerKind string, getOwnerFn GetOwner)
  • func (c *Controller) Run(ctx context.Context, threadiness int) error
• type ControllerTestSuite
  • func (s *ControllerTestSuite) SetupTest()
  • func (s *ControllerTestSuite) SyncedChannelCallback() func(ctx context.Context, namespace string, name string, ...) error
  • func (s *ControllerTestSuite) TearDownTest()
  • func (s *ControllerTestSuite) WaitForNotSynced(failMessage string)
  • func (s *ControllerTestSuite) WaitForSynced(expectedOperation string)
• type GetOwner
• type Handler
• type HasSynced
• type LockKeyAndIdentifierFunc
• type MockHandler
  • func NewMockHandler(ctrl *gomock.Controller) *MockHandler
  • func (m *MockHandler) EXPECT() *MockHandlerMockRecorder
  • func (m *MockHandler) Sync(ctx context.Context, namespace, name string, ...) error
• type MockHandlerMockRecorder
  • func (mr *MockHandlerMockRecorder) Sync(ctx, namespace, name, eventRecorder interface{}) *gomock.Call

Functions

func NamePartitionKey

func NamePartitionKey(obj interface{}) (lockKey string, identifier string, err error)

NamePartitionKey returns a string which serves as a "locking key" for parallel processing of RadixEnvironments and RadixRegistrations

func NamespacePartitionKey

func NamespacePartitionKey(obj interface{}) (lockKey string, identifier string, err error)

NamespacePartitionKey returns a string which serves as a "locking key" for parallel processing of RadixApplications, RadixAlerts, RadixDeployments and RadixJobs

func NewEventRecorder

func NewEventRecorder(controllerAgentName string, events typedcorev1.EventInterface, logger zerolog.Logger) record.EventRecorder

NewEventRecorder Creates an event recorder for controller

func NewRateLimitedWorkQueue

func NewRateLimitedWorkQueue(ctx context.Context, name string) workqueue.RateLimitingInterface

Types

type Controller

type Controller struct {
	Name                  string
	HandlerOf             string
	KubeClient            kubernetes.Interface
	RadixClient           radixclient.Interface
	WorkQueue             workqueue.RateLimitingInterface
	Informer              cache.SharedIndexInformer
	KubeInformerFactory   kubeinformers.SharedInformerFactory
	Handler               Handler
	Log                   zerolog.Logger
	WaitForChildrenToSync bool
	Recorder              record.EventRecorder
	LockKeyAndIdentifier  LockKeyAndIdentifierFunc
	// contains filtered or unexported fields
}

Controller Instance variables

func (*Controller) Enqueue

func (c *Controller) Enqueue(obj interface{}) (requeued bool, err error)

Enqueue takes a resource and converts it into a namespace/name string which is then put onto the work queue

func (*Controller) HandleObject

func (c *Controller) HandleObject(ctx context.Context, obj interface{}, ownerKind string, getOwnerFn GetOwner)

HandleObject ensures that when anything happens to object which any custom resource is owner of, that custom resource is synced

func (*Controller) Run

func (c *Controller) Run(ctx context.Context, threadiness int) error

Run starts the shared informer, which will be stopped when stopCh is closed.

type ControllerTestSuite

type ControllerTestSuite struct {
	suite.Suite
	KubeClient           *fake.Clientset
	RadixClient          *fakeradix.Clientset
	SecretProviderClient *secretproviderfake.Clientset

	PromClient                *prometheusfake.Clientset
	KubeUtil                  *kube.Kube
	EventRecorder             *record.FakeRecorder
	RadixInformerFactory      informers.SharedInformerFactory
	KubeInformerFactory       kubeinformers.SharedInformerFactory
	MockCtrl                  *gomock.Controller
	Handler                   *MockHandler
	Synced                    chan bool
	Ctx                       context.Context
	CtxCancel                 context.CancelFunc
	TestControllerSyncTimeout time.Duration
	// contains filtered or unexported fields
}

ControllerTestSuite Test suite

func (*ControllerTestSuite) SetupTest

func (s *ControllerTestSuite) SetupTest()

SetupTest Set up the test suite

func (*ControllerTestSuite) SyncedChannelCallback

func (s *ControllerTestSuite) SyncedChannelCallback() func(ctx context.Context, namespace string, name string, eventRecorder record.EventRecorder) error

SyncedChannelCallback Callback to send a signal to the Synced

func (*ControllerTestSuite) TearDownTest

func (s *ControllerTestSuite) TearDownTest()

TearDownTest Tear down the test suite

func (*ControllerTestSuite) WaitForNotSynced

func (s *ControllerTestSuite) WaitForNotSynced(failMessage string)

WaitForNotSynced Wait for Synced signal is not received during a second

func (*ControllerTestSuite) WaitForSynced

func (s *ControllerTestSuite) WaitForSynced(expectedOperation string)

WaitForSynced Wait while Synced signal received or fail after TestControllerSyncTimeout

type GetOwner

type GetOwner func(context.Context, radixclient.Interface, string, string) (interface{}, error)

GetOwner Function pointer to pass to retrieve owner

type Handler

type Handler interface {
	Sync(ctx context.Context, namespace, name string, eventRecorder record.EventRecorder) error
}

Handler Common handler interface

type HasSynced

type HasSynced func(bool)

HasSynced Handler to function to report back on sync

type LockKeyAndIdentifierFunc

type LockKeyAndIdentifierFunc func(obj interface{}) (lockKey string, identifier string, err error)

LockKeyAndIdentifierFunc is a function which is either NamespacePartitionKey or NamePartitionKey

type MockHandler

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

MockHandler is a mock of Handler interface.

func NewMockHandler

func NewMockHandler(ctrl *gomock.Controller) *MockHandler

NewMockHandler creates a new mock instance.

func (*MockHandler) EXPECT

func (m *MockHandler) EXPECT() *MockHandlerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockHandler) Sync

func (m *MockHandler) Sync(ctx context.Context, namespace, name string, eventRecorder record.EventRecorder) error

Sync mocks base method.

type MockHandlerMockRecorder

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

MockHandlerMockRecorder is the mock recorder for MockHandler.

func (*MockHandlerMockRecorder) Sync

func (mr *MockHandlerMockRecorder) Sync(ctx, namespace, name, eventRecorder interface{}) *gomock.Call

Sync indicates an expected call of Sync.