Fix & improve e2e test

Author: sbueringer

internal/controllers/machinedeployment/machinedeployment_canupdatemachineset.go

@@ -31,6 +31,7 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
 	runtimehooksv1 "sigs.k8s.io/cluster-api/api/runtime/hooks/v1alpha1"
 	"sigs.k8s.io/cluster-api/controllers/external"
+	"sigs.k8s.io/cluster-api/internal/controllers/machinedeployment/mdutil"
 	"sigs.k8s.io/cluster-api/internal/util/compare"
 	"sigs.k8s.io/cluster-api/internal/util/patch"
 )
@@ -258,22 +259,29 @@ func matchesMachineSet(req *runtimehooksv1.CanUpdateMachineSetRequest) (bool, []
 
 func matchesMachineSetSpec(patched, desired *clusterv1.MachineSet) (equal bool, diff string, matchErr error) {
 	// Note: Wrapping MachineSet specs in a MachineSet for proper formatting of the diff.
-	return compare.Diff(
-		&clusterv1.MachineSet{
-			Spec: clusterv1.MachineSetSpec{
-				Template: clusterv1.MachineTemplateSpec{
-					Spec: patched.Spec.Template.Spec,
-				},
+	cleanedUpPatchedMachineSet := &clusterv1.MachineSet{
+		Spec: clusterv1.MachineSetSpec{
+			Template: clusterv1.MachineTemplateSpec{
+				Spec: patched.Spec.Template.Spec,
 			},
 		},
-		&clusterv1.MachineSet{
-			Spec: clusterv1.MachineSetSpec{
-				Template: clusterv1.MachineTemplateSpec{
-					Spec: desired.Spec.Template.Spec,
-				},
+	}
+	cleanedUpDesiredMachineSet := &clusterv1.MachineSet{
+		Spec: clusterv1.MachineSetSpec{
+			Template: clusterv1.MachineTemplateSpec{
+				Spec: desired.Spec.Template.Spec,
 			},
 		},
-	)
+	}
+
+	// Cleanup fields that are not the responsibility of the in-place update extension.
+	// Remove in-place mutable fields.
+	cleanedUpPatchedMachineSet.Spec.Template = *mdutil.MachineTemplateDeepCopyRolloutFields(&cleanedUpPatchedMachineSet.Spec.Template)
+	cleanedUpDesiredMachineSet.Spec.Template = *mdutil.MachineTemplateDeepCopyRolloutFields(&cleanedUpDesiredMachineSet.Spec.Template)
+	// Set refs equal.
+	cleanedUpPatchedMachineSet.Spec.Template.Spec.Bootstrap.ConfigRef = cleanedUpDesiredMachineSet.Spec.Template.Spec.Bootstrap.ConfigRef
+	cleanedUpPatchedMachineSet.Spec.Template.Spec.InfrastructureRef = cleanedUpDesiredMachineSet.Spec.Template.Spec.InfrastructureRef
+	return compare.Diff(cleanedUpPatchedMachineSet, cleanedUpDesiredMachineSet)
 }
 
 func matchesUnstructuredSpec(patched, desired runtime.RawExtension) (equal bool, diff string, matchErr error) {

test/e2e/cluster_in_place_update.go

@@ -246,15 +246,16 @@ func ClusterInPlaceUpdateSpec(ctx context.Context, inputGetter func() ClusterInP
 					Namespace:     clusterResources.Cluster.Namespace,
 					ConditionType: clusterv1.ClusterWorkerMachinesUpToDateCondition,
 				})
-				for _, kubeadmConfig := range machineObjectsAfterInPlaceUpdate.KubeadmConfigByMachine {
-					g.Expect(kubeadmConfig.Spec.Files).To(ContainElement(HaveField("Path", filePath)))
-					g.Expect(kubeadmConfig.Spec.Files).To(ContainElement(HaveField("Content", fileContent)))
-				}
 
 				// Ensure only in-place updates were executed and no Machine was re-created.
 				machineObjectsAfterInPlaceUpdate = getMachineObjects(ctx, g, mgmtClient, cluster)
 				g.Expect(machineNames(machineObjectsAfterInPlaceUpdate.ControlPlaneMachines)).To(Equal(machineNames(machineObjectsBeforeInPlaceUpdate.ControlPlaneMachines)))
 				g.Expect(machineNames(machineObjectsAfterInPlaceUpdate.WorkerMachines)).To(Equal(machineNames(machineObjectsBeforeInPlaceUpdate.WorkerMachines)))
+
+				for _, kubeadmConfig := range machineObjectsAfterInPlaceUpdate.KubeadmConfigByMachine {
+					g.Expect(kubeadmConfig.Spec.Files).To(ContainElement(HaveField("Path", filePath)))
+					g.Expect(kubeadmConfig.Spec.Files).To(ContainElement(HaveField("Content", fileContent)))
+				}
 			}, input.E2EConfig.GetIntervals(specName, "wait-control-plane")...).Should(Succeed())
 
 			// Update machineObjectsBeforeInPlaceUpdate for the next round of in-place update.