Added missing integration tests for access-control commmands. (#101)

* Added missing integration tests for access-control commmands.

* Updated @oclif to fix 1 high severity vulnerability.

Author: Nadegamra

.github/workflows/ci.yaml

@@ -49,4 +49,5 @@ jobs:
           ITP_ISSUER_URL: ${{ vars.ITP_ISSUER_URL }}
           ITP_SERVICE_CLIENT_ID: ${{ vars.ITP_SERVICE_CLIENT_ID }}
           ITP_SERVICE_CLIENT_SECRET: ${{ secrets.ITP_SERVICE_CLIENT_SECRET }}
+          ITP_MAILINATOR_API_KEY: ${{ secrets.ITP_MAILINATOR_API_KEY }}
         run: npm run test

.vscode/launch.json

@@ -42,7 +42,7 @@
                 "--forbid-only",
                 "--timeout",
                 "999999",
-                "integration-tests/**/api.test.ts"
+                "integration-tests/**/*.test.ts"
             ],
             "console": "integratedTerminal",
             "internalConsoleOptions": "neverOpen"

integration-tests/access-control/member/owner.ts

@@ -10,12 +10,13 @@ import { expect } from "chai";
 import { groupMember } from "../../../src/services/access-control-client/models/group-members";
 import { ownerResponse } from "../../../src/services/access-control-client/models/owner";
 import { User } from "../../../src/services/user-client/models/user";
+import { fetchEmailsAndGetInvitationLink } from "../../utils/helpers";
 
 const tests = () => {
     let iTwinId: string;
+    const iTwinName: string = `cli-itwin-integration-test-${new Date().toISOString()}`;
 
     before(async () => {
-        const iTwinName = `cli-itwin-integration-test-${new Date().toISOString()}`;
         const iTwin = await runCommand<ITwin>(`itwin create --class Thing --sub-class Asset --name ${iTwinName}`);
         expect(iTwin.result?.id).is.not.undefined;
         iTwinId = iTwin.result!.id!;
@@ -26,13 +27,27 @@ const tests = () => {
         expect(result.stdout).to.contain('deleted');
     });
 
-    it('Should add new owner to an iTwin', async () => {
-        const emailToAdd = 'itwin.cli.qa-testaccount@be-mailinator.eastus.cloudapp.azure.com';
-        const owner = await runCommand<ownerResponse>(`access-control member owner add -i ${iTwinId} --email ${emailToAdd}`);
-        expect(owner.result).is.not.undefined;
-        expect(owner.result!.member).is.null;
-        expect(owner.result!.invitation).is.not.undefined;
-        expect(owner.result!.invitation.email).to.equal(emailToAdd);
+    it('Should invite an external member to an iTwin, accept invitation and remove owner member', async () => {
+        const emailToAdd = 'iTwin.CLI.QA.IntegrationTest@bentley.m8r.co';
+        const invitedOwner = await runCommand<ownerResponse>(`access-control member owner add -i ${iTwinId} --email ${emailToAdd}`);
+        expect(invitedOwner.result).is.not.undefined;
+        expect(invitedOwner.result!.member).is.null;
+        expect(invitedOwner.result!.invitation).is.not.undefined;
+        expect(invitedOwner.result!.invitation.email.toLowerCase()).to.equal(emailToAdd.toLowerCase());
+
+        const invitationLink = await fetchEmailsAndGetInvitationLink(emailToAdd.split('@')[0], iTwinName);
+
+        await fetch(invitationLink);
+
+        const usersInfo = await runCommand<groupMember[]>(`access-control member owner list --itwin-id ${iTwinId}`);
+        expect(usersInfo.result).is.not.undefined;
+        expect(usersInfo.result!.length).to.be.equal(2);
+        const joinedUser = usersInfo.result?.filter(user => user.email.toLowerCase() === emailToAdd.toLowerCase())[0];
+        expect(joinedUser).to.not.be.undefined;
+
+        const deletionResult = await runCommand<{result: string}>(`access-control member owner delete --itwin-id ${iTwinId} --member-id ${joinedUser?.id}`);
+        expect(deletionResult.result).to.not.be.undefined;
+        expect(deletionResult.result!.result).to.be.equal("deleted");
     });
 
     it('Should list owners of an iTwin', async () => {

integration-tests/access-control/member/user.ts

@@ -7,15 +7,16 @@ import { ITwin } from "@itwin/itwins-client";
 import { runCommand } from "@oclif/test";
 import { expect } from "chai";
 
-import { member } from "../../../src/services/access-control-client/models/members";
+import { member, membersResponse } from "../../../src/services/access-control-client/models/members";
 import { Role } from "../../../src/services/access-control-client/models/role";
 import { User } from "../../../src/services/user-client/models/user";
+import { fetchEmailsAndGetInvitationLink } from "../../utils/helpers";
 
 const tests = () => {
     let iTwinId: string;
+    const iTwinName: string = `cli-itwin-integration-test-${new Date().toISOString()}`;
 
     before(async () => {
-        const iTwinName = `cli-itwin-integration-test-${new Date().toISOString()}`;
         const iTwin = await runCommand<ITwin>(`itwin create --class Thing --sub-class Asset --name ${iTwinName}`);
         expect(iTwin.result?.id).is.not.undefined;
         iTwinId = iTwin.result!.id!;
@@ -26,7 +27,39 @@ const tests = () => {
         expect(result.stdout).to.contain('deleted');
     });
 
-    it('Should dispaly owner info of an iTwin in member info', async () => {
+    it('Should invite an external member to an iTwin, accept sent invitation and remove user member', async () => {
+        const newRole = await runCommand<Role>(`access-control role create -i ${iTwinId} -n "Test Role 1" -d "Test Role Description"`);
+        expect(newRole.result).is.not.undefined;
+        expect(newRole.result!.id).is.not.undefined;
+        
+        const emailToAdd = 'iTwin.CLI.QA.IntegrationTest@bentley.m8r.co';
+
+        const invitedUser = await runCommand<membersResponse>(`access-control member user add --itwin-id ${iTwinId} --members "[{"email": "${emailToAdd}", "roleIds": ["${newRole.result!.id}"]}]"`);
+
+        expect(invitedUser.result).to.not.be.undefined;
+        expect(invitedUser.result!.invitations.length).to.be.equal(1);
+        expect(invitedUser.result!.invitations[0].email.toLowerCase()).to.be.equal(emailToAdd.toLowerCase());
+        expect(invitedUser.result!.invitations[0].roles.length).to.be.equal(1);
+        expect(invitedUser.result!.invitations[0].roles[0].id).to.be.equal(newRole.result!.id);
+
+        const invitationLink = await fetchEmailsAndGetInvitationLink(emailToAdd.split('@')[0], iTwinName);
+
+        await fetch(invitationLink);
+
+        const usersInfo = await runCommand<member[]>(`access-control member user list --itwin-id ${iTwinId}`);
+        expect(usersInfo.result).is.not.undefined;
+        expect(usersInfo.result!.length).to.be.equal(2);
+        const joinedUser = usersInfo.result?.filter(user => user.email.toLowerCase() === emailToAdd.toLowerCase())[0];
+        expect(joinedUser).to.not.be.undefined;
+        expect(joinedUser?.roles.length).to.be.equal(1);
+        expect(joinedUser?.roles[0].id).to.be.equal(newRole.result!.id);
+
+        const deletionResult = await runCommand<{result: string}>(`access-control member user delete --itwin-id ${iTwinId} --member-id ${joinedUser?.id}`);
+        expect(deletionResult.result).to.not.be.undefined;
+        expect(deletionResult.result!.result).to.be.equal("deleted");
+    });
+
+    it('Should display owner info of an iTwin in member info', async () => {
         const userInfo = await runCommand<User>(`user me`);
         expect(userInfo.result).is.not.undefined;
 
@@ -37,7 +70,7 @@ const tests = () => {
     });
 
     it('Should add new member to an iTwin and update the role', async () => {
-        const newRole = await runCommand<Role>(`access-control role create -i ${iTwinId} -n "Test Role" -d "Test Role Description"`);
+        const newRole = await runCommand<Role>(`access-control role create -i ${iTwinId} -n "Test Role 2" -d "Test Role Description"`);
         expect(newRole.result).is.not.undefined;
         expect(newRole.result!.id).is.not.undefined;
 

integration-tests/utils/helpers.ts

@@ -7,6 +7,7 @@ import { IModel } from "@itwin/imodels-client-management"
 import { ITwin } from "@itwin/itwins-client";
 import { runCommand } from "@oclif/test";
 import { expect } from "chai";
+import { GetInboxRequest, GetMessageRequest, MailinatorClient } from 'mailinator-client'
 
 import { fileTyped } from "../../src/services/storage-client/models/file-typed.js";
 import { fileUpload } from "../../src/services/storage-client/models/file-upload.js";
@@ -100,7 +101,43 @@ export async function deleteIModel(id: string): Promise<void> {
 export async function getRootFolderId(iTwinId: string): Promise<string> {
     const { result: topFolders } = await runCommand<itemsWithFolderLink>(`storage root-folder --itwin-id ${iTwinId}`);
     const rootFolderId = topFolders?._links?.folder?.href?.split('/').pop();
-
     expect(rootFolderId).to.not.be.undefined;
     return rootFolderId as string;
+}
+
+/**
+ * Fetches emails from the specified inbox and then finds and returns the invitation link for iTwinName iTwin.
+ * NOTE: This function only works for `@bentley.m8r.co` email addresses and not `@be-mailinator.eastus.cloudapp.azure.com` email addresses.
+ * @param inbox Inbox to fetch the invitation email from.
+ * @param iTwinName Name of the iTwin.
+ * @returns Invitation link for joining the iTwin.
+ */
+export async function fetchEmailsAndGetInvitationLink(inbox: string, iTwinName: string): Promise<string> {
+    await new Promise<void>(resolve => {setTimeout(_ => resolve(), 30 * 1000);});
+
+    expect(process.env.ITP_MAILINATOR_API_KEY).to.not.be.undefined;
+
+    const client = new MailinatorClient(process.env.ITP_MAILINATOR_API_KEY!);
+    const inboxResponse = await client.request(new GetInboxRequest("private", inbox, undefined, 10));
+    expect(inboxResponse.result).to.not.be.null;
+
+    for (let i = 0; i < inboxResponse.result!.msgs.length; i++) {
+        if (inboxResponse.result!.msgs[i].subject !== "You have been invited to collaborate")
+            continue;
+        
+        // eslint-disable-next-line no-await-in-loop
+        const messageResponse = await client.request(new GetMessageRequest("private", inboxResponse.result!.msgs[0].id ));
+        expect(messageResponse.result).to.not.be.null;
+        const messageBody = messageResponse.result!.parts[0].body;
+        if (!messageBody.includes(iTwinName))
+            continue;
+
+        const invitationTokenRegex = /href=".*?invitationToken.*?"/;
+        const matches = messageBody.match(invitationTokenRegex);
+        expect(matches).to.not.be.null;
+        expect(matches!.length).to.be.equal(1);
+        return matches![0].slice("href=\"".length, -1);
+    }
+
+    throw new Error("Email was not found in inbox.")
 }