common

package
v1.114.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 7, 2026 License: MIT Imports: 31 Imported by: 0

Documentation

Overview

Package common is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NamePartitionKey 

func NamePartitionKey(obj cache.ObjectName) (lockKey string)

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

func NamespacePartitionKey 

func NamespacePartitionKey(obj cache.ObjectName) (lockKey string)

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

func NewRateLimitedWorkQueue 

func NewRateLimitedWorkQueue(ctx context.Context, name string) workqueue.TypedRateLimitingInterface[cache.ObjectName]

Types

type Controller 

type Controller struct {
	Name                 string
	HandlerOf            string
	KubeClient           kubernetes.Interface
	RadixClient          radixclient.Interface
	WorkQueue            workqueue.TypedRateLimitingInterface[cache.ObjectName]
	KubeInformerFactory  kubeinformers.SharedInformerFactory
	RadixInformerFactory informers.SharedInformerFactory
	Handler              Handler
	LockKey              LockKeyFunc
	// contains filtered or unexported fields
}

Controller Instance variables

func (*Controller) Enqueue 

func (c *Controller) Enqueue(obj interface{}) 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
	DynamicClient        client.Client
	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) 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) error
}

Handler Common handler interface

type LockKeyFunc added in v1.103.1 

type LockKeyFunc func(obj cache.ObjectName) (lockKey string)

LockKeyFunc 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) 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 any) *gomock.Call

Sync indicates an expected call of Sync.

type SyncEventRecorder added in v1.103.1 

type SyncEventRecorder struct {
	Recorder record.EventRecorder
}

func NewSyncEventRecorder added in v1.103.1 

func NewSyncEventRecorder(recorder record.EventRecorder) SyncEventRecorder

func (SyncEventRecorder) RecordSyncErrorEvent added in v1.103.1 

func (r SyncEventRecorder) RecordSyncErrorEvent(obj runtime.Object, err error)

func (SyncEventRecorder) RecordSyncSuccessEvent added in v1.103.1 

func (r SyncEventRecorder) RecordSyncSuccessEvent(obj runtime.Object)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.