Adding index for mcio.users.principalIds (#1018)

* Adding index for mcio.users.principalIds

* Adding integration tests for filtering on the newly indexed field

Author: crobby

pkg/sqlcache/informer/listoption_indexer.go

@@ -384,6 +384,12 @@ func (l *ListOptionIndexer) addIndexFields(key string, obj any, tx db.TxClient)
 			args = append(args, fmt.Sprint(typedValue))
 		case []string:
 			args = append(args, strings.Join(typedValue, "|"))
+		case []interface{}:
+			var s []string
+			for _, v := range typedValue {
+				s = append(s, fmt.Sprint(v))
+			}
+			args = append(args, strings.Join(s, "|"))
 		default:
 			err2 := fmt.Errorf("field %v has a non-supported type value: %v", field, value)
 			return err2

pkg/stores/sqlproxy/proxy_store.go

@@ -192,6 +192,9 @@ var (
 		gvkKey("management.cattle.io", "v3", "RoleTemplate"): {
 			{"context"},
 		},
+		gvkKey("management.cattle.io", "v3", "User"): {
+			{"principalIds"},
+		},
 		gvkKey("networking.k8s.io", "v1", "Ingress"): {
 			{"spec", "rules", "host"},
 			{"spec", "ingressClassName"},

tests/integration/testdata/crds/management.cattle.io_users.yaml

@@ -0,0 +1,103 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.17.1
+  name: users.management.cattle.io
+spec:
+  group: management.cattle.io
+  names:
+    kind: User
+    listKind: UserList
+    plural: users
+    singular: user
+  scope: Cluster
+  versions:
+  - name: v3
+    schema:
+      openAPIV3Schema:
+        description: User represents a user in Rancher
+        properties:
+          apiVersion:
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+            type: string
+          description:
+            description: Description provides a brief summary about the user.
+            type: string
+          displayName:
+            description: DisplayName is the user friendly name shown in the UI.
+            type: string
+          enabled:
+            description: Enabled indicates whether the user account is active.
+            type: boolean
+          kind:
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+            type: string
+          me:
+            description: Deprecated. Only used by /v3 Rancher API.
+            type: boolean
+          metadata:
+            type: object
+          mustChangePassword:
+            description: |-
+              MustChangePassword is a flag that, if true, forces the user to change their
+              password upon their next login.
+            type: boolean
+          password:
+            description: Deprecated. Password are stored in secrets in the cattle-local-user-passwords
+              namespace.
+            type: string
+          principalIds:
+            description: |-
+              PrincipalIDs lists the authentication provider identities (e.g. GitHub, Keycloak or Active Directory)
+              that are associated with this user account.
+            items:
+              type: string
+            type: array
+          status:
+            description: Status contains the most recent observed state of the user.
+            properties:
+              conditions:
+                items:
+                  properties:
+                    lastTransitionTime:
+                      description: Last time the condition transitioned from one status
+                        to another.
+                      type: string
+                    lastUpdateTime:
+                      description: The last time this condition was updated.
+                      type: string
+                    message:
+                      description: Human-readable message indicating details about
+                        last transition
+                      type: string
+                    reason:
+                      description: The reason for the condition's last transition.
+                      type: string
+                    status:
+                      description: Status of the condition, one of True, False, Unknown.
+                      type: string
+                    type:
+                      description: Type of user condition.
+                      type: string
+                  required:
+                  - status
+                  - type
+                  type: object
+                type: array
+            type: object
+          username:
+            description: Username is the unique login identifier for the user.
+            type: string
+        type: object
+    served: true
+    storage: true

tests/integration/testdata/filtering/principalids.manifests.yaml

@@ -0,0 +1,22 @@
+apiVersion: management.cattle.io/v3
+kind: User
+metadata:
+  name: user-one
+principalIds:
+  - local://user-one-principal
+  - local://another-id-for-user1
+---
+apiVersion: management.cattle.io/v3
+kind: User
+metadata:
+  name: user-two
+principalIds:
+  - local://user-two-principal
+  - local://another-id-for-user2
+---
+apiVersion: management.cattle.io/v3
+kind: User
+metadata:
+  name: admin-user
+principalIds:
+  - local://admin-principal

tests/integration/testdata/filtering/principalids.test.yaml

@@ -0,0 +1,24 @@
+schemaID: management.cattle.io.users
+tests:
+  - description: "Filter by principalId: local://user-one-principal"
+    query: "filter=principalIds~local://user-one-principal"
+    expected:
+      - user-one
+  - description: "Filter by principalId: local://admin-principal"
+    query: "filter=principalIds~local://admin-principal"
+    expected:
+      - admin-user
+  - description: "Filter by principalId: local://another-id-for-user2"
+    query: "filter=principalIds~local://another-id-for-user2"
+    expected:
+      - user-two
+  - description: "Filter by non-existent principalId"
+    query: "filter=principalIds~local://non-existent-id"
+    expected: []
+  - description: "Filter by multiple principalIds (AND logic): local://user-one-principal AND local://another-id-for-user1"
+    query: "filter=principalIds~local://user-one-principal&filter=principalIds~local://another-id-for-user1"
+    expected:
+      - user-one
+  - description: "Filter by multiple principalIds (AND logic) for different users"
+    query: "filter=principalIds~local://user-one-principal&filter=principalIds~local://admin-principal"
+    expected: []