MOBILE-4842 behat: Internationalize standard button presses

crazyserver · crazyserver · commit 17d0602a3084 · 2025-10-24T11:42:52.000+02:00
diff --git a/local_moodleappbehat/tests/behat/behat_app.php b/local_moodleappbehat/tests/behat/behat_app.php
@@ -476,7 +476,7 @@ public function i_enter_the_activity_in_the_app(string $activity, string $activi
     /**
      * Presses standard buttons in the app.
      *
-     * @When /^I press the (back|more menu|page menu|user menu) button in the app$/
+     * @When /^I press the (back|more menu|page context menu|user menu) button in the app$/
      * @param string $button Button type
      * @throws DriverException If the button push doesn't work
      */
@@ -485,7 +485,30 @@ public function i_press_the_standard_button_in_the_app(string $button) {
             $result = $this->runtime_js("pressStandard('$button')");
 
             if ($result !== 'OK') {
-                throw new DriverException('Error pressing standard button - ' . $result);
+                throw new DriverException("Error pressing $button button - $result");
+            }
+
+            return true;
+        });
+
+        $this->wait_for_pending_js();
+    }
+
+    /**
+     * Presses deprecated page menu button in the app.
+     *
+     * @When /^I press the page menu button in the app$/
+     * @throws DriverException If the button push doesn't work
+     * @deprecated since 5.1 Use "I press the page context menu button in the app" instead.
+     */
+    public function i_press_the_page_menu_button_in_the_app() {
+        $button = 'page context menu';
+
+        $this->spin(function() use ($button) {
+            $result = $this->runtime_js("pressStandard('$button')");
+
+            if ($result !== 'OK') {
+                throw new DriverException('Error pressing deprecated page menu button - ' . $result);
             }
 
             return true;
diff --git a/src/addons/calendar/tests/behat/create_events.feature b/src/addons/calendar/tests/behat/create_events.feature
@@ -57,7 +57,7 @@ Feature: Test creation of calendar events in app
     And I should find "Barcelona" in the app
     But I should not find "Ending time" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     Then I should find "Edit" in the app
     And I should find "Delete" in the app
 
diff --git a/src/addons/competency/tests/behat/navigation.feature b/src/addons/competency/tests/behat/navigation.feature
@@ -240,7 +240,7 @@ Feature: Test competency navigation
     And I set the field "Search" to "student" in the app
     And I press "Search" "button" in the app
     And I press "Student first" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "User info" in the app
     And I press "Learning plans" in the app
     Then I should find "Cookery" in the app
@@ -428,7 +428,7 @@ Feature: Test competency navigation
     And I press "Search people and messages" in the app
     And I set the field "Search" to "student" in the app
     And I press "Search" "button" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "User info" in the app
     And I press "Learning plans" in the app
     Then I should find "Cookery is important" in the app
diff --git a/src/addons/messages/tests/behat/basic_usage.feature b/src/addons/messages/tests/behat/basic_usage.feature
@@ -31,7 +31,7 @@ Feature: Test basic usage of messages in app
     And I press "Student1 student1" in the app
     And I set the field "New message" to "heeey student" in the app
     And I press "Send" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Add to contacts" in the app
     And I press "Add" near "Are you sure you want to add Student1 student1 to your contacts?" in the app
     Then I should find "Contact request sent" in the app
@@ -133,7 +133,7 @@ Feature: Test basic usage of messages in app
     And I press "Send" in the app
     Then I should find "heeey student" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "Add to contacts" in the app
     And I press "Add" in the app
     Then I should find "Contact request sent" in the app
@@ -148,20 +148,20 @@ Feature: Test basic usage of messages in app
     When I press "Accept and add to contacts" in the app
     Then I should not find "Teacher teacher would like to contact you" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "User info" in the app
     And I press "Message" in the app
     And I set the field "New message" to "hi" in the app
     And I press "Send" "button" in the app
     Then I should find "heeey student" in the app
     And I should find "hi" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "Remove from contacts" in the app
     And I press "Remove" in the app
     And I wait loading to finish in the app
     And I go back 2 times in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     Then I should find "Add to contacts" in the app
 
     When I press "Delete conversation" in the app
@@ -276,7 +276,7 @@ Feature: Test basic usage of messages in app
     And I should find "Starred (1)" in the app
 
     When I press "star message" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Star conversation" in the app
     And I go back in the app
     Then I should find "Private (1)" in the app
@@ -291,7 +291,7 @@ Feature: Test basic usage of messages in app
     When I press "Participants" in the app
     And I press "Student1 student1" in the app
     And I press "Message" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Block user" in the app
     And I press "Block user" near "Are you sure you want to block Student1 student1?" in the app
     Then I should find "You have blocked this user" in the app
@@ -306,7 +306,7 @@ Feature: Test basic usage of messages in app
     When I press "Participants" in the app
     And I press "Student1 student1" in the app
     And I press "Message" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     Then I should find "Unblock user" in the app
     But I should not find "Block user" in the app
 
@@ -332,15 +332,15 @@ Feature: Test basic usage of messages in app
     And I press "Send" in the app
     Then I should find "test message" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "Mute" in the app
     Then I should find "Muted conversation" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "Unmute" in the app
     Then I should not find "Muted conversation" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     When I press "Mute" in the app
     Then I should find "Muted conversation" in the app
 
@@ -369,12 +369,12 @@ Feature: Test basic usage of messages in app
     When I switch network connection to wifi
     And I go back in the app
     And I press "Student1 student1" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     Then I should find "Show delete messages" in the app
     And I should find "Delete conversation" in the app
 
     When I press "Unstar conversation" in the app
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     Then I should find "Star conversation" in the app
     And I should find "Delete conversation" in the app
 
@@ -388,7 +388,7 @@ Feature: Test basic usage of messages in app
     Then I should find "self conversation online" in the app
     But I should not find "self conversation offline" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "Delete conversation" in the app
     And I press "Delete" near "Are you sure you would like to delete this entire personal conversation?" in the app
     Then I should not find "self conversation online" in the app
diff --git a/src/addons/messages/tests/behat/navigation.feature b/src/addons/messages/tests/behat/navigation.feature
@@ -26,14 +26,14 @@ Feature: Test messages navigation in the app
     And I press "Send" in the app
     Then I should find "Hi there" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     And I press "User info" in the app
     Then I should find "Details" in the app
 
     When I press "Message" in the app
     Then I should find "Hi there" in the app
 
-    When I press "Display options" in the app
+    When I press the page context menu button in the app
     Then I should not find "User info" in the app
 
     When I close the popup in the app
diff --git a/src/core/features/comments/tests/behat/basic_usage.feature b/src/core/features/comments/tests/behat/basic_usage.feature
@@ -84,7 +84,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (0)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should find "comment test" in the app
@@ -104,7 +104,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (1)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should not see "There are offline comments to be synchronised."
@@ -171,7 +171,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (0)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should find "comment test" in the app
@@ -191,7 +191,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (1)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should not see "There are offline comments to be synchronised."
@@ -253,7 +253,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (0)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should find "comment test" in the app
@@ -273,7 +273,7 @@ Feature: Test basic usage of comments in app
     When I go back in the app
     And I press "Comments (1)" in the app
     And I switch network connection to wifi
-    And I press "Display options" in the app
+    And I press the page context menu button in the app
     And I press "Synchronise now" in the app
     And I close the popup in the app
     Then I should not see "There are offline comments to be synchronised."
diff --git a/src/testing/services/behat-dom.ts b/src/testing/services/behat-dom.ts
@@ -373,11 +373,11 @@ export class TestingBehatDomUtilsService {
      * Get closest element matching a selector, without traversing up a given container.
      *
      * @param element Element.
-     * @param selector Selector.
+     * @param selector Ancestor selector.
      * @param container Topmost container to search within.
      * @returns Closest matching element.
      */
-    protected getClosestMatching(element: HTMLElement, selector: string, container: HTMLElement | null): HTMLElement | null {
+    protected getClosestMatching(element: HTMLElement, selector: string, container: HTMLElement): HTMLElement | null {
         if (element.matches(selector)) {
             return element;
         }
@@ -390,6 +390,27 @@ export class TestingBehatDomUtilsService {
         return this.getClosestMatching(parent, selector, container);
     }
 
+    /**
+     * For a list of elements, get the closest matching ancestor for each of them, if matches.
+     *
+     * @param elements List of elements.
+     * @param selector Ancestor selector.
+     * @param container Topmost container to search within.
+     * @returns Closest matching elements.
+     */
+    protected getClosestMatchingElements(elements: HTMLElement[], selector: string, container: HTMLElement): HTMLElement[] {
+        const closestMatchingElements: HTMLElement[] = [];
+
+        elements.forEach((element) => {
+            const closest = this.getClosestMatching(element, selector, container);
+            if (closest) {
+                closestMatchingElements.push(closest);
+            }
+        });
+
+        return closestMatchingElements;
+    }
+
     /**
      * Function to find top container elements.
      *
@@ -520,6 +541,29 @@ export class TestingBehatDomUtilsService {
         }
     }
 
+    /**
+     * Function to find element based on a CSS selector.
+     *
+     * @param selector Element selector.
+     * @param options Search options.
+     * @returns First found element.
+     */
+    findElementBasedOnSelector(
+        selector: string,
+        options: TestingBehatFindOptions = {},
+    ): HTMLElement | undefined {
+        const topContainers = this.getCurrentTopContainerElements(options.containerName);
+        let elements: HTMLElement[] = [];
+
+        topContainers.some((container) => {
+            elements = this.findElementsBasedOnSelectorInContainer(selector, container, options);
+
+            return elements.length > 0;
+        });
+
+        return elements[0];
+    }
+
     /**
      * Function to find element based on their text or Aria label.
      *
@@ -672,20 +716,49 @@ export class TestingBehatDomUtilsService {
 
             const elements = this.findElementsBasedOnTextWithin(container, locator.text, options);
 
-            let filteredElements: HTMLElement[] = elements;
+            let filteredElements = elements;
 
             if (locator.selector) {
-                filteredElements = [];
-                const selector = locator.selector;
+                filteredElements = this.getClosestMatchingElements(elements, locator.selector, container);
+            }
 
-                elements.forEach((element) => {
-                    const closest = this.getClosestMatching(element, selector, container);
-                    if (closest) {
-                        filteredElements.push(closest);
-                    }
-                });
+            if (filteredElements.length > 0) {
+                return filteredElements;
             }
 
+        } while (container !== topContainer && (container = this.getParentElement(container)) && container !== topContainer);
+
+        return [];
+    }
+
+    /**
+     * Function to find elements based on a CSS selector.
+     *
+     * @param selector Element selector.
+     * @param topContainer Container to search in.
+     * @param options Search options.
+     * @returns Found elements
+     */
+    protected findElementsBasedOnSelectorInContainer(
+        selector: string,
+        topContainer: HTMLElement,
+        options: TestingBehatFindOptions = {},
+    ): HTMLElement[] {
+        let container: HTMLElement | null = topContainer;
+
+        do {
+            if (!container) {
+                break;
+            }
+
+            const elements = Array.from(container.querySelectorAll<HTMLElement>(selector))
+                .filter(
+                    element => this.isElementVisible(element, topContainer) &&
+                        (!options.onlyClickable || this.isElementClickable(element)),
+                );
+
+            const filteredElements = this.getClosestMatchingElements(elements, selector, container);
+
             if (filteredElements.length > 0) {
                 return filteredElements;
             }
diff --git a/src/testing/services/behat-runtime.ts b/src/testing/services/behat-runtime.ts
