Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(envtest): set mock SDK to test creating control plane #573

Merged
merged 4 commits into from
Sep 11, 2024
Merged

test(envtest): set mock SDK to test creating control plane #573

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21930bd
set mock SDK to test creating control plane
randmonkey Sep 11, 2024
80f261b
rename wrapper to sdk
randmonkey Sep 11, 2024
6ac5730
add assertExpctations to tests
randmonkey Sep 11, 2024
2bc03d0
Merge branch 'main' into test/envtest_mock_konnect_sdk
randmonkey Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions controller/konnect/ops/sdkfactory_mock.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ type MockSDKWrapper struct {

var _ SDKWrapper = MockSDKWrapper{}

func NewMockSDKWrapper() *MockSDKWrapper {
return &MockSDKWrapper{
ControlPlaneSDK: &MockControlPlaneSDK{},
ServicesSDK: &MockServicesSDK{},
RoutesSDK: &MockRoutesSDK{},
ConsumersSDK: &MockConsumersSDK{},
ConsumerGroupSDK: &MockConsumerGroupSDK{},
PluginSDK: &MockPluginSDK{},
MeSDK: &MockMeSDK{},
}
}

func (m MockSDKWrapper) GetControlPlaneSDK() ControlPlaneSDK {
return m.ControlPlaneSDK
}
Expand Down Expand Up @@ -41,16 +53,16 @@ func (m MockSDKWrapper) GetMeSDK() MeSDK {
}

type MockSDKFactory struct {
w *MockSDKWrapper
Wapper *MockSDKWrapper
randmonkey marked this conversation as resolved.
Show resolved Hide resolved
}

var _ SDKFactory = MockSDKFactory{}

func (m MockSDKFactory) NewKonnectSDK(_ string, _ SDKToken) SDKWrapper {
if m.w != nil {
return *m.w
if m.Wapper != nil {
return *m.Wapper
}
return &MockSDKWrapper{
return MockSDKWrapper{
randmonkey marked this conversation as resolved.
Show resolved Hide resolved
ControlPlaneSDK: &MockControlPlaneSDK{},
ServicesSDK: &MockServicesSDK{},
RoutesSDK: &MockRoutesSDK{},
Expand Down
57 changes: 49 additions & 8 deletions test/envtest/reconciler_setupwithmanager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ import (
"testing"
"time"

sdkkonnectcomp "github.com/Kong/sdk-konnect-go/models/components"
sdkkonnectops "github.com/Kong/sdk-konnect-go/models/operations"
"github.com/go-logr/logr/testr"
"github.com/samber/lo"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down Expand Up @@ -42,24 +46,42 @@ func TestNewKonnectEntityReconciler(t *testing.T) {
type konnectEntityReconcilerTestCase struct {
name string
objectOps func(ctx context.Context, t *testing.T, cl client.Client, ns *corev1.Namespace)
mockSDKSettings func(t *testing.T, m *ops.MockSDKWrapper, ns *corev1.Namespace)
randmonkey marked this conversation as resolved.
Show resolved Hide resolved
eventuallyPredicate func(ctx context.Context, t *testing.T, cl client.Client, ns *corev1.Namespace) bool
}

var konnectGatewayControlPlaneTestCases = []konnectEntityReconcilerTestCase{
{
name: "should resolve auth",
name: "should create control plane successfully",
objectOps: func(ctx context.Context, t *testing.T, cl client.Client, ns *corev1.Namespace) {
auth := &konnectv1alpha1.KonnectAPIAuthConfiguration{
ObjectMeta: metav1.ObjectMeta{
Name: "auth",
Namespace: ns.Name,
},
Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{
Type: konnectv1alpha1.KonnectAPIAuthTypeToken,
Token: "kpat_test",
Type: konnectv1alpha1.KonnectAPIAuthTypeToken,
Token: "kpat_test",
ServerURL: "127.0.0.1",
},
}
require.NoError(t, cl.Create(ctx, auth))
// We cannot create KonnectAPIAuthConfiguration with specified status, so we update the status after creating it.
auth.Status = konnectv1alpha1.KonnectAPIAuthConfigurationStatus{
OrganizationID: "org-1",
ServerURL: "127.0.0.1",
Conditions: []metav1.Condition{
{
Type: conditions.KonnectEntityAPIAuthConfigurationValidConditionType,
ObservedGeneration: auth.GetGeneration(),
Status: metav1.ConditionTrue,
Reason: conditions.KonnectEntityAPIAuthConfigurationReasonValid,
LastTransitionTime: metav1.Now(),
},
},
}
require.NoError(t, cl.Status().Update(ctx, auth))
// Create KonnectGatewayControlPlane.
cp := &konnectv1alpha1.KonnectGatewayControlPlane{
ObjectMeta: metav1.ObjectMeta{
Name: "cp-1",
Expand All @@ -71,10 +93,24 @@ var konnectGatewayControlPlaneTestCases = []konnectEntityReconcilerTestCase{
Name: "auth",
},
},
CreateControlPlaneRequest: sdkkonnectcomp.CreateControlPlaneRequest{
Name: "cp-1",
Description: lo.ToPtr("test control plane 1"),
},
},
}
require.NoError(t, cl.Create(ctx, cp))
},
mockSDKSettings: func(t *testing.T, m *ops.MockSDKWrapper, ns *corev1.Namespace) {
randmonkey marked this conversation as resolved.
Show resolved Hide resolved
m.ControlPlaneSDK.EXPECT().CreateControlPlane(mock.Anything, sdkkonnectcomp.CreateControlPlaneRequest{
Name: "cp-1",
Description: lo.ToPtr("test control plane 1"),
}).Return(&sdkkonnectops.CreateControlPlaneResponse{
ControlPlane: &sdkkonnectcomp.ControlPlane{
ID: "12345",
},
}, nil)
},
eventuallyPredicate: func(ctx context.Context, t *testing.T, cl client.Client, ns *corev1.Namespace) bool {
cp := &konnectv1alpha1.KonnectGatewayControlPlane{}
require.NoError(t,
Expand All @@ -86,10 +122,10 @@ var konnectGatewayControlPlaneTestCases = []konnectEntityReconcilerTestCase{
cp,
),
)
// TODO: setup mock Konnect SDK and verify that Konnect CP is "Created".
return lo.ContainsBy(cp.Status.Conditions, func(condition metav1.Condition) bool {
return condition.Type == conditions.KonnectEntityAPIAuthConfigurationResolvedRefConditionType && condition.Status == metav1.ConditionTrue
})
return cp.Status.ID == "12345" && // Call of creating control plane should be OK
lo.ContainsBy(cp.Status.Conditions, func(condition metav1.Condition) bool { // "Programmed" condition should be true
return condition.Type == conditions.KonnectEntityProgrammedConditionType && condition.Status == metav1.ConditionTrue
})
},
},
}
Expand All @@ -116,6 +152,7 @@ func testNewKonnectEntityReconciler[

mgr, err := ctrl.NewManager(cfg, ctrl.Options{
Scheme: scheme.Get(),
Logger: testr.New(t).V(1),
Metrics: metricsserver.Options{
// We do not need metrics server so we set BindAddress to 0 to disable it.
BindAddress: "0",
Expand All @@ -124,7 +161,10 @@ func testNewKonnectEntityReconciler[
require.NoError(t, err)

cl := mgr.GetClient()
reconciler := konnect.NewKonnectEntityReconciler[T, TEnt](&ops.MockSDKFactory{}, false, cl)
wrapper := ops.NewMockSDKWrapper()
randmonkey marked this conversation as resolved.
Show resolved Hide resolved
reconciler := konnect.NewKonnectEntityReconciler[T, TEnt](&ops.MockSDKFactory{
Wapper: wrapper,
}, false, cl)
require.NoError(t, reconciler.SetupWithManager(ctx, mgr))

ns := &corev1.Namespace{
Expand All @@ -148,6 +188,7 @@ func testNewKonnectEntityReconciler[
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
tc.objectOps(ctx, t, cl, ns)
tc.mockSDKSettings(t, wrapper, ns)
require.Eventually(t, func() bool {
return tc.eventuallyPredicate(ctx, t, cl, ns)
}, wait, tick)
Expand Down
Loading