Move utility functions around, update tests

Signed-off-by: Anish Asthana <anishasthana1@gmail.com>

Author: anishasthana

config/internal/mcad/rolebinding_custom-metrics-auth-reader.yaml.tmpl

@@ -2,7 +2,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   name: {{.Name}}-custom-metrics-auth-reader
-  namespace: {{.Namespace}}
+  namespace: kube-system
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role

controllers/mcad_controller_test.go

@@ -7,15 +7,14 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	codeflarev1alpha1 "github.com/project-codeflare/codeflare-operator/api/v1alpha1"
-	"github.com/project-codeflare/codeflare-operator/controllers/testutil"
-
-	v1 "k8s.io/api/core/v1"
-	"k8s.io/apimachinery/pkg/types"
 )
 
 const (
-	mcadCRCase1    = "./testdata/mcad_test_cases/case_1.yaml"
-	mcadConfigMap1 = "./testdata/mcad_test_results/case_1/configmap.yaml"
+	mcadCRCase1         = "./testdata/mcad_test_cases/case_1.yaml"
+	mcadConfigMap1      = "./testdata/mcad_test_results/case_1/configmap.yaml"
+	mcadRolebinding1    = "./testdata/mcad_test_results/case_1/rolebinding.yaml"
+	mcadService1        = "./testdata/mcad_test_results/case_1/service.yaml"
+	mcadServiceAccount1 = "./testdata/mcad_test_results/case_1/serviceaccount.yaml"
 )
 
 func deployMCAD(ctx context.Context, path string, opts mf.Option) {
@@ -25,20 +24,6 @@ func deployMCAD(ctx context.Context, path string, opts mf.Option) {
 	Expect(k8sClient.Create(ctx, mcad)).Should(Succeed())
 }
 
-func compareConfigMaps(path string, opts mf.Option) {
-	expectedConfigMap := &v1.ConfigMap{}
-	Expect(convertToStructuredResource(path, expectedConfigMap, opts)).NotTo(HaveOccurred())
-
-	actualConfigMap := &v1.ConfigMap{}
-	Eventually(func() error {
-		namespacedNamed := types.NamespacedName{Name: expectedConfigMap.Name, Namespace: WorkingNamespace}
-		return k8sClient.Get(ctx, namespacedNamed, actualConfigMap)
-	}, timeout, interval).ShouldNot(HaveOccurred())
-
-	Expect(testutil.ConfigMapsAreEqual(*expectedConfigMap, *actualConfigMap)).Should(BeTrue())
-
-}
-
 var _ = Describe("The MCAD Controller", func() {
 	client := mfc.NewClient(k8sClient)
 	opts := mf.UseClient(client)
@@ -49,6 +34,9 @@ var _ = Describe("The MCAD Controller", func() {
 		It("It should create a configmap", func() {
 			deployMCAD(ctx, mcadCRCase1, opts)
 			compareConfigMaps(mcadConfigMap1, opts)
+			compareRoleBindings(mcadRolebinding1, opts)
+			compareServiceAccounts(mcadServiceAccount1, opts)
+			compareServices(mcadService1, opts)
 		})
 	})
 

controllers/multi_cluster_app_dispatcher.go

@@ -11,7 +11,7 @@ var multiClusterAppDispatcherTemplates = []string{
 	"mcad/service.yaml.tmpl",
 	"mcad/serviceaccount.yaml.tmpl",
 	"mcad/service.yaml.tmpl",
-	"mcad/rolebinding_custom-metrics-auth-reader.yaml.tmpl",
+	"mcad/rolebinding_custom-metrics-auth-reader.yaml.tmpl", //Confirm is this rolebinding is actually required by MCAD
 }
 
 func (r *MCADReconciler) ReconcileMCAD(ctx context.Context, mcad *codeflarev1alpha1.MCAD, req ctrl.Request, params *MCADParams) error {

controllers/suite_test.go

@@ -18,7 +18,11 @@ package controllers
 
 import (
 	"context"
+	"github.com/project-codeflare/codeflare-operator/controllers/util"
 	"go.uber.org/zap/zapcore"
+	corev1 "k8s.io/api/core/v1"
+	k8srbacv1 "k8s.io/api/rbac/v1"
+	"k8s.io/apimachinery/pkg/types"
 	"path/filepath"
 	"testing"
 	"time"
@@ -52,7 +56,7 @@ var (
 )
 
 const (
-	WorkingNamespace = "default"
+	workingNamespace = "default"
 	timeout          = time.Second * 30
 	interval         = time.Millisecond * 10
 )
@@ -132,7 +136,7 @@ var _ = AfterSuite(func() {
 
 // Cleanup resources to not contaminate between tests
 var _ = AfterEach(func() {
-	inNamespace := client.InNamespace(WorkingNamespace)
+	inNamespace := client.InNamespace(workingNamespace)
 	Expect(k8sClient.DeleteAllOf(context.TODO(), &codeflarev1alpha1.MCAD{}, inNamespace)).ToNot(HaveOccurred())
 
 })
@@ -142,7 +146,7 @@ func convertToStructuredResource(path string, out interface{}, opts mf.Option) e
 	if err != nil {
 		return err
 	}
-	m, err = m.Transform(mf.InjectNamespace(WorkingNamespace))
+	m, err = m.Transform(mf.InjectNamespace(workingNamespace))
 	if err != nil {
 		return err
 	}
@@ -155,3 +159,57 @@ func convertToStructuredResource(path string, out interface{}, opts mf.Option) e
 	}
 	return nil
 }
+
+func compareConfigMaps(path string, opts mf.Option) {
+	expectedConfigMap := &corev1.ConfigMap{}
+	Expect(convertToStructuredResource(path, expectedConfigMap, opts)).NotTo(HaveOccurred())
+
+	actualConfigMap := &corev1.ConfigMap{}
+	Eventually(func() error {
+		namespacedNamed := types.NamespacedName{Name: expectedConfigMap.Name, Namespace: workingNamespace}
+		return k8sClient.Get(ctx, namespacedNamed, actualConfigMap)
+	}, timeout, interval).ShouldNot(HaveOccurred())
+
+	Expect(util.ConfigMapsAreEqual(*expectedConfigMap, *actualConfigMap)).Should(BeTrue())
+}
+
+func compareRoleBindings(path string, opts mf.Option) {
+	expectedRB := &k8srbacv1.RoleBinding{}
+	Expect(convertToStructuredResource(path, expectedRB, opts)).NotTo(HaveOccurred())
+	expectedRB.Subjects[0].Namespace = workingNamespace
+
+	actualRB := &k8srbacv1.RoleBinding{}
+	Eventually(func() error {
+		namespacedNamed := types.NamespacedName{Name: expectedRB.Name, Namespace: workingNamespace}
+		return k8sClient.Get(ctx, namespacedNamed, actualRB)
+	}, timeout, interval).ShouldNot(HaveOccurred())
+
+	Expect(util.RoleBindingsAreEqual(*expectedRB, *actualRB)).Should(BeTrue())
+}
+
+func compareServiceAccounts(path string, opts mf.Option) {
+	expectedSA := &corev1.ServiceAccount{}
+	Expect(convertToStructuredResource(path, expectedSA, opts)).NotTo(HaveOccurred())
+	expectedSA.Namespace = workingNamespace
+
+	actualSA := &corev1.ServiceAccount{}
+	Eventually(func() error {
+		namespacedNamed := types.NamespacedName{Name: expectedSA.Name, Namespace: workingNamespace}
+		return k8sClient.Get(ctx, namespacedNamed, actualSA)
+	}, timeout, interval).ShouldNot(HaveOccurred())
+
+	Expect(util.ServiceAccountsAreEqual(*expectedSA, *actualSA)).Should(BeTrue())
+}
+
+func compareServices(path string, opts mf.Option) {
+	expectedService := &corev1.Service{}
+	Expect(convertToStructuredResource(path, expectedService, opts)).NotTo(HaveOccurred())
+
+	actualService := &corev1.Service{}
+	Eventually(func() error {
+		namespacedNamed := types.NamespacedName{Name: expectedService.Name, Namespace: workingNamespace}
+		return k8sClient.Get(ctx, namespacedNamed, actualService)
+	}, timeout, interval).ShouldNot(HaveOccurred())
+
+	Expect(util.ServicesAreEqual(*expectedService, *actualService)).Should(BeTrue())
+}

controllers/testdata/mcad_test_results/case_1/rolebinding.yaml

@@ -0,0 +1,13 @@
+kind: RoleBinding
+apiVersion: rbac.authorization.k8s.io/v1
+metadata:
+  name: blank-custom-resource-custom-metrics-auth-reader
+  namespace: default
+subjects:
+  - kind: ServiceAccount
+    name: mcad-controller-blank-custom-resource
+    namespace: default
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: Role
+  name: extension-apiserver-authentication-reader

controllers/testdata/mcad_test_results/case_1/service.yaml

@@ -0,0 +1,26 @@
+kind: Service
+apiVersion: v1
+metadata:
+  name: mcad-blank-custom-resource-metrics
+  namespace: default
+spec:
+  clusterIP: 172.31.181.101
+  ipFamilies:
+    - IPv4
+  ports:
+    - name: https
+      protocol: TCP
+      port: 443
+      targetPort: 6443
+    - name: http
+      protocol: TCP
+      port: 80
+      targetPort: 8080
+  internalTrafficPolicy: Cluster
+  clusterIPs:
+    - 172.31.181.101
+  type: ClusterIP
+  ipFamilyPolicy: SingleStack
+  sessionAffinity: None
+  selector:
+    app: mcad-blank-custom-resource

controllers/testdata/mcad_test_results/case_1/serviceaccount.yaml

@@ -0,0 +1,5 @@
+kind: ServiceAccount
+apiVersion: v1
+metadata:
+  name: mcad-controller-blank-custom-resource
+  namespace: default

controllers/testutil/utils.go

@@ -0,0 +1,145 @@
+package util
+
+import (
+	"fmt"
+	appsv1 "k8s.io/api/apps/v1"
+	corev1 "k8s.io/api/core/v1"
+	k8srbacv1 "k8s.io/api/rbac/v1"
+	"reflect"
+)
+
+func notEqualMsg(value string) {
+	print(fmt.Sprintf("%s are not equal.", value))
+}
+
+func ConfigMapsAreEqual(expected corev1.ConfigMap, actual corev1.ConfigMap) bool {
+	if expected.Name != actual.Name {
+		notEqualMsg("Configmap Names")
+		return false
+	}
+
+	if !reflect.DeepEqual(expected.Data, actual.Data) {
+		notEqualMsg("Configmap Data values")
+		return false
+	}
+	return true
+}
+
+func RoleBindingsAreEqual(rb1 k8srbacv1.RoleBinding, rb2 k8srbacv1.RoleBinding) bool {
+
+	if !reflect.DeepEqual(rb1.ObjectMeta.Labels, rb2.ObjectMeta.Labels) {
+		notEqualMsg("Rolebinding labels")
+		return false
+	}
+	if !reflect.DeepEqual(rb1.Subjects, rb2.Subjects) {
+		notEqualMsg("Rolebinding subjects")
+		return false
+	}
+	if !reflect.DeepEqual(rb1.RoleRef, rb2.RoleRef) {
+		notEqualMsg("Rolebinding role references")
+		return false
+	}
+	return true
+}
+
+func ServiceAccountsAreEqual(sa1 corev1.ServiceAccount, sa2 corev1.ServiceAccount) bool {
+	if !reflect.DeepEqual(sa1.ObjectMeta.Labels, sa2.ObjectMeta.Labels) {
+		notEqualMsg("ServiceAccount labels")
+		return false
+	}
+	if !reflect.DeepEqual(sa1.Name, sa2.Name) {
+		notEqualMsg("ServiceAccount names")
+		return false
+	}
+	if !reflect.DeepEqual(sa1.Namespace, sa2.Namespace) {
+		notEqualMsg("ServiceAccount namespaces")
+		return false
+	}
+	return true
+}
+
+func ServicesAreEqual(service1 corev1.Service, service2 corev1.Service) bool {
+	if !reflect.DeepEqual(service1.ObjectMeta.Labels, service2.ObjectMeta.Labels) {
+		notEqualMsg("Service labels")
+		return false
+	}
+	if !reflect.DeepEqual(service1.Name, service2.Name) {
+		notEqualMsg("Service Names")
+		return false
+	}
+	if !reflect.DeepEqual(service1.Namespace, service2.Namespace) {
+		notEqualMsg("Service namespaces")
+		return false
+	}
+	if !reflect.DeepEqual(service1.Spec.Selector, service2.Spec.Selector) {
+		notEqualMsg("Service Selectors")
+		return false
+	}
+	if !reflect.DeepEqual(service1.Spec.Ports, service2.Spec.Ports) {
+		notEqualMsg("Service Ports")
+		return false
+	}
+	return true
+}
+
+func DeploymentsAreEqual(dp1 appsv1.Deployment, dp2 appsv1.Deployment) bool {
+
+	if !reflect.DeepEqual(dp1.ObjectMeta.Labels, dp2.ObjectMeta.Labels) {
+		notEqualMsg("labels")
+		return false
+	}
+
+	if !reflect.DeepEqual(dp1.Spec.Selector, dp2.Spec.Selector) {
+		notEqualMsg("selector")
+		return false
+	}
+
+	if !reflect.DeepEqual(dp1.Spec.Template.ObjectMeta, dp2.Spec.Template.ObjectMeta) {
+		notEqualMsg("selector")
+		return false
+	}
+
+	if !reflect.DeepEqual(dp1.Spec.Template.Spec.Volumes, dp2.Spec.Template.Spec.Volumes) {
+		notEqualMsg("Volumes")
+		return false
+	}
+
+	if len(dp1.Spec.Template.Spec.Containers) != len(dp2.Spec.Template.Spec.Containers) {
+		notEqualMsg("Containers")
+		return false
+	}
+	for i := range dp1.Spec.Template.Spec.Containers {
+		c1 := dp1.Spec.Template.Spec.Containers[i]
+		c2 := dp2.Spec.Template.Spec.Containers[i]
+		if !reflect.DeepEqual(c1.Env, c2.Env) {
+			notEqualMsg("Container Env")
+			return false
+		}
+		if !reflect.DeepEqual(c1.Ports, c2.Ports) {
+			notEqualMsg("Container Ports")
+			return false
+		}
+		if !reflect.DeepEqual(c1.Resources, c2.Resources) {
+			notEqualMsg("Container Resources")
+			return false
+		}
+		if !reflect.DeepEqual(c1.VolumeMounts, c2.VolumeMounts) {
+			notEqualMsg("Container VolumeMounts")
+			return false
+		}
+		if !reflect.DeepEqual(c1.Args, c2.Args) {
+			notEqualMsg("Container Args")
+			return false
+		}
+		if c1.Name != c2.Name {
+			notEqualMsg("Container Name")
+			return false
+		}
+		if c1.Image != c2.Image {
+			notEqualMsg("Container Image")
+			return false
+		}
+	}
+
+	return true
+}