Skip to content

Commit 510bcee

Browse files
ecordellecordell
authored
Merge pull request #66 from ecordell/must-star
Add non-panicing versions of ListerFor, IndexerFor
2 parents 0091c10 + 596172c commit 510bcee

File tree

11 files changed

+201
-35
lines changed

11 files changed

+201
-35
lines changed

‎adopt/adopt.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ const Owned = "owned"
8686

8787
var (
8888
// AlwaysExistsFunc is an ExistsFunc that always returns nil
89-
AlwaysExistsFunc ExistsFunc = func(ctx context.Context, nn types.NamespacedName) error {
89+
AlwaysExistsFunc ExistsFunc = func(_ context.Context, _ types.NamespacedName) error {
9090
return nil
9191
}
9292
// NoopObjectMissingFunc is an ObjectMissing func that does nothing
93-
NoopObjectMissingFunc = func(ctx context.Context, err error) {}
93+
NoopObjectMissingFunc = func(_ context.Context, _ error) {}
9494
)
9595

9696
// AdoptionHandler implements handler.Handler to "adopt" an existing resource

‎adopt/adopt_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func TestSecretAdopterHandler(t *testing.T) {
4646
err error
4747
}
4848

49-
secretNotFound := func(name string) error {
49+
secretNotFound := func(_ string) error {
5050
return apierrors.NewNotFound(
5151
corev1.SchemeGroupVersion.WithResource("secrets").GroupResource(),
5252
"test")
@@ -324,21 +324,21 @@ func TestSecretAdopterHandler(t *testing.T) {
324324
applyCallIndex := 0
325325
s := NewSecretAdoptionHandler(
326326
recorder,
327-
func(ctx context.Context) (*corev1.Secret, error) {
327+
func(_ context.Context) (*corev1.Secret, error) {
328328
return tt.secretInCache, tt.cacheErr
329329
},
330-
func(ctx context.Context, err error) {
330+
func(_ context.Context, err error) {
331331
require.Equal(t, tt.expectObjectMissingErr, err)
332332
},
333333
typed.NewIndexer[*corev1.Secret](indexer),
334-
func(ctx context.Context, secret *applycorev1.SecretApplyConfiguration, opts metav1.ApplyOptions) (result *corev1.Secret, err error) {
334+
func(_ context.Context, secret *applycorev1.SecretApplyConfiguration, _ metav1.ApplyOptions) (result *corev1.Secret, err error) {
335335
defer func() { applyCallIndex++ }()
336336
call := tt.applyCalls[applyCallIndex]
337337
call.called = true
338338
require.Equal(t, call.input, secret, "error on call %d", applyCallIndex)
339339
return call.result, call.err
340340
},
341-
func(ctx context.Context, nn types.NamespacedName) error {
341+
func(_ context.Context, _ types.NamespacedName) error {
342342
return tt.secretExistsErr
343343
},
344344
handler.NewHandlerFromFunc(func(ctx context.Context) {

‎bootstrap/crds.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ func waitForDiscovery(ctx context.Context, config *rest.Config, crds []*apiexten
117117
return err
118118
}
119119

120-
return wait.PollUntilContextTimeout(ctx, crdInstallPollInterval, maxCRDInstallTime, true, func(ctx context.Context) (done bool, err error) {
120+
return wait.PollUntilContextTimeout(ctx, crdInstallPollInterval, maxCRDInstallTime, true, func(_ context.Context) (done bool, err error) {
121121
_, serverGVRs, err := discoveryClient.ServerGroupsAndResources()
122122
if err != nil {
123123
return false, nil

‎component/ensure_component_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ func TestEnsureServiceHandler(t *testing.T) {
122122
client := clientfake.NewSimpleDynamicClient(scheme, tt.existingServices...)
123123
informerFactory := dynamicinformer.NewDynamicSharedInformerFactory(client, 0)
124124
require.NoError(t, informerFactory.ForResource(serviceGVR).Informer().AddIndexers(map[string]cache.IndexFunc{
125-
ownerIndex: func(obj interface{}) ([]string, error) {
125+
ownerIndex: func(_ interface{}) ([]string, error) {
126126
return []string{types.NamespacedName{Namespace: "test", Name: "owner"}.String()}, nil
127127
},
128128
}))
@@ -137,23 +137,23 @@ func TestEnsureServiceHandler(t *testing.T) {
137137
NewIndexedComponent(
138138
indexer,
139139
ownerIndex,
140-
func(ctx context.Context) labels.Selector {
140+
func(_ context.Context) labels.Selector {
141141
return labels.SelectorFromSet(map[string]string{
142142
"example.com/component": "the-main-service-component",
143143
})
144144
}),
145145
hash.NewObjectHash(), hashKey),
146146
ctxOwner,
147147
queueOps,
148-
func(ctx context.Context, apply *applycorev1.ServiceApplyConfiguration) (*corev1.Service, error) {
148+
func(_ context.Context, _ *applycorev1.ServiceApplyConfiguration) (*corev1.Service, error) {
149149
applyCalled = true
150150
return nil, nil
151151
},
152-
func(ctx context.Context, nn types.NamespacedName) error {
152+
func(_ context.Context, _ types.NamespacedName) error {
153153
deleteCalled = true
154154
return nil
155155
},
156-
func(ctx context.Context) *applycorev1.ServiceApplyConfiguration {
156+
func(_ context.Context) *applycorev1.ServiceApplyConfiguration {
157157
return applycorev1.Service("test", "test").
158158
WithLabels(map[string]string{
159159
"example.com/component": "the-main-service-component",

‎handler/handler.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ func (f Builder) Handler(id Key) Handler {
127127
}
128128

129129
// NoopHandler is a handler that does nothing
130-
var NoopHandler = NewHandler(ContextHandlerFunc(func(ctx context.Context) {}), NextKey)
130+
var NoopHandler = NewHandler(ContextHandlerFunc(func(_ context.Context) {}), NextKey)
131131

132132
// Key is used to identify a given Handler in a set of Handlers
133133
type Key string

‎manager/controller_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ func ExampleNewOwnedResourceController() {
3232

3333
// the controller processes objects on the queue, but doesn't set up any
3434
// informers by default.
35-
controller := NewOwnedResourceController(klogr.New(), "my-controller", gvr, CtxQueue, registry, broadcaster, func(ctx context.Context, gvr schema.GroupVersionResource, namespace, name string) {
36-
// process object
35+
controller := NewOwnedResourceController(klogr.New(), "my-controller", gvr, CtxQueue, registry, broadcaster, func(_ context.Context, gvr schema.GroupVersionResource, namespace, name string) {
36+
fmt.Println("processing", gvr, namespace, name)
3737
})
3838

3939
mgr := NewManager(ctrlmanageropts.RecommendedDebuggingOptions().DebuggingConfiguration, ":", broadcaster, eventSink)
@@ -54,7 +54,8 @@ func TestControllerQueueDone(t *testing.T) {
5454
broadcaster := record.NewBroadcaster()
5555
eventSink := &typedcorev1.EventSinkImpl{Interface: fake.NewSimpleClientset().CoreV1().Events("")}
5656

57-
controller := NewOwnedResourceController(klogr.New(), "my-controller", gvr, CtxQueue, registry, broadcaster, func(ctx context.Context, gvr schema.GroupVersionResource, namespace, name string) {
57+
controller := NewOwnedResourceController(klogr.New(), "my-controller", gvr, CtxQueue, registry, broadcaster, func(_ context.Context, gvr schema.GroupVersionResource, namespace, name string) {
58+
fmt.Println("processing", gvr, namespace, name)
5859
})
5960

6061
mgr := NewManager(ctrlmanageropts.RecommendedDebuggingOptions().DebuggingConfiguration, ":", broadcaster, eventSink)

‎pause/pause_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func ExampleNewPauseContextHandler() {
4444
queueOperations.Key,
4545
"example.com/paused",
4646
ctxObject,
47-
func(ctx context.Context, patch *MyObject) error {
47+
func(_ context.Context, _ *MyObject) error {
4848
// update status
4949
return nil
5050
},
@@ -184,7 +184,7 @@ func TestPauseHandler(t *testing.T) {
184184
ctrls := &fake.FakeInterface{}
185185
patchCalled := false
186186

187-
patchStatus := func(ctx context.Context, patch *MyObject) error {
187+
patchStatus := func(_ context.Context, patch *MyObject) error {
188188
patchCalled = true
189189

190190
if tt.patchError != nil {
@@ -209,7 +209,7 @@ func TestPauseHandler(t *testing.T) {
209209
ctx = ctxMyObject.WithValue(ctx, tt.obj)
210210
var called handler.Key
211211

212-
NewPauseContextHandler(queueOps.Key, PauseLabelKey, ctxMyObject, patchStatus, handler.ContextHandlerFunc(func(ctx context.Context) {
212+
NewPauseContextHandler(queueOps.Key, PauseLabelKey, ctxMyObject, patchStatus, handler.ContextHandlerFunc(func(_ context.Context) {
213213
called = nextKey
214214
})).Handle(ctx)
215215

‎queue/controls_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func ExampleNewOperations() {
2828
}, cancel)
2929

3030
// typically called from a handler
31-
handler.NewHandlerFromFunc(func(ctx context.Context) {
31+
handler.NewHandlerFromFunc(func(_ context.Context) {
3232
// do some work
3333
operations.Done()
3434
}, "example").Handle(ctx)
@@ -60,7 +60,7 @@ func ExampleNewQueueOperationsCtx() {
6060
}, cancel))
6161

6262
// queue controls are passed via context
63-
handler.NewHandlerFromFunc(func(ctx context.Context) {
63+
handler.NewHandlerFromFunc(func(_ context.Context) {
6464
// do some work
6565
CtxQueue.Done()
6666
}, "example").Handle(ctx)

‎static/controller.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ func NewStaticController[K bootstrap.KubeResourceObject](log logr.Logger, name s
4949
func (c *Controller[K]) Start(ctx context.Context, _ int) {
5050
inf := c.fileInformerFactory.ForResource(c.staticClusterResource).Informer()
5151
_, err := inf.AddEventHandler(cache.ResourceEventHandlerFuncs{
52-
AddFunc: func(obj interface{}) { c.handleStaticResource(ctx) },
53-
UpdateFunc: func(_, obj interface{}) { c.handleStaticResource(ctx) },
54-
DeleteFunc: func(obj interface{}) { c.handleStaticResource(ctx) },
52+
AddFunc: func(_ any) { c.handleStaticResource(ctx) },
53+
UpdateFunc: func(_, _ any) { c.handleStaticResource(ctx) },
54+
DeleteFunc: func(_ any) { c.handleStaticResource(ctx) },
5555
})
5656
if err != nil {
5757
panic("failed to add handlers: " + err.Error())

‎typed/registry.go

Lines changed: 105 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,43 @@ func (r *Registry) NewFilteredDynamicSharedInformerFactory(key FactoryKey, clien
9494
}
9595

9696
// ListerFor returns a typed Lister from a Registry
97+
// Deprecated: Use MustListerForKey instead
9798
func ListerFor[K runtime.Object](r *Registry, key RegistryKey) *Lister[K] {
98-
return NewLister[K](r.ListerFor(key))
99+
return MustListerForKey[K](r, key)
100+
}
101+
102+
// MustListerForKey returns a typed Lister from a Registry, or panics if the key is not found
103+
func MustListerForKey[K runtime.Object](r *Registry, key RegistryKey) *Lister[K] {
104+
return NewLister[K](r.MustListerForKey(key))
105+
}
106+
107+
// ListerForKey returns a typed Lister from a Registry, or an error if the key is not found
108+
func ListerForKey[K runtime.Object](r *Registry, key RegistryKey) (*Lister[K], error) {
109+
lister, err := r.ListerForKey(key)
110+
if err != nil {
111+
return nil, err
112+
}
113+
return NewLister[K](lister), nil
99114
}
100115

101116
// IndexerFor returns a typed Indexer from a Registry
117+
// Deprecated: Use MustIndexerForKey instead
102118
func IndexerFor[K runtime.Object](r *Registry, key RegistryKey) *Indexer[K] {
103-
return NewIndexer[K](r.InformerFor(key).GetIndexer())
119+
return MustIndexerForKey[K](r, key)
120+
}
121+
122+
// MustIndexerForKey returns a typed Indexer from a Registry, or panics if the key is not found
123+
func MustIndexerForKey[K runtime.Object](r *Registry, key RegistryKey) *Indexer[K] {
124+
return NewIndexer[K](r.MustIndexerForKey(key))
125+
}
126+
127+
// IndexerForKey returns a typed Indexer from a Registry, or an error if the key is not found
128+
func IndexerForKey[K runtime.Object](r *Registry, key RegistryKey) (*Indexer[K], error) {
129+
indexer, err := r.IndexerForKey(key)
130+
if err != nil {
131+
return nil, err
132+
}
133+
return NewIndexer[K](indexer), nil
104134
}
105135

106136
// Add adds a factory to the registry under the given FactoryKey
@@ -124,27 +154,95 @@ func (r *Registry) Remove(key FactoryKey) {
124154
}
125155

126156
// InformerFactoryFor returns GVR-specific InformerFactory from the Registry.
157+
// Deprecated: use MustInformerFactoryForKey instead.
127158
func (r *Registry) InformerFactoryFor(key RegistryKey) informers.GenericInformer {
159+
return r.MustInformerFactoryForKey(key)
160+
}
161+
162+
// MustInformerFactoryForKey returns GVR-specific InformerFactory from the Registry
163+
// or panics if the key is not found.
164+
func (r *Registry) MustInformerFactoryForKey(key RegistryKey) informers.GenericInformer {
165+
informer, err := r.InformerFactoryForKey(key)
166+
if err != nil {
167+
panic(err)
168+
}
169+
return informer
170+
}
171+
172+
// InformerFactoryForKey returns GVR-specific InformerFactory from the Registry
173+
// or returns an error if the key is not found.
174+
func (r *Registry) InformerFactoryForKey(key RegistryKey) (informers.GenericInformer, error) {
128175
r.RLock()
129176
defer r.RUnlock()
130177
factory, ok := r.factories[key.FactoryKey]
131178
if !ok {
132-
panic(fmt.Errorf("InformerFactoryFor called with unknown key %s", key))
179+
return nil, fmt.Errorf("InformerFactoryFor called with unknown key %s", key)
133180
}
134-
return factory.ForResource(key.GroupVersionResource)
181+
return factory.ForResource(key.GroupVersionResource), nil
135182
}
136183

137184
// ListerFor returns the GVR-specific Lister from the Registry
185+
// Deprecated: use MustListerForKey instead.
138186
func (r *Registry) ListerFor(key RegistryKey) cache.GenericLister {
139-
return r.InformerFactoryFor(key).Lister()
187+
return r.MustInformerFactoryForKey(key).Lister()
188+
}
189+
190+
// MustListerForKey returns the GVR-specific Lister from the Registry, or panics
191+
// if the key is not found.
192+
func (r *Registry) MustListerForKey(key RegistryKey) cache.GenericLister {
193+
return r.MustInformerFactoryForKey(key).Lister()
194+
}
195+
196+
// ListerForKey returns the GVR-specific Lister from the Registry, or an error
197+
// if the key is not found.
198+
func (r *Registry) ListerForKey(key RegistryKey) (cache.GenericLister, error) {
199+
factory, err := r.InformerFactoryForKey(key)
200+
if err != nil {
201+
return nil, err
202+
}
203+
return factory.Lister(), nil
140204
}
141205

142206
// InformerFor returns the GVR-specific Informer from the Registry
207+
// Deprecated: use MustInformerForKey instead.
143208
func (r *Registry) InformerFor(key RegistryKey) cache.SharedIndexInformer {
144-
return r.InformerFactoryFor(key).Informer()
209+
return r.MustInformerFactoryForKey(key).Informer()
210+
}
211+
212+
// MustInformerForKey returns the GVR-specific Informer from the Registry, or panics
213+
// if the key is not found.
214+
func (r *Registry) MustInformerForKey(key RegistryKey) cache.SharedIndexInformer {
215+
return r.MustInformerFactoryForKey(key).Informer()
216+
}
217+
218+
// InformerForKey returns the GVR-specific Informer from the Registry, or an error
219+
// if the key is not found.
220+
func (r *Registry) InformerForKey(key RegistryKey) (cache.SharedIndexInformer, error) {
221+
factory, err := r.InformerFactoryForKey(key)
222+
if err != nil {
223+
return nil, err
224+
}
225+
return factory.Informer(), nil
145226
}
146227

147228
// IndexerFor returns the GVR-specific Indexer from the Registry
229+
// Deprecated: use MustIndexerForKey instead.
148230
func (r *Registry) IndexerFor(key RegistryKey) cache.Indexer {
149-
return r.InformerFactoryFor(key).Informer().GetIndexer()
231+
return r.MustInformerForKey(key).GetIndexer()
232+
}
233+
234+
// MustIndexerForKey returns the GVR-specific Indexer from the Registry, or panics
235+
// if the key is not found.
236+
func (r *Registry) MustIndexerForKey(key RegistryKey) cache.Indexer {
237+
return r.MustInformerForKey(key).GetIndexer()
238+
}
239+
240+
// IndexerForKey returns the GVR-specific Indexer from the Registry, or an error
241+
// if the key is not found.
242+
func (r *Registry) IndexerForKey(key RegistryKey) (cache.Indexer, error) {
243+
informer, err := r.InformerForKey(key)
244+
if err != nil {
245+
return nil, err
246+
}
247+
return informer.GetIndexer(), nil
150248
}

0 commit comments

Comments
 (0)