-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ensure finalizers are resilient on reconciliation
- Loading branch information
1 parent
7b21e0c
commit 2f3e62a
Showing
4 changed files
with
208 additions
and
4 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
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
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,169 @@ | ||
| /* | ||
| Copyright 2023 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 framework | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "reflect" | ||
| "time" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| kerrors "k8s.io/apimachinery/pkg/util/errors" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1" | ||
| clusterctlcluster "sigs.k8s.io/cluster-api/cmd/clusterctl/client/cluster" | ||
| controlplanev1 "sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1" | ||
| addonsv1 "sigs.k8s.io/cluster-api/exp/addons/api/v1beta1" | ||
| infrav1 "sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1beta1" | ||
| "sigs.k8s.io/cluster-api/util/patch" | ||
| ) | ||
|
|
||
| // finalizerAssertion contains list of expected Finalizers corresponding to a resource Kind. | ||
| var finalizerAssertion = map[string][]string{ | ||
| "Cluster": {clusterv1.ClusterFinalizer}, | ||
| "Machine": {clusterv1.MachineFinalizer}, | ||
| "MachineSet": {clusterv1.MachineSetTopologyFinalizer}, | ||
| "MachineDeployment": {clusterv1.MachineDeploymentTopologyFinalizer}, | ||
| "ClusterResourceSet": {addonsv1.ClusterResourceSetFinalizer}, | ||
| "DockerMachine": {infrav1.MachineFinalizer}, | ||
| "DockerCluster": {infrav1.ClusterFinalizer}, | ||
| "KubeadmControlPlane": {controlplanev1.KubeadmControlPlaneFinalizer}, | ||
| } | ||
|
|
||
| // ValidateFinalizersResilience checks that expected finalizers are in place, deletes them, and verifies that expected finalizers are properly added again. | ||
| func ValidateFinalizersResilience(ctx context.Context, proxy ClusterProxy, namespace, clusterName string) { | ||
| clusterKey := client.ObjectKey{Namespace: namespace, Name: clusterName} | ||
|
|
||
| // collect all objects where finalizers were initially set | ||
| objectsWithFinalizers := getObjectsWithFinalizers(ctx, proxy, namespace) | ||
|
|
||
| // Removes all the Finalizers. | ||
| // We are testing the worst-case scenario, i.e. all finalizers are deleted, even when reconciliation is paused. | ||
| // Deletion of the Finalizers can either happen from a system generated attack or by mistake, which is an edge case. | ||
| // The reconciliation loop should be able to recover from this, by adding the required finalizers back. | ||
| setClusterPause(ctx, proxy.GetClient(), clusterKey, true) | ||
|
|
||
| // Once all Clusters are paused remove the Finalizers from all objects in the graph. | ||
| removeFinalizers(ctx, proxy, namespace) | ||
|
|
||
| // Unpause the cluster. | ||
| setClusterPause(ctx, proxy.GetClient(), clusterKey, false) | ||
|
|
||
| // Annotate the clusterClass, if one is in use, to speed up reconciliation. This ensures ClusterClass Finalizers | ||
| // are re-reconciled before asserting the owner reference graph. | ||
| forceClusterClassReconcile(ctx, proxy.GetClient(), clusterKey) | ||
|
|
||
| // The MachineDeployment Topology reconciler does not trigger reconciliations, when owner Cluster is in paused state. | ||
| // So, a manual update is required to trigger a reconciliation. | ||
| forceMachineDeploymentTopologyReconcile(ctx, proxy.GetClient(), clusterKey) | ||
|
|
||
| // Check that the Finalizers are as expected after further reconciliations. | ||
| assertFinalizersExist(ctx, proxy, namespace, objectsWithFinalizers) | ||
| } | ||
|
|
||
| // removeFinalizers removes all Finalizers from objects in the owner graph. | ||
| func removeFinalizers(ctx context.Context, proxy ClusterProxy, namespace string) { | ||
| graph, err := clusterctlcluster.GetOwnerGraph(ctx, namespace, proxy.GetKubeconfigPath()) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| for _, object := range graph { | ||
| ref := object.Object | ||
| obj := new(unstructured.Unstructured) | ||
| obj.SetAPIVersion(ref.APIVersion) | ||
| obj.SetKind(ref.Kind) | ||
| obj.SetName(ref.Name) | ||
|
|
||
| Expect(proxy.GetClient().Get(ctx, client.ObjectKey{Namespace: namespace, Name: object.Object.Name}, obj)).To(Succeed()) | ||
| helper, err := patch.NewHelper(obj, proxy.GetClient()) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| obj.SetFinalizers([]string{}) | ||
| Expect(helper.Patch(ctx, obj)).To(Succeed()) | ||
| } | ||
| } | ||
|
|
||
| func getObjectsWithFinalizers(ctx context.Context, proxy ClusterProxy, namespace string) map[string]*unstructured.Unstructured { | ||
| graph, err := clusterctlcluster.GetOwnerGraph(ctx, namespace, proxy.GetKubeconfigPath()) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
|
|
||
| objsWithFinalizers := map[string]*unstructured.Unstructured{} | ||
|
|
||
| for _, node := range graph { | ||
| nodeNamespacedName := client.ObjectKey{Namespace: node.Object.Namespace, Name: node.Object.Name} | ||
| obj := &unstructured.Unstructured{} | ||
| obj.SetAPIVersion(node.Object.APIVersion) | ||
| obj.SetKind(node.Object.Kind) | ||
| err = proxy.GetClient().Get(ctx, nodeNamespacedName, obj) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
|
|
||
| setFinalizers := obj.GetFinalizers() | ||
|
|
||
| if len(setFinalizers) > 0 { | ||
| objsWithFinalizers[client.ObjectKey{Namespace: node.Object.Namespace, Name: node.Object.Name}.String()] = obj | ||
| } | ||
| } | ||
|
|
||
| return objsWithFinalizers | ||
| } | ||
|
|
||
| // assertFinalizersExist ensures that expected Finalizers are present on all objects in the owner graph. | ||
| func assertFinalizersExist(ctx context.Context, proxy ClusterProxy, namespace string, initialObjsWithFinalizers map[string]*unstructured.Unstructured) { | ||
| Eventually(func() error { | ||
| var allErrs []error | ||
| finalObjsWithFinalizers := getObjectsWithFinalizers(ctx, proxy, namespace) | ||
|
|
||
| for objNamespacedName, obj := range initialObjsWithFinalizers { | ||
| // verify if finalizers for this resource were set on reconcile | ||
| if _, valid := finalObjsWithFinalizers[objNamespacedName]; !valid { | ||
| allErrs = append(allErrs, fmt.Errorf("no finalizers set for %s/%s", | ||
| obj.GetKind(), objNamespacedName)) | ||
| continue | ||
| } | ||
|
|
||
| // verify if this resource has the appropriate Finalizers set | ||
| expectedFinalizers, assert := finalizerAssertion[obj.GetKind()] | ||
| if !assert { | ||
| continue | ||
| } | ||
|
|
||
| setFinalizers := finalObjsWithFinalizers[objNamespacedName].GetFinalizers() | ||
| if !reflect.DeepEqual(expectedFinalizers, setFinalizers) { | ||
| allErrs = append(allErrs, fmt.Errorf("expected finalizers do not exist for %s/%s: expected: %v, found: %v", | ||
| obj.GetKind(), objNamespacedName, expectedFinalizers, setFinalizers)) | ||
| } | ||
| } | ||
|
|
||
| return kerrors.NewAggregate(allErrs) | ||
| }).WithTimeout(1 * time.Minute).WithPolling(2 * time.Second).Should(Succeed()) | ||
| } | ||
|
|
||
| // forceMachineDeploymentTopologyReconcile forces reconciliation of the MachineDeployment and MachineSet (owned). | ||
| func forceMachineDeploymentTopologyReconcile(ctx context.Context, cli client.Client, clusterKey types.NamespacedName) { | ||
| mdList := &clusterv1.MachineDeploymentList{} | ||
| clientOptions := (&client.ListOptions{}).ApplyOptions([]client.ListOption{ | ||
| client.MatchingLabels{clusterv1.ClusterNameLabel: clusterKey.Name}, | ||
| client.Limit(1), | ||
| }) | ||
| Expect(cli.List(ctx, mdList, clientOptions)).To(Succeed()) | ||
|
|
||
| if _, ok := mdList.Items[0].GetLabels()[clusterv1.ClusterTopologyOwnedLabel]; ok { | ||
| annotationPatch := client.RawPatch(types.MergePatchType, []byte(fmt.Sprintf("{\"metadata\":{\"annotations\":{\"cluster.x-k8s.io/modifiedAt\":\"%v\"}}}", time.Now().Format(time.RFC3339)))) | ||
| Expect(cli.Patch(ctx, &mdList.Items[0], annotationPatch)).To(Succeed()) | ||
| } | ||
| } |
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