Some retouch, improve comments, and visibility

Author: soncuteanca

modules/browser_object_panel_ui.py

@@ -155,6 +155,31 @@ def open_private_window(self) -> BasePage:
             self.get_element("panel-ui-new-private-window").click()
         return self
 
+    @BasePage.context_chrome
+    def redirect_to_about_logins_page(self) -> BasePage:
+        """
+        Opens the about:logins page by clicking the Password option in Hamburger Menu"
+        """
+        self.open_panel_menu()
+        self.get_element("password-button").click()
+        return self
+
+    @BasePage.context_chrome
+    def reopen_recently_closed_tabs(self) -> BasePage:
+        """Reopen all recently closed tabs"""
+        self.open_panel_menu()
+        self.click_on("panel-ui-history")
+
+        self.click_on("panel-ui-history-recently-closed")
+        if self.sys_platform() == "Linux":
+            sleep(2)
+
+        self.click_on("panel-ui-history-recently-closed-reopen-tabs")
+
+        return self
+
+    # History
+
     @BasePage.context_chrome
     def open_history_menu(self) -> BasePage:
         """
@@ -166,9 +191,12 @@ def open_history_menu(self) -> BasePage:
 
     @BasePage.context_chrome
     def open_clear_history_dialog(self) -> BasePage:
-        """Opens the clear history dialog and switches to iframe context, assuming the history panel is opened"""
+        """
+        Opens the clear history dialog and switches to iframe context, assuming the history panel is opened
+        """
         self.click_on("clear-recent-history")
 
+        # Switch to iframe
         self.element_visible("iframe")
         iframe = self.get_element("iframe")
         BrowserActions(self.driver).switch_to_iframe_context(iframe)
@@ -199,11 +227,9 @@ def verify_most_recent_history_item(self, expected_value: str) -> BasePage:
         Argument:
             Expected_value (str): The expected value of the most recent history entry
         """
-
         recent_history_items = self.get_elements("recent-history-content")
         actual_value = recent_history_items[0].get_attribute("value")
         assert actual_value == expected_value
-
         return self
 
     @BasePage.context_chrome
@@ -226,7 +252,6 @@ def get_random_history_entry(self) -> Optional[Tuple[str, str]]:
 
         trimmed_url = self._extract_url_from_history(raw_url)
         assert trimmed_url and label, "History item has missing URL or label."
-
         return trimmed_url, label
 
     def _extract_url_from_history(self, raw_url: str) -> str:
@@ -238,20 +263,19 @@ def _extract_url_from_history(self, raw_url: str) -> str:
         """
         if not raw_url:
             return ""
-
         if "http" in raw_url:
             return raw_url[raw_url.find("http") :]
-
         return raw_url.strip()
 
     @BasePage.context_chrome
-    def redirect_to_about_logins_page(self) -> BasePage:
+    def confirm_history_clear(self):
         """
-        Opens the about:logins page by clicking the Password option in Hamburger Menu"
+        Confirm that the history is empty
         """
-        self.open_panel_menu()
-        self.get_element("password-button").click()
-        return self
+        self.open_history_menu()
+        self.expect_element_attribute_contains(
+            "recent-history-content", "value", "(Empty)"
+        )
 
     # Bookmarks section
 
@@ -327,25 +351,3 @@ def get_bookmark_tags(self, tags: List[str]) -> List[str]:
             )
             for tag in tags
         ]
-
-    @BasePage.context_chrome
-    def confirm_history_clear(self):
-        """Confirm that the history is empty"""
-        self.open_history_menu()
-        self.expect_element_attribute_contains(
-            "recent-history-content", "value", "(Empty)"
-        )
-
-    @BasePage.context_chrome
-    def reopen_recently_closed_tabs(self) -> BasePage:
-        """Reopen all recently closed tabs"""
-        self.open_panel_menu()
-        self.click_on("panel-ui-history")
-
-        self.click_on("panel-ui-history-recently-closed")
-        if self.sys_platform() == "Linux":
-            sleep(2)
-
-        self.click_on("panel-ui-history-recently-closed-reopen-tabs")
-
-        return self

tests/bookmarks_and_history/test_clear_all_history.py

@@ -19,7 +19,6 @@ def test_clear_all_history(driver: Firefox):
     """
     C172045: Verify that the user can Clear all the History
     """
-
     # Instantiate objects
     page = GenericPage(driver)
     panel = PanelUi(driver)
@@ -30,7 +29,8 @@ def test_clear_all_history(driver: Firefox):
 
     # Select the option to clear all the history
     panel.select_history_time_range_option("Everything")
-    # A method in panel-ui with selectors moved accordingly would work better, I'll come to this later, couldn't make it work so far
+    # A method in panel BOM  with selectors moved accordingly would make more sense, I'll come to this later,
+    # there are some context switching + iframe entanglements, couldn't make it work so far
     page.click_on("clear-history-button")
 
     # Verify all the history is deleted

tests/bookmarks_and_history/test_clear_recent_history_displayed.py

@@ -13,7 +13,6 @@ def test_clear_recent_history_displayed(driver: Firefox):
     """
     C172043: Clear recent history panel displayed
     """
-
     # Instantiate object
     panel = PanelUi(driver)
 

tests/bookmarks_and_history/test_open_websites_from_history.py

@@ -21,21 +21,22 @@ def test_open_websites_from_history(driver: Firefox):
     """
     C118807: Verify that the user can open any random website from Hamburger Menu, History section
     """
-
-    # Instantiate objects
+    # Instantiate object
     panel = PanelUi(driver)
-    panel.open_history_menu()
 
+    # Open History section from Hamburger Menu and get a random entry from browser history
+    panel.open_history_menu()
     result = panel.get_random_history_entry()
 
+    # Skip test if no history entries are available
     if result is None:
         logging.info("Test skipped: No history available")
         return
 
-    # Retrieve a random item from history and its label
+    # Extract URL and page title from the selected history entry
     url, label = result
 
-    # Open the corresponding page and verify URL and title match
+    # Navigate to the selected page and verify it loads correctly
     page = GenericPage(driver, url=url)
     page.open()
     page.url_contains(url)

tests/bookmarks_and_history/test_opened_website_in_new_tab_present_in_hamburger_history_menu.py

@@ -28,11 +28,11 @@ def test_the_website_opened_in_new_tab_is_present_in_history_menu(driver: Firefo
     page = GenericPage(driver, url=WIKIPEDIA_URL)
     panel = PanelUi(driver)
 
-    # Open a new tab, switch to it and verify is the url contains the desired page name
+    # Open a desired webpage in a new tab
     tabs.open_web_page_in_new_tab(page, 2)
     page.url_contains("wikipedia")
 
-    # Verify Wikipedia is present in the Hamburger Menu, History section and is on top of the list as the most recent
-    # website visited
+    # Verify the opened webpage from last step is present in the Hamburger Menu, History section and is on top of the
+    # list as the most recent website visited
     panel.open_history_menu()
     panel.verify_most_recent_history_item("Wikipedia")

tests/bookmarks_and_history/test_opened_website_in_new_window_present_in_hamburger_history_menu.py

@@ -23,16 +23,16 @@ def test_the_website_opened_in_new_window_is_present_in_history_menu(driver: Fir
     C118805 - Verify that the website opened in new window is displayed in Hamburger Menu, History section, on top of the
     list
     """
-
     # Instantiate objects
     page = GenericPage(driver, url=WIKIPEDIA_URL)
     panel = PanelUi(driver)
 
-    # Open a new window, switch to it and verify is the url contains the desired page name
+    # Open a desired webpage in a new window
     panel.open_and_switch_to_new_window("window")
     page.open()
     page.url_contains("wikipedia")
 
-    # Verify Wikipedia is present in the history menu and is on top of the list as the most recent website visited
+    # Verify the opened webpage from last step is present in the Hamburger Menu, History section and is on top of the
+    # list as the most recent website visited
     panel.open_history_menu()
     panel.verify_most_recent_history_item("Wikipedia")

tests/bookmarks_and_history/test_opened_website_present_in_hamburger_history_menu.py

@@ -30,6 +30,7 @@ def test_the_most_recent_website_is_present_in_history_menu(driver: Firefox):
     # Open the desired webpage
     page.open()
 
-    # Verify Wikipedia is present in the history menu and is on top of the list as the most recent website visited
+    # Verify the opened webpage from last step is present in the Hamburger Menu, History section and is on top of the
+    # list as the most recent website visited
     panel.open_history_menu()
     panel.verify_most_recent_history_item("Wikipedia")