From 4f1352f042c6f2eb0d2c037e4a4ea6d3fd88de41 Mon Sep 17 00:00:00 2001 From: Aditya Bhatia <7274741+adityabhatia@users.noreply.github.com> Date: Fri, 19 Jan 2024 18:00:48 +0100 Subject: [PATCH] test: Ensure finalizers are re-reconciled --- Makefile | 2 +- test/e2e/config/vsphere-ci.yaml | 2 +- test/e2e/config/vsphere-dev.yaml | 2 +- .../cluster-identity.yaml | 4 +-- .../drop-existing-identity-secret.yaml | 0 .../failure-domains.yaml | 6 ++-- .../kustomization.yaml | 0 .../vsphereclusteridentity.yaml | 2 +- ...e_test.go => ownerrefs_finalizers_test.go} | 29 +++++++++++++++---- 9 files changed, 32 insertions(+), 15 deletions(-) rename test/e2e/data/infrastructure-vsphere/main/{ownerreferences => ownerrefs-finalizers}/cluster-identity.yaml (76%) rename test/e2e/data/infrastructure-vsphere/main/{ownerreferences => ownerrefs-finalizers}/drop-existing-identity-secret.yaml (100%) rename test/e2e/data/infrastructure-vsphere/main/{ownerreferences => ownerrefs-finalizers}/failure-domains.yaml (88%) rename test/e2e/data/infrastructure-vsphere/main/{ownerreferences => ownerrefs-finalizers}/kustomization.yaml (100%) rename test/e2e/data/infrastructure-vsphere/main/{ownerreferences => ownerrefs-finalizers}/vsphereclusteridentity.yaml (86%) rename test/e2e/{ownerreference_test.go => ownerrefs_finalizers_test.go} (91%) diff --git a/Makefile b/Makefile index af6cac5367..e0ab0d20e9 100644 --- a/Makefile +++ b/Makefile @@ -321,7 +321,7 @@ generate-e2e-templates-main: $(KUSTOMIZE) ## Generate test templates for the mai "$(KUSTOMIZE)" --load-restrictor LoadRestrictionsNone build "$(E2E_TEMPLATE_DIR)/main/pci" > "$(E2E_TEMPLATE_DIR)/main/cluster-template-pci.yaml" # for DHCP overrides "$(KUSTOMIZE)" --load-restrictor LoadRestrictionsNone build "$(E2E_TEMPLATE_DIR)/main/dhcp-overrides" > "$(E2E_TEMPLATE_DIR)/main/cluster-template-dhcp-overrides.yaml" - "$(KUSTOMIZE)" --load-restrictor LoadRestrictionsNone build "$(E2E_TEMPLATE_DIR)/main/ownerreferences" > "$(E2E_TEMPLATE_DIR)/main/cluster-template-ownerreferences.yaml" + "$(KUSTOMIZE)" --load-restrictor LoadRestrictionsNone build "$(E2E_TEMPLATE_DIR)/main/ownerrefs-finalizers" > "$(E2E_TEMPLATE_DIR)/main/cluster-template-ownerrefs-finalizers.yaml" .PHONY: generate-e2e-templates-v1.9 generate-e2e-templates-v1.9: $(KUSTOMIZE) diff --git a/test/e2e/config/vsphere-ci.yaml b/test/e2e/config/vsphere-ci.yaml index 688d527405..11981d7d55 100644 --- a/test/e2e/config/vsphere-ci.yaml +++ b/test/e2e/config/vsphere-ci.yaml @@ -118,7 +118,7 @@ providers: - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-kcp-remediation.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-md-remediation.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-node-drain.yaml" - - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-ownerreferences.yaml" + - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-ownerrefs-finalizers.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-pci.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-remote-management.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-storage-policy.yaml" diff --git a/test/e2e/config/vsphere-dev.yaml b/test/e2e/config/vsphere-dev.yaml index 41d6e64b21..4df5d4b42c 100644 --- a/test/e2e/config/vsphere-dev.yaml +++ b/test/e2e/config/vsphere-dev.yaml @@ -121,7 +121,7 @@ providers: - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-kcp-remediation.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-md-remediation.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-node-drain.yaml" - - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-ownerreferences.yaml" + - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-ownerrefs-finalizers.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-pci.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-remote-management.yaml" - sourcePath: "../../../test/e2e/data/infrastructure-vsphere/main/cluster-template-storage-policy.yaml" diff --git a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/cluster-identity.yaml b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/cluster-identity.yaml similarity index 76% rename from test/e2e/data/infrastructure-vsphere/main/ownerreferences/cluster-identity.yaml rename to test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/cluster-identity.yaml index efbd83e992..93854ddb04 100644 --- a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/cluster-identity.yaml +++ b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/cluster-identity.yaml @@ -2,9 +2,9 @@ apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 kind: VSphereClusterIdentity metadata: - name: ownerreferences + name: ownerrefs-finalizers spec: - secretName: ownerreferences + secretName: ownerrefs-finalizers allowedNamespaces: selector: matchLabels: diff --git a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/drop-existing-identity-secret.yaml b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/drop-existing-identity-secret.yaml similarity index 100% rename from test/e2e/data/infrastructure-vsphere/main/ownerreferences/drop-existing-identity-secret.yaml rename to test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/drop-existing-identity-secret.yaml diff --git a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/failure-domains.yaml b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/failure-domains.yaml similarity index 88% rename from test/e2e/data/infrastructure-vsphere/main/ownerreferences/failure-domains.yaml rename to test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/failure-domains.yaml index 19e99df921..3ddeccdc62 100644 --- a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/failure-domains.yaml +++ b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/failure-domains.yaml @@ -2,7 +2,7 @@ apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 kind: VSphereFailureDomain metadata: - name: "ownerreferences" + name: ownerrefs-finalizers spec: region: name: '${VSPHERE_DATACENTER}' @@ -23,9 +23,9 @@ spec: apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 kind: VSphereDeploymentZone metadata: - name: "ownerreferences" + name: ownerrefs-finalizers spec: server: '${VSPHERE_SERVER}' - failureDomain: "ownerreferences" + failureDomain: "ownerrefs-finalizers" placementConstraint: resourcePool: '${VSPHERE_RESOURCE_POOL}' diff --git a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/kustomization.yaml b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/kustomization.yaml similarity index 100% rename from test/e2e/data/infrastructure-vsphere/main/ownerreferences/kustomization.yaml rename to test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/kustomization.yaml diff --git a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/vsphereclusteridentity.yaml b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/vsphereclusteridentity.yaml similarity index 86% rename from test/e2e/data/infrastructure-vsphere/main/ownerreferences/vsphereclusteridentity.yaml rename to test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/vsphereclusteridentity.yaml index 9c5f80fd28..20dec7a75b 100644 --- a/test/e2e/data/infrastructure-vsphere/main/ownerreferences/vsphereclusteridentity.yaml +++ b/test/e2e/data/infrastructure-vsphere/main/ownerrefs-finalizers/vsphereclusteridentity.yaml @@ -7,5 +7,5 @@ metadata: spec: identityRef: kind: VSphereClusterIdentity - name: ownerreferences + name: ownerrefs-finalizers diff --git a/test/e2e/ownerreference_test.go b/test/e2e/ownerrefs_finalizers_test.go similarity index 91% rename from test/e2e/ownerreference_test.go rename to test/e2e/ownerrefs_finalizers_test.go index 88664cb27d..1d1a644e86 100644 --- a/test/e2e/ownerreference_test.go +++ b/test/e2e/ownerrefs_finalizers_test.go @@ -42,7 +42,7 @@ import ( "sigs.k8s.io/cluster-api-provider-vsphere/test/e2e/ipam" ) -var _ = Describe("OwnerReference checks with FailureDomains and ClusterIdentity", func() { +var _ = Describe("Ensure OwnerReferences and Finalizers are resilient with FailureDomains and ClusterIdentity", func() { var ( testSpecificClusterctlConfigPath string testSpecificIPAddressClaims ipam.IPAddressClaims @@ -66,7 +66,7 @@ var _ = Describe("OwnerReference checks with FailureDomains and ClusterIdentity" BootstrapClusterProxy: bootstrapClusterProxy, ArtifactFolder: artifactFolder, SkipCleanup: skipCleanup, - Flavor: ptr.To("ownerreferences"), + Flavor: ptr.To("ownerrefs-finalizers"), PostMachinesProvisioned: func(proxy framework.ClusterProxy, namespace, clusterName string) { // Inject a client to use for checkClusterIdentitySecretOwnerRef checkClusterIdentitySecretOwnerRef(ctx, proxy.GetClient()) @@ -92,6 +92,13 @@ var _ = Describe("OwnerReference checks with FailureDomains and ClusterIdentity" VSphereKubernetesReferenceAssertions, VSphereReferenceAssertions, ) + // This check ensures that finalizers are resilient - i.e. correctly re-reconciled, when removed. + framework.ValidateFinalizersResilience(ctx, proxy, namespace, clusterName, + framework.CoreFinalizersAssertion, + framework.KubeadmControlPlaneFinalizersAssertion, + framework.ExpFinalizersAssertion, + vSphereFinalizers, + ) }, } }) @@ -182,14 +189,25 @@ var ( // The following names are hardcoded in templates to make cleanup easier. var ( - clusterIdentityName = "ownerreferences" + clusterIdentityName = "ownerrefs-finalizers" clusterIdentitySecretNamespace = "capv-system" - deploymentZoneName = "ownerreferences" + deploymentZoneName = "ownerrefs-finalizers" ) +// vSphereFinalizers maps VSphere infrastructure resource types to their expected finalizers. +var vSphereFinalizers = map[string][]string{ + "VSphereVM": {infrav1.VMFinalizer}, + "Secret": {infrav1.SecretIdentitySetFinalizer}, + "VSphereClusterIdentity": {infrav1.VSphereClusterIdentityFinalizer}, + "VSphereDeploymentZone": {infrav1.DeploymentZoneFinalizer}, + "VSphereMachine": {infrav1.MachineFinalizer}, + "IPAddressClaim": {infrav1.IPAddressClaimFinalizer}, + "VSphereCluster": {infrav1.ClusterFinalizer}, +} + // cleanupVSphereObjects deletes the Secret, VSphereClusterIdentity, and VSphereDeploymentZone created for this test. // The VSphereFailureDomain, and the Secret for the VSphereClusterIdentity should be deleted as a result of the above. -func cleanupVSphereObjects(ctx context.Context, bootstrapClusterProxy framework.ClusterProxy) bool { +func cleanupVSphereObjects(ctx context.Context, bootstrapClusterProxy framework.ClusterProxy) { Eventually(func() error { if err := bootstrapClusterProxy.GetClient().Delete(ctx, &infrav1.VSphereClusterIdentity{ @@ -209,7 +227,6 @@ func cleanupVSphereObjects(ctx context.Context, bootstrapClusterProxy framework. } return nil }).Should(Succeed()) - return true } func createVsphereIdentitySecret(ctx context.Context, bootstrapClusterProxy framework.ClusterProxy) {