refs 126149: create external-user-sync-service test file

apps/app/src/features/external-user-group/interfaces/external-user-group.ts

@@ -40,7 +40,7 @@ export type ExternalUserInfo = {
 
 // Data structure to express the tree structure of external groups, before converting to ExternalUserGroup model
 export interface ExternalUserGroupTreeNode {
-  id: string
+  id: string // external group id
   userInfos: ExternalUserInfo[]
   childGroupNodes: ExternalUserGroupTreeNode[]
   name: string

apps/app/src/features/external-user-group/server/service/external-user-group-sync-service.integ.ts

@@ -0,0 +1,105 @@
+import { mock } from 'vitest-mock-extended';
+
+import ExternalUserGroup from '~/features/external-user-group/server/models/external-user-group';
+import ExternalUserGroupRelation from '~/features/external-user-group/server/models/external-user-group-relation';
+import { configManager } from '~/server/service/config-manager';
+import { instanciate } from '~/server/service/external-account';
+import PassportService from '~/server/service/passport';
+
+import { ExternalGroupProviderType, ExternalUserGroupTreeNode } from '../../interfaces/external-user-group';
+
+import ExternalUserGroupSyncService from './external-user-group-sync-service';
+
+
+// dummy class to implement generateExternalUserGroupTrees which returns test data
+class TestExternalUserGroupSyncService extends ExternalUserGroupSyncService {
+
+  constructor() {
+    super(ExternalGroupProviderType.ldap, 'ldap');
+  }
+
+  async generateExternalUserGroupTrees(): Promise<ExternalUserGroupTreeNode[]> {
+    const childNode: ExternalUserGroupTreeNode = {
+      id: 'cn=childGroup,ou=groups,dc=example,dc=org',
+      userInfos: [{
+        id: 'childGroupUser',
+        username: 'childGroupUser',
+        name: 'Child Group User',
+        email: 'user@childgroup.com',
+      }],
+      childGroupNodes: [],
+      name: 'childGroup',
+      description: 'this is a child group',
+    };
+    const parentNode: ExternalUserGroupTreeNode = {
+      id: 'cn=parentGroup,ou=groups,dc=example,dc=org',
+      // name is undefined
+      userInfos: [{
+        id: 'parentGroupUser',
+        username: 'parentGroupUser',
+        email: 'user@parentgroup.com',
+      }],
+      childGroupNodes: [childNode],
+      name: 'parentGroup',
+      description: 'this is a parent group',
+    };
+    const grandParentNode: ExternalUserGroupTreeNode = {
+      id: 'cn=grandParentGroup,ou=groups,dc=example,dc=org',
+      // email is undefined
+      userInfos: [{
+        id: 'grandParentGroupUser',
+        username: 'grandParentGroupUser',
+        name: 'Grand Parent Group User',
+      }],
+      childGroupNodes: [parentNode],
+      name: 'grandParentGroup',
+      description: 'this is a grand parent group',
+    };
+
+    const rootNode: ExternalUserGroupTreeNode = {
+      id: 'cn=rootGroup,ou=groups,dc=example,dc=org',
+      userInfos: [{
+        id: 'rootGroupUser',
+        username: 'rootGroupUser',
+        name: 'Root Group User',
+        email: 'user@rootgroup.com',
+      }],
+      childGroupNodes: [],
+      name: 'rootGroup',
+      description: 'this is a root group',
+    };
+
+    return [grandParentNode, rootNode];
+  }
+
+}
+
+const testService = new TestExternalUserGroupSyncService();
+
+describe('ExternalUserGroupSyncService.syncExternalUserGroups', () => {
+  describe('When autoGenerateUserOnGroupSync is true', () => {
+    const configParams = {
+      'external-user-group:ldap:autoGenerateUserOnGroupSync': true,
+      'external-user-group:ldap:preserveDeletedGroups': false,
+    };
+
+    beforeAll(async() => {
+      const passportServiceMock = mock<PassportService>();
+      passportServiceMock.isSameUsernameTreatedAsIdenticalUser.mockReturnValue(true);
+      passportServiceMock.isSameEmailTreatedAsIdenticalUser.mockReturnValue(true);
+      instanciate(passportServiceMock);
+
+      await configManager.updateConfigsInTheSameNamespace('crowi', configParams, true);
+    });
+
+    it('syncs groups with new users', async() => {
+      await testService.syncExternalUserGroups();
+
+      const externalUserGroups = await ExternalUserGroup.find().sort('name');
+      console.log(await ExternalUserGroupRelation.find());
+      const relation = await ExternalUserGroupRelation.find({ relatedGroup: externalUserGroups[0]._id }).populate('relatedUser');
+      console.log(relation);
+      expect(externalUserGroups.length).toBe(4);
+    });
+  });
+});

apps/app/src/features/external-user-group/server/service/external-user-group-sync-service.ts

@@ -35,9 +35,9 @@ abstract class ExternalUserGroupSyncService {
     const syncNode = async(node: ExternalUserGroupTreeNode, parentId?: string) => {
       const externalUserGroup = await this.createUpdateExternalUserGroup(node, parentId);
       existingExternalUserGroupIds.push(externalUserGroup._id);
-      node.childGroupNodes.forEach((childNode) => {
-        syncNode(childNode, externalUserGroup._id);
-      });
+      await Promise.all(node.childGroupNodes.map((childNode) => {
+        return syncNode(childNode, externalUserGroup._id);
+      }));
     };
 
     await Promise.all(trees.map((root) => {

apps/app/src/server/models/external-account.ts

@@ -72,7 +72,6 @@ schema.statics.findOrRegister = function(
     nameToBeRegistered?: string,
     mailToBeRegistered?: string,
 ): Promise<IExternalAccountHasId> {
-//
   return this.findOne({ providerType, accountId })
     .then((account) => {
     // ExternalAccount is found