Avoid nil pointer panics with clusterProfileCreds (#8071)

Author: mszadkow

pkg/controller/admissionchecks/multikueue/controllers.go

@@ -124,7 +124,7 @@ func SetupControllers(mgr ctrl.Manager, namespace string, opts ...SetupOption) e
 		return err
 	}
 
-	var cpCreds *credentials.CredentialsProvider
+	var cpCreds clusterProfileCreds
 	if features.Enabled(features.MultiKueueClusterProfile) && options.clusterProfileConfig != nil {
 		p := make([]credentials.Provider, 0, len(options.clusterProfileConfig.CredentialsProviders))
 		for _, provider := range options.clusterProfileConfig.CredentialsProviders {
@@ -135,6 +135,9 @@ func SetupControllers(mgr ctrl.Manager, namespace string, opts ...SetupOption) e
 		}
 		cpCreds = credentials.New(p)
 	}
+	if cpCreds == nil {
+		cpCreds = &NoOpClusterProfileCreds{}
+	}
 
 	cRec := newClustersReconciler(mgr.GetClient(), namespace, options.gcInterval, options.origin, fsWatcher, options.adapters, cpCreds)
 	err = cRec.setupWithManager(mgr)

pkg/controller/admissionchecks/multikueue/multikueuecluster.go

@@ -46,6 +46,7 @@ import (
 	"k8s.io/klog/v2"
 	"k8s.io/utils/ptr"
 	inventoryv1alpha1 "sigs.k8s.io/cluster-inventory-api/apis/v1alpha1"
+	"sigs.k8s.io/cluster-inventory-api/pkg/credentials"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/event"
@@ -358,6 +359,15 @@ type clusterProfileCreds interface {
 	BuildConfigFromCP(clusterprofile *inventoryv1alpha1.ClusterProfile) (*rest.Config, error)
 }
 
+type NoOpClusterProfileCreds struct{}
+
+func (NoOpClusterProfileCreds) BuildConfigFromCP(clusterprofile *inventoryv1alpha1.ClusterProfile) (*rest.Config, error) {
+	return nil, errors.New("no credentials provider configured")
+}
+
+var _ clusterProfileCreds = (*credentials.CredentialsProvider)(nil)
+var _ clusterProfileCreds = (*NoOpClusterProfileCreds)(nil)
+
 var _ manager.Runnable = (*clustersReconciler)(nil)
 var _ reconcile.Reconciler = (*clustersReconciler)(nil)
 

pkg/util/testing/v1beta2/wrappers.go

@@ -28,6 +28,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
+	inventoryv1alpha1 "sigs.k8s.io/cluster-inventory-api/apis/v1alpha1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	kueue "sigs.k8s.io/kueue/apis/kueue/v1beta2"
@@ -1561,3 +1562,35 @@ func (prc *ProvisioningRequestConfigWrapper) Clone() *ProvisioningRequestConfigW
 func (prc *ProvisioningRequestConfigWrapper) Obj() *kueue.ProvisioningRequestConfig {
 	return &prc.ProvisioningRequestConfig
 }
+
+type ClusterProfileWrapper struct {
+	inventoryv1alpha1.ClusterProfile
+}
+
+func MakeClusterProfile(name, ns string) *ClusterProfileWrapper {
+	return &ClusterProfileWrapper{
+		ClusterProfile: inventoryv1alpha1.ClusterProfile{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      name,
+				Namespace: ns,
+			},
+			Spec: inventoryv1alpha1.ClusterProfileSpec{},
+		},
+	}
+}
+
+func (cpw *ClusterProfileWrapper) Obj() *inventoryv1alpha1.ClusterProfile {
+	return &cpw.ClusterProfile
+}
+
+func (cpw *ClusterProfileWrapper) DisplayName(displayName string) *ClusterProfileWrapper {
+	cpw.Spec.DisplayName = displayName
+	return cpw
+}
+
+func (cpw *ClusterProfileWrapper) ClusterManager(clusterManagerName string) *ClusterProfileWrapper {
+	cpw.Spec.ClusterManager = inventoryv1alpha1.ClusterManager{
+		Name: clusterManagerName,
+	}
+	return cpw
+}

test/integration/framework/framework.go

@@ -40,6 +40,7 @@ import (
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 	"k8s.io/utils/ptr"
+	inventoryv1alpha1 "sigs.k8s.io/cluster-inventory-api/apis/v1alpha1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	crconfig "sigs.k8s.io/controller-runtime/pkg/config"
@@ -158,6 +159,9 @@ func (f *Framework) SetupClient(cfg *rest.Config) (context.Context, client.WithW
 	err = resourcev1.AddToScheme(f.scheme)
 	gomega.ExpectWithOffset(1, err).NotTo(gomega.HaveOccurred())
 
+	err = inventoryv1alpha1.AddToScheme(f.scheme)
+	gomega.ExpectWithOffset(1, err).NotTo(gomega.HaveOccurred())
+
 	k8sClient, err := client.NewWithWatch(cfg, client.Options{Scheme: f.scheme})
 	gomega.ExpectWithOffset(1, err).NotTo(gomega.HaveOccurred())
 	gomega.ExpectWithOffset(1, k8sClient).NotTo(gomega.BeNil())

test/integration/multikueue/setup_test.go

@@ -809,4 +809,33 @@ var _ = ginkgo.Describe("MultiKueue", ginkgo.Label("area:multikueue", "feature:m
 			})
 		})
 	})
+
+	ginkgo.It("Should report no cluster providers configured", func() {
+		features.SetFeatureGateDuringTest(ginkgo.GinkgoTB(), features.MultiKueueClusterProfile, true)
+
+		ginkgo.By("Create ClusterProfile", func() {
+			clusterProfile := utiltestingapi.MakeClusterProfile("test-profile", config.DefaultNamespace).Obj()
+			gomega.Expect(managerTestCluster.client.Create(managerTestCluster.ctx, clusterProfile)).To(gomega.Succeed())
+		})
+
+		var workerCluster3 *kueue.MultiKueueCluster
+		ginkgo.By("Create a MultiKueueCluster with ClusterProfile as ClusterSource", func() {
+			workerCluster3 = utiltestingapi.MakeMultiKueueCluster("worker3").ClusterProfile("test-profile").Obj()
+			gomega.Expect(managerTestCluster.client.Create(managerTestCluster.ctx, workerCluster3)).To(gomega.Succeed())
+		})
+
+		workerCluster3Key := client.ObjectKeyFromObject(workerCluster3)
+		ginkgo.By("Verify status of the MultiKueueCluster", func() {
+			mkc := &kueue.MultiKueueCluster{}
+			gomega.Eventually(func(g gomega.Gomega) {
+				g.Expect(managerTestCluster.client.Get(managerTestCluster.ctx, workerCluster3Key, mkc)).To(gomega.Succeed())
+				g.Expect(mkc.Status.Conditions).To(gomega.ContainElement(gomega.BeComparableTo(metav1.Condition{
+					Type:    kueue.MultiKueueClusterActive,
+					Status:  metav1.ConditionFalse,
+					Reason:  "BadClusterProfile",
+					Message: "load client config failed: no credentials provider configured",
+				}, util.IgnoreConditionTimestampsAndObservedGeneration)))
+			}, util.Timeout, util.Interval).Should(gomega.Succeed())
+		})
+	})
 })

test/integration/multikueue/suite_test.go

@@ -110,6 +110,7 @@ func createCluster(setupFnc framework.ManagerSetup, apiFeatureGates ...string) c
 			util.AppWrapperCrds,
 			util.KfTrainerCrds,
 			util.AutoscalerCrds,
+			util.ClusterProfileCrds,
 		},
 		APIServerFeatureGates: apiFeatureGates,
 	}