Remove getters from ClusterBpfApplicationState and BpfApplicationState

API review: remove BpfApplicationState GetClientObject

Method GetClientObject is not used and removing it removes
the dependency on sigs.k8s.io/controller-runtime/pkg/client

Signed-off-by: Andreas Karis <[email protected]>

Author: andreaskaris

apis/v1alpha1/bpf_application_state_types.go

@@ -18,8 +18,6 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	metav1types "k8s.io/apimachinery/pkg/types"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 // +union
@@ -160,31 +158,3 @@ type BpfApplicationStateList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []BpfApplicationState `json:"items"`
 }
-
-func (an BpfApplicationState) GetName() string {
-	return an.Name
-}
-
-func (an BpfApplicationState) GetUID() metav1types.UID {
-	return an.UID
-}
-
-func (an BpfApplicationState) GetAnnotations() map[string]string {
-	return an.Annotations
-}
-
-func (an BpfApplicationState) GetLabels() map[string]string {
-	return an.Labels
-}
-
-func (an BpfApplicationState) GetConditions() []metav1.Condition {
-	return an.Status.Conditions
-}
-
-func (an BpfApplicationState) GetClientObject() client.Object {
-	return &an
-}
-
-func (anl BpfApplicationStateList) GetItems() []BpfApplicationState {
-	return anl.Items
-}

apis/v1alpha1/cluster_bpf_application_state_types.go

@@ -18,8 +18,6 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	metav1types "k8s.io/apimachinery/pkg/types"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 // +union
@@ -211,31 +209,3 @@ type ClusterBpfApplicationStateList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ClusterBpfApplicationState `json:"items"`
 }
-
-func (an ClusterBpfApplicationState) GetName() string {
-	return an.Name
-}
-
-func (an ClusterBpfApplicationState) GetUID() metav1types.UID {
-	return an.UID
-}
-
-func (an ClusterBpfApplicationState) GetAnnotations() map[string]string {
-	return an.Annotations
-}
-
-func (an ClusterBpfApplicationState) GetLabels() map[string]string {
-	return an.Labels
-}
-
-func (an ClusterBpfApplicationState) GetConditions() []metav1.Condition {
-	return an.Status.Conditions
-}
-
-func (an ClusterBpfApplicationState) GetClientObject() client.Object {
-	return &an
-}
-
-func (anl ClusterBpfApplicationStateList) GetItems() []ClusterBpfApplicationState {
-	return anl.Items
-}

cmd/bpfman-operator/main.go

@@ -162,7 +162,7 @@ func main() {
 		}
 	}
 
-	commonApp := bpfmanoperator.ReconcilerCommon[bpfmaniov1alpha1.ClusterBpfApplicationState, bpfmaniov1alpha1.ClusterBpfApplicationStateList]{
+	commonApp := bpfmanoperator.ReconcilerCommon{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}
@@ -171,7 +171,7 @@ func main() {
 		ReconcilerCommon: commonApp,
 	}
 
-	commonNsApp := bpfmanoperator.ReconcilerCommon[bpfmaniov1alpha1.BpfApplicationState, bpfmaniov1alpha1.BpfApplicationStateList]{
+	commonNsApp := bpfmanoperator.ReconcilerCommon{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}

controllers/bpfman-agent/cl_application_program.go

@@ -535,7 +535,7 @@ func (r *ClBpfApplicationReconciler) getBpfAppState(ctx context.Context) (*bpfma
 
 	opts := []client.ListOption{
 		client.MatchingLabels{
-			internal.BpfAppStateOwner: r.currentApp.GetName(),
+			internal.BpfAppStateOwner: r.currentApp.Name,
 			internal.K8sHostLabel:     r.NodeName,
 		},
 	}
@@ -566,7 +566,7 @@ func (r *ClBpfApplicationReconciler) initBpfAppState() error {
 			Name:       generateUniqueName(r.currentApp.Name),
 			Finalizers: []string{r.finalizer},
 			Labels: map[string]string{
-				internal.BpfAppStateOwner: r.currentApp.GetName(),
+				internal.BpfAppStateOwner: r.currentApp.Name,
 				internal.K8sHostLabel:     r.NodeName,
 			},
 		},

controllers/bpfman-agent/ns_application_program.go

@@ -478,7 +478,7 @@ func (r *NsBpfApplicationReconciler) getBpfAppState(ctx context.Context) (*bpfma
 
 	opts := []client.ListOption{
 		client.MatchingLabels{
-			internal.BpfAppStateOwner: r.currentApp.GetName(),
+			internal.BpfAppStateOwner: r.currentApp.Name,
 			internal.K8sHostLabel:     r.NodeName,
 		},
 	}
@@ -510,7 +510,7 @@ func (r *NsBpfApplicationReconciler) initBpfAppState() error {
 			Namespace:  r.currentApp.Namespace,
 			Finalizers: []string{r.finalizer},
 			Labels: map[string]string{
-				internal.BpfAppStateOwner: r.currentApp.GetName(),
+				internal.BpfAppStateOwner: r.currentApp.Name,
 				internal.K8sHostLabel:     r.NodeName,
 			},
 		},

controllers/bpfman-operator/cl_application_program_test.go

@@ -178,7 +178,7 @@ func appProgramReconcile(t *testing.T, multiCondition bool) {
 	// Create a fake client to mock API calls.
 	cl := fake.NewClientBuilder().WithStatusSubresource(app).WithRuntimeObjects(objs...).Build()
 
-	rc := ReconcilerCommon[bpfmaniov1alpha1.ClusterBpfApplicationState, bpfmaniov1alpha1.ClusterBpfApplicationStateList]{
+	rc := ReconcilerCommon{
 		Client: cl,
 		Scheme: s,
 	}

controllers/bpfman-operator/cl_application_programs.go

@@ -44,7 +44,7 @@ type BpfApplicationReconciler struct {
 }
 
 //lint:ignore U1000 Linter claims function unused, but generics confusing linter
-func (r *BpfApplicationReconciler) getRecCommon() *ReconcilerCommon[bpfmaniov1alpha1.ClusterBpfApplicationState, bpfmaniov1alpha1.ClusterBpfApplicationStateList] {
+func (r *BpfApplicationReconciler) getRecCommon() *ReconcilerCommon {
 	return &r.ClusterApplicationReconciler.ReconcilerCommon
 }
 

controllers/bpfman-operator/common.go

@@ -55,23 +55,23 @@ type BpfProgListOper[T any] interface {
 	GetItems() []T
 }
 
-type ReconcilerCommon[T BpfProgOper, TL BpfProgListOper[T]] struct {
+type ReconcilerCommon struct {
 	client.Client
 	Scheme *runtime.Scheme
 	Logger logr.Logger
 }
 
 // ApplicationReconciler defines a k8s reconciler which can program bpfman.
-type ApplicationReconciler[T BpfProgOper, TL BpfProgListOper[T]] interface {
+type ApplicationReconciler interface {
 	// BPF Cluster of Namespaced Reconciler
 	getAppStateList(ctx context.Context,
 		appName string,
 		appNamespace string,
-	) (*TL, error)
-	containsFinalizer(bpfApplication *T, finalizer string) bool
+	) (client.ObjectList, error)
+	containsFinalizer(bpfApplication client.Object, finalizer string) bool
 
 	// *Program Reconciler
-	getRecCommon() *ReconcilerCommon[T, TL]
+	getRecCommon() *ReconcilerCommon
 	updateStatus(ctx context.Context,
 		namespace string,
 		name string,
@@ -80,9 +80,23 @@ type ApplicationReconciler[T BpfProgOper, TL BpfProgListOper[T]] interface {
 	getFinalizer() string
 }
 
-func reconcileBpfApplication[T BpfProgOper, TL BpfProgListOper[T]](
+// ValidReconciler encompasses BpfApplicationReconciler and BpfNSApplicationReconciler.
+type ValidReconciler interface {
+	ValidReconcilerMethods
+	*BpfApplicationReconciler | *BpfNsApplicationReconciler
+}
+
+type ValidReconcilerMethods interface {
+	getRecCommon() *ReconcilerCommon
+	getAppStateList(ctx context.Context, appName string, appNamespace string) (client.ObjectList, error)
+	updateStatus(ctx context.Context, namespace string, name string, cond bpfmaniov1alpha1.BpfApplicationConditionType, message string) (ctrl.Result, error)
+	containsFinalizer(bpfApplication client.Object, finalizer string) bool
+	getFinalizer() string
+}
+
+func reconcileBpfApplication[T ValidReconciler](
 	ctx context.Context,
-	rec ApplicationReconciler[T, TL],
+	rec T,
 	app client.Object,
 ) (ctrl.Result, error) {
 	r := rec.getRecCommon()
@@ -103,6 +117,12 @@ func reconcileBpfApplication[T BpfProgOper, TL BpfProgListOper[T]](
 		r.Logger.Error(err, "failed to get freshPrograms for full reconcile")
 		return ctrl.Result{}, nil
 	}
+	var bpfAppStateList []client.Object
+	_ = meta.EachListItem(bpfAppStateObjs, func(obj runtime.Object) error {
+		appState := obj.(client.Object)
+		bpfAppStateList = append(bpfAppStateList, appState)
+		return nil
+	})
 
 	// List all nodes since a BpfApplicationState object will always be created for each
 	nodes := &corev1.NodeList{}
@@ -116,7 +136,7 @@ func reconcileBpfApplication[T BpfProgOper, TL BpfProgListOper[T]](
 	if app.GetDeletionTimestamp().IsZero() {
 		for _, node := range nodes.Items {
 			nodeFound := false
-			for _, appState := range (*bpfAppStateObjs).GetItems() {
+			for _, appState := range bpfAppStateList {
 				bpfProgramState := appState.GetLabels()[internal.K8sHostLabel]
 				if node.Name == bpfProgramState {
 					nodeFound = true
@@ -133,13 +153,15 @@ func reconcileBpfApplication[T BpfProgOper, TL BpfProgListOper[T]](
 	failedBpfApplications := []string{}
 	finalApplied := []string{}
 	// Make sure no BpfApplications had any issues in the loading or unloading process
-	for _, bpfAppState := range (*bpfAppStateObjs).GetItems() {
-
-		if rec.containsFinalizer(&bpfAppState, rec.getFinalizer()) {
+	for _, bpfAppState := range bpfAppStateList {
+		if rec.containsFinalizer(bpfAppState, rec.getFinalizer()) {
 			finalApplied = append(finalApplied, bpfAppState.GetName())
 		}
 
-		conditions := bpfAppState.GetConditions()
+		conditions, err := getBpfApplicationConditions(bpfAppState)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
 		if bpfmanHelpers.IsBpfAppStateConditionFailure(conditions) {
 			failedBpfApplications = append(failedBpfApplications, bpfAppState.GetName())
 		} else if bpfmanHelpers.IsBpfAppStateConditionPending(conditions) {
@@ -169,7 +191,18 @@ func reconcileBpfApplication[T BpfProgOper, TL BpfProgListOper[T]](
 	return rec.updateStatus(ctx, appNamespace, appName, bpfmaniov1alpha1.BpfAppCondSuccess, "")
 }
 
-func (r *ReconcilerCommon[T, TL]) removeFinalizer(ctx context.Context, bpfApp client.Object, finalizer string) (ctrl.Result, error) {
+func getBpfApplicationConditions(bpfAppState client.Object) ([]metav1.Condition, error) {
+	switch v := bpfAppState.(type) {
+	case *bpfmaniov1alpha1.ClusterBpfApplicationState:
+		return v.Status.Conditions, nil
+	case *bpfmaniov1alpha1.BpfApplicationState:
+		return v.Status.Conditions, nil
+	}
+	return nil, fmt.Errorf("this error should never be triggered as only " +
+		"*BpfApplicationReconciler | *BpfNsApplicationReconciler are valid types for rec")
+}
+
+func (r *ReconcilerCommon) removeFinalizer(ctx context.Context, bpfApp client.Object, finalizer string) (ctrl.Result, error) {
 	r.Logger.Info("Calling KubeAPI to delete Program Finalizer", "Type", bpfApp.GetObjectKind().GroupVersionKind().Kind, "Name", bpfApp.GetName())
 
 	if changed := controllerutil.RemoveFinalizer(bpfApp, finalizer); changed {
@@ -183,7 +216,7 @@ func (r *ReconcilerCommon[T, TL]) removeFinalizer(ctx context.Context, bpfApp cl
 	return ctrl.Result{}, nil
 }
 
-func (r *ReconcilerCommon[T, TL]) addFinalizer(ctx context.Context, app client.Object, finalizer string) (ctrl.Result, error) {
+func (r *ReconcilerCommon) addFinalizer(ctx context.Context, app client.Object, finalizer string) (ctrl.Result, error) {
 	controllerutil.AddFinalizer(app, finalizer)
 
 	r.Logger.Info("Calling KubeAPI to add Program Finalizer", "Type", app.GetObjectKind().GroupVersionKind().Kind, "Name", app.GetName())
@@ -196,7 +229,7 @@ func (r *ReconcilerCommon[T, TL]) addFinalizer(ctx context.Context, app client.O
 	return ctrl.Result{}, nil
 }
 
-func (r *ReconcilerCommon[T, TL]) updateCondition(
+func (r *ReconcilerCommon) updateCondition(
 	ctx context.Context,
 	obj client.Object,
 	conditions *[]metav1.Condition,

controllers/bpfman-operator/common_cluster.go

@@ -30,15 +30,15 @@ import (
 )
 
 type ClusterApplicationReconciler struct {
-	ReconcilerCommon[bpfmaniov1alpha1.ClusterBpfApplicationState, bpfmaniov1alpha1.ClusterBpfApplicationStateList]
+	ReconcilerCommon
 }
 
 //lint:ignore U1000 Linter claims function unused, but generics confusing linter
 func (r *ClusterApplicationReconciler) getAppStateList(
 	ctx context.Context,
 	appName string,
 	_appNamespace string,
-) (*bpfmaniov1alpha1.ClusterBpfApplicationStateList, error) {
+) (client.ObjectList, error) {
 
 	appStateList := &bpfmaniov1alpha1.ClusterBpfApplicationStateList{}
 
@@ -57,7 +57,7 @@ func (r *ClusterApplicationReconciler) getAppStateList(
 
 //lint:ignore U1000 Linter claims function unused, but generics confusing linter
 func (r *ClusterApplicationReconciler) containsFinalizer(
-	bpfAppState *bpfmaniov1alpha1.ClusterBpfApplicationState,
+	bpfAppState client.Object,
 	finalizer string,
 ) bool {
 	return controllerutil.ContainsFinalizer(bpfAppState, finalizer)

controllers/bpfman-operator/common_namespace.go

@@ -30,15 +30,15 @@ import (
 )
 
 type NamespaceApplicationReconciler struct {
-	ReconcilerCommon[bpfmaniov1alpha1.BpfApplicationState, bpfmaniov1alpha1.BpfApplicationStateList]
+	ReconcilerCommon
 }
 
 //lint:ignore U1000 Linter claims function unused, but generics confusing linter
 func (r *NamespaceApplicationReconciler) getAppStateList(
 	ctx context.Context,
 	appName string,
 	appNamespace string,
-) (*bpfmaniov1alpha1.BpfApplicationStateList, error) {
+) (client.ObjectList, error) {
 
 	appStateList := &bpfmaniov1alpha1.BpfApplicationStateList{}
 
@@ -58,7 +58,7 @@ func (r *NamespaceApplicationReconciler) getAppStateList(
 
 //lint:ignore U1000 Linter claims function unused, but generics confusing linter
 func (r *NamespaceApplicationReconciler) containsFinalizer(
-	bpfAppState *bpfmaniov1alpha1.BpfApplicationState,
+	bpfAppState client.Object,
 	finalizer string,
 ) bool {
 	return controllerutil.ContainsFinalizer(bpfAppState, finalizer)