|
| 1 | +# This Source Code Form is subject to the terms of the Mozilla Public |
| 2 | +# License, v. 2.0. If a copy of the MPL was not distributed with this file, |
| 3 | +# You can obtain one at http://mozilla.org/MPL/2.0/. |
| 4 | +"""Contains classes for handling Firefox Panel UI (Hamburger menu).""" |
| 5 | + |
| 6 | +from selenium.webdriver.common.by import By |
| 7 | +import time |
| 8 | +from foxpuppet.windows.browser.navbar import NavBar |
| 9 | +from selenium.webdriver.remote.webelement import WebElement |
| 10 | +from typing import Type, Any, TYPE_CHECKING, Optional |
| 11 | +from selenium.webdriver.support import expected_conditions as EC |
| 12 | + |
| 13 | + |
| 14 | +class PanelUI(NavBar): |
| 15 | + """Handles interaction with Panel UI.""" |
| 16 | + |
| 17 | + if TYPE_CHECKING: |
| 18 | + from foxpuppet.windows import BrowserWindow |
| 19 | + |
| 20 | + @staticmethod |
| 21 | + def create( |
| 22 | + window: Optional["BrowserWindow"], root: WebElement |
| 23 | + ) -> Type["PanelUI"] | Any: |
| 24 | + """Create a Panel UI object. |
| 25 | +
|
| 26 | + Args: |
| 27 | + window (:py:class:`BrowserWindow`): Window object this region |
| 28 | + appears in. |
| 29 | + root |
| 30 | + (:py:class:`~selenium.webdriver.remote.webelement.WebElement`): |
| 31 | + WebDriver element object that serves as the root for the |
| 32 | + Panel UI. |
| 33 | +
|
| 34 | + Returns: |
| 35 | + :py:class:`PanelUI`: Firefox Panel UI. |
| 36 | +
|
| 37 | + """ |
| 38 | + panel_items: dict = {} |
| 39 | + _id: str | bool | WebElement | dict = root.get_property("id") |
| 40 | + |
| 41 | + panel_items.update(PANEL_ITEMS) |
| 42 | + return panel_items.get(_id, PanelUI)(window, root) |
| 43 | + |
| 44 | + @property |
| 45 | + def is_update_available(self) -> bool: |
| 46 | + """ |
| 47 | + Checks if the Panel UI button indicates a pending Firefox update. |
| 48 | +
|
| 49 | + Returns: |
| 50 | + bool: True if an update notification (barge) is present, False otherwise. |
| 51 | + """ |
| 52 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 53 | + update_status = self.selenium.find_element( |
| 54 | + *PanelUILocators.PANEL_UI_BUTTON |
| 55 | + ).get_attribute("barged") |
| 56 | + return update_status == "true" |
| 57 | + |
| 58 | + def open_panel_menu(self) -> None: |
| 59 | + """ |
| 60 | + Opens the Panel UI menu. |
| 61 | + """ |
| 62 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 63 | + self.selenium.find_element(*PanelUILocators.PANEL_UI_BUTTON).click() |
| 64 | + self.wait.until( |
| 65 | + EC.presence_of_element_located(*PanelUILocators.PANEL_POPUP), |
| 66 | + message="Panel UI menu did not open", |
| 67 | + ) |
| 68 | + |
| 69 | + def open_new_tab(self) -> None: |
| 70 | + """ |
| 71 | + Opens a new tab using the Panel UI menu. |
| 72 | + """ |
| 73 | + initial_handles = set(self.selenium.window_handles) |
| 74 | + self.open_panel_menu() |
| 75 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 76 | + self.selenium.find_element(*PanelUILocators.NEW_TAB).click() |
| 77 | + self.wait.until( |
| 78 | + lambda _: set(self.selenium.window_handles) - initial_handles, |
| 79 | + message="New Tab did not open", |
| 80 | + ) |
| 81 | + new_tab = (set(self.selenium.window_handles) - initial_handles).pop() |
| 82 | + self.selenium.switch_to.window(new_tab) |
| 83 | + |
| 84 | + def open_new_window(self) -> None: |
| 85 | + """ |
| 86 | + Opens a new window using the Panel UI menu. |
| 87 | + """ |
| 88 | + initial_handles = set(self.selenium.window_handles) |
| 89 | + self.open_panel_menu() |
| 90 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 91 | + self.selenium.find_element(*PanelUILocators.NEW_WINDOW).click() |
| 92 | + self.wait.until( |
| 93 | + lambda _: set(self.selenium.window_handles) - initial_handles, |
| 94 | + message="New window did not open", |
| 95 | + ) |
| 96 | + new_window = (set(self.selenium.window_handles) - initial_handles).pop() |
| 97 | + self.selenium.switch_to.window(new_window) |
| 98 | + self.wait.until( |
| 99 | + lambda _: self.selenium.execute_script("return document.readyState") |
| 100 | + == "complete", |
| 101 | + message="New window document not fully loaded", |
| 102 | + ) |
| 103 | + |
| 104 | + def open_private_window(self) -> None: |
| 105 | + """ |
| 106 | + Opens a new window in private browsing mode using the Panel UI menu. |
| 107 | + """ |
| 108 | + initial_handles = set(self.selenium.window_handles) |
| 109 | + self.open_panel_menu() |
| 110 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 111 | + self.selenium.find_element(*PanelUILocators.PRIVATE_WINDOW).click() |
| 112 | + self.wait.until( |
| 113 | + lambda _: set(self.selenium.window_handles) - initial_handles, |
| 114 | + message="Private window did not open", |
| 115 | + ) |
| 116 | + from foxpuppet.windows.browser.window import BrowserWindow |
| 117 | + |
| 118 | + new_private_window = self.selenium.window_handles[-1] |
| 119 | + try: |
| 120 | + private_window = BrowserWindow( |
| 121 | + self.selenium, new_private_window |
| 122 | + ).is_private |
| 123 | + if private_window: |
| 124 | + self.selenium.switch_to.window(new_private_window) |
| 125 | + except Exception as e: |
| 126 | + raise Exception(f"The new window is not private: {str(e)}") |
| 127 | + |
| 128 | + def open_history_menu(self) -> None: |
| 129 | + """ |
| 130 | + Opens the History in Panel UI Menu |
| 131 | + """ |
| 132 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 133 | + self.selenium.find_element(*PanelUILocators.HISTORY).click() |
| 134 | + self.wait.until( |
| 135 | + lambda _: self.selenium.find_element( |
| 136 | + *PanelUILocators.PANEL_HISTORY |
| 137 | + ).is_displayed(), |
| 138 | + message="History menu did not open", |
| 139 | + ) |
| 140 | + |
| 141 | + |
| 142 | +class History(PanelUI): |
| 143 | + def history_items(self) -> list[WebElement]: |
| 144 | + """ |
| 145 | + Retrieves all history items from the Panel UI history menu. |
| 146 | +
|
| 147 | + Returns: |
| 148 | + list[WebElement]: List of WebElement objects representing history items. |
| 149 | + Returns an empty list if no history items are found. |
| 150 | + """ |
| 151 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 152 | + history_items = self.selenium.find_elements( |
| 153 | + *PanelUILocators.RECENT_HISTORY_ITEMS |
| 154 | + ) |
| 155 | + return history_items |
| 156 | + |
| 157 | + def clear_history(self): |
| 158 | + """ |
| 159 | + Clears the browsing history. |
| 160 | + """ |
| 161 | + with self.selenium.context(self.selenium.CONTEXT_CHROME): |
| 162 | + self.selenium.find_element(*PanelUILocators.CLEAR_RECENT_HISTORY).click() |
| 163 | + self.selenium.switch_to.frame( |
| 164 | + self.selenium.find_element(*PanelUILocators.HISTORY_IFRAME) |
| 165 | + ) |
| 166 | + with self.selenium.context(self.selenium.CONTEXT_CONTENT): |
| 167 | + self.selenium.find_element(*PanelUILocators.DROPDOWN_HISTORY).click() |
| 168 | + self.selenium.find_element( |
| 169 | + *PanelUILocators.CLEAR_HISTORY_EVERYTHING |
| 170 | + ).click() |
| 171 | + self.selenium.execute_script( |
| 172 | + """ |
| 173 | + const shadowHost = arguments[0]; |
| 174 | + const shadowRoot = shadowHost.shadowRoot; |
| 175 | + const clearRecentHistoryButton = shadowRoot.querySelector('button[dlgtype="accept"]'); |
| 176 | + clearRecentHistoryButton.click(); |
| 177 | + """, |
| 178 | + self.selenium.find_element(*PanelUILocators.HISTORY_DIALOG_BUTTON), |
| 179 | + ) |
| 180 | + time.sleep(1) |
| 181 | + |
| 182 | + |
| 183 | +class PanelUILocators: |
| 184 | + CLEAR_HISTORY_EVERYTHING = (By.CSS_SELECTOR, "menuitem[value='0']") |
| 185 | + CLEAR_RECENT_HISTORY = (By.ID, "appMenuClearRecentHistory") |
| 186 | + CLEAR_RECENT_HISTORY_BUTTON = (By.CSS_SELECTOR, "button[dlgtype='accept']") |
| 187 | + DROPDOWN_HISTORY = (By.ID, "sanitizeDurationChoice") |
| 188 | + HISTORY = (By.ID, "appMenu-history-button") |
| 189 | + HISTORY_DIALOG_BUTTON = (By.CSS_SELECTOR, "dialog[defaultButton='accept']") |
| 190 | + HISTORY_IFRAME = (By.CSS_SELECTOR, "browser.dialogFrame") |
| 191 | + NEW_TAB = (By.ID, "appMenu-new-tab-button2") |
| 192 | + NEW_WINDOW = (By.ID, "appMenu-new-window-button2") |
| 193 | + PANEL_HISTORY = (By.ID, "PanelUI-history") |
| 194 | + PANEL_POPUP = ((By.ID, "appMenu-popup"),) |
| 195 | + PANEL_UI_BUTTON = (By.ID, "PanelUI-menu-button") |
| 196 | + PRIVATE_WINDOW = (By.ID, "appMenu-new-private-window-button2") |
| 197 | + RECENT_HISTORY_ITEMS = ( |
| 198 | + By.CSS_SELECTOR, |
| 199 | + "#appMenu_historyMenu toolbarbutton.subviewbutton", |
| 200 | + ) |
| 201 | + |
| 202 | + |
| 203 | +PANEL_ITEMS = { |
| 204 | + "PanelUI-menu-button": PanelUI, |
| 205 | + "appMenu-history-button": History, |
| 206 | +} |
0 commit comments