adress comments: extract common func

Author: randmonkey

test/helpers/conditions.go

@@ -0,0 +1,26 @@
+package helpers
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/samber/lo"
+
+	"github.com/kong/gateway-operator/pkg/consts"
+	k8sutils "github.com/kong/gateway-operator/pkg/utils/kubernetes"
+)
+
+// CheckAllConditionsTrue returns true if all the conditions with given type in `conditionTypes` are set to `True` in the given resource.
+// If it returns `false`, the second return value contains a message to tell what conditions are not `True`.
+func CheckAllConditionsTrue(resource k8sutils.ConditionsAware, conditionTypes []consts.ConditionType) (bool, string) {
+	failedConditions := make([]string, 0, len(conditionTypes))
+	lo.ForEach(conditionTypes, func(conditionType consts.ConditionType, _ int) {
+		if !k8sutils.HasConditionTrue(conditionType, resource) {
+			failedConditions = append(failedConditions, string(conditionType))
+		}
+	})
+	if len(failedConditions) > 0 {
+		return false, fmt.Sprintf("condition(s) %s not set to True", strings.Join(failedConditions, ", "))
+	}
+	return true, ""
+}

test/helpers/deploy/deploy_resources.go

@@ -1033,6 +1033,29 @@ func KonnectExtension(
 	return ke
 }
 
+// ObjectSupportingKonnectConfiguration defines the interface of types supporting setting `KonnectConfiguration`.
+type ObjectSupportingKonnectConfiguration interface {
+	*konnectv1alpha1.KonnectGatewayControlPlane |
+		*konnectv1alpha1.KonnectExtension |
+		*konnectv1alpha1.KonnectCloudGatewayNetwork
+}
+
+// WithKonnectConfiguration returns an option function that sets the `KonnectConfiguration` in the object.
+func WithKonnectConfiguration[T ObjectSupportingKonnectConfiguration](
+	konnectConfiguration konnectv1alpha1.KonnectConfiguration,
+) ObjOption {
+	return func(obj client.Object) {
+		switch o := any(obj).(type) {
+		case *konnectv1alpha1.KonnectGatewayControlPlane:
+			o.Spec.KonnectConfiguration = konnectConfiguration
+		case *konnectv1alpha1.KonnectExtension:
+			o.Spec.KonnectConfiguration = lo.ToPtr(konnectConfiguration)
+		case *konnectv1alpha1.KonnectCloudGatewayNetwork:
+			o.Spec.KonnectConfiguration = konnectConfiguration
+		}
+	}
+}
+
 // KonnectExtensionWithAPIAuthRefAndCPID deploys a KonnectExtension attaching to control plane
 // by the CP's ID and the API auth configuration to the Konnect server where the CP is in.
 func KonnectExtensionWithAPIAuthRefAndCPID(

test/integration/test_konnect_extension.go

@@ -1,24 +1,23 @@
 package integration
 
 import (
-	"fmt"
-	"strings"
 	"testing"
 
 	"github.com/google/uuid"
 	"github.com/samber/lo"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/kong/gateway-operator/pkg/consts"
 	testutils "github.com/kong/gateway-operator/pkg/utils/test"
 	"github.com/kong/gateway-operator/test"
 	"github.com/kong/gateway-operator/test/helpers"
 	"github.com/kong/gateway-operator/test/helpers/deploy"
 
+	commonv1alpha1 "github.com/kong/kubernetes-configuration/api/common/v1alpha1"
 	konnectv1alpha1 "github.com/kong/kubernetes-configuration/api/konnect/v1alpha1"
 )
 
@@ -67,12 +66,14 @@ func TestKonnectExtension(t *testing.T) {
 	)
 	// Create a KonnectExtension attaching to the CP by its ID.
 	t.Logf("Creating a KonnectExtension and waiting for Konnect control plane ref resolved")
-	ke := deploy.KonnectExtensionWithAPIAuthRefAndCPID(
+	ke := deploy.KonnectExtension(
 		t, ctx, clientNamespaced,
-		konnectv1alpha1.KonnectAPIAuthConfigurationRef{
-			Name: authCfg.Name,
-		},
-		cp.GetKonnectID(),
+		deploy.WithKonnectConfiguration[*konnectv1alpha1.KonnectExtension](konnectv1alpha1.KonnectConfiguration{
+			APIAuthConfigurationRef: konnectv1alpha1.KonnectAPIAuthConfigurationRef{
+				Name: authCfg.Name,
+			},
+		}),
+		setKonnectExtensionKonnectIDControlPlaneRef(t, cp.GetKonnectID()),
 		setKonnectExtensionDPCertSecretRef(t, s),
 	)
 
@@ -104,6 +105,19 @@ func TestKonnectExtension(t *testing.T) {
 
 }
 
+func setKonnectExtensionKonnectIDControlPlaneRef(t *testing.T, cpID string) deploy.ObjOption {
+	return func(obj client.Object) {
+		ke, ok := obj.(*konnectv1alpha1.KonnectExtension)
+		require.True(t, ok)
+		// TODO: use `WithKonnectIDControlPlaneRef` after KonnectExtension support `SetControlPlaneRef`:
+		// https://github.com/Kong/kubernetes-configuration/issues/328
+		ke.Spec.KonnectControlPlane.ControlPlaneRef = commonv1alpha1.ControlPlaneRef{
+			Type:      commonv1alpha1.ControlPlaneRefKonnectID,
+			KonnectID: lo.ToPtr(cpID),
+		}
+	}
+}
+
 func setKonnectExtensionDPCertSecretRef(t *testing.T, s *corev1.Secret) func(client.Object) {
 	return func(obj client.Object) {
 		ke, ok := obj.(*konnectv1alpha1.KonnectExtension)
@@ -123,25 +137,10 @@ func checkKonnectExtensionConditions(t *assert.CollectT, ke *konnectv1alpha1.Kon
 	err := GetClients().MgrClient.Get(GetCtx(), types.NamespacedName{Name: ke.Name, Namespace: ke.Namespace}, ke)
 	require.NoError(t, err)
 
-	checkConditionTypes := []string{
+	checkConditionTypes := []consts.ConditionType{
 		konnectv1alpha1.ControlPlaneRefValidConditionType,
 		konnectv1alpha1.DataPlaneCertificateProvisionedConditionType,
 		konnectv1alpha1.KonnectExtensionReadyConditionType,
 	}
-	failedConditionTypes := make([]string, 0, len(checkConditionTypes))
-	conditionMap := lo.SliceToMap(ke.Status.Conditions, func(condition metav1.Condition) (string, metav1.ConditionStatus) {
-		return condition.Type, condition.Status
-	})
-
-	for _, conditionType := range checkConditionTypes {
-		status, ok := conditionMap[conditionType]
-		if !ok || status != metav1.ConditionTrue {
-			failedConditionTypes = append(failedConditionTypes, conditionType)
-		}
-	}
-
-	if len(failedConditionTypes) > 0 {
-		return false, fmt.Sprintf("condition(s) %s not set to True", strings.Join(failedConditionTypes, ", "))
-	}
-	return true, ""
+	return helpers.CheckAllConditionsTrue(ke, checkConditionTypes)
 }