refactor: split machineset migration testing into multiple files

Author: sunzhaohua2

e2e/machineset_migration_capi_authoritative_test.go

@@ -17,7 +17,7 @@ import (
 var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] MachineSet Migration CAPI Authoritative Tests", Ordered, func() {
 	BeforeAll(func() {
 		if platform != configv1.AWSPlatformType {
-			Skip(fmt.Sprintf("Skipping tests on %s, this only support on aws", platform))
+			Skip(fmt.Sprintf("Skipping tests on %s, this is only supported on AWS", platform))
 		}
 
 		if !capiframework.IsMachineAPIMigrationEnabled(ctx, cl) {
@@ -120,8 +120,9 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 
 				mapiMachines, err := mapiframework.GetMachinesFromMachineSet(ctx, cl, mapiMachineSet)
 				Expect(err).ToNot(HaveOccurred(), "failed to get MAPI Machines from MachineSet")
-				capiMachines := capiframework.GetMachinesFromMachineSet(cl, capiMachineSet)
 				Expect(mapiMachines).ToNot(BeEmpty(), "no MAPI Machines found")
+
+				capiMachines := capiframework.GetMachinesFromMachineSet(cl, capiMachineSet)
 				Expect(capiMachines).ToNot(BeEmpty(), "no CAPI Machines found")
 				Expect(capiMachines[0].Name).To(Equal(mapiMachines[0].Name))
 				firstMAPIMachine = mapiMachines[0]
@@ -268,8 +269,10 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 				Expect(err).ToNot(HaveOccurred(), "failed to get mapiMachineSet")
 				mapiframework.DeleteMachineSets(cl, mapiMachineSet)
 
-				// TODO bug https://issues.redhat.com/browse/OCPBUGS-56897
 				By("Verifying CAPI MachineSet not removed, both MAPI Machines and Mirrors remain")
+				// TODO: Add full verification once OCPBUGS-56897 is fixed
+				capiMS := capiframework.GetMachineSet(cl, mapiMSAuthMAPIName, capiframework.CAPINamespace)
+				Expect(capiMS).ToNot(BeNil(), "CAPI MachineSet should still exist after deleting non-authoritative MAPI MachineSet")
 			})
 		})
 	})

e2e/machineset_migration_helpers.go

@@ -69,7 +69,7 @@ func createMAPIMachineSetWithAuthoritativeAPI(ctx context.Context, cl client.Cli
 		},
 	}
 	Eventually(komega.Get(capiMachineSet), capiframework.WaitShort, capiframework.RetryShort).Should(
-		Succeed(), "Mirror CAPI MachineSet should be created within 1 minute")
+		Succeed(), "Should have mirror CAPI MachineSet created within 1 minute")
 
 	switch machineAuthority {
 	case mapiv1beta1.MachineAuthorityMachineAPI:
@@ -127,7 +127,7 @@ func verifyMachineSetPausedCondition(machineSet client.Object, authority mapiv1b
 
 		Eventually(komega.Object(ms), capiframework.WaitMedium, capiframework.RetryMedium).Should(
 			HaveField("Status.Conditions", ContainElement(conditionMatcher)),
-			fmt.Sprintf("Should have found the expected Paused condition for MAPI MachineSet %s with authority: %s", ms.Name, authority),
+			fmt.Sprintf("Should have the expected Paused condition for MAPI MachineSet %s with authority: %s", ms.Name, authority),
 		)
 
 	case *clusterv1.MachineSet:
@@ -153,7 +153,7 @@ func verifyMachineSetPausedCondition(machineSet client.Object, authority mapiv1b
 
 		Eventually(komega.Object(ms), capiframework.WaitMedium, capiframework.RetryMedium).Should(
 			HaveField("Status.V1Beta2.Conditions", ContainElement(conditionMatcher)),
-			fmt.Sprintf("Should have found the expected Paused condition for CAPI MachineSet %s with authority: %s", ms.Name, authority),
+			fmt.Sprintf("Should have the expected Paused condition for CAPI MachineSet %s with authority: %s", ms.Name, authority),
 		)
 
 	default:
@@ -168,13 +168,13 @@ func verifyMachinesetReplicas(machineSet client.Object, replicas int) {
 	case *mapiv1beta1.MachineSet:
 		By(fmt.Sprintf("Verifying MAPI MachineSet status.Replicas is %d", replicas))
 		Eventually(komega.Object(ms), capiframework.WaitLong, capiframework.RetryLong).Should(
-			HaveField("Status.Replicas", HaveValue(Equal(int32(replicas)))),
-			"MAPI MachineSet %q replicas status should eventually be %d", ms.Name, replicas)
+			HaveField("Status.Replicas", Equal(int32(replicas))),
+			"Should have MAPI MachineSet %q replicas status eventually be %d", ms.Name, replicas)
 	case *clusterv1.MachineSet:
 		By(fmt.Sprintf("Verifying CAPI MachineSet status.Replicas is %d", replicas))
 		Eventually(komega.Object(ms), capiframework.WaitLong, capiframework.RetryLong).Should(
-			HaveField("Status.Replicas", HaveValue(Equal(int32(replicas)))),
-			"CAPI MachineSet %q replicas status should eventually be %d", ms.Name, replicas)
+			HaveField("Status.Replicas", Equal(int32(replicas))),
+			"Should have CAPI MachineSet %q replicas status eventually be %d", ms.Name, replicas)
 	default:
 		Fail(fmt.Sprintf("unsupported MachineSet type: %T", machineSet))
 	}
@@ -207,7 +207,7 @@ func verifyMAPIMachineSetSynchronizedCondition(mapiMachineSet *mapiv1beta1.Machi
 				),
 			),
 		),
-		fmt.Sprintf("Expected Synchronized condition for %s not found or incorrect", authority),
+		fmt.Sprintf("Should have Synchronized condition for %s", authority),
 	)
 }
 
@@ -256,12 +256,12 @@ func waitForMAPIMachineSetMirrors(cl client.Client, machineSetNameMAPI string) (
 			return fmt.Errorf("CAPI MachineSet %s/%s not found", capiframework.CAPINamespace, machineSetNameMAPI)
 		}
 		return nil
-	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "CAPI MachineSet %s/%s should exist", capiframework.CAPINamespace, machineSetNameMAPI)
+	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "Should have CAPI MachineSet %s/%s exist", capiframework.CAPINamespace, machineSetNameMAPI)
 
 	Eventually(func() error {
 		awsMachineTemplate, err = capiframework.GetAWSMachineTemplateByPrefix(cl, machineSetNameMAPI, capiframework.CAPINamespace)
 		return err
-	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "AWSMachineTemplate with prefix %s should exist", machineSetNameMAPI)
+	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "Should have AWSMachineTemplate with prefix %s exist", machineSetNameMAPI)
 
 	return capiMachineSet, awsMachineTemplate
 }
@@ -275,7 +275,7 @@ func waitForCAPIMachineSetMirror(cl client.Client, machineName string) *clusterv
 			return fmt.Errorf("CAPI MachineSet %s/%s not found", capiframework.CAPINamespace, machineName)
 		}
 		return nil
-	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "CAPI MachineSet %s/%s should exist", capiframework.CAPINamespace, machineName)
+	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(), "Should have CAPI MachineSet %s/%s exist", capiframework.CAPINamespace, machineName)
 	return capiMachineSet
 }
 
@@ -290,7 +290,7 @@ func waitForAWSMachineTemplate(cl client.Client, prefix string) *awsv1.AWSMachin
 		}
 		return nil
 	}, capiframework.WaitMedium, capiframework.RetryMedium).Should(Succeed(),
-		"AWSMachineTemplate with prefix %s should exist", prefix)
+		"Should have AWSMachineTemplate with prefix %s exist", prefix)
 	return awsMachineTemplate
 }
 

e2e/machineset_migration_mapi_authoritative_test.go

@@ -20,7 +20,7 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 
 	BeforeAll(func() {
 		if platform != configv1.AWSPlatformType {
-			Skip(fmt.Sprintf("Skipping tests on %s, this only support on aws", platform))
+			Skip(fmt.Sprintf("Skipping tests on %s, this is only supported on AWS", platform))
 		}
 
 		if !capiframework.IsMachineAPIMigrationEnabled(ctx, cl) {
@@ -296,8 +296,8 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 				}), capiframework.WaitMedium, capiframework.RetryShort).Should(Succeed(), "Failed to update CAPI MachineSet DeletePolicy")
 
 				By("Verifying both MAPI and CAPI MachineSet spec value are restored to original value")
-				Eventually(k.Object(mapiMachineSet), capiframework.WaitShort, capiframework.RetryShort).Should(HaveField("Spec.DeletePolicy", SatisfyAny(BeEmpty(), Equal("Random"))), "DeletePolicy should be either empty or 'Random'")
-				Eventually(k.Object(capiMachineSet), capiframework.WaitShort, capiframework.RetryShort).Should(HaveField("Spec.DeletePolicy", HaveValue(Equal("Random"))), "DeletePolicy should be 'Random'")
+				Eventually(k.Object(mapiMachineSet), capiframework.WaitShort, capiframework.RetryShort).Should(HaveField("Spec.DeletePolicy", SatisfyAny(BeEmpty(), Equal("Random"))), "Should have DeletePolicy be either empty or 'Random'")
+				Eventually(k.Object(capiMachineSet), capiframework.WaitShort, capiframework.RetryShort).Should(HaveField("Spec.DeletePolicy", HaveValue(Equal("Random"))), "Should have DeletePolicy be 'Random'")
 			})
 
 			It("should create a new InfraTemplate when update MAPI MachineSet providerSpec", func() {
@@ -310,7 +310,7 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 				By("Waiting for new InfraTemplate to be created")
 				originalAWSMachineTemplateName := capiMachineSet.Spec.Template.Spec.InfrastructureRef.Name
 				capiMachineSet = capiframework.GetMachineSet(cl, mapiMSAuthMAPIName, capiframework.CAPINamespace)
-				Eventually(k.Object(capiMachineSet), capiframework.WaitMedium, capiframework.RetryMedium).Should(HaveField("Spec.Template.Spec.InfrastructureRef.Name", Not(Equal(originalAWSMachineTemplateName))), "InfraTemplate name should be changed")
+				Eventually(k.Object(capiMachineSet), capiframework.WaitMedium, capiframework.RetryMedium).Should(HaveField("Spec.Template.Spec.InfrastructureRef.Name", Not(Equal(originalAWSMachineTemplateName))), "Should have InfraTemplate name changed")
 
 				By("Verifying new InfraTemplate has the updated InstanceType")
 				newAWSMachineTemplate, err := capiframework.GetAWSMachineTemplateByPrefix(cl, mapiMSAuthMAPIName, capiframework.CAPINamespace)
@@ -364,7 +364,7 @@ var _ = Describe("[sig-cluster-lifecycle][OCPFeatureGate:MachineAPIMigration] Ma
 				mapiMachineSet, _ = mapiframework.GetMachineSet(ctx, cl, mapiMSAuthMAPIName)
 				Eventually(k.Object(mapiMachineSet), capiframework.WaitMedium, capiframework.RetryMedium).Should(
 					HaveField("Spec.Template.Spec.ProviderSpec.Value.Raw", ContainSubstring(newInstanceType)),
-					"MAPI MachineSet providerSpec should be updated to reflect the new InfraTemplate with InstanceType %s", newInstanceType,
+					"Should have MAPI MachineSet providerSpec updated to reflect the new InfraTemplate with InstanceType %s", newInstanceType,
 				)
 			})
 		})