Enhance groups endpoint (kubeflow#1206)

Signed-off-by: lucferbux <[email protected]>

Author: lucferbux

clients/ui/api/openapi/mod-arch.yaml

@@ -300,6 +300,35 @@ paths:
       description: Deletes an existing Role Binding associated with Model Registries.
     parameters: # Add parameters at the path level
       - $ref: '#/components/parameters/roleBindingName' # Ensure this path parameter is defined
+  /api/v1/settings/groups:
+    summary: Path used to get available groups.
+    description: >-
+      The REST endpoint/path used to get a list of all available OpenShift/Kubernetes groups in the cluster.
+    get:
+      tags:
+        - K8SOperation
+      parameters:
+        - $ref: "#/components/parameters/kubeflowUserId"
+        - $ref: "#/components/parameters/namespace"
+      responses:
+        "200":
+          description: 'Ok'
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/Group"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+      operationId: getGroups
+      summary: Get Available Groups
+      description: Returns available OpenShift/Kubernetes groups in the cluster.
   /api/v1/model_registry/{modelRegistryName}/model_versions/{modelversionId}:
     summary: Path used to manage a single ModelVersion.
     description: >-
@@ -1469,6 +1498,56 @@ components:
             -----BEGIN CERTIFICATE-----
             MIID...
             -----END CERTIFICATE-----
+    Group:
+      description: OpenShift/Kubernetes Group object
+      type: object
+      required:
+        - metadata
+        - users
+      properties:
+        apiVersion:
+          type: string
+          example: "user.openshift.io/v1"
+        kind:
+          type: string
+          example: "Group"
+        metadata:
+          type: object
+          required:
+            - name
+          properties:
+            name:
+              type: string
+              example: "dora-group"
+            namespace:
+              type: string
+              nullable: true
+            annotations:
+              type: object
+              additionalProperties:
+                type: string
+              nullable: true
+            labels:
+              type: object
+              additionalProperties:
+                type: string
+              nullable: true
+            creationTimestamp:
+              type: string
+              format: date-time
+              nullable: true
+              example: "2023-01-15T10:30:00Z"
+            resourceVersion:
+              type: string
+              nullable: true
+            uid:
+              type: string
+              nullable: true
+        users:
+          type: array
+          items:
+            type: string
+          example: ["[email protected]", "[email protected]"]
   responses:
     NotFound:
       content:
@@ -1887,6 +1966,13 @@ components:
         type: string
       in: path
       required: true
+    namespace:
+      name: namespace
+      description: The namespace to filter resources by.
+      schema:
+        type: string
+      in: query
+      required: false
   securitySchemes:
     Bearer:
       scheme: bearer

clients/ui/bff/internal/api/model_registry_settings_groups_handler.go

@@ -10,7 +10,7 @@ import (
 	"github.com/kubeflow/model-registry/ui/bff/internal/models"
 )
 
-type GroupsEnvelope Envelope[[]models.GroupModel, None]
+type GroupsEnvelope Envelope[[]models.Group, None]
 
 // STUB IMPLEMENTATION (see kubernetes clients for more details)
 func (app *App) GetGroupsHandler(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {

clients/ui/bff/internal/api/model_registry_settings_groups_handler_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/kubeflow/model-registry/ui/bff/internal/config"
 	"github.com/kubeflow/model-registry/ui/bff/internal/constants"
 	"github.com/kubeflow/model-registry/ui/bff/internal/integrations/kubernetes"
-	"github.com/kubeflow/model-registry/ui/bff/internal/models"
 	"github.com/kubeflow/model-registry/ui/bff/internal/repositories"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -51,13 +50,18 @@ var _ = Describe("TestGroupsHandler", func() {
 			err = json.Unmarshal(body, &actual)
 			Expect(err).NotTo(HaveOccurred())
 
-			expected := []models.GroupModel{
-				{Name: "dora-group-mock"},
-				{Name: "bella-group-mock"},
-			}
-
 			Expect(rr.Code).To(Equal(http.StatusOK))
-			Expect(actual.Data).To(ConsistOf(expected))
+			Expect(actual.Data).To(HaveLen(2))
+
+			// Verify first group
+			firstGroup := actual.Data[0]
+			Expect(firstGroup.Metadata.Name).To(Equal("dora-group-mock"))
+			Expect(firstGroup.Users).To(ConsistOf("[email protected]", "[email protected]"))
+
+			// Verify second group
+			secondGroup := actual.Data[1]
+			Expect(secondGroup.Metadata.Name).To(Equal("bella-group-mock"))
+			Expect(secondGroup.Users).To(ConsistOf("[email protected]", "[email protected]"))
 		})
 	})
 })

clients/ui/bff/internal/models/groups.go

@@ -1,9 +1,48 @@
 package models
 
+import "time"
+
+// K8sObjectMeta represents the metadata of a Kubernetes object
+type K8sObjectMeta struct {
+	Name              string            `json:"name"`
+	Namespace         *string           `json:"namespace,omitempty"`
+	Annotations       map[string]string `json:"annotations,omitempty"`
+	Labels            map[string]string `json:"labels,omitempty"`
+	CreationTimestamp *time.Time        `json:"creationTimestamp,omitempty"`
+	ResourceVersion   *string           `json:"resourceVersion,omitempty"`
+	UID               *string           `json:"uid,omitempty"`
+}
+
+// Group represents an OpenShift/Kubernetes Group object
+type Group struct {
+	APIVersion *string       `json:"apiVersion,omitempty"`
+	Kind       *string       `json:"kind,omitempty"`
+	Metadata   K8sObjectMeta `json:"metadata"`
+	Users      []string      `json:"users"`
+}
+
+// Legacy GroupModel for backward compatibility (if needed)
 type GroupModel struct {
 	Name string `json:"name"`
 }
 
+// NewGroup creates a new Group with the specified name and users
+func NewGroup(name string, users []string) Group {
+	apiVersion := "user.openshift.io/v1"
+	kind := "Group"
+	now := time.Now()
+
+	return Group{
+		APIVersion: &apiVersion,
+		Kind:       &kind,
+		Metadata: K8sObjectMeta{
+			Name:              name,
+			CreationTimestamp: &now,
+		},
+		Users: users,
+	}
+}
+
 func NewGroupModel(name string) GroupModel {
 	return GroupModel{
 		Name: name,

clients/ui/bff/internal/repositories/model_registry_settings.go

@@ -15,15 +15,26 @@ func NewModelRegistrySettingsRepository() *ModelRegistrySettingsRepository {
 	return &ModelRegistrySettingsRepository{}
 }
 
-func (r *ModelRegistrySettingsRepository) GetGroups(ctx context.Context, client k8s.KubernetesClientInterface) ([]models.GroupModel, error) {
+func (r *ModelRegistrySettingsRepository) GetGroups(ctx context.Context, client k8s.KubernetesClientInterface) ([]models.Group, error) {
 	groupNames, err := client.GetGroups(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("error fetching groups: %w", err)
 	}
 
-	var groups []models.GroupModel
+	var groups []models.Group
 	for _, name := range groupNames {
-		groups = append(groups, models.NewGroupModel(name))
+		// Create mock users for each group to make the data more realistic
+		var users []string
+		switch name {
+		case "dora-group-mock":
+			users = []string{"[email protected]", "[email protected]"}
+		case "bella-group-mock":
+			users = []string{"[email protected]", "[email protected]"}
+		default:
+			users = []string{fmt.Sprintf("%[email protected]", name)}
+		}
+
+		groups = append(groups, models.NewGroup(name, users))
 	}
 
 	return groups, nil

clients/ui/bff/internal/repositories/model_registry_settings_test.go

@@ -23,11 +23,22 @@ var _ = Describe("TestModelRegistrySettingsRepository", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 			By("verifying the returned group models")
-			expected := []models.GroupModel{
-				{Name: "dora-group-mock"},
-				{Name: "bella-group-mock"},
-			}
-			Expect(groups).To(ConsistOf(expected))
+			Expect(groups).To(HaveLen(2))
+
+			// Verify first group
+			firstGroup := groups[0]
+			Expect(firstGroup.Metadata.Name).To(Equal("dora-group-mock"))
+			Expect(firstGroup.Users).To(ConsistOf("[email protected]", "[email protected]"))
+			Expect(*firstGroup.APIVersion).To(Equal("user.openshift.io/v1"))
+			Expect(*firstGroup.Kind).To(Equal("Group"))
+			Expect(firstGroup).To(BeAssignableToTypeOf(models.Group{}))
+
+			// Verify second group
+			secondGroup := groups[1]
+			Expect(secondGroup.Metadata.Name).To(Equal("bella-group-mock"))
+			Expect(secondGroup.Users).To(ConsistOf("[email protected]", "[email protected]"))
+			Expect(*secondGroup.APIVersion).To(Equal("user.openshift.io/v1"))
+			Expect(*secondGroup.Kind).To(Equal("Group"))
 		})
 	})
 })