test: add Portal envtest coverage

Signed-off-by: Jintao Zhang <[email protected]>

Author: tao12345666333

test/envtest/konnect_entities_portal_test.go

@@ -0,0 +1,263 @@
+package envtest
+
+import (
+	"context"
+	"sync/atomic"
+	"testing"
+
+	sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
+	sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
+	sdkkonnecterrs "github.com/Kong/sdk-konnect-go/models/sdkerrors"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	apiwatch "k8s.io/apimachinery/pkg/watch"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+
+	konnectv1alpha1 "github.com/kong/kong-operator/v2/api/konnect/v1alpha1"
+	konnectv1alpha2 "github.com/kong/kong-operator/v2/api/konnect/v1alpha2"
+	"github.com/kong/kong-operator/v2/controller/konnect"
+	"github.com/kong/kong-operator/v2/controller/konnect/ops"
+	"github.com/kong/kong-operator/v2/modules/manager/logging"
+	"github.com/kong/kong-operator/v2/modules/manager/scheme"
+	"github.com/kong/kong-operator/v2/test/helpers/deploy"
+	"github.com/kong/kong-operator/v2/test/mocks/metricsmocks"
+	"github.com/kong/kong-operator/v2/test/mocks/sdkmocks"
+)
+
+func TestPortal(t *testing.T) {
+	t.Parallel()
+	ctx, cancel := Context(t, t.Context())
+	defer cancel()
+	cfg, ns := Setup(t, ctx, scheme.Get(), WithInstallGatewayCRDs(true))
+
+	t.Log("Setting up the manager with reconcilers")
+	mgr, logs := NewManager(t, ctx, cfg, scheme.Get())
+	factory := sdkmocks.NewMockSDKFactory(t)
+	sdk := factory.SDK
+	StartReconcilers(ctx, t, mgr, logs,
+		konnect.NewKonnectEntityReconciler(factory, logging.DevelopmentMode, mgr.GetClient(),
+			konnect.WithKonnectEntitySyncPeriod[konnectv1alpha1.Portal](konnectInfiniteSyncTime),
+			konnect.WithMetricRecorder[konnectv1alpha1.Portal](&metricsmocks.MockRecorder{}),
+		),
+	)
+
+	t.Log("Setting up clients")
+	cl, err := client.NewWithWatch(mgr.GetConfig(), client.Options{
+		Scheme: scheme.Get(),
+	})
+	require.NoError(t, err)
+	clientNamespaced := client.NewNamespacedClient(mgr.GetClient(), ns.Name)
+
+	t.Log("Creating KonnectAPIAuthConfiguration")
+	apiAuth := deploy.KonnectAPIAuthConfigurationWithProgrammed(t, ctx, clientNamespaced)
+
+	t.Run("should create, update and delete Portal successfully", func(t *testing.T) {
+		const (
+			portalID           = "portal-12345"
+			portalName         = "dev-portal"
+			initialDisplayName = "Developer Portal"
+			updatedDisplayName = "Updated Developer Portal"
+		)
+		initialDescription := "Portal created from envtest"
+		var createCalls, updateCalls, deleteCalls atomic.Int32
+
+		watchI, err := cl.Watch(ctx, &konnectv1alpha1.PortalList{}, client.InNamespace(ns.Name))
+		require.NoError(t, err)
+		t.Cleanup(func() { watchI.Stop() })
+		w := watch[*konnectv1alpha1.Portal]{w: watchI}
+
+		portal := testPortal(apiAuth, portalName, initialDisplayName, initialDescription)
+		sdk.PortalsSDK.EXPECT().
+			CreatePortal(mock.Anything, mock.MatchedBy(func(req sdkkonnectcomp.CreatePortal) bool {
+				return req.Name == portalName &&
+					req.DisplayName != nil && *req.DisplayName == initialDisplayName &&
+					req.Description != nil && *req.Description == initialDescription &&
+					req.Labels != nil &&
+					req.Labels["team"] != nil && *req.Labels["team"] == "platform" &&
+					req.Labels[ops.KubernetesUIDLabelKey] != nil && *req.Labels[ops.KubernetesUIDLabelKey] != ""
+			})).
+			RunAndReturn(func(_ context.Context, _ sdkkonnectcomp.CreatePortal, _ ...sdkkonnectops.Option) (*sdkkonnectops.CreatePortalResponse, error) {
+				createCalls.Add(1)
+				return &sdkkonnectops.CreatePortalResponse{
+					PortalResponse: &sdkkonnectcomp.PortalResponse{
+						ID: portalID,
+					},
+				}, nil
+			}).
+			Maybe()
+
+		t.Log("Creating Portal")
+		require.NoError(t, clientNamespaced.Create(ctx, portal))
+
+		t.Log("Waiting for Portal to be programmed")
+		watchFor(t, ctx, w, apiwatch.Modified,
+			assertsAnd(
+				objectMatchesName(portal),
+				objectMatchesKonnectID[*konnectv1alpha1.Portal](portalID),
+				objectHasConditionProgrammedSetToTrue[*konnectv1alpha1.Portal](),
+				func(p *konnectv1alpha1.Portal) bool {
+					return controllerutil.ContainsFinalizer(p, konnect.KonnectCleanupFinalizer)
+				},
+			),
+			"Portal didn't get Programmed status condition, Konnect ID, or cleanup finalizer",
+		)
+
+		require.Eventually(t, func() bool {
+			return createCalls.Load() > 0
+		}, waitTime, tickTime)
+
+		t.Log("Setting up SDK expectations on Portal update")
+		portalToPatch := portal.DeepCopy()
+		portalToPatch.Spec.APISpec.DisplayName = updatedDisplayName
+		sdk.PortalsSDK.EXPECT().
+			UpdatePortal(mock.Anything, portalID, mock.MatchedBy(func(req sdkkonnectcomp.UpdatePortal) bool {
+				return req.DisplayName != nil && *req.DisplayName == updatedDisplayName &&
+					req.Labels != nil &&
+					req.Labels["team"] != nil && *req.Labels["team"] == "platform" &&
+					req.Labels[ops.KubernetesUIDLabelKey] != nil && *req.Labels[ops.KubernetesUIDLabelKey] != ""
+			})).
+			RunAndReturn(func(_ context.Context, _ string, _ sdkkonnectcomp.UpdatePortal, _ ...sdkkonnectops.Option) (*sdkkonnectops.UpdatePortalResponse, error) {
+				updateCalls.Add(1)
+				return &sdkkonnectops.UpdatePortalResponse{}, nil
+			}).
+			Maybe()
+
+		t.Log("Patching Portal")
+		require.NoError(t, clientNamespaced.Patch(ctx, portalToPatch, client.MergeFrom(portal)))
+
+		t.Log("Waiting for Portal to be patched")
+		watchFor(t, ctx, w, apiwatch.Modified,
+			assertsAnd(
+				objectMatchesName(portal),
+				objectMatchesKonnectID[*konnectv1alpha1.Portal](portalID),
+				objectHasConditionProgrammedSetToTrue[*konnectv1alpha1.Portal](),
+				func(p *konnectv1alpha1.Portal) bool {
+					return p.Spec.APISpec.DisplayName == updatedDisplayName
+				},
+			),
+			"Portal didn't get patched",
+		)
+
+		require.Eventually(t, func() bool {
+			return updateCalls.Load() > 0
+		}, waitTime, tickTime)
+
+		t.Log("Setting up SDK expectations on Portal deletion")
+		sdk.PortalsSDK.EXPECT().
+			DeletePortal(mock.Anything, portalID, (*sdkkonnectops.DeletePortalQueryParamForce)(nil)).
+			RunAndReturn(func(_ context.Context, _ string, _ *sdkkonnectops.DeletePortalQueryParamForce, _ ...sdkkonnectops.Option) (*sdkkonnectops.DeletePortalResponse, error) {
+				deleteCalls.Add(1)
+				return &sdkkonnectops.DeletePortalResponse{}, nil
+			}).
+			Maybe()
+
+		t.Log("Deleting Portal")
+		require.NoError(t, clientNamespaced.Delete(ctx, portal))
+		require.Eventually(t, func() bool {
+			err := clientNamespaced.Get(ctx, client.ObjectKeyFromObject(portal), &konnectv1alpha1.Portal{})
+			return client.IgnoreNotFound(err) == nil && err != nil
+		}, waitTime, tickTime)
+		require.Eventually(t, func() bool {
+			return deleteCalls.Load() > 0
+		}, waitTime, tickTime)
+	})
+
+	t.Run("should create Portal successfully on conflict when Portal with matching uid tag exists", func(t *testing.T) {
+		const (
+			portalID    = "portal-conflict-id"
+			portalName  = "conflict-portal"
+			displayName = "Conflict Portal"
+			description = "Portal resolved through UID tag lookup"
+		)
+		var createCalls, listCalls atomic.Int32
+
+		watchI, err := cl.Watch(ctx, &konnectv1alpha1.PortalList{}, client.InNamespace(ns.Name))
+		require.NoError(t, err)
+		t.Cleanup(func() { watchI.Stop() })
+		w := watch[*konnectv1alpha1.Portal]{w: watchI}
+
+		portal := testPortal(apiAuth, portalName, displayName, description)
+		sdk.PortalsSDK.EXPECT().
+			CreatePortal(mock.Anything, mock.MatchedBy(func(req sdkkonnectcomp.CreatePortal) bool {
+				return req.Name == portalName
+			})).
+			RunAndReturn(func(_ context.Context, _ sdkkonnectcomp.CreatePortal, _ ...sdkkonnectops.Option) (*sdkkonnectops.CreatePortalResponse, error) {
+				createCalls.Add(1)
+				return nil, &sdkkonnecterrs.SDKError{
+					StatusCode: 400,
+					Body:       ErrBodyDataConstraintError,
+				}
+			}).
+			Maybe()
+
+		sdk.PortalsSDK.EXPECT().
+			ListPortals(mock.Anything, sdkkonnectops.ListPortalsRequest{}).
+			RunAndReturn(func(_ context.Context, _ sdkkonnectops.ListPortalsRequest, _ ...sdkkonnectops.Option) (*sdkkonnectops.ListPortalsResponse, error) {
+				listCalls.Add(1)
+				return &sdkkonnectops.ListPortalsResponse{
+					ListPortalsResponse: &sdkkonnectcomp.ListPortalsResponse{
+						Data: []sdkkonnectcomp.ListPortalsResponsePortal{
+							{
+								ID: portalID,
+								Labels: map[string]string{
+									ops.KubernetesUIDLabelKey: string(portal.GetUID()),
+								},
+							},
+						},
+					},
+				}, nil
+			}).
+			Maybe()
+
+		t.Log("Creating Portal")
+		require.NoError(t, clientNamespaced.Create(ctx, portal))
+
+		t.Log("Waiting for Portal to be programmed after UID conflict lookup")
+		watchFor(t, ctx, w, apiwatch.Modified,
+			assertsAnd(
+				objectMatchesName(portal),
+				objectMatchesKonnectID[*konnectv1alpha1.Portal](portalID),
+				objectHasConditionProgrammedSetToTrue[*konnectv1alpha1.Portal](),
+			),
+			"Portal didn't get Programmed status condition or Konnect ID after conflict resolution",
+		)
+
+		require.Eventually(t, func() bool {
+			return createCalls.Load() > 0
+		}, waitTime, tickTime)
+		require.Eventually(t, func() bool {
+			return listCalls.Load() > 0
+		}, waitTime, tickTime)
+	})
+}
+
+func testPortal(
+	apiAuth *konnectv1alpha1.KonnectAPIAuthConfiguration,
+	name,
+	displayName,
+	description string,
+) *konnectv1alpha1.Portal {
+	return &konnectv1alpha1.Portal{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: name,
+		},
+		Spec: konnectv1alpha1.PortalSpec{
+			KonnectConfiguration: konnectv1alpha2.KonnectConfiguration{
+				APIAuthConfigurationRef: konnectv1alpha2.KonnectAPIAuthConfigurationRef{
+					Name: apiAuth.Name,
+				},
+			},
+			APISpec: konnectv1alpha1.PortalAPISpec{
+				AuthenticationEnabled: "Enabled",
+				Description:           &description,
+				DisplayName:           displayName,
+				Labels: konnectv1alpha1.LabelsUpdate{
+					"team": "platform",
+				},
+				Name: name,
+			},
+		},
+	}
+}