Merge pull request #1012 from jhadvig/OCPBUGS-58434

OCPBUGS-58434: Console-operator should report plugin services as relatedObjects

Author: openshift-merge-bot[bot]

pkg/console/starter/starter.go

@@ -67,6 +67,7 @@ import (
 
 	telemetry "github.com/openshift/console-operator/pkg/console/telemetry"
 
+	"github.com/go-test/deep"
 	consoleoperator "github.com/openshift/console-operator/pkg/console/operator"
 	"github.com/openshift/library-go/pkg/operator/loglevel"
 )
@@ -456,21 +457,41 @@ func RunOperator(ctx context.Context, controllerContext *controllercmd.Controlle
 	)
 
 	// Show all ConsolePlugin instances as related objects
+	// Show all namespaces that are used by ConsolePlugin Backend Service as related objects
+	// Show all namespaces that are used by Proxy Service configs as related objects
+	// Deduplicate related objects
 	clusterOperatorStatus.WithRelatedObjectsFunc(func() (bool, []configv1.ObjectReference) {
 		relatedObjects := []configv1.ObjectReference{}
 		consolePlugins, err := consoleClient.ConsoleV1().ConsolePlugins().List(ctx, metav1.ListOptions{})
 		if err != nil {
 			return false, nil
 		}
 		for _, plugin := range consolePlugins.Items {
-			relatadPlugin := configv1.ObjectReference{
+			relatedObjects = append(relatedObjects, configv1.ObjectReference{
 				Group:    "console.openshift.io",
 				Resource: "consoleplugins",
 				Name:     plugin.GetName(),
+			})
+			if plugin.Spec.Backend.Service != nil {
+				ns := plugin.Spec.Backend.Service.Namespace
+				relatedObjects = append(relatedObjects, configv1.ObjectReference{
+					Group:    corev1.GroupName,
+					Resource: "namespaces",
+					Name:     ns,
+				})
+			}
+			for _, proxy := range plugin.Spec.Proxy {
+				if proxy.Endpoint.Service != nil && proxy.Endpoint.Service.Namespace != "" {
+					relatedObjects = append(relatedObjects, configv1.ObjectReference{
+						Group:    corev1.GroupName,
+						Resource: "namespaces",
+						Name:     proxy.Endpoint.Service.Namespace,
+					})
+				}
 			}
-			relatedObjects = append(relatedObjects, relatadPlugin)
 		}
-		return true, relatedObjects
+
+		return true, deduplicateObjectReferences(relatedObjects)
 	})
 
 	// NOTE: be sure to uncomment the .Run() below if using this
@@ -661,3 +682,20 @@ func extractStaticPodOperatorStatus(obj *unstructured.Unstructured, fieldManager
 	}
 	return &ret.Status.OperatorStatusApplyConfiguration, nil
 }
+
+func deduplicateObjectReferences(objs []configv1.ObjectReference) []configv1.ObjectReference {
+	result := make([]configv1.ObjectReference, 0, len(objs))
+	for _, obj := range objs {
+		duplicate := false
+		for _, existing := range result {
+			if len(deep.Equal(obj, existing)) == 0 {
+				duplicate = true
+				break
+			}
+		}
+		if !duplicate {
+			result = append(result, obj)
+		}
+	}
+	return result
+}

pkg/console/starter/starter_test.go

@@ -0,0 +1,46 @@
+package starter
+
+import (
+	"reflect"
+	"testing"
+
+	configv1 "github.com/openshift/api/config/v1"
+)
+
+func TestDeduplicateObjectReferences(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    []configv1.ObjectReference
+		expected []configv1.ObjectReference
+	}{
+		{
+			name:     "no duplicates",
+			input:    []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1"}, {Group: "g2", Resource: "r2", Name: "n2"}},
+			expected: []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1"}, {Group: "g2", Resource: "r2", Name: "n2"}},
+		},
+		{
+			name:     "with duplicates",
+			input:    []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1"}, {Group: "g1", Resource: "r1", Name: "n1"}},
+			expected: []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1"}},
+		},
+		{
+			name:     "different namespace not duplicate",
+			input:    []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns1"}, {Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns2"}},
+			expected: []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns1"}, {Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns2"}},
+		},
+		{
+			name:     "all fields equal",
+			input:    []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns1"}, {Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns1"}},
+			expected: []configv1.ObjectReference{{Group: "g1", Resource: "r1", Name: "n1", Namespace: "ns1"}},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := deduplicateObjectReferences(tt.input)
+			if !reflect.DeepEqual(got, tt.expected) {
+				t.Errorf("deduplicateObjectReferences() = %v, want %v", got, tt.expected)
+			}
+		})
+	}
+}