Skip to content

Commit 2948c51

Browse files
committed
Remove inject.Cache
Signed-off-by: Vince Prignano <[email protected]>
1 parent 9a6c6ac commit 2948c51

File tree

6 files changed

+2
-97
lines changed

6 files changed

+2
-97
lines changed

.golangci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ issues:
7474
- Subprocess launch(ed with variable|ing should be audited)
7575
- (G204|G104|G307)
7676
- "ST1000: at least one file in a package should have a package comment"
77+
- "SA1019: \"sigs.k8s.io/controller-runtime/pkg/runtime/inject\""
78+
- "SA1019: inject.*"
7779
exclude-rules:
7880
- linters:
7981
- gosec

pkg/cluster/cluster_test.go

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,6 @@ var _ = Describe("cluster.Cluster", func() {
137137
Expect(client).To(Equal(c.GetClient()))
138138
return nil
139139
},
140-
cache: func(cache cache.Cache) error {
141-
defer GinkgoRecover()
142-
Expect(cache).To(Equal(c.GetCache()))
143-
return nil
144-
},
145140
log: func(logger logr.Logger) error {
146141
defer GinkgoRecover()
147142
Expect(logger).To(Equal(logf.RuntimeLog.WithName("cluster")))
@@ -173,13 +168,6 @@ var _ = Describe("cluster.Cluster", func() {
173168
},
174169
})
175170
Expect(err).To(Equal(expected))
176-
177-
err = c.SetFields(&injectable{
178-
cache: func(c cache.Cache) error {
179-
return expected
180-
},
181-
})
182-
Expect(err).To(Equal(expected))
183171
})
184172
})
185173

@@ -243,7 +231,6 @@ var _ = Describe("cluster.Cluster", func() {
243231
})
244232
})
245233

246-
var _ inject.Cache = &injectable{}
247234
var _ inject.Client = &injectable{}
248235
var _ inject.Scheme = &injectable{}
249236
var _ inject.Config = &injectable{}
@@ -253,17 +240,9 @@ type injectable struct {
253240
scheme func(scheme *runtime.Scheme) error
254241
client func(client.Client) error
255242
config func(config *rest.Config) error
256-
cache func(cache.Cache) error
257243
log func(logger logr.Logger) error
258244
}
259245

260-
func (i *injectable) InjectCache(c cache.Cache) error {
261-
if i.cache == nil {
262-
return nil
263-
}
264-
return i.cache(c)
265-
}
266-
267246
func (i *injectable) InjectConfig(config *rest.Config) error {
268247
if i.config == nil {
269248
return nil

pkg/cluster/internal.go

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,6 @@ func (c *cluster) SetFields(i interface{}) error {
7777
if _, err := inject.SchemeInto(c.scheme, i); err != nil {
7878
return err
7979
}
80-
if _, err := inject.CacheInto(c.cache, i); err != nil {
81-
return err
82-
}
8380
if _, err := inject.MapperInto(c.mapper, i); err != nil {
8481
return err
8582
}

pkg/manager/manager_test.go

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1542,11 +1542,6 @@ var _ = Describe("manger.Manager", func() {
15421542
Expect(client).To(Equal(m.GetClient()))
15431543
return nil
15441544
},
1545-
cache: func(c cache.Cache) error {
1546-
defer GinkgoRecover()
1547-
Expect(c).To(Equal(m.GetCache()))
1548-
return nil
1549-
},
15501545
f: func(f inject.Func) error {
15511546
defer GinkgoRecover()
15521547
Expect(f).NotTo(BeNil())
@@ -1584,13 +1579,6 @@ var _ = Describe("manger.Manager", func() {
15841579
})
15851580
Expect(err).To(Equal(expected))
15861581

1587-
err = m.SetFields(&injectable{
1588-
cache: func(c cache.Cache) error {
1589-
return expected
1590-
},
1591-
})
1592-
Expect(err).To(Equal(expected))
1593-
15941582
err = m.SetFields(&injectable{
15951583
f: func(c inject.Func) error {
15961584
return expected
@@ -1726,7 +1714,6 @@ func (*failRec) InjectClient(client.Client) error {
17261714
}
17271715

17281716
var _ inject.Injector = &injectable{}
1729-
var _ inject.Cache = &injectable{}
17301717
var _ inject.Client = &injectable{}
17311718
var _ inject.Scheme = &injectable{}
17321719
var _ inject.Config = &injectable{}
@@ -1736,18 +1723,10 @@ type injectable struct {
17361723
scheme func(scheme *runtime.Scheme) error
17371724
client func(client.Client) error
17381725
config func(config *rest.Config) error
1739-
cache func(cache.Cache) error
17401726
f func(inject.Func) error
17411727
log func(logger logr.Logger) error
17421728
}
17431729

1744-
func (i *injectable) InjectCache(c cache.Cache) error {
1745-
if i.cache == nil {
1746-
return nil
1747-
}
1748-
return i.cache(c)
1749-
}
1750-
17511730
func (i *injectable) InjectConfig(config *rest.Config) error {
17521731
if i.config == nil {
17531732
return nil

pkg/runtime/inject/inject.go

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,9 @@ import (
2525
"k8s.io/apimachinery/pkg/runtime"
2626
"k8s.io/client-go/rest"
2727

28-
"sigs.k8s.io/controller-runtime/pkg/cache"
2928
"sigs.k8s.io/controller-runtime/pkg/client"
3029
)
3130

32-
// Cache is used by the ControllerManager to inject Cache into Sources, EventHandlers, Predicates, and
33-
// Reconciles.
34-
//
35-
// Deprecated: Dependency injection methods are deprecated and going to be removed in a future version.
36-
type Cache interface {
37-
InjectCache(cache cache.Cache) error
38-
}
39-
40-
// CacheInto will set informers on i and return the result if it implements Cache. Returns
41-
// false if i does not implement Cache.
42-
//
43-
// Deprecated: Dependency injection methods are deprecated and going to be removed in a future version.
44-
func CacheInto(c cache.Cache, i interface{}) (bool, error) {
45-
if s, ok := i.(Cache); ok {
46-
return true, s.InjectCache(c)
47-
}
48-
return false, nil
49-
}
50-
5131
// APIReader is used by the Manager to inject the APIReader into necessary types.
5232
//
5333
// Deprecated: Dependency injection methods are deprecated and going to be removed in a future version.

pkg/runtime/inject/inject_test.go

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,13 @@ import (
2525
"k8s.io/apimachinery/pkg/runtime"
2626
"k8s.io/client-go/rest"
2727
"sigs.k8s.io/controller-runtime/pkg/cache"
28-
"sigs.k8s.io/controller-runtime/pkg/cache/informertest"
2928
"sigs.k8s.io/controller-runtime/pkg/client"
3029
"sigs.k8s.io/controller-runtime/pkg/client/fake"
3130
)
3231

3332
var instance *testSource
3433
var uninjectable *failSource
3534
var errInjectFail = fmt.Errorf("injection fails")
36-
var expectedFalse = false
3735

3836
var _ = Describe("runtime inject", func() {
3937

@@ -42,28 +40,6 @@ var _ = Describe("runtime inject", func() {
4240
uninjectable = &failSource{}
4341
})
4442

45-
It("should set informers", func() {
46-
injectedCache := &informertest.FakeInformers{}
47-
48-
By("Validating injecting the informer")
49-
res, err := CacheInto(injectedCache, instance)
50-
Expect(err).NotTo(HaveOccurred())
51-
Expect(res).To(Equal(true))
52-
Expect(injectedCache).To(Equal(instance.GetCache()))
53-
54-
By("Returning false if the type does not implement inject.Cache")
55-
res, err = CacheInto(injectedCache, uninjectable)
56-
Expect(err).NotTo(HaveOccurred())
57-
Expect(res).To(Equal(expectedFalse))
58-
Expect(uninjectable.GetCache()).To(BeNil())
59-
60-
By("Returning an error if informer injection fails")
61-
res, err = CacheInto(nil, instance)
62-
Expect(err).To(Equal(errInjectFail))
63-
Expect(res).To(Equal(true))
64-
65-
})
66-
6743
It("should set config", func() {
6844

6945
cfg := &rest.Config{}
@@ -186,14 +162,6 @@ type testSource struct {
186162
stop <-chan struct{}
187163
}
188164

189-
func (s *testSource) InjectCache(c cache.Cache) error {
190-
if c != nil {
191-
s.cache = c
192-
return nil
193-
}
194-
return fmt.Errorf("injection fails")
195-
}
196-
197165
func (s *testSource) InjectConfig(config *rest.Config) error {
198166
if config != nil {
199167
s.config = config

0 commit comments

Comments
 (0)