Bugfix: "User Profile" attributes not available for Users Attribute s…

…earch, when admin user does not have view- or manage-realm realm-management role Closes keycloak#27536 Signed-off-by: Daniel Fesenmeyer <[email protected]>
bosch-io · Jul 30, 2024 · 34f2969 · 34f2969
1 parent 1fe5082
commit 34f2969
Show file tree

Hide file tree

Showing 17 changed files with 459 additions and 78 deletions.
diff --git a/js/apps/admin-ui/cypress/e2e/users_attribute_search_test.spec.ts b/js/apps/admin-ui/cypress/e2e/users_attribute_search_test.spec.ts
@@ -0,0 +1,100 @@
+import SidebarPage from "../support/pages/admin-ui/SidebarPage";
+import LoginPage from "../support/pages/LoginPage";
+import { keycloakBefore } from "../support/util/keycloak_hooks";
+import adminClient from "../support/util/AdminClient";
+import {
+  DefaultUserAttribute,
+  UserFilterType,
+} from "../support/pages/admin-ui/manage/users/UsersListingPage";
+import UsersPage from "../support/pages/admin-ui/manage/users/UsersPage";
+
+describe("Query by user attributes", () => {
+  const loginPage = new LoginPage();
+  const sidebarPage = new SidebarPage();
+  const usersPage = new UsersPage();
+  const listingPage = usersPage.listing();
+
+  const emailSuffix = "@example.org";
+
+  const user1Username = "user-attrs-1";
+  const user1FirstName = "John";
+  const user1LastName = "Doe";
+  const user1Pwd = "pwd";
+  const user2Username = "user-attrs-2";
+  const user2FirstName = "Jane";
+  const user2LastName = user1LastName;
+
+  before(async () => {
+    await cleanupTestData();
+    const user1 = await adminClient.createUser({
+      username: user1Username,
+      credentials: [
+        {
+          type: "password",
+          value: user1Pwd,
+        },
+      ],
+      email: user1Username + emailSuffix,
+      firstName: user1FirstName,
+      lastName: user1LastName,
+      enabled: true,
+    });
+    const user1Id = user1.id!;
+    await adminClient.addClientRoleToUser(user1Id, "master-realm", [
+      "view-users",
+    ]);
+
+    await adminClient.createUser({
+      username: user2Username,
+      email: user2Username + emailSuffix,
+      firstName: user2FirstName,
+      lastName: user2LastName,
+      enabled: true,
+    });
+  });
+
+  beforeEach(() => {
+    loginPage.logIn(user1Username, user1Pwd);
+    keycloakBefore();
+    sidebarPage.goToUsers();
+  });
+
+  after(async () => {
+    await cleanupTestData();
+  });
+
+  async function cleanupTestData() {
+    await adminClient.deleteUser(user1Username, true);
+    await adminClient.deleteUser(user2Username, true);
+  }
+
+  it("Query with one attribute condition", () => {
+    listingPage
+      .selectUserSearchFilter(UserFilterType.AttributeSearch)
+      .openUserAttributesSearchForm()
+      .addUserAttributeSearchCriteria(
+        DefaultUserAttribute.lastName,
+        user1LastName,
+      )
+      .triggerAttributesSearch()
+      .itemExist(user1Username, true)
+      .itemExist(user2Username, true);
+  });
+
+  it("Query with two attribute conditions", () => {
+    listingPage
+      .selectUserSearchFilter(UserFilterType.AttributeSearch)
+      .openUserAttributesSearchForm()
+      .addUserAttributeSearchCriteria(
+        DefaultUserAttribute.lastName,
+        user1LastName,
+      )
+      .addUserAttributeSearchCriteria(
+        DefaultUserAttribute.firstName,
+        user1FirstName,
+      )
+      .triggerAttributesSearch()
+      .itemExist(user1Username, true)
+      .itemExist(user2Username, false);
+  });
+});
diff --git a/js/apps/admin-ui/cypress/support/pages/admin-ui/ListingPage.ts b/js/apps/admin-ui/cypress/support/pages/admin-ui/ListingPage.ts
@@ -52,7 +52,6 @@ export default class ListingPage extends CommonElements {
   public tableRowItem = "tbody tr[data-ouia-component-type]:visible";
   #table = "table[aria-label]";
   #filterSessionDropdownButton = ".pf-v5-c-select button:nth-child(1)";
-  #searchTypeButton = "[data-testid='clientScopeSearch']";
   #filterDropdownButton = "[data-testid='clientScopeSearchType']";
   #protocolFilterDropdownButton = "[data-testid='clientScopeSearchProtocol']";
   #kebabMenu = "[data-testid='kebab']";
@@ -321,8 +320,12 @@ export default class ListingPage extends CommonElements {
   }
 
   selectFilter(filter: Filter) {
-    cy.get(this.#searchTypeButton).click();
-    cy.get(this.#dropdownItem).contains(filter).click();
+    return this.selectFilter("clientScopeSearch", filter);
+  }
+
+  protected selectFilter(searchTypeButtonTestId: string, filterStr: string) {
+    cy.get(`[data-testid='${searchTypeButtonTestId}']`).click();
+    cy.get(this.#dropdownItem).contains(filterStr).click();
 
     return this;
   }

diff --git a/js/apps/admin-ui/cypress/support/pages/admin-ui/components/PageObject.ts b/js/apps/admin-ui/cypress/support/pages/admin-ui/components/PageObject.ts
@@ -8,13 +8,14 @@ export default class PageObject {
   #selectMenuToggleBtn = ".pf-v5-c-menu-toggle";
   #switchInput = ".pf-v5-c-switch__input";
   #formLabel = ".pf-v5-c-form__label";
-  #chipGroup = ".pf-v5-c-chip-group";
   #chipGroupCloseBtn = ".pf-v5-c-chip-group__close";
   #chipItem = ".pf-v5-c-chip-group__list-item";
   #emptyStateDiv = ".pf-v5-c-empty-state:visible";
   #toolbarActionsButton = ".pf-v5-c-toolbar button[aria-label='Actions']";
   #breadcrumbItem = ".pf-v5-c-breadcrumb .pf-v5-c-breadcrumb__item";
 
+  genericChipGroupSelector = ".pf-v5-c-chip-group";
+
   protected assertExist(element: Cypress.Chainable<JQuery>, exist: boolean) {
     element.should((!exist ? "not." : "") + "exist");
     return this;
@@ -281,41 +282,55 @@ export default class PageObject {
     return this;
   }
 
-  #getChipGroup(groupName: string) {
-    return cy.get(this.#chipGroup).contains(groupName).parent().parent();
+  #getChipGroup(groupSelector: string, groupName: string) {
+    return cy.get(groupSelector).contains(groupName).parent().parent();
   }
 
-  #getChipItem(itemName: string) {
-    return cy.get(this.#chipItem).contains(itemName).parent();
+  #getChipGroupWithLabel(groupSelector: string, label: string) {
+    cy.get(groupSelector)
+      .parent()
+      .find(".pf-v5-c-chip-group__label")
+      .contains(label);
+
+    return cy.get(groupSelector);
   }
 
-  #getChipGroupItem(groupName: string, itemName: string) {
-    return this.#getChipGroup(groupName)
+  #getChipGroupItem(
+    groupSelector: string,
+    groupName: string,
+    itemName: string,
+  ) {
+    return this.#getChipGroup(groupSelector, groupName)
       .find(this.#chipItem)
       .contains(itemName)
       .parent();
   }
 
-  protected removeChipGroup(groupName: string) {
-    this.#getChipGroup(groupName)
+  protected removeChipGroup(groupSelector: string, groupName: string) {
+    this.#getChipGroup(groupSelector, groupName)
       .find(this.#chipGroupCloseBtn)
       .find("button")
       .click();
     return this;
   }
 
-  protected removeChipItem(itemName: string) {
-    this.#getChipItem(itemName).find("button").click();
-    return this;
-  }
-
-  protected removeChipGroupItem(groupName: string, itemName: string) {
-    this.#getChipGroupItem(groupName, itemName).find("button").click();
+  protected removeChipGroupItem(
+    groupSelector: string,
+    groupName: string,
+    itemName: string,
+  ) {
+    this.#getChipGroupItem(groupSelector, groupName, itemName)
+      .find("button")
+      .click();
     return this;
   }
 
-  protected assertChipGroupExist(groupName: string, exist: boolean) {
-    this.assertExist(cy.contains(this.#chipGroup, groupName), exist);
+  protected assertChipGroupExist(
+    groupSelector: string,
+    groupName: string,
+    exist: boolean,
+  ) {
+    this.assertExist(cy.contains(groupSelector, groupName), exist);
     return this;
   }
 
@@ -325,20 +340,33 @@ export default class PageObject {
     return this;
   }
 
-  protected assertChipItemExist(itemName: string, exist: boolean) {
-    cy.get(this.#chipItem).within(() => {
-      cy.contains(itemName).should((exist ? "" : "not.") + "exist");
-    });
+  protected assertChipGroupItemExist(
+    groupSelector: string,
+    groupName: string,
+    itemName: string,
+    exist: boolean,
+  ) {
+    this.assertExist(
+      this.#getChipGroup(groupSelector, groupName).contains(
+        this.#chipItem,
+        itemName,
+      ),
+      exist,
+    );
     return this;
   }
 
-  protected assertChipGroupItemExist(
-    groupName: string,
+  protected assertLabeledChipGroupItemExist(
+    groupSelector: string,
+    labelName: string,
     itemName: string,
     exist: boolean,
   ) {
     this.assertExist(
-      this.#getChipGroup(groupName).contains(this.#chipItem, itemName),
+      this.#getChipGroupWithLabel(groupSelector, labelName).contains(
+        this.#chipItem,
+        itemName,
+      ),
       exist,
     );
     return this;

diff --git a/js/apps/admin-ui/cypress/support/pages/admin-ui/manage/events/tabs/AdminEventsTab.ts b/js/apps/admin-ui/cypress/support/pages/admin-ui/manage/events/tabs/AdminEventsTab.ts
@@ -200,12 +200,16 @@ export default class AdminEventsTab extends PageObject {
   }
 
   public removeResourcePathChipGroup() {
-    super.removeChipGroup(AdminEventsTabSearchFormFieldsLabel.ResourcePath);
+    super.removeChipGroup(
+      this.genericChipGroupSelector,
+      AdminEventsTabSearchFormFieldsLabel.ResourcePath,
+    );
     return this;
   }
 
   public assertResourceTypesChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.ResourceTypes,
       exist,
     );
@@ -214,6 +218,7 @@ export default class AdminEventsTab extends PageObject {
 
   public assertOperationTypesChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.OperationTypes,
       exist,
     );
@@ -222,6 +227,7 @@ export default class AdminEventsTab extends PageObject {
 
   public assertResourcePathChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.ResourcePath,
       exist,
     );
@@ -233,6 +239,7 @@ export default class AdminEventsTab extends PageObject {
     exist: boolean,
   ) {
     super.assertChipGroupItemExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.ResourcePath,
       itemName,
       exist,
@@ -242,6 +249,7 @@ export default class AdminEventsTab extends PageObject {
 
   public assertRealmChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.Realm,
       exist,
     );
@@ -250,19 +258,25 @@ export default class AdminEventsTab extends PageObject {
 
   public assertClientChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.Client,
       exist,
     );
     return this;
   }
 
   public assertUserChipGroupExist(exist: boolean) {
-    super.assertChipGroupExist(AdminEventsTabSearchFormFieldsLabel.User, exist);
+    super.assertChipGroupExist(
+      this.genericChipGroupSelector,
+      AdminEventsTabSearchFormFieldsLabel.User,
+      exist,
+    );
     return this;
   }
 
   public assertIpAddressChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.IpAddress,
       exist,
     );
@@ -271,6 +285,7 @@ export default class AdminEventsTab extends PageObject {
 
   public assertDateFromChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.DateFrom,
       exist,
     );
@@ -279,6 +294,7 @@ export default class AdminEventsTab extends PageObject {
 
   public assertDateToChipGroupExist(exist: boolean) {
     super.assertChipGroupExist(
+      this.genericChipGroupSelector,
       AdminEventsTabSearchFormFieldsLabel.DateTo,
       exist,
     );