Datasets:
File size: 10,530 Bytes
0e239c6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | diff --git a/pkg/cluster/cluster_test.go b/pkg/cluster/cluster_test.go
index e076faf3..f8b8e8ca 100644
--- a/pkg/cluster/cluster_test.go
+++ b/pkg/cluster/cluster_test.go
@@ -31,6 +31,7 @@ import (
utilnet "k8s.io/apimachinery/pkg/util/net"
"k8s.io/client-go/rest"
+ "k8s.io/client-go/tools/events"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
intrec "sigs.k8s.io/controller-runtime/pkg/internal/recorder"
@@ -159,7 +160,11 @@ var _ = Describe("cluster.Cluster", func() {
It("should provide a function to get the EventRecorder", func() {
c, err := New(cfg)
Expect(err).NotTo(HaveOccurred())
- Expect(c.GetEventRecorder("test")).NotTo(BeNil())
+ recorder := c.GetEventRecorder("test")
+ Expect(recorder).NotTo(BeNil())
+ // The returned recorder should support both Eventf and AnnotatedEventf
+ var _ events.EventRecorder = recorder
+ var _ events.AnnotatedEventRecorder = recorder
})
It("should provide a function to get the deprecated EventRecorder", func() {
diff --git a/pkg/cluster/internal.go b/pkg/cluster/internal.go
index 755f83b5..e01f0726 100644
--- a/pkg/cluster/internal.go
+++ b/pkg/cluster/internal.go
@@ -24,12 +24,12 @@ import (
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/rest"
- "k8s.io/client-go/tools/events"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
intrec "sigs.k8s.io/controller-runtime/pkg/internal/recorder"
+ "sigs.k8s.io/controller-runtime/pkg/recorder"
)
type cluster struct {
@@ -88,7 +88,7 @@ func (c *cluster) GetEventRecorderFor(name string) record.EventRecorder {
return c.recorderProvider.GetEventRecorderFor(name)
}
-func (c *cluster) GetEventRecorder(name string) events.EventRecorder {
+func (c *cluster) GetEventRecorder(name string) recorder.EventRecorder {
return c.recorderProvider.GetEventRecorder(name)
}
diff --git a/pkg/internal/recorder/recorder.go b/pkg/internal/recorder/recorder.go
index 097d2dee..1f2738e5 100644
--- a/pkg/internal/recorder/recorder.go
+++ b/pkg/internal/recorder/recorder.go
@@ -30,6 +30,7 @@ import (
"k8s.io/client-go/tools/events"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/controller-runtime/pkg/log"
+ "sigs.k8s.io/controller-runtime/pkg/recorder"
)
// EventBroadcasterProducer makes an event broadcaster, returning
@@ -164,7 +165,8 @@ func (p *Provider) GetEventRecorderFor(name string) record.EventRecorder {
// broadcaster. All events will be associated with the given reportingController
// name. client-go appends "-" and the hostname to derive reportingInstance,
// which must fit within the events.k8s.io/v1 128-character limit.
-func (p *Provider) GetEventRecorder(name string) events.EventRecorder {
+// The returned recorder supports both Eventf and AnnotatedEventf.
+func (p *Provider) GetEventRecorder(name string) recorder.EventRecorder {
return &lazyRecorder{
prov: p,
name: name,
@@ -173,19 +175,24 @@ func (p *Provider) GetEventRecorder(name string) events.EventRecorder {
// lazyRecorder is a recorder that doesn't actually instantiate any underlying
// recorder until the first event is emitted.
+var _ recorder.EventRecorder = (*lazyRecorder)(nil)
+
type lazyRecorder struct {
prov *Provider
name string
- recOnce sync.Once
- rec events.EventRecorder
+ recOnce sync.Once
+ eventRecorder events.EventRecorder
+ annotatedEventRecorder events.AnnotatedEventRecorder
}
// ensureRecording ensures that a concrete recorder is populated for this recorder.
func (l *lazyRecorder) ensureRecording() {
l.recOnce.Do(func() {
_, broadcaster := l.prov.getBroadcaster()
- l.rec = broadcaster.NewRecorder(l.prov.scheme, l.name)
+ rec := broadcaster.NewRecorder(l.prov.scheme, l.name)
+ l.eventRecorder = rec
+ l.annotatedEventRecorder = rec.(events.AnnotatedEventRecorder)
})
}
@@ -194,7 +201,17 @@ func (l *lazyRecorder) Eventf(regarding runtime.Object, related runtime.Object,
l.prov.lock.RLock()
if !l.prov.stopped {
- l.rec.Eventf(regarding, related, eventtype, reason, action, note, args...)
+ l.eventRecorder.Eventf(regarding, related, eventtype, reason, action, note, args...)
+ }
+ l.prov.lock.RUnlock()
+}
+
+func (l *lazyRecorder) AnnotatedEventf(regarding runtime.Object, related runtime.Object, annotations map[string]string, eventtype, reason, action, note string, args ...any) {
+ l.ensureRecording()
+
+ l.prov.lock.RLock()
+ if !l.prov.stopped {
+ l.annotatedEventRecorder.AnnotatedEventf(regarding, related, annotations, eventtype, reason, action, note, args...)
}
l.prov.lock.RUnlock()
}
diff --git a/pkg/internal/recorder/recorder_integration_test.go b/pkg/internal/recorder/recorder_integration_test.go
index 72c8335c..1f3950af 100644
--- a/pkg/internal/recorder/recorder_integration_test.go
+++ b/pkg/internal/recorder/recorder_integration_test.go
@@ -45,15 +45,16 @@ var _ = Describe("recorder", func() {
Expect(err).NotTo(HaveOccurred())
By("Creating the Controller")
- deprecatedRecorder := cm.GetEventRecorder("test-deprecated-recorder")
+ deprecatedRecorder := cm.GetEventRecorderFor("test-deprecated-recorder") //nolint:staticcheck // testing deprecated API
recorder := cm.GetEventRecorder("test-recorder")
instance, err := controller.New("foo-controller", cm, controller.Options{
Reconciler: reconcile.Func(
func(ctx context.Context, request reconcile.Request) (reconcile.Result, error) {
dp, err := clientset.AppsV1().Deployments(request.Namespace).Get(ctx, request.Name, metav1.GetOptions{})
Expect(err).NotTo(HaveOccurred())
- deprecatedRecorder.Eventf(dp, nil, corev1.EventTypeNormal, "deprecated-test-reason", "deprecatedAction", "deprecated-test-msg")
+ deprecatedRecorder.Eventf(dp, corev1.EventTypeNormal, "deprecated-test-reason", "deprecated-test-msg")
recorder.Eventf(dp, nil, corev1.EventTypeNormal, "test-reason", "test-action", "test-note")
+ recorder.AnnotatedEventf(dp, nil, map[string]string{"key": "value"}, corev1.EventTypeNormal, "test-annotated-reason", "test-annotated-action", "test-annotated-note")
return reconcile.Result{}, nil
}),
})
@@ -129,6 +130,24 @@ var _ = Describe("recorder", func() {
Expect(evt.Reason).To(Equal("test-reason"))
Expect(evt.Action).To(Equal("test-action"))
Expect(evt.Note).To(Equal("test-note"))
+
+ By("Validate annotated event is published as expected")
+ annotatedEvtWatcher, err := clientset.EventsV1().Events("default").Watch(ctx,
+ metav1.ListOptions{FieldSelector: fields.OneTermEqualSelector("reason", "test-annotated-reason").String()})
+ Expect(err).NotTo(HaveOccurred())
+
+ resultEvent = <-annotatedEvtWatcher.ResultChan()
+
+ Expect(resultEvent.Type).To(Equal(watch.Added))
+ annotatedEvt, isEvent := resultEvent.Object.(*eventsv1.Event)
+ Expect(isEvent).To(BeTrue())
+
+ Expect(annotatedEvt.Regarding).To(Equal(*dpRef))
+ Expect(annotatedEvt.Type).To(Equal(corev1.EventTypeNormal))
+ Expect(annotatedEvt.Reason).To(Equal("test-annotated-reason"))
+ Expect(annotatedEvt.Action).To(Equal("test-annotated-action"))
+ Expect(annotatedEvt.Note).To(Equal("test-annotated-note"))
+ Expect(annotatedEvt.Annotations).To(HaveKeyWithValue("key", "value"))
})
})
})
diff --git a/pkg/internal/recorder/recorder_test.go b/pkg/internal/recorder/recorder_test.go
index e592a1e1..50fd5979 100644
--- a/pkg/internal/recorder/recorder_test.go
+++ b/pkg/internal/recorder/recorder_test.go
@@ -54,12 +54,15 @@ var _ = Describe("recorder.Provider", func() {
})
})
Describe("GetEventRecorder", func() {
- It("should return a recorder instance.", func() {
+ It("should return a recorder instance that supports both Eventf and AnnotatedEventf.", func() {
provider, err := recorder.NewProvider(cfg, httpClient, scheme.Scheme, logr.Discard(), makeBroadcaster())
Expect(err).NotTo(HaveOccurred())
- recorder := provider.GetEventRecorder("test")
- Expect(recorder).NotTo(BeNil())
+ rec := provider.GetEventRecorder("test")
+ Expect(rec).NotTo(BeNil())
+ // Verify it satisfies both interfaces
+ var _ events.EventRecorder = rec
+ var _ events.AnnotatedEventRecorder = rec
})
})
})
diff --git a/pkg/manager/internal.go b/pkg/manager/internal.go
index ceb1450d..55fa2fca 100644
--- a/pkg/manager/internal.go
+++ b/pkg/manager/internal.go
@@ -32,7 +32,6 @@ import (
"k8s.io/apimachinery/pkg/runtime"
kerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/client-go/rest"
- "k8s.io/client-go/tools/events"
"k8s.io/client-go/tools/leaderelection"
"k8s.io/client-go/tools/leaderelection/resourcelock"
"k8s.io/client-go/tools/record"
@@ -46,6 +45,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/internal/httpserver"
intrec "sigs.k8s.io/controller-runtime/pkg/internal/recorder"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
+ "sigs.k8s.io/controller-runtime/pkg/recorder"
"sigs.k8s.io/controller-runtime/pkg/webhook"
)
@@ -264,7 +264,7 @@ func (cm *controllerManager) GetEventRecorderFor(name string) record.EventRecord
return cm.cluster.GetEventRecorderFor(name) //nolint:staticcheck
}
-func (cm *controllerManager) GetEventRecorder(name string) events.EventRecorder {
+func (cm *controllerManager) GetEventRecorder(name string) recorder.EventRecorder {
return cm.cluster.GetEventRecorder(name)
}
diff --git a/pkg/recorder/recorder.go b/pkg/recorder/recorder.go
index 896098ad..945202f8 100644
--- a/pkg/recorder/recorder.go
+++ b/pkg/recorder/recorder.go
@@ -25,6 +25,13 @@ import (
"k8s.io/client-go/tools/record"
)
+// EventRecorder combines both events.EventRecorder and events.AnnotatedEventRecorder
+// so that callers only need a single recorder to emit both regular and annotated events.
+type EventRecorder interface {
+ events.EventRecorder
+ events.AnnotatedEventRecorder
+}
+
// Provider knows how to generate new event recorders with given name.
type Provider interface {
// GetEventRecorderFor returns an EventRecorder for the old events API.
@@ -39,5 +46,6 @@ type Provider interface {
// reportingController. reportingInstance must be no more than 128
// characters, so callers should ensure that len(name) + 1 + len(hostname)
// is at most 128.
- GetEventRecorder(name string) events.EventRecorder
+ // The returned recorder supports both Eventf and AnnotatedEventf.
+ GetEventRecorder(name string) EventRecorder
}
|