Skip to content

chore: migrate status controller to events.EventRecorder API #205

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

Closed
jamesmt-aws wants to merge 1 commit into from
Closed

chore: migrate status controller to events.EventRecorder API #205

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
17 changes: 9 additions & 8 deletions status/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"github.com/samber/lo"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/tools/events"
controllerruntime "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
Expand All @@ -35,7 +35,7 @@ type Controller[T Object] struct {
additionalMetricFields map[string]string
additionalGaugeMetricFields map[string]string
kubeClient client.Client
eventRecorder record.EventRecorder
eventRecorder events.EventRecorder
observedConditions sync.Map // map[reconcile.Request]ConditionSet
observedGaugeLabels sync.Map // map[reconcile.Request]map[string]string
observedFinalizers sync.Map // map[reconcile.Request]Finalizer
Expand Down Expand Up @@ -107,7 +107,7 @@ func WitMaxConcurrentReconciles(m int) func(*Option) {
}
}

func NewController[T Object](client client.Client, eventRecorder record.EventRecorder, opts ...option.Function[Option]) *Controller[T] {
func NewController[T Object](client client.Client, eventRecorder events.EventRecorder, opts ...option.Function[Option]) *Controller[T] {
options := option.Resolve(opts...)
obj := reflect.New(reflect.TypeOf(*new(T)).Elem()).Interface().(runtime.Object)
obj.GetObjectKind().SetGroupVersionKind(obj.GetObjectKind().GroupVersionKind())
Expand Down Expand Up @@ -166,7 +166,7 @@ type GenericObjectController[T client.Object] struct {
*Controller[*UnstructuredAdapter[T]]
}

func NewGenericObjectController[T client.Object](client client.Client, eventRecorder record.EventRecorder, opts ...option.Function[Option]) *GenericObjectController[T] {
func NewGenericObjectController[T client.Object](client client.Client, eventRecorder events.EventRecorder, opts ...option.Function[Option]) *GenericObjectController[T] {
return &GenericObjectController[T]{
Controller: NewController[*UnstructuredAdapter[T]](client, eventRecorder, opts...),
}
Expand Down Expand Up @@ -236,7 +236,7 @@ func (c *Controller[T]) reconcile(ctx context.Context, req reconcile.Request, o
}
if finalizers, ok := c.observedFinalizers.LoadAndDelete(req); ok {
for _, finalizer := range finalizers.([]string) {
c.eventRecorder.Event(o, v1.EventTypeNormal, "Finalized", fmt.Sprintf("Finalized %s", finalizer))
c.eventRecorder.Eventf(o, nil, v1.EventTypeNormal, "Finalized", "Finalize", "Finalized %s", finalizer)
}
}
return reconcile.Result{}, nil
Expand All @@ -248,7 +248,7 @@ func (c *Controller[T]) reconcile(ctx context.Context, req reconcile.Request, o
observedFinalizers, _ := c.observedFinalizers.Swap(req, o.GetFinalizers())
if observedFinalizers != nil {
for _, finalizer := range lo.Without(observedFinalizers.([]string), o.GetFinalizers()...) {
c.eventRecorder.Event(o, v1.EventTypeNormal, "Finalized", fmt.Sprintf("Finalized %s", finalizer))
c.eventRecorder.Eventf(o, nil, v1.EventTypeNormal, "Finalized", "Finalize", "Finalized %s", finalizer)
}
}

Expand Down Expand Up @@ -347,13 +347,14 @@ func (c *Controller[T]) reconcile(ctx context.Context, req reconcile.Request, o
pmetrics.LabelType: observedCondition.Type,
MetricLabelConditionStatus: string(observedCondition.Status),
}, c.toAdditionalMetricLabels(o))
c.eventRecorder.Event(o, v1.EventTypeNormal, condition.Type, fmt.Sprintf("Status condition transitioned, Type: %s, Status: %s -> %s, Reason: %s%s",
c.eventRecorder.Eventf(o, nil, v1.EventTypeNormal, condition.Type, "TransitionCondition",
"Status condition transitioned, Type: %s, Status: %s -> %s, Reason: %s%s",
condition.Type,
observedCondition.Status,
condition.Status,
condition.Reason,
lo.Ternary(condition.Message != "", fmt.Sprintf(", Message: %s", condition.Message), ""),
))
)
}
return reconcile.Result{RequeueAfter: time.Second * 10}, nil
}
Expand Down
10 changes: 5 additions & 5 deletions status/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/tools/events"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/metrics"
)

var ctx context.Context
var recorder *record.FakeRecorder
var recorder *events.FakeRecorder
var kubeClient client.Client
var registry = metrics.Registry

Expand All @@ -41,11 +41,11 @@ var _ = AfterEach(func() {

var _ = Describe("Controller", func() {
var ctx context.Context
var recorder *record.FakeRecorder
var recorder *events.FakeRecorder
var controller *status.Controller[*test.CustomObject]
var kubeClient client.Client
BeforeEach(func() {
recorder = record.NewFakeRecorder(10)
recorder = events.NewFakeRecorder(10)
kubeClient = fake.NewClientBuilder().WithScheme(scheme.Scheme).WithStatusSubresource(&test.CustomObject{}).Build()
ctx = log.IntoContext(context.Background(), GinkgoLogr)
controller = status.NewController[*test.CustomObject](kubeClient, recorder, status.EmitDeprecatedMetrics)
Expand Down Expand Up @@ -807,7 +807,7 @@ var _ = Describe("Controller", func() {
var _ = Describe("Generic Controller", func() {
var genericController *status.GenericObjectController[*TestGenericObject]
BeforeEach(func() {
recorder = record.NewFakeRecorder(10)
recorder = events.NewFakeRecorder(10)
kubeClient = fake.NewClientBuilder().WithScheme(scheme.Scheme).Build()
ctx = log.IntoContext(context.Background(), GinkgoLogr)
genericController = status.NewGenericObjectController[*TestGenericObject](kubeClient, recorder, status.EmitDeprecatedMetrics)
Expand Down