Verify istio installation before verifying gw-api objects in e2e tests

Also, check that an appropriate service mesh cluster service version has
been installed as part of verifying istio installation.

This is part of the fix for OCPBUGS-53424

Author: rfredette

test/e2e/gateway_api_test.go

@@ -95,8 +95,8 @@ func TestGatewayAPI(t *testing.T) {
 
 	t.Run("testGatewayAPIResources", testGatewayAPIResources)
 	if gatewayAPIControllerEnabled {
-		t.Run("testGatewayAPIObjects", testGatewayAPIObjects)
 		t.Run("testGatewayAPIIstioInstallation", testGatewayAPIIstioInstallation)
+		t.Run("testGatewayAPIObjects", testGatewayAPIObjects)
 	} else {
 		t.Log("Gateway API Controller not enabled, skipping testGatewayAPIObjects and testGatewayAPIIstioInstallation")
 	}
@@ -134,6 +134,12 @@ func testGatewayAPIResources(t *testing.T) {
 //   - If the Istio and Subscription CRs are deleted, they are recreated
 //     automatically.
 func testGatewayAPIIstioInstallation(t *testing.T) {
+	gatewayClassName := "openshift-test"
+	t.Logf("Ensure gateway class %s exists...", gatewayClassName)
+	_, err := createGatewayClass(gatewayClassName, operatorcontroller.OpenShiftGatewayClassControllerName)
+	if err != nil {
+		t.Fatalf("feature gate was enabled, but gateway class object could not be created: %v", err)
+	}
 	t.Log("Checking for the Subscription...")
 	if err := assertSubscription(t, openshiftOperatorsNamespace, expectedSubscriptionName); err != nil {
 		t.Fatalf("failed to find expected Subscription %s: %v", expectedSubscriptionName, err)
@@ -142,6 +148,9 @@ func testGatewayAPIIstioInstallation(t *testing.T) {
 	if err := assertCatalogSource(t, expectedCatalogSourceNamespace, expectedCatalogSourceName); err != nil {
 		t.Fatalf("failed to find expected CatalogSource %s: %v", expectedCatalogSourceName, err)
 	}
+	if err := assertClusterServiceVersionSucceeded(t); err != nil {
+		t.Fatalf("failed to find cluster service version: %v", err)
+	}
 	t.Log("Checking for the OSSM operator deployment and pods...")
 	if err := assertOSSMOperator(t); err != nil {
 		t.Fatalf("failed to find expected Istio operator: %v", err)

test/e2e/util_gatewayapi_test.go

@@ -17,6 +17,7 @@ import (
 
 	sailv1 "github.com/istio-ecosystem/sail-operator/api/v1"
 	v1 "github.com/openshift/api/operatoringress/v1"
+	"github.com/openshift/cluster-ingress-operator/pkg/operator/controller"
 	operatorcontroller "github.com/openshift/cluster-ingress-operator/pkg/operator/controller"
 	util "github.com/openshift/cluster-ingress-operator/pkg/util"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -461,20 +462,30 @@ func assertOSSMOperator(t *testing.T) error {
 		return true, nil
 	})
 	if err != nil {
-		return fmt.Errorf("error finding deployment %v: %v", ns, err)
+		return fmt.Errorf("error finding deployment %v: %w", ns, err)
 	}
 
+	pod := corev1.Pod{}
 	// Get the istio-operator pod.
-	podlist, err := getPods(t, kclient, dep)
+	err = wait.PollUntilContextTimeout(context.Background(), 1*time.Second, 30*time.Second, false, func(context context.Context) (bool, error) {
+		podlist, err := getPods(t, kclient, dep)
+		if err != nil {
+			t.Logf("error finding pod for deployment %v: %v", ns, err)
+			return false, nil
+		}
+		if len(podlist.Items) > 1 {
+			t.Logf("too many pods for deployment %v: %d", ns, len(podlist.Items))
+			return false, nil
+		}
+		pod = podlist.Items[0]
+		if pod.Status.Phase != corev1.PodRunning {
+			t.Logf("OSSM operator failure: pod %s is not running, it is %v", pod.Name, pod.Status.Phase)
+			return false, nil
+		}
+		return true, nil
+	})
 	if err != nil {
-		return fmt.Errorf("error finding pod for deployment %v: %v", ns, err)
-	}
-	if len(podlist.Items) > 1 {
-		return fmt.Errorf("too many pods for deployment %v: %d", ns, len(podlist.Items))
-	}
-	pod := podlist.Items[0]
-	if pod.Status.Phase != corev1.PodRunning {
-		return fmt.Errorf("OSSM operator failure: pod %s is not running, it is %v", pod.Name, pod.Status.Phase)
+		return fmt.Errorf("error finding OSSM operator pod %v: %w", ns, err)
 	}
 
 	t.Logf("found OSSM operator pod %s/%s to be %s", pod.Namespace, pod.Name, pod.Status.Phase)
@@ -766,6 +777,47 @@ func assertCatalogSource(t *testing.T, namespace, csName string) error {
 	return err
 }
 
+func assertClusterServiceVersionSucceeded(t *testing.T) error {
+	t.Helper()
+	expectedVersion, err := expectedOSSMVersion(t)
+	if err != nil {
+		return fmt.Errorf("Could not determine expected OSSM version: %w", err)
+	}
+	err = wait.PollUntilContextTimeout(context.Background(), 1*time.Second, 60*time.Second, false, func(context context.Context) (bool, error) {
+		t.Log("getting cluster service version...")
+		csv := &operatorsv1alpha1.ClusterServiceVersion{}
+		if err := kclient.Get(context, types.NamespacedName{Namespace: controller.OpenshiftOperatorNamespace, Name: expectedVersion}, csv); err != nil {
+			t.Logf("failed to get cluster service version %s/%s: %v", controller.OpenshiftOperatorNamespace, expectedVersion, err)
+			return false, err
+		}
+		if csv.Status.Phase != operatorsv1alpha1.CSVPhaseSucceeded {
+			t.Logf("found cluster service version %s, but phase is %s, expected Succeeded", csv.Name, csv.Status.Phase)
+			return false, nil
+		}
+		t.Logf("found cluster service version %s, and phase is Succeeded", csv.Name)
+		return true, nil
+	})
+	return err
+}
+
+func expectedOSSMVersion(t *testing.T) (string, error) {
+	t.Helper()
+	deployment, err := getDeployment(t, kclient, types.NamespacedName{Namespace: controller.DefaultOperatorNamespace, Name: "ingress-operator"}, timeout)
+	if err != nil {
+		return "", err
+	}
+	for _, container := range deployment.Spec.Template.Spec.Containers {
+		if container.Name == "ingress-operator" {
+			for _, envvar := range container.Env {
+				if envvar.Name == "GATEWAY_API_OPERATOR_VERSION" {
+					return envvar.Value, nil
+				}
+			}
+		}
+	}
+	return "servicemeshoperator3.v3.0.0", nil
+}
+
 // assertIstio checks if the Istio exists in a ready state,
 // and returns an error if not.
 func assertIstio(t *testing.T) error {