Skip to content

feat: define interface for event recorder #1985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bakito wants to merge 1 commit into
base: main
Choose a base branch
from
+92 −36
Open

feat: define interface for event recorder #1985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/controller/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ func main() {

if err = webhook.Register(
manager,
*evt.NewEventRecorder(
evt.NewEventRecorder(
manager.GetClient(),
ctrl.Log.WithName("capsule.ctrl").WithName("events"),
manager.GetEventRecorder("tenant-controller"),
Expand Down
78 changes: 64 additions & 14 deletions pkg/runtime/events/event_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,26 @@ import (
"github.com/projectcapsule/capsule/pkg/api/meta"
)

type LabeledEvent struct {
recorder *EventRecorder
type LabeledEvent interface {
Emit(ctx context.Context)
WithRelated(obj runtime.Object) LabeledEvent
WithLabels(labels map[string]string) LabeledEvent
WithAnnotations(annotations map[string]string) LabeledEvent
WithTenantLabel(tnt *capsulev1beta2.Tenant) LabeledEvent
WithRequestAnnotations(req admission.Request) LabeledEvent

Reason() string
Action() string
Regarding() runtime.Object
Labels() map[string]string
Annotations() map[string]string
Note() string
EventType() string
Related() runtime.Object
}

type labeledEvent struct {
emitter eventEmitter

regarding runtime.Object
related runtime.Object
Expand All @@ -29,15 +47,47 @@ type LabeledEvent struct {
annotations map[string]string
}

func (r *EventRecorder) LabeledEvent(
func (e *labeledEvent) Reason() string {
return e.reason
}

func (e *labeledEvent) Action() string {
return e.action
}

func (e *labeledEvent) Regarding() runtime.Object {
return e.regarding
}

func (e *labeledEvent) Labels() map[string]string {
return maps.Clone(e.labels)
}

func (e *labeledEvent) Annotations() map[string]string {
return maps.Clone(e.annotations)
}

func (e *labeledEvent) Note() string {
return e.note
}

func (e *labeledEvent) EventType() string {
return e.eventType
}

func (e *labeledEvent) Related() runtime.Object {
return e.related
}

func (r *eventRecorder) LabeledEvent(
regarding runtime.Object,
eventType string,
reason string,
action string,
note string,
) *LabeledEvent {
return &LabeledEvent{
recorder: r,
) LabeledEvent {
return &labeledEvent{
emitter: r,
regarding: regarding,
eventType: eventType,
reason: reason,
Expand All @@ -48,33 +98,33 @@ func (r *EventRecorder) LabeledEvent(
}
}

func (e *LabeledEvent) Emit(ctx context.Context) {
if e == nil || e.recorder == nil {
func (e *labeledEvent) Emit(ctx context.Context) {
if e == nil || e.emitter == nil {
return
}

e.recorder.emitLabeledEvent(ctx, e)
e.emitter.Emit(ctx, e)
}

func (e *LabeledEvent) WithRelated(obj runtime.Object) *LabeledEvent {
func (e *labeledEvent) WithRelated(obj runtime.Object) LabeledEvent {
e.related = obj

return e
}

func (e *LabeledEvent) WithLabels(labels map[string]string) *LabeledEvent {
func (e *labeledEvent) WithLabels(labels map[string]string) LabeledEvent {
maps.Copy(e.labels, labels)

return e
}

func (e *LabeledEvent) WithAnnotations(annotations map[string]string) *LabeledEvent {
func (e *labeledEvent) WithAnnotations(annotations map[string]string) LabeledEvent {
maps.Copy(e.annotations, annotations)

return e
}

func (e *LabeledEvent) WithTenantLabel(tnt *capsulev1beta2.Tenant) *LabeledEvent {
func (e *labeledEvent) WithTenantLabel(tnt *capsulev1beta2.Tenant) LabeledEvent {
if tnt == nil {
return e
}
Expand All @@ -84,7 +134,7 @@ func (e *LabeledEvent) WithTenantLabel(tnt *capsulev1beta2.Tenant) *LabeledEvent
return e
}

func (e *LabeledEvent) WithRequestAnnotations(req admission.Request) *LabeledEvent {
func (e *labeledEvent) WithRequestAnnotations(req admission.Request) LabeledEvent {
if req.UID != "" {
e.annotations[meta.AuditRequestUID] = string(req.UID)
}
Expand Down
48 changes: 27 additions & 21 deletions pkg/runtime/events/recorder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,16 @@ const (
ReportingInstance = "capsule-admission"
)

type EventRecorder struct {
type EventRecorder interface {
k8sevents.EventRecorder
LabeledEvent(regarding runtime.Object, eventType string, reason string, action string, note string) LabeledEvent
}

type eventEmitter interface {
Emit(ctx context.Context, e LabeledEvent)
}
Comment thread
bakito marked this conversation as resolved.

type eventRecorder struct {
Comment thread
bakito marked this conversation as resolved.
k8sevents.EventRecorder

client client.Client
Expand All @@ -37,19 +46,16 @@ func NewEventRecorder(
log logr.Logger,
recorder k8sevents.EventRecorder,
configuration configuration.Configuration,
) *EventRecorder {
return &EventRecorder{
) EventRecorder {
return &eventRecorder{
Comment thread
bakito marked this conversation as resolved.
EventRecorder: recorder,
client: c,
log: log.WithName("event-recorder"),
configuration: configuration,
}
}

func (r *EventRecorder) emitLabeledEvent(
ctx context.Context,
e *LabeledEvent,
) {
func (r *eventRecorder) Emit(ctx context.Context, e LabeledEvent) {
if r == nil {
return
}
Expand All @@ -66,19 +72,19 @@ func (r *EventRecorder) emitLabeledEvent(
return
}

if e.reason == "" {
if e.Reason() == "" {
r.log.Error(nil, "cannot emit labeled event: reason is empty")

return
}

if e.action == "" {
if e.Action() == "" {
r.log.Error(nil, "cannot emit labeled event: action is empty")

return
}

regardingRef, metaObj, err := objectReference(e.regarding)
regardingRef, metaObj, err := objectReference(e.Regarding())
if err != nil {
r.log.Error(err, "cannot emit labeled event: build regarding reference")

Expand All @@ -100,21 +106,21 @@ func (r *EventRecorder) emitLabeledEvent(
ObjectMeta: metav1.ObjectMeta{
GenerateName: metaObj.GetName(),
Namespace: namespace,
Labels: e.labels,
Annotations: e.annotations,
Labels: e.Labels(),
Annotations: e.Annotations(),
},
EventTime: metav1.MicroTime{Time: time.Now()},
ReportingController: ReportingController,
ReportingInstance: ReportingInstance,
Action: e.action,
Reason: e.reason,
Action: e.Action(),
Reason: e.Reason(),
Regarding: regardingRef,
Note: e.note,
Type: e.eventType,
Note: e.Note(),
Type: e.EventType(),
}

if e.related != nil {
relatedRef, _, err := objectReference(e.related)
if e.Related() != nil {
relatedRef, _, err := objectReference(e.Related())
if err != nil {
r.log.Error(err, "cannot emit labeled event: build related reference")

Expand All @@ -128,9 +134,9 @@ func (r *EventRecorder) emitLabeledEvent(
r.log.Error(
err,
"cannot emit labeled event",
"reason", e.reason,
"action", e.action,
"type", e.eventType,
"reason", e.Reason(),
"action", e.Action(),
"type", e.EventType(),
"regarding", regardingRef.Name,
"namespace", namespace,
)
Expand Down
Loading