Merge pull request #452 from frobware/fix-nil-pointer-access-getBpfAppState

Fix SEGV (nil pointer access) in getBpfAppState logging functions

Author: dave-tucker

controllers/bpfman-agent/cl_application_program.go

@@ -547,8 +547,7 @@ func (r *ClBpfApplicationReconciler) getBpfAppState(ctx context.Context) (*bpfma
 
 	switch len(appProgramList.Items) {
 	case 1:
-		// We got exactly one BpfApplicationState, so update r.currentAppState
-		r.Logger.V(1).Info("Found BpfApplicationState", "Name", r.currentAppState.Name)
+		r.Logger.V(1).Info("Found BpfApplicationState", "Name", appProgramList.Items[0].Name)
 		return &appProgramList.Items[0], nil
 	case 0:
 		// No BpfApplicationState found, so return nil

controllers/bpfman-agent/cl_application_program_test.go

@@ -37,6 +37,55 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
+func TestClBpfApplicationReconcilerGetBpfAppState(t *testing.T) {
+	s := scheme.Scheme
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.ClusterBpfApplication{})
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.ClusterBpfApplicationState{})
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.ClusterBpfApplicationStateList{})
+
+	// Create a mock ClusterBpfApplicationState that will be
+	// found.
+	mockAppState := &bpfmaniov1alpha1.ClusterBpfApplicationState{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "test-app-state",
+			Labels: map[string]string{
+				internal.BpfAppStateOwner: "test-app",
+				internal.K8sHostLabel:     "test-node",
+			},
+		},
+	}
+
+	objs := []runtime.Object{mockAppState}
+	cl := fake.NewClientBuilder().WithRuntimeObjects(objs...).Build()
+	cli := agenttestutils.NewBpfmanClientFake()
+
+	rc := ReconcilerCommon{
+		Client:       cl,
+		Scheme:       s,
+		BpfmanClient: cli,
+		NodeName:     "test-node",
+	}
+
+	r := &ClBpfApplicationReconciler{
+		ReconcilerCommon: rc,
+	}
+
+	// Set currentApp (required for getBpfAppState).
+	r.currentApp = &bpfmaniov1alpha1.ClusterBpfApplication{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "test-app",
+		},
+	}
+
+	// Test getBpfAppState when currentAppState is nil.
+	ctx := context.Background()
+	result, err := r.getBpfAppState(ctx)
+
+	require.NoError(t, err)
+	require.NotNil(t, result)
+	require.Equal(t, "test-app-state", result.Name)
+}
+
 func TestClBpfApplicationControllerCreate(t *testing.T) {
 	var (
 		// global config

controllers/bpfman-agent/ns_application_program.go

@@ -490,8 +490,7 @@ func (r *NsBpfApplicationReconciler) getBpfAppState(ctx context.Context) (*bpfma
 
 	switch len(appProgramList.Items) {
 	case 1:
-		// We got exactly one BpfApplicationState, so update r.currentAppState
-		r.Logger.V(1).Info("Found BpfApplicationState", "Name", r.currentAppState.Name)
+		r.Logger.V(1).Info("Found BpfApplicationState", "Name", appProgramList.Items[0].Name)
 		return &appProgramList.Items[0], nil
 	case 0:
 		// No BpfApplicationState found, so return nil

controllers/bpfman-agent/ns_application_program_test.go

@@ -37,6 +37,55 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 )
 
+func TestNsBpfApplicationReconcilerGetBpfAppState(t *testing.T) {
+	s := scheme.Scheme
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.BpfApplication{})
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.BpfApplicationState{})
+	s.AddKnownTypes(bpfmaniov1alpha1.SchemeGroupVersion, &bpfmaniov1alpha1.BpfApplicationStateList{})
+
+	// Create a mock BpfApplicationState that will be found.
+	mockAppState := &bpfmaniov1alpha1.BpfApplicationState{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "test-app-state",
+			Namespace: "test-namespace",
+			Labels: map[string]string{
+				internal.BpfAppStateOwner: "test-app",
+				internal.K8sHostLabel:     "test-node",
+			},
+		},
+	}
+
+	objs := []runtime.Object{mockAppState}
+	cl := fake.NewClientBuilder().WithRuntimeObjects(objs...).Build()
+	cli := agenttestutils.NewBpfmanClientFake()
+
+	rc := ReconcilerCommon{
+		Client:       cl,
+		Scheme:       s,
+		BpfmanClient: cli,
+		NodeName:     "test-node",
+	}
+
+	r := &NsBpfApplicationReconciler{
+		ReconcilerCommon: rc,
+	}
+
+	// Set currentApp (required for getBpfAppState).
+	r.currentApp = &bpfmaniov1alpha1.BpfApplication{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "test-app",
+			Namespace: "test-namespace",
+		},
+	}
+
+	ctx := context.Background()
+	result, err := r.getBpfAppState(ctx)
+
+	require.NoError(t, err)
+	require.NotNil(t, result)
+	require.Equal(t, "test-app-state", result.Name)
+}
+
 func TestNsBpfApplicationControllerCreate(t *testing.T) {
 	var (
 		// global config