Enhances group member remove. Closes pnp#4098

Author: nicodecleyre

docs/docs/cmd/spo/group/group-member-remove.md

@@ -20,36 +20,54 @@ m365 spo group member remove [options]
 : Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
 
 `--userName [userName]`
-: The UPN (user principal name, eg. [email protected]) of the user that needs to be removed. Specify either `userName`, `email`, or `userId`, but not multiple.
+: The UPN (user principal name, eg. [email protected]) of the user that needs to be removed. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
 
 `--email [email]`
-: The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
+: The email of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
 
 `--userId [userId]`
-: The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
+: The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--aadGroupId [aadGroupId]`
+: The object Id of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--aadGroupName [aadGroupName]`
+: The name of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Remove a user from a SharePoint group by userName.
+Remove a user from a SharePoint group based on the id on a given web
 
 ```sh
 m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "[email protected]"
 ```
 
-Remove a user from a SharePoint group by email.
+Remove a user from a SharePoint group based on the username on a given web
 
 ```sh
 m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "[email protected]"
 ```
 
-Remove a user from a SharePoint group by id.
+Remove a user from a SharePoint group by email.
 
 ```sh
 m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
 ```
 
+Remove an Azure AD group from a SharePoint group based on the Azure AD group name on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadGroupName "Azure AD Security Group"
+```
+
+Remove an Azure AD group from a SharePoint group based on the Azure AD group ID on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --aadGroupId "5786b8e8-c495-4734-b345-756733960730"
+```
+
 ## Response
 
 The command won't return a response on success.

src/m365/spo/commands/group/group-member-list.ts

@@ -10,7 +10,7 @@ interface CommandArgs {
   options: Options;
 }
 
-interface Options extends GlobalOptions {
+export interface Options extends GlobalOptions {
   webUrl: string;
   groupId?: number;
   groupName?: string;

src/m365/spo/commands/group/group-member-remove.spec.ts

@@ -11,6 +11,7 @@ import { formatting } from '../../../../utils/formatting';
 import { pid } from '../../../../utils/pid';
 import { sinonUtil } from '../../../../utils/sinonUtil';
 import commands from '../../commands';
+import * as SpoGroupMemberListCommand from './group-member-list';
 const command: Command = require('./group-member-remove');
 
 describe(commands.GROUP_MEMBER_REMOVE, () => {
@@ -25,6 +26,7 @@ describe(commands.GROUP_MEMBER_REMOVE, () => {
   const email = '[email protected]';
   const userId = 14;
 
+  const spoGroupMemberListCommandOutput = `[{ "Id": 13, "IsHiddenInUI": false, "LoginName": "c:0t.c|tenant|4b468129-3b44-4414-bd45-aa5bde29df2f", "Title": "Azure AD Security Group 2", "PrincipalType": 1, "Email": "", "Expiration": "", "IsEmailAuthenticationGuestUser": false, "IsShareByEmailGuestUser": false, "IsSiteAdmin": false, "UserId": null, "UserPrincipalName": null },{ "Id": 13, "IsHiddenInUI": false, "LoginName": "c:0t.c|tenant|3f10f4af-8704-4394-80c0-ee8cef5eae27", "Title": "Azure AD Security Group", "PrincipalType": 1, "Email": "", "Expiration": "", "IsEmailAuthenticationGuestUser": false, "IsShareByEmailGuestUser": false, "IsSiteAdmin": false, "UserId": null, "UserPrincipalName": null }, { "Id": 17, "IsHiddenInUI": false, "LoginName": "c:0o.c|federateddirectoryclaimprovider|5786b8e8-c495-4734-b345-756733960730", "Title": "Office 365 Group", "PrincipalType": 4, "Email": "[email protected]", "Expiration": "", "IsEmailAuthenticationGuestUser": false, "IsShareByEmailGuestUser": false, "IsSiteAdmin": false, "UserId": null, "UserPrincipalName": null }]`;
   const UserRemovalJSONResponse =
   {
     "odata.null": true
@@ -70,6 +72,7 @@ describe(commands.GROUP_MEMBER_REMOVE, () => {
 
   afterEach(() => {
     sinonUtil.restore([
+      request.get,
       request.post,
       Cli.prompt,
       Cli.executeCommandWithOutput
@@ -93,15 +96,143 @@ describe(commands.GROUP_MEMBER_REMOVE, () => {
     assert.notStrictEqual(command.description, null);
   });
 
-  it('fails validation if webURL is Invalid', async () => {
-    const actual = await command.validate({
+  it('Removes Azure AD group from SharePoint group using Azure AD Group Name', async () => {
+    sinonUtil.restore(Cli.prompt);
+    sinon.stub(Cli, 'prompt').callsFake(async () => (
+      { continue: true }
+    ));
+
+    sinon.stub(Cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
+      if (command === SpoGroupMemberListCommand) {
+        return ({
+          stdout: spoGroupMemberListCommandOutput
+        });
+      }
+
+      throw new CommandError('Unknown case');
+    });
+
+    const postStub = sinon.stub(request, 'post').callsFake(opts => {
+      if ((opts.url as string).indexOf('/_api/web/sitegroups/GetByName') > -1) {
+        return Promise.resolve(UserRemovalJSONResponse);
+      }
+
+      return Promise.reject(`Invalid request ${JSON.stringify(opts)}`);
+    });
+    await command.action(logger, {
       options: {
-        webUrl: "InvalidWEBURL",
-        groupId: groupId,
-        userName: userName
+        debug: true,
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupName: "Site A Visitors",
+        aadGroupName: "Azure AD Security Group"
       }
-    }, commandInfo);
-    assert.notStrictEqual(actual, true);
+    });
+    assert(postStub.called);
+  });
+
+  it('Removes Azure AD group from SharePoint group using Azure AD Group ID - Without Confirmation Prompt', async () => {
+    sinon.stub(Cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
+      if (command === SpoGroupMemberListCommand) {
+        return ({
+          stdout: spoGroupMemberListCommandOutput
+        });
+      }
+
+      throw new CommandError('Unknown case');
+    });
+
+    const postStub = sinon.stub(request, 'post').callsFake(opts => {
+      if ((opts.url as string).indexOf('/_api/web/sitegroups/GetByName') > -1) {
+        return Promise.resolve(UserRemovalJSONResponse);
+      }
+
+      return Promise.reject(`Invalid request ${JSON.stringify(opts)}`);
+    });
+    await command.action(logger, {
+      options: {
+        debug: true,
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupName: "Site A Visitors",
+        aadGroupId: "5786b8e8-c495-4734-b345-756733960730",
+        confirm: true
+      }
+    });
+    assert(postStub.called);
+  });
+
+  it('Removes Azure AD group from SharePoint group using Azure AD Group ID and SharePoint Group ID', async () => {
+    sinonUtil.restore(Cli.prompt);
+    sinon.stub(Cli, 'prompt').callsFake(async () => (
+      { continue: true }
+    ));
+
+    sinon.stub(Cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
+      if (command === SpoGroupMemberListCommand) {
+        return ({
+          stdout: spoGroupMemberListCommandOutput
+        });
+      }
+
+      throw new CommandError('Unknown case');
+    });
+
+    const postStub = sinon.stub(request, 'post').callsFake(opts => {
+      if ((opts.url as string).indexOf('/_api/web/sitegroups/GetById') > -1) {
+        return Promise.resolve(UserRemovalJSONResponse);
+      }
+
+      return Promise.reject(`Invalid request ${JSON.stringify(opts)}`);
+    });
+    await command.action(logger, {
+      options: {
+        debug: true,
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupId: 4,
+        aadGroupId: "4b468129-3b44-4414-bd45-aa5bde29df2f"
+      }
+    });
+    assert(postStub.called);
+  });
+
+  it('Throws error when Azure AD group not found', async () => {
+    sinon.stub(Cli, 'executeCommandWithOutput').callsFake(async (command): Promise<any> => {
+      if (command === SpoGroupMemberListCommand) {
+        return ({
+          stdout: spoGroupMemberListCommandOutput
+        });
+      }
+
+      throw new CommandError('Unknown case');
+    });
+
+    await assert.rejects(command.action(logger, {
+      options: {
+        debug: true,
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupName: "Site A Visitors",
+        aadGroupName: "Not existing group",
+        confirm: true
+      }
+    }), new CommandError('The Azure AD group Not existing group is not found in SharePoint group Site A Visitors'));
+  });
+
+  it('Removes user from SharePoint group using Group ID - Without Confirmation Prompt', async () => {
+    const postStub = sinon.stub(request, 'post').callsFake(opts => {
+      if ((opts.url as string).indexOf('/_api/web/sitegroups/GetById') > -1) {
+        return Promise.resolve(UserRemovalJSONResponse);
+      }
+
+      return Promise.reject(`Invalid request ${JSON.stringify(opts)}`);
+    });
+    await command.action(logger, {
+      options: {
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupId: 4,
+        userName: "[email protected]",
+        confirm: true
+      }
+    });
+    assert(postStub.called);
   });
 
   it('fails validation if the userName is not a valid UPN.', async () => {
@@ -440,4 +571,25 @@ describe(commands.GROUP_MEMBER_REMOVE, () => {
       }
     }), new CommandError('The user does not exist or is not unique.'));
   });
+
+  it('fails validation if webURL is Invalid', async () => {
+    const actual = await command.validate({ options: { webUrl: "InvalidWEBURL", groupId: 4, userName: "[email protected]" } }, commandInfo);
+    assert.notStrictEqual(actual, true);
+  });
+
+  it('fails validation if groupid and groupName is entered', async () => {
+    const actual = await command.validate({ options: { webUrl: "https://contoso.sharepoint.com/sites/SiteA", groupId: "4", groupName: "Site A Visitors", userName: "[email protected]" } }, commandInfo);
+    assert.notStrictEqual(actual, true);
+  });
+
+  it('fails validation if aadGroupId is not a valid guid.', async () => {
+    const actual = await command.validate({
+      options: {
+        webUrl: "https://contoso.sharepoint.com/sites/SiteA",
+        groupId: 3,
+        aadGroupId: 'Invalid GUID'
+      }
+    }, commandInfo);
+    assert.notStrictEqual(actual, true);
+  });
 });