Add access-control command mocked integration tests (#209)

* Added remaining mocked integration tests for 'access-control' commands.

* Added mocked integration tests for 'access-control member group' commands.

* Removed all references of ITP_TEST_USER_SAMEORG and ITP_TEST_USER_EXTERNAL from the project.

* Added missing copyright notice to a file.

Author: Nadegamra

.github/workflows/ci.yaml

@@ -96,8 +96,6 @@ 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_TEST_USER_SAMEORG: ${{ vars.ITP_TEST_USER_SAMEORG }}
-          ITP_TEST_USER_EXTERNAL: ${{ vars.ITP_TEST_USER_EXTERNAL }}
 
   test_native:
     name: Tests (Native Client)
@@ -130,8 +128,6 @@ jobs:
           ITP_NATIVE_TEST_CLIENT_ID: ${{ vars.ITP_NATIVE_TEST_CLIENT_ID }}
           ITP_TEST_USER_EMAIL: ${{ vars.ITP_TEST_USER_EMAIL }}
           ITP_TEST_USER_PASSWORD: ${{ secrets.ITP_TEST_USER_PASSWORD }}
-          ITP_TEST_USER_SAMEORG: ${{ vars.ITP_TEST_USER_SAMEORG }}
-          ITP_TEST_USER_EXTERNAL: ${{ vars.ITP_TEST_USER_EXTERNAL }}
   test_mocked:
     name: Tests (Mocked HTTP traffic)
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -51,10 +51,6 @@ ITP_NATIVE_TEST_CLIENT_ID=
 # Email and password of a test user. (Belonging to an organization is needed by some of the tests)
 ITP_TEST_USER_EMAIL=
 ITP_TEST_USER_PASSWORD=
-# Mailinator email address, that belongs to the same organization as ITP_TEST_USER_EMAIL
-ITP_TEST_USER_SAMEORG=
-# Mailinator email address, that does not belong to the same organization as ITP_TEST_USER_EMAIL
-ITP_TEST_USER_EXTERNAL=
 ```
 
 #### **Install Dependencies**

integration-tests/access-control/group.test.ts

@@ -10,7 +10,6 @@ import { runCommand } from "@oclif/test";
 
 import { Group } from "../../src/services/access-control/models/group";
 import { ResultResponse } from "../../src/services/general-models/result-response.js";
-import { ITP_TEST_USER_SAMEORG } from "../utils/environment";
 import runSuiteIfMainModule from "../utils/run-suite-if-main-module";
 
 const tests = () => {
@@ -51,17 +50,15 @@ const tests = () => {
 
     const updatedGroupName = "Updated Group Name";
     const updatedGroupDescription = "Updated Group Description";
-    const memberEmail = ITP_TEST_USER_SAMEORG;
 
     const { result: groupUpdate } = await runCommand<Group>(
-      `access-control group update --itwin-id ${iTwinId} --group-id ${groupCreate!.id} --name "${updatedGroupName}" --description "${updatedGroupDescription}" --member ${memberEmail}`,
+      `access-control group update --itwin-id ${iTwinId} --group-id ${groupCreate!.id} --name "${updatedGroupName}" --description "${updatedGroupDescription}"`,
     );
     expect(groupUpdate).to.not.be.undefined;
     expect(groupUpdate!.id).to.not.be.undefined;
     expect(groupUpdate!.name).to.be.equal(updatedGroupName);
     expect(groupUpdate!.description).to.be.equal(updatedGroupDescription);
     expect(groupUpdate!.members).to.not.be.undefined;
-    expect(groupUpdate!.members!.some((member) => member.email.toLowerCase() === memberEmail!.toLowerCase())).to.be.true;
   });
 
   it("Should list groups", async () => {

integration-tests/access-control/member/invitations.test.ts

@@ -11,7 +11,6 @@ import { runCommand } from "@oclif/test";
 import { Invitation } from "../../../src/services/access-control/models/invitations";
 import { OwnerMemberResponse } from "../../../src/services/access-control/models/owner-member";
 import { ResultResponse } from "../../../src/services/general-models/result-response.js";
-import { ITP_TEST_USER_EXTERNAL } from "../../utils/environment";
 import runSuiteIfMainModule from "../../utils/run-suite-if-main-module";
 
 const tests = () => {
@@ -30,17 +29,17 @@ const tests = () => {
   });
 
   it("Should get pending invitations", async () => {
-    const emailToAdd = ITP_TEST_USER_EXTERNAL;
+    const emailToAdd = "email@example.com";
     const { result: owner } = await runCommand<OwnerMemberResponse>(`access-control member owner add --itwin-id ${iTwinId} --email ${emailToAdd}`);
     expect(owner).to.not.be.undefined;
     expect(owner!.member).is.null;
     expect(owner!.invitation).to.not.be.null;
-    expect(owner!.invitation!.email.toLowerCase()).to.equal(emailToAdd!.toLowerCase());
+    expect(owner!.invitation!.email.toLowerCase()).to.equal(emailToAdd.toLowerCase());
 
     const { result: invitationResults } = await runCommand<Invitation[]>(`access-control member invitations --itwin-id ${iTwinId}`);
     expect(invitationResults).to.not.be.undefined;
     expect(invitationResults!.length).to.be.greaterThanOrEqual(1);
-    expect(invitationResults!.some((invitation) => invitation.email.toLowerCase() === emailToAdd!.toLowerCase())).to.be.true;
+    expect(invitationResults!.some((invitation) => invitation.email.toLowerCase() === emailToAdd.toLowerCase())).to.be.true;
   });
 };
 

integration-tests/utils/environment.ts

@@ -14,7 +14,5 @@ export const {
   ITP_SERVICE_CLIENT_ID,
   ITP_SERVICE_CLIENT_SECRET,
   ITP_TEST_USER_EMAIL,
-  ITP_TEST_USER_EXTERNAL,
   ITP_TEST_USER_PASSWORD,
-  ITP_TEST_USER_SAMEORG,
 } = process.env;

mocked-integration-tests/access-control/access-control.test.ts

@@ -4,11 +4,15 @@
  *--------------------------------------------------------------------------------------------*/
 
 import runSuiteIfMainModule from "../../integration-tests/utils/run-suite-if-main-module";
+import groupTests from "./group/group.test";
 import memberTests from "./member/member.test";
+import permissionsTests from "./permissions.test";
 
 const tests = () =>
   describe("access-control", () => {
+    groupTests();
     memberTests();
+    permissionsTests();
   });
 
 export default tests;

mocked-integration-tests/access-control/group/add.test.ts

@@ -0,0 +1,47 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+import { expect } from "chai";
+
+import { runCommand } from "@oclif/test";
+
+import runSuiteIfMainModule from "../../../integration-tests/utils/run-suite-if-main-module.js";
+import { Group } from "../../../src/services/access-control/models/group.js";
+import { AccessControlApiMock } from "../../utils/api-mocks/access-control-api/access-control-api-mock.js";
+
+const tests = () =>
+  describe("add", () => {
+    const iTwinId = crypto.randomUUID();
+
+    it("should create a group", async () => {
+      const groupName = "Test Group";
+      const groupDescription = "Test Group Description";
+
+      const response = AccessControlApiMock.groups.createiTwinGroup.success(iTwinId, groupName, groupDescription);
+
+      const { result: groupCreate } = await runCommand<Group>(
+        `access-control group create --itwin-id ${iTwinId} --name "${groupName}" --description "${groupDescription}"`,
+      );
+      expect(groupCreate).to.not.be.undefined;
+      expect(groupCreate).to.be.deep.equal(response.group);
+    });
+
+    it("should return an error, when provided iTwin is not found", async () => {
+      const groupName = "Test Group";
+      const groupDescription = "Test Group Description";
+
+      const response = AccessControlApiMock.groups.createiTwinGroup.iTwinNotFound(iTwinId, groupName, groupDescription);
+
+      const { error: createError } = await runCommand<Group>(
+        `access-control group create --itwin-id ${iTwinId} --name "${groupName}" --description "${groupDescription}"`,
+      );
+      expect(createError).to.not.be.undefined;
+      expect(createError?.message).to.be.equal(`HTTP error! ${JSON.stringify(response)}`);
+    });
+  });
+
+export default tests;
+
+runSuiteIfMainModule(import.meta, tests);

mocked-integration-tests/access-control/group/delete.test.ts

@@ -0,0 +1,45 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+import { expect } from "chai";
+
+import { runCommand } from "@oclif/test";
+
+import runSuiteIfMainModule from "../../../integration-tests/utils/run-suite-if-main-module.js";
+import { ResultResponse } from "../../../src/services/general-models/result-response.js";
+import { AccessControlApiMock } from "../../utils/api-mocks/access-control-api/access-control-api-mock.js";
+
+const tests = () =>
+  describe("delete", () => {
+    const iTwinId = crypto.randomUUID();
+    const groupId = crypto.randomUUID();
+
+    it("should delete group", async () => {
+      AccessControlApiMock.groups.deleteiTwinGroup.success(iTwinId, groupId);
+
+      const { result: deleteResult } = await runCommand<ResultResponse>(`access-control group delete --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteResult).to.have.property("result", "deleted");
+    });
+
+    it("should return an error when iTwin is not found", async () => {
+      const response = AccessControlApiMock.groups.deleteiTwinGroup.iTwinNotFound(iTwinId, groupId);
+
+      const { error: deleteError } = await runCommand<ResultResponse>(`access-control group delete --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteError).to.not.be.undefined;
+      expect(deleteError?.message).to.be.equal(`HTTP error! ${JSON.stringify(response)}`);
+    });
+
+    it("should return an error when group is not found", async () => {
+      const response = AccessControlApiMock.groups.deleteiTwinGroup.groupNotFound(iTwinId, groupId);
+
+      const { error: deleteError } = await runCommand<ResultResponse>(`access-control group delete --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteError).to.not.be.undefined;
+      expect(deleteError?.message).to.be.equal(`HTTP error! ${JSON.stringify(response)}`);
+    });
+  });
+
+export default tests;
+
+runSuiteIfMainModule(import.meta, tests);

mocked-integration-tests/access-control/group/group.test.ts

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+import runSuiteIfMainModule from "../../../integration-tests/utils/run-suite-if-main-module";
+import addTests from "./add.test";
+import deleteTests from "./delete.test";
+import infoTests from "./info.test";
+import listTests from "./list.test";
+import updateTests from "./update.test";
+
+const tests = () =>
+  describe("group", () => {
+    addTests();
+    deleteTests();
+    infoTests();
+    listTests();
+    updateTests();
+  });
+
+export default tests;
+
+runSuiteIfMainModule(import.meta, tests);

mocked-integration-tests/access-control/group/info.test.ts

@@ -0,0 +1,46 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+import { expect } from "chai";
+
+import { runCommand } from "@oclif/test";
+
+import runSuiteIfMainModule from "../../../integration-tests/utils/run-suite-if-main-module.js";
+import { ResultResponse } from "../../../src/services/general-models/result-response.js";
+import { AccessControlApiMock } from "../../utils/api-mocks/access-control-api/access-control-api-mock.js";
+
+const tests = () =>
+  describe("info", () => {
+    const iTwinId = crypto.randomUUID();
+    const groupId = crypto.randomUUID();
+
+    it("should get group", async () => {
+      const response = AccessControlApiMock.groups.getiTwinGroup.success(iTwinId, groupId);
+
+      const { result: deleteResult } = await runCommand<ResultResponse>(`access-control group info --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteResult).to.not.be.undefined;
+      expect(deleteResult).to.be.deep.equal(response.group);
+    });
+
+    it("should return an error when iTwin is not found", async () => {
+      const response = AccessControlApiMock.groups.getiTwinGroup.iTwinNotFound(iTwinId, groupId);
+
+      const { error: deleteError } = await runCommand<ResultResponse>(`access-control group info --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteError).to.not.be.undefined;
+      expect(deleteError?.message).to.be.equal(`HTTP error! ${JSON.stringify(response)}`);
+    });
+
+    it("should return an error when group is not found", async () => {
+      const response = AccessControlApiMock.groups.getiTwinGroup.groupNotFound(iTwinId, groupId);
+
+      const { error: deleteError } = await runCommand<ResultResponse>(`access-control group info --itwin-id ${iTwinId} --group-id ${groupId}`);
+      expect(deleteError).to.not.be.undefined;
+      expect(deleteError?.message).to.be.equal(`HTTP error! ${JSON.stringify(response)}`);
+    });
+  });
+
+export default tests;
+
+runSuiteIfMainModule(import.meta, tests);