Merge pull request #5155 from jmgrimes/group-members-support

Added support for 'members' field of Group catalog model entity.

packages/catalog-model/src/kinds/GroupEntityV1alpha1.test.ts

@@ -39,6 +39,7 @@ describe('GroupV1alpha1Validator', () => {
         },
         parent: 'group-a',
         children: ['child-a', 'child-b'],
+        members: ['jdoe'],
       },
     };
   });
@@ -172,4 +173,26 @@ describe('GroupV1alpha1Validator', () => {
     (entity as any).spec.children = [];
     await expect(validator.check(entity)).resolves.toBe(true);
   });
+
+  // members
+
+  it('accepts missing members', async () => {
+    delete (entity as any).spec.members;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects empty members', async () => {
+    (entity as any).spec.members = [''];
+    await expect(validator.check(entity)).rejects.toThrow(/members/);
+  });
+
+  it('rejects undefined members', async () => {
+    (entity as any).spec.members = [undefined];
+    await expect(validator.check(entity)).rejects.toThrow(/members/);
+  });
+
+  it('accepts no members', async () => {
+    (entity as any).spec.members = [];
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
 });

packages/catalog-model/src/kinds/GroupEntityV1alpha1.ts

@@ -36,6 +36,7 @@ export interface GroupEntityV1alpha1 extends Entity {
     };
     parent?: string;
     children: string[];
+    members?: string[];
   };
 }
 

packages/catalog-model/src/schema/kinds/Group.v1alpha1.schema.json

@@ -86,6 +86,15 @@
                 "examples": ["backstage", "other"],
                 "minLength": 1
               }
+            },
+            "members": {
+              "type": "array",
+              "description": "The users that are members of this group. The entries of this array are entity references.",
+              "items": {
+                "type": "string",
+                "examples": ["jdoe"],
+                "minLength": 1
+              }
             }
           }
         }