Skip to content

feat: allow subroutines to decide on the finalizer considering the instance #73

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

Merged
merged 1 commit into from
Sep 30, 2025
Merged

feat: allow subroutines to decide on the finalizer considering the instance #73

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
8 changes: 4 additions & 4 deletions controller/lifecycle/lifecycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ func reconcileSubroutine(ctx context.Context, instance runtimeobject.RuntimeObje
var result ctrl.Result
var err errors.OperatorError
if instance.GetDeletionTimestamp() != nil {
if containsFinalizer(instance, subroutine.Finalizers()) {
if containsFinalizer(instance, subroutine.Finalizers(instance)) {
subroutineLogger.Debug().Msg("finalizing instance")
result, err = subroutine.Finalize(ctx, instance)
subroutineLogger.Debug().Any("result", result).Msg("finalized instance")
Expand Down Expand Up @@ -222,7 +222,7 @@ func removeFinalizerIfNeeded(ctx context.Context, instance runtimeobject.Runtime
if result.RequeueAfter == 0 {
update := false
original := instance.DeepCopyObject().(client.Object)
for _, f := range subroutine.Finalizers() {
for _, f := range subroutine.Finalizers(instance) {
needsUpdate := controllerutil.RemoveFinalizer(instance, f)
if needsUpdate {
update = true
Expand Down Expand Up @@ -320,7 +320,7 @@ func AddFinalizersIfNeeded(ctx context.Context, cl client.Client, instance runti
update := false
original := instance.DeepCopyObject().(client.Object)
for _, s := range subroutines {
if len(s.Finalizers()) > 0 {
if len(s.Finalizers(instance)) > 0 {
needsUpdate := AddFinalizerIfNeeded(instance, s)
if needsUpdate {
update = true
Expand All @@ -338,7 +338,7 @@ func AddFinalizersIfNeeded(ctx context.Context, cl client.Client, instance runti

func AddFinalizerIfNeeded(instance runtimeobject.RuntimeObject, subroutine subroutine.Subroutine) bool {
update := false
for _, f := range subroutine.Finalizers() {
for _, f := range subroutine.Finalizers(instance) {
needsUpdate := controllerutil.AddFinalizer(instance, f)
if needsUpdate {
update = true
Expand Down
4 changes: 2 additions & 2 deletions controller/lifecycle/lifecycle_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,9 +967,9 @@ func TestRemoveFinalizerIfNeeded(t *testing.T) {
func TestContainsFinalizer(t *testing.T) {
instance := &pmtesting.TestApiObject{}
sub := pmtesting.FinalizerSubroutine{}
assert.False(t, containsFinalizer(instance, sub.Finalizers()))
assert.False(t, containsFinalizer(instance, sub.Finalizers(instance)))
AddFinalizerIfNeeded(instance, sub)
assert.True(t, containsFinalizer(instance, sub.Finalizers()))
assert.True(t, containsFinalizer(instance, sub.Finalizers(instance)))
}

func TestMarkResourceAsFinal(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion controller/lifecycle/subroutine/subroutine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ type Subroutine interface {
Process(ctx context.Context, instance runtimeobject.RuntimeObject) (ctrl.Result, errors.OperatorError)
Finalize(ctx context.Context, instance runtimeobject.RuntimeObject) (ctrl.Result, errors.OperatorError)
GetName() string
Finalizers() []string
Finalizers(instance runtimeobject.RuntimeObject) []string
}
2 changes: 1 addition & 1 deletion controller/testSupport/finalizerSubroutine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func (c FinalizerSubroutine) GetName() string {
return "changeStatus"
}

func (c FinalizerSubroutine) Finalizers() []string {
func (c FinalizerSubroutine) Finalizers(_ runtimeobject.RuntimeObject) []string {
return []string{
SubroutineFinalizer,
}
Expand Down
8 changes: 4 additions & 4 deletions controller/testSupport/testSupport.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func (c ChangeStatusSubroutine) GetName() string {
return "changeStatus"
}

func (c ChangeStatusSubroutine) Finalizers() []string {
func (c ChangeStatusSubroutine) Finalizers(instance runtimeobject.RuntimeObject) []string {
return []string{"changestatus"}
}

Expand Down Expand Up @@ -142,7 +142,7 @@ func (c AddConditionSubroutine) GetName() string {
return "addCondition"
}

func (c AddConditionSubroutine) Finalizers() []string {
func (c AddConditionSubroutine) Finalizers(instance runtimeobject.RuntimeObject) []string {
return []string{}
}

Expand All @@ -169,7 +169,7 @@ func (f FailureScenarioSubroutine) Finalize(_ context.Context, _ runtimeobject.R
return controllerruntime.Result{}, errors.NewOperatorError(fmt.Errorf("FailureScenarioSubroutine"), true, false)
}

func (f FailureScenarioSubroutine) Finalizers() []string {
func (f FailureScenarioSubroutine) Finalizers(instance runtimeobject.RuntimeObject) []string {
return []string{FailureScenarioSubroutineFinalizer}
}

Expand Down Expand Up @@ -220,7 +220,7 @@ func (f ContextValueSubroutine) Finalize(_ context.Context, _ runtimeobject.Runt
return controllerruntime.Result{}, nil
}

func (f ContextValueSubroutine) Finalizers() []string {
func (f ContextValueSubroutine) Finalizers(instance runtimeobject.RuntimeObject) []string {
return []string{}
}

Expand Down