Merge pull request #559 from mozilla/as/refactor-bookmark-history-suite

Anca/Bookmarks refactoring - star icon and hamburger menu (first part)

[Tracy] Landing on Anca's behalf, since she is out and we want to get this landed before Beta1

Author: Tracy-Walker

modules/browser_object_navigation.py

@@ -256,6 +256,77 @@ def open_tracker_panel(self) -> BasePage:
         self.get_element("shield-icon").click()
         return self
 
+    def wait_for_item_to_download(self, filename: str) -> BasePage:
+        """
+        Check the downloads tool in the toolbar to wait for a given file to download
+        """
+        original_timeout = self.driver.timeouts.implicit_wait
+        try:
+            # Whatever our timeout, we want to lengthen it because downloads
+            self.driver.implicitly_wait(original_timeout * 2)
+            self.element_visible("downloads-item-by-file", labels=[filename])
+            self.expect_not(
+                EC.element_attribute_to_include(
+                    self.get_selector("downloads-button"), "animate"
+                )
+            )
+            with self.driver.context(self.context_id):
+                self.driver.execute_script(
+                    "arguments[0].setAttribute('hidden', true)",
+                    self.get_element("downloads-button"),
+                )
+        finally:
+            self.driver.implicitly_wait(original_timeout)
+        return self
+
+    @BasePage.context_chrome
+    def refresh_page(self) -> BasePage:
+        """
+        Refreshes the current page by clicking the refresh button in the browser.
+        """
+
+        self.get_element("refresh-button").click()
+        self.wait_for_page_to_load()
+        return self
+
+    def handle_geolocation_prompt(self, button_type="primary"):
+        """
+        Handles geolocation prompt by clicking either the 'Allow' or 'Block' button based on the button_type provided
+        """
+        button_selector = f"popup-notification-{button_type}-button"
+        self.element_clickable(button_selector)
+        self.click_on(button_selector)
+
+    def open_searchmode_switcher_settings(self):
+        """Open search settings from searchmode switcher in awesome bar"""
+        self.click_on("searchmode-switcher")
+        self.click_on("searchmode-switcher-settings")
+        return self
+
+    @BasePage.context_chrome
+    def select_element_in_nav(self, element: str) -> BasePage:
+        self.get_element(element).click()
+        return self
+
+    # Bookmark
+
+    @BasePage.context_chrome
+    def add_bookmark_via_star_icon(self) -> BasePage:
+        """
+        Bookmark a site via star button and click save on the bookmark panel
+        """
+        self.get_element("star-button").click()
+        self.get_element("save-bookmark-button").click()
+        return self
+
+    @BasePage.context_chrome
+    def verify_star_button_is_blue(self) -> BasePage:
+        """
+        Verifies that the star button is blue (indicating a bookmarked page)
+        """
+        self.element_visible("blue-star-button")
+        return self
+
     @BasePage.context_chrome
     def bookmark_page_other(self) -> BasePage:
         self.get_element("star-button").click()
@@ -289,25 +360,6 @@ def add_bookmark_advanced(
         ba.switch_to_content_context()
         return self
 
-    @BasePage.context_chrome
-    def add_bookmark_via_star(self) -> BasePage:
-        """
-        Bookmark a site via star button and click save on the bookmark panel
-        """
-        self.get_element("star-button").click()
-        self.get_element("save-bookmark-button").click()
-        return self
-
-    @BasePage.context_chrome
-    def add_bookmark_via_menu(self) -> BasePage:
-        """
-        Bookmark a site via bookmarks menu and click save on the bookmark panel
-        """
-
-        self.get_element("bookmark-current-tab").click()
-        self.get_element("save-bookmark-button").click()
-        return self
-
     @BasePage.context_chrome
     def toggle_bookmarks_toolbar_with_key_combo(self) -> BasePage:
         """Use Cmd/Ctrl + B to open the Print Preview, wait for load"""
@@ -319,29 +371,6 @@ def toggle_bookmarks_toolbar_with_key_combo(self) -> BasePage:
         self.perform_key_combo(mod_key, Keys.SHIFT, "b")
         return self
 
-    def wait_for_item_to_download(self, filename: str) -> BasePage:
-        """
-        Check the downloads tool in the toolbar to wait for a given file to download
-        """
-        original_timeout = self.driver.timeouts.implicit_wait
-        try:
-            # Whatever our timeout, we want to lengthen it because downloads
-            self.driver.implicitly_wait(original_timeout * 2)
-            self.element_visible("downloads-item-by-file", labels=[filename])
-            self.expect_not(
-                EC.element_attribute_to_include(
-                    self.get_selector("downloads-button"), "animate"
-                )
-            )
-            with self.driver.context(self.context_id):
-                self.driver.execute_script(
-                    "arguments[0].setAttribute('hidden', true)",
-                    self.get_element("downloads-button"),
-                )
-        finally:
-            self.driver.implicitly_wait(original_timeout)
-        return self
-
     @BasePage.context_chrome
     def confirm_bookmark_exists(self, match_string: str) -> BasePage:
         """
@@ -361,32 +390,3 @@ def confirm_bookmark_exists(self, match_string: str) -> BasePage:
         )
         assert matches_short_string or matches_long_string
         return self
-
-    @BasePage.context_chrome
-    def refresh_page(self) -> BasePage:
-        """
-        Refreshes the current page by clicking the refresh button in the browser.
-        """
-
-        self.get_element("refresh-button").click()
-        self.wait_for_page_to_load()
-        return self
-
-    def handle_geolocation_prompt(self, button_type="primary"):
-        """
-        Handles geolocation prompt by clicking either the 'Allow' or 'Block' button based on the button_type provided
-        """
-        button_selector = f"popup-notification-{button_type}-button"
-        self.element_clickable(button_selector)
-        self.click_on(button_selector)
-
-    def open_searchmode_switcher_settings(self):
-        """Open search settings from searchmode switcher in awesome bar"""
-        self.click_on("searchmode-switcher")
-        self.click_on("searchmode-switcher-settings")
-        return self
-
-    @BasePage.context_chrome
-    def select_element_in_nav(self, element: str) -> BasePage:
-        self.get_element(element).click()
-        return self

modules/browser_object_panel_ui.py

@@ -2,9 +2,11 @@
 
 from pypom import Region
 from selenium.common.exceptions import NoSuchElementException, TimeoutException
+from selenium.webdriver import Firefox
 from selenium.webdriver.remote.webelement import WebElement
 from selenium.webdriver.support import expected_conditions as EC
 
+from modules.browser_object_navigation import Navigation
 from modules.components.dropdown import Dropdown
 from modules.page_base import BasePage
 from modules.util import BrowserActions, PomUtils
@@ -15,6 +17,10 @@ class PanelUi(BasePage):
 
     URL_TEMPLATE = "about:blank"
 
+    def __init__(self, driver: Firefox, **kwargs):
+        super().__init__(driver, **kwargs)
+        self.navigation = Navigation(self.driver)
+
     class Menu(Region):
         """
         PyPOM Region factory for the PanelUi Dropdown menu
@@ -153,15 +159,6 @@ def open_history_menu(self) -> BasePage:
             self.get_element("panel-ui-history").click()
         return self
 
-    def open_bookmarks_menu(self) -> BasePage:
-        """
-        Opens the Bookmarks menu
-        """
-        self.open_panel_menu()
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            self.get_element("panel-ui-bookmarks").click()
-        return self
-
     def select_clear_history_option(self, option: str) -> BasePage:
         """
         Selects the clear history option, assumes the history panel is open.
@@ -192,3 +189,35 @@ def redirect_to_about_logins_page(self) -> BasePage:
         with self.driver.context(self.driver.CONTEXT_CHROME):
             self.get_element("password-button").click()
         return self
+
+    # Bookmarks section
+
+    @BasePage.context_chrome
+    def open_bookmarks_panel_from_hamburger_menu(self) -> BasePage:
+        """
+        Opens the Bookmarks panel from the Hamburger Menu
+        """
+        self.open_panel_menu()
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.get_element("panel-ui-bookmarks").click()
+        return self
+
+    @BasePage.context_chrome
+    def bookmark_current_tab_via_hamburger_menu(self) -> BasePage:
+        """
+        Opens the Bookmarks panel from the Hamburger Menu, selects Bookmarks the current tab.. and clicks
+        Save button from Add Bookmark in Address bar "
+        """
+        self.get_element("bookmark-current-tab").click()
+        self.navigation.get_element("save-bookmark-button").click()
+        return self
+
+    @BasePage.context_chrome
+    def verify_bookmark_exists_in_hamburger_menu(self, bookmark_title: str) -> BasePage:
+        """
+        Verifies that a bookmark with the specified title exists inside Bookmark section from Hamburger menu
+        Arguments:
+            bookmark_title (str): The title text to look for in the bookmark
+        """
+        self.element_visible("bookmark-by-title", labels=[bookmark_title])
+        return self

modules/data/navigation.components.json

@@ -171,6 +171,7 @@
     },
 
     "firefox-suggest": {
+        "doNotCache": true,
         "selectorData": "div.urlbarView-row[label='Firefox Suggest'] > span.urlbarView-row-inner",
         "strategy": "css",
         "groups": []

tests/address_bar_and_search/test_preferences_all_toggles_enabled.py

@@ -17,7 +17,7 @@ def test_preferences_all_toggles_enabled(driver: Firefox):
     """
     C1618400: Preferences - All toggles buttons Enabled
     """
-    # instantiate objects
+    # Instantiate objects
     nav = Navigation(driver)
     about_prefs = AboutPrefs(driver, category="search")
     about_prefs.open()

tests/bookmarks_and_history/test_bookmark_via_bookmark_menu.py

@@ -1,7 +1,6 @@
 import pytest
 from selenium.webdriver import Firefox
 
-from modules.browser_object_navigation import Navigation
 from modules.browser_object_panel_ui import PanelUi
 
 
@@ -11,21 +10,23 @@ def test_case():
 
 
 URL_TO_BOOKMARK = "https://www.mozilla.org/"
+BOOKMARK_TITLE = "Internet for people"
 
 
-def test_bookmark_via_bookmark_menu(driver: Firefox):
+def test_bookmark_via_hamburger_menu(driver: Firefox):
     """
-    C2084489: Verify that the user can Bookmark a page from the Bookmarks menu
+    C2084489: Verify that the user can bookmark a page using Bookmark current tab .. opened from Hamburger Menu
     """
-    # instantiate object
-    nav = Navigation(driver)
+    # Instantiate object
     panel = PanelUi(driver)
 
-    # Bookmark the given website via bookmarks menu
+    # Navigate to test website
     driver.get(URL_TO_BOOKMARK)
-    panel.open_bookmarks_menu()
-    nav.add_bookmark_via_menu()
 
-    # Verify that the bookmark is displayed in bookmarks menu
-    panel.open_bookmarks_menu()
-    panel.element_visible("bookmark-by-title", labels=["Internet for people"])
+    # Bookmark using Bookmark current tab option from Hamburger Menu
+    panel.open_bookmarks_panel_from_hamburger_menu()
+    panel.bookmark_current_tab_via_hamburger_menu()
+
+    # Verify bookmark appears in Hamburger Menu, Bookmarks section
+    panel.open_bookmarks_panel_from_hamburger_menu()
+    panel.verify_bookmark_exists_in_hamburger_menu(BOOKMARK_TITLE)

tests/bookmarks_and_history/test_bookmark_website_via_star_button.py

@@ -11,23 +11,25 @@ def test_case():
 
 
 URL_TO_BOOKMARK = "https://www.mozilla.org/"
+BOOKMARK_TITLE = "Internet for people"
 
 
 @pytest.mark.ci
 def test_bookmark_website_via_star(driver: Firefox):
     """
     C2084539: Verify that the Websites can be bookmarked via star-shaped button
     """
-    # instantiate object
+    # Instantiate object
     nav = Navigation(driver)
     panel = PanelUi(driver)
 
-    # Bookmark the given website and check the bookmark star turned blue
+    # Navigate to test website
     driver.get(URL_TO_BOOKMARK)
-    nav.add_bookmark_via_star()
-    with driver.context(driver.CONTEXT_CHROME):
-        nav.element_visible("blue-star-button")
 
-    # Verify that the bookmark is displayed in bookmarks menu
-    panel.open_bookmarks_menu()
-    panel.element_visible("bookmark-by-title", labels=["Internet for people"])
+    # Bookmark using star button and verify star turned blue
+    nav.add_bookmark_via_star_icon()
+    nav.verify_star_button_is_blue()
+
+    # Verify bookmark appears in Hamburger Menu, Bookmarks section
+    panel.open_bookmarks_panel_from_hamburger_menu()
+    panel.verify_bookmark_exists_in_hamburger_menu(BOOKMARK_TITLE)

tests/bookmarks_and_history/test_delete_bookmarks_from_toolbar.py

@@ -26,7 +26,7 @@ def test_delete_bookmarks_from_toolbar(driver: Firefox):
 
     # Bookmark the given website via star button
     driver.get(URL_TO_BOOKMARK)
-    nav.add_bookmark_via_star()
+    nav.add_bookmark_via_star_icon()
 
     with driver.context(driver.CONTEXT_CHROME):
         # Verify that the bookmark is added

tests/bookmarks_and_history/test_edit_bookmark_from_bookmark_menu.py

@@ -28,15 +28,15 @@ def test_edit_bookmark_from_bookmark_menu(driver: Firefox):
 
     # Bookmark the given website via bookmarks menu
     GenericPage(driver, url=URL_TO_BOOKMARK).open()
-    panel.open_bookmarks_menu()
-    nav.add_bookmark_via_menu()
+    panel.open_bookmarks_panel_from_hamburger_menu()
+    nav.add_bookmark_via_star_icon()
 
     with driver.context(driver.CONTEXT_CHROME):
         # enable add a tag to a bookmark in the bookmark panel
         driver.execute_script(ENABLE_ADD_TAG)
 
         # Open the Hamburger menu, click on the Edit This Bookmark button from the Bookmarks section
-        panel.open_bookmarks_menu()
+        panel.open_bookmarks_panel_from_hamburger_menu()
         panel.get_element("bookmark-current-tab").click()
 
         # Change bookmark name, location and add a tag

tests/bookmarks_and_history/test_edit_bookmark_via_star_button.py

@@ -25,7 +25,7 @@ def test_edit_bookmark_via_star_button(driver: Firefox):
 
     # Bookmark the given website via star button
     GenericPage(driver, url=URL_TO_EDIT).open()
-    nav.add_bookmark_via_star()
+    nav.add_bookmark_via_star_icon()
 
     # Open the edit bookmark panel and change bookmark name and location
     with driver.context(driver.CONTEXT_CHROME):

tests/bookmarks_and_history/test_open_all_bookmarks_from_bookmarks_toolbar.py

@@ -32,7 +32,7 @@ def test_open_all_bookmarks_from_bookmarks_toolbar(driver: Firefox):
     urls_to_bookmark = [URL1_TO_BOOKMARK, URL2_TO_BOOKMARK, URL3_TO_BOOKMARK]
     for url in urls_to_bookmark:
         GenericPage(driver, url=url).open()
-        nav.add_bookmark_via_star()
+        nav.add_bookmark_via_star_icon()
 
     # Load a page that we didn't bookmark, so we can ensure that we're not just picking up on that instance of the page
     GenericPage(driver, url=URL_NOT_BOOKMARKED).open()