feat(test): add github_endpoint reconciler tests

mercedes-benz · Aug 26, 2024 · 0cc2f68 · 0cc2f68
1 parent 686f43a
commit 0cc2f68
Show file tree

Hide file tree

Showing 9 changed files with 932 additions and 18 deletions.
diff --git a/internal/controller/garmserverconfig_controller_test.go b/internal/controller/garmserverconfig_controller_test.go
@@ -1 +1,118 @@
 package controller
+
+import (
+	"context"
+	"github.com/cloudbase/garm/client/controller_info"
+	"github.com/cloudbase/garm/params"
+	"github.com/google/uuid"
+	garmoperatorv1alpha1 "github.com/mercedes-benz/garm-operator/api/v1alpha1"
+	"github.com/mercedes-benz/garm-operator/pkg/client/mock"
+	"github.com/mercedes-benz/garm-operator/pkg/util/conditions"
+	"go.uber.org/mock/gomock"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/client-go/kubernetes/scheme"
+	"k8s.io/client-go/tools/record"
+	"reflect"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	"testing"
+)
+
+var controllerId = uuid.New()
+
+func TestGarmServerConfig_reconcile(t *testing.T) {
+	mockCtrl := gomock.NewController(t)
+	defer mockCtrl.Finish()
+
+	tests := []struct {
+		name              string
+		object            *garmoperatorv1alpha1.GarmServerConfig
+		expectGarmRequest func(m *mock.MockControllerClientMockRecorder)
+		runtimeObjects    []runtime.Object
+		wantErr           bool
+		expectedObject    *garmoperatorv1alpha1.GarmServerConfig
+	}{
+		{
+			name: "sync controller info to GarmServerConfig",
+			object: &garmoperatorv1alpha1.GarmServerConfig{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "garm-server-config",
+					Namespace: "default",
+				},
+				Spec: garmoperatorv1alpha1.GarmServerConfigSpec{
+					MetadataURL: "http://garm-server.garm-server.svc:9997/api/v1/metadata",
+					CallbackURL: "http://garm-server.garm-server.svc:9997/api/v1/callbacks",
+					WebhookURL:  "http://garm-server.garm-server.svc:9997/api/v1/webhook",
+				},
+			},
+			expectedObject: &garmoperatorv1alpha1.GarmServerConfig{},
+			runtimeObjects: []runtime.Object{},
+			wantErr:        false,
+			expectGarmRequest: func(m *mock.MockControllerClientMockRecorder) {
+				m.GetControllerInfo().Return(&controller_info.ControllerInfoOK{Payload: params.ControllerInfo{
+					ControllerID:         controllerId,
+					Hostname:             "garm.server.com",
+					MetadataURL:          "http://garm-server.garm-server.svc:9997/api/v1/metadata",
+					CallbackURL:          "http://garm-server.garm-server.svc:9997/api/v1/callbacks",
+					WebhookURL:           "http://garm-server.garm-server.svc:9997/api/v1/webhook",
+					ControllerWebhookURL: " http://garm-server.garm-server.svc:9997/api/v1/webhook/BE4B3620-D424-43AC-8EDD-5760DBD516BF",
+					MinimumJobAgeBackoff: 30,
+					Version:              "v0.1.5",
+				}}, nil)
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			schemeBuilder := runtime.SchemeBuilder{
+				garmoperatorv1alpha1.AddToScheme,
+			}
+
+			err := schemeBuilder.AddToScheme(scheme.Scheme)
+			if err != nil {
+				t.Fatal(err)
+			}
+			runtimeObjects := []runtime.Object{tt.object}
+			runtimeObjects = append(runtimeObjects, tt.runtimeObjects...)
+			client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithRuntimeObjects(runtimeObjects...).WithStatusSubresource(&garmoperatorv1alpha1.GarmServerConfig{}).Build()
+
+			// create a fake reconciler
+			reconciler := &GarmServerConfigReconciler{
+				Client:   client,
+				Recorder: record.NewFakeRecorder(3),
+			}
+
+			garmServerConfig := tt.object.DeepCopyObject().(*garmoperatorv1alpha1.GarmServerConfig)
+
+			mockController := mock.NewMockControllerClient(mockCtrl)
+			tt.expectGarmRequest(mockController.EXPECT())
+
+			_, err = reconciler.reconcile(context.Background(), ctrl.Request{
+				NamespacedName: types.NamespacedName{
+					Namespace: tt.object.Namespace,
+					Name:      tt.object.Name,
+				},
+			}, mockController)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("EnterpriseReconciler.reconcileNormal() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+
+			// clear out annotations to avoid comparison errors
+			garmServerConfig.ObjectMeta.Annotations = nil
+
+			// empty resource version to avoid comparison errors
+			garmServerConfig.ObjectMeta.ResourceVersion = ""
+
+			// clear conditions lastTransitionTime to avoid comparison errors
+			conditions.NilLastTransitionTime(tt.expectedObject)
+			conditions.NilLastTransitionTime(garmServerConfig)
+
+			if !reflect.DeepEqual(garmServerConfig, tt.expectedObject) {
+				t.Errorf("EnterpriseReconciler.reconcileNormal() \ngot = %#v\n want %#v", garmServerConfig, tt.expectedObject)
+			}
+		})
+	}
+}
diff --git a/internal/controller/githubendpoint_controller.go b/internal/controller/githubendpoint_controller.go
@@ -210,8 +210,8 @@ func (r *GitHubEndpointReconciler) reconcileDelete(ctx context.Context, client g
 		return ctrl.Result{}, err
 	}
 
-	if controllerutil.ContainsFinalizer(endpoint, key.EndpointFinalizerName) {
-		controllerutil.RemoveFinalizer(endpoint, key.EndpointFinalizerName)
+	if controllerutil.ContainsFinalizer(endpoint, key.GitHubEndpointFinalizerName) {
+		controllerutil.RemoveFinalizer(endpoint, key.GitHubEndpointFinalizerName)
 		if err := r.Update(ctx, endpoint); err != nil {
 			return ctrl.Result{}, err
 		}
@@ -223,8 +223,8 @@ func (r *GitHubEndpointReconciler) reconcileDelete(ctx context.Context, client g
 }
 
 func (r *GitHubEndpointReconciler) ensureFinalizer(ctx context.Context, endpoint *garmoperatorv1alpha1.GitHubEndpoint) error {
-	if !controllerutil.ContainsFinalizer(endpoint, key.EndpointFinalizerName) {
-		controllerutil.AddFinalizer(endpoint, key.EndpointFinalizerName)
+	if !controllerutil.ContainsFinalizer(endpoint, key.GitHubEndpointFinalizerName) {
+		controllerutil.AddFinalizer(endpoint, key.GitHubEndpointFinalizerName)
 		return r.Update(ctx, endpoint)
 	}
 	return nil