Wait for machine creation in ports e2e test

The ports e2e test was checking that a failure condition had not
occurred. However, it's possible the failure condition hadn't occurred
because the machine used for the test had not been created yet, and the
rest of the tests race ahead and do not find the port.

This commit ensures that we wait for the machine to be created before
listing ports.

Author: macaptain

test/e2e/suites/e2e/e2e_test.go

@@ -23,7 +23,6 @@ import (
 	"errors"
 	"fmt"
 	"path/filepath"
-	"reflect"
 	"strings"
 	"time"
 
@@ -145,32 +144,32 @@ var _ = Describe("e2e tests", func() {
 			customPortOptions := &[]infrav1.PortOpts{
 				{Description: "primary"},
 			}
+			machineDeployment := makeMachineDeployment(namespace.Name, md3Name, clusterName, "", 1)
 			framework.CreateMachineDeployment(ctx, framework.CreateMachineDeploymentInput{
 				Creator:                 e2eCtx.Environment.BootstrapClusterProxy.GetClient(),
-				MachineDeployment:       makeMachineDeployment(namespace.Name, md3Name, clusterName, "", 1),
+				MachineDeployment:       machineDeployment,
 				BootstrapConfigTemplate: makeJoinBootstrapConfigTemplate(namespace.Name, md3Name),
 				InfraMachineTemplate:    makeOpenStackMachineTemplateWithPortOptions(namespace.Name, clusterName, md3Name, customPortOptions),
 			})
 
-			shared.Byf("Expecting MachineDeployment to be created successfully")
-			Eventually(func() bool {
-				eventList := getEvents(namespace.Name)
-				portError := "Failed to create server with custom port options"
-				return isErrorEventExists(namespace.Name, md3Name, "FailedCreateServer", portError, eventList)
-			}, e2eCtx.E2EConfig.GetIntervals(specName, "wait-worker-nodes")...).Should(BeFalse())
+			cluster := framework.GetClusterByName(ctx, framework.GetClusterByNameInput{
+				Getter:    e2eCtx.Environment.BootstrapClusterProxy.GetClient(),
+				Name:      clusterName,
+				Namespace: namespace.Name,
+			})
 
-			filterNone := ports.ListOpts{}
-			plist1, err := shared.DumpOpenStackPorts(e2eCtx, filterNone)
-			Expect(err).To(BeNil())
-			Expect(plist1).NotTo(BeNil())
+			shared.Byf("Waiting for MachineDeployment node to be created")
+			framework.WaitForMachineDeploymentNodesToExist(ctx, framework.WaitForMachineDeploymentNodesToExistInput{
+				Lister:            e2eCtx.Environment.BootstrapClusterProxy.GetClient(),
+				Cluster:           cluster,
+				MachineDeployment: machineDeployment,
+			}, e2eCtx.E2EConfig.GetIntervals(specName, "wait-worker-nodes")...)
 
-			filterOne := ports.ListOpts{Description: "primary"}
-			plist2, err := shared.DumpOpenStackPorts(e2eCtx, filterOne)
+			shared.Byf("Expecting custom port to be found")
+			plist, err := shared.DumpOpenStackPorts(e2eCtx, ports.ListOpts{Description: "primary"})
 			Expect(err).To(BeNil())
-			count := len(*plist2)
+			count := len(*plist)
 			Expect(count).To(Equal(1))
-			found := portContainsProperty(*plist2, "Description", "primary")
-			Expect(found).Should(BeTrue())
 		})
 		It("It should be creatable and deletable", func() {
 			shared.Byf("Creating a cluster")
@@ -483,19 +482,3 @@ func isCloudProviderInitialized(taints []corev1.Taint) bool {
 	}
 	return true
 }
-
-// Verifies that a Port contains a valid property with a correct value.
-func portContainsProperty(plist interface{}, property string, value interface{}) bool {
-	ports := reflect.ValueOf(plist)
-	portsCount := ports.Len()
-	for i := 0; i < portsCount; i++ {
-		currentPort := ports.Index(i)
-		searchProperty := currentPort.FieldByName(property)
-		correctValue := searchProperty.Interface() == value
-		if correctValue {
-			return true
-		}
-	}
-	// Non-existing property or incorrect value
-	return false
-}