Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit for finalizer helper library
Signed-off-by: rashmigottipati <chowdary.grashmi@gmail.com>
- Loading branch information
1 parent
10ae090
commit e4d01c8
Showing
2 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package finalizer | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
|
||
"sigs.k8s.io/controller-runtime/pkg/client" | ||
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" | ||
) | ||
|
||
func NewFinalizers() Finalizers { | ||
return finalizers(map[string]Finalizer{}) | ||
} | ||
|
||
func (f finalizers) Register(key string, finalizer Finalizer) error { | ||
if _, ok := f[key]; ok { | ||
return fmt.Errorf("finalizer for key %q already registered") | ||
} | ||
f[key] = finalizer | ||
return nil | ||
} | ||
|
||
func (f finalizers) Finalize(ctx context.Context, obj client.Object) (bool, error) { | ||
needsUpdate := false | ||
for key, finalizer := range f { | ||
if obj.GetDeletionTimestamp() == nil && !controllerutil.ContainsFinalizer(obj, key) { | ||
controllerutil.AddFinalizer(obj, key) | ||
needsUpdate = true | ||
} else if obj.GetDeletionTimestamp() != nil && controllerutil.ContainsFinalizer(obj, key) { | ||
_, err := finalizer.Finalize(ctx, obj) | ||
if err != nil { | ||
return true, fmt.Errorf("finalize failed for key %q: %v", key, err) | ||
} | ||
controllerutil.RemoveFinalizer(obj, key) | ||
needsUpdate = true | ||
} | ||
} | ||
return needsUpdate, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
/* | ||
Copyright 2021 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package finalizer | ||
|
||
import ( | ||
"context" | ||
|
||
"sigs.k8s.io/controller-runtime/pkg/client" | ||
) | ||
|
||
type Registerer interface { | ||
Register(key string, f Finalizer) error | ||
} | ||
|
||
type Finalizer interface { | ||
Finalize(context.Context, client.Object) (needsUpdate bool, err error) | ||
} | ||
|
||
type finalizers map[string]Finalizer | ||
|
||
type Finalizers interface { | ||
// implements Registerer and Finalizer to finalize | ||
// all registered finalizers if the provided object | ||
// has a deletion timestamp or set all registered | ||
// finalizers if it doesn't | ||
Registerer | ||
Finalizer | ||
} |