Include capabilities in CSIAddonsNode status

This patch adds support to display advertised capabilities in the status field of CSIAddonsNode Closes: csi-addons#376 Signed-off-by: Niraj Yadav <niryadav@redhat.com>
black-dragon74 · Aug 6, 2024 · 0038360 · 0038360
1 parent dd4b168
commit 0038360
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 1 deletion.
diff --git a/api/csiaddons/v1alpha1/csiaddonsnode_types.go b/api/csiaddons/v1alpha1/csiaddonsnode_types.go
@@ -74,6 +74,9 @@ type CSIAddonsNodeStatus struct {
 	// for machine parsing and tidy display in the CLI.
 	// +optional
 	Reason string `json:"reason,omitempty"`
+
+	// A list of capabilities advertised by the sidecar
+	Capabilities []string `json:"capabilities,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/csiaddons/v1alpha1/zz_generated.deepcopy.go b/api/csiaddons/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/csiaddons.openshift.io_csiaddonsnodes.yaml b/config/crd/bases/csiaddons.openshift.io_csiaddonsnodes.yaml
@@ -94,6 +94,11 @@ spec:
           status:
             description: CSIAddonsNodeStatus defines the observed state of CSIAddonsNode
             properties:
+              capabilities:
+                description: A list of capabilities advertised by the sidecar
+                items:
+                  type: string
+                type: array
               message:
                 description: |-
                   Message is a human-readable message indicating details about why the CSIAddonsNode

diff --git a/deploy/controller/crds.yaml b/deploy/controller/crds.yaml
@@ -93,6 +93,11 @@ spec:
           status:
             description: CSIAddonsNodeStatus defines the observed state of CSIAddonsNode
             properties:
+              capabilities:
+                description: A list of capabilities advertised by the sidecar
+                items:
+                  type: string
+                type: array
               message:
                 description: |-
                   Message is a human-readable message indicating details about why the CSIAddonsNode

diff --git a/internal/controller/csiaddons/csiaddonsnode_controller.go b/internal/controller/csiaddons/csiaddonsnode_controller.go
@@ -27,6 +27,7 @@ import (
 	csiaddonsv1alpha1 "github.com/csi-addons/kubernetes-csi-addons/api/csiaddons/v1alpha1"
 	"github.com/csi-addons/kubernetes-csi-addons/internal/connection"
 	"github.com/csi-addons/kubernetes-csi-addons/internal/util"
+	"github.com/csi-addons/spec/lib/go/identity"
 
 	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
@@ -142,6 +143,7 @@ func (r *CSIAddonsNodeReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 
 	csiAddonsNode.Status.State = csiaddonsv1alpha1.CSIAddonsNodeStateConnected
 	csiAddonsNode.Status.Message = "Successfully established connection with sidecar"
+	csiAddonsNode.Status.Capabilities = parseCapabilities(newConn.Capabilities)
 	err = r.Client.Status().Update(ctx, csiAddonsNode)
 	if err != nil {
 		logger.Error(err, "Failed to update status")
@@ -271,3 +273,21 @@ func validateCSIAddonsNodeSpec(csiaddonsnode *csiaddonsv1alpha1.CSIAddonsNode) e
 
 	return nil
 }
+
+// parseCapabilities returns a list of capabilities in the format
+// capability.Type
+func parseCapabilities(caps []*identity.Capability) []string {
+	if len(caps) == 0 {
+		return []string{}
+	}
+
+	capabilities := make([]string, 0, len(caps))
+
+	for _, cap := range caps {
+		capStr := strings.ReplaceAll(cap.String(), ":{type:", ".")
+		capStr = strings.ReplaceAll(capStr, "}", "")
+		capabilities = append(capabilities, capStr)
+	}
+
+	return capabilities
+}
diff --git a/internal/controller/csiaddons/csiaddonsnode_controller_test.go b/internal/controller/csiaddons/csiaddonsnode_controller_test.go
@@ -20,6 +20,8 @@ import (
 	"errors"
 	"testing"
 
+	"github.com/csi-addons/spec/lib/go/identity"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -42,3 +44,77 @@ func TestParseEndpoint(t *testing.T) {
 	_, _, _, err = parseEndpoint("pod://pod.ns.cluster.local:5678")
 	assert.Error(t, err)
 }
+
+func TestParseCapabilities(t *testing.T) {
+	tests := []struct {
+		name     string
+		caps     []*identity.Capability
+		expected []string
+	}{
+		{
+			name:     "Empty capabilities",
+			caps:     []*identity.Capability{},
+			expected: []string{},
+		},
+		{
+			name: "Single capability",
+			caps: []*identity.Capability{
+				{
+					Type: &identity.Capability_Service_{
+						Service: &identity.Capability_Service{
+							Type: identity.Capability_Service_NODE_SERVICE,
+						},
+					},
+				},
+			},
+			expected: []string{"service.NODE_SERVICE"},
+		},
+		{
+			name: "Multiple capabilities",
+			caps: []*identity.Capability{
+				{
+					Type: &identity.Capability_Service_{
+						Service: &identity.Capability_Service{
+							Type: identity.Capability_Service_NODE_SERVICE,
+						},
+					},
+				},
+				{
+					Type: &identity.Capability_ReclaimSpace_{
+						ReclaimSpace: &identity.Capability_ReclaimSpace{
+							Type: identity.Capability_ReclaimSpace_ONLINE,
+						},
+					},
+				},
+			},
+			expected: []string{"service.NODE_SERVICE", "reclaim_space.ONLINE"},
+		},
+		{
+			name: "Same capability with different types",
+			caps: []*identity.Capability{
+				{
+					Type: &identity.Capability_ReclaimSpace_{
+						ReclaimSpace: &identity.Capability_ReclaimSpace{
+							Type: identity.Capability_ReclaimSpace_ONLINE,
+						},
+					},
+				},
+				{
+					Type: &identity.Capability_ReclaimSpace_{
+						ReclaimSpace: &identity.Capability_ReclaimSpace{
+							Type: identity.Capability_ReclaimSpace_OFFLINE,
+						},
+					},
+				},
+			},
+			expected: []string{"reclaim_space.ONLINE", "reclaim_space.OFFLINE"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := parseCapabilities(tt.caps)
+			assert.Equal(t, tt.expected, result)
+		})
+	}
+}