"""A mixin to extend a class that has self.driver with higher-level constructs.
This should be mixed into classes with a self.driver and self.default_timeout
attribute.
"""
import abc
import threading
from typing import (
Dict,
List,
Optional,
Type,
Union,
)
import requests
from axe_selenium_python import Axe
from selenium.common.exceptions import (
NoSuchElementException,
TimeoutException as SeleniumTimeoutException,
)
from selenium.webdriver.common.action_chains import ActionChains
from selenium.webdriver.common.by import By
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.remote.webdriver import WebDriver
from selenium.webdriver.remote.webelement import WebElement
from selenium.webdriver.support import expected_conditions as ec
from selenium.webdriver.support.wait import WebDriverWait
from galaxy.navigation.components import Target
from .axe_results import (
AxeResults,
NullAxeResults,
RealAxeResults,
)
UNSPECIFIED_TIMEOUT = object()
HasFindElement = Union[WebDriver, WebElement]
DEFAULT_AXE_SCRIPT_URL = "https://cdnjs.cloudflare.com/ajax/libs/axe-core/4.7.1/axe.min.js"
AXE_SCRIPT_HASH: Dict[str, str] = {}
AXE_SCRIPT_HASH_LOCK = threading.Lock()
def get_axe_script(script_url: str) -> str:
with AXE_SCRIPT_HASH_LOCK:
if script_url not in AXE_SCRIPT_HASH:
content = requests.get(script_url).text
AXE_SCRIPT_HASH[script_url] = content
return AXE_SCRIPT_HASH[script_url]
[docs]class HasDriver:
by: Type[By] = By
keys: Type[Keys] = Keys
driver: WebDriver
axe_script_url: str = DEFAULT_AXE_SCRIPT_URL
axe_skip: bool = False
[docs] def re_get_with_query_params(self, params_str: str):
driver = self.driver
new_url = driver.current_url
if "?" not in new_url:
new_url += "?"
new_url += params_str
driver.get(new_url)
[docs] def assert_xpath(self, xpath: str):
assert self.driver.find_element(By.XPATH, xpath)
[docs] def assert_selector(self, selector: str):
assert self.driver.find_element(By.CSS_SELECTOR, selector)
[docs] def assert_selector_absent_or_hidden(self, selector: str):
elements = self.driver.find_elements(By.CSS_SELECTOR, selector)
for element in elements:
assert not element.is_displayed()
[docs] def assert_absent_or_hidden(self, selector_template: Target):
elements = self.find_elements(selector_template)
for element in elements:
assert not element.is_displayed()
[docs] def assert_disabled(self, selector_template: Target):
elements = self.find_elements(selector_template)
assert len(elements) > 0
for element in elements:
assert not element.is_enabled()
[docs] def selector_is_displayed(self, selector: str):
element = self.driver.find_element(By.CSS_SELECTOR, selector)
return element.is_displayed()
[docs] def is_displayed(self, selector_template: Target) -> bool:
element = self.driver.find_element(*selector_template.element_locator)
return element.is_displayed()
[docs] def assert_selector_absent(self, selector: str):
assert len(self.driver.find_elements(By.CSS_SELECTOR, selector)) == 0
[docs] def find_elements(self, selector_template: Target) -> List[WebElement]:
return self.driver.find_elements(*selector_template.element_locator)
[docs] def assert_absent(self, selector_template: Target) -> None:
elements = self.find_elements(selector_template)
if len(elements) != 0:
description = selector_template.description
any_displayed = False
for element in elements:
any_displayed = any_displayed or element.is_displayed()
msg = f"Expected DOM elements [{elements}] to be empty for selector target {description} - any actually displayed? [{any_displayed}]"
raise AssertionError(msg)
[docs] def element_absent(self, selector_template: Target) -> bool:
return len(self.find_elements(selector_template)) == 0
[docs] def wait_for_xpath(self, xpath: str, **kwds) -> WebElement:
element = self._wait_on(
ec.presence_of_element_located((By.XPATH, xpath)), f"XPATH selector [{xpath}] to become present", **kwds
)
return element
[docs] def wait_for_xpath_visible(self, xpath: str, **kwds) -> WebElement:
element = self._wait_on(
ec.visibility_of_element_located((By.XPATH, xpath)), f"XPATH selector [{xpath}] to become visible", **kwds
)
return element
[docs] def wait_for_selector(self, selector: str, **kwds) -> WebElement:
element = self._wait_on(
ec.presence_of_element_located((By.CSS_SELECTOR, selector)),
f"CSS selector [{selector}] to become present",
**kwds,
)
return element
[docs] def wait_for_present(self, selector_template: Target, **kwds) -> WebElement:
element = self._wait_on(
ec.presence_of_element_located(selector_template.element_locator),
f"{selector_template.description} to become present",
**kwds,
)
return element
[docs] def wait_for_visible(self, selector_template: Target, **kwds) -> WebElement:
element = self._wait_on(
ec.visibility_of_element_located(selector_template.element_locator),
f"{selector_template.description} to become visible",
**kwds,
)
return element
[docs] def wait_for_selector_visible(self, selector: str, **kwds) -> WebElement:
element = self._wait_on(
ec.visibility_of_element_located((By.CSS_SELECTOR, selector)),
f"CSS selector [{selector}] to become visible",
**kwds,
)
return element
[docs] def wait_for_selector_clickable(self, selector: str, **kwds) -> WebElement:
element = self._wait_on(
ec.element_to_be_clickable((By.CSS_SELECTOR, selector)),
f"CSS selector [{selector}] to become clickable",
**kwds,
)
return element
[docs] def wait_for_clickable(self, selector_template: Target, **kwds) -> WebElement:
element = self._wait_on(
ec.element_to_be_clickable(selector_template.element_locator),
f"{selector_template.description} to become clickable",
**kwds,
)
return element
[docs] def wait_for_selector_absent_or_hidden(self, selector: str, **kwds) -> WebElement:
element = self._wait_on(
ec.invisibility_of_element_located((By.CSS_SELECTOR, selector)),
f"CSS selector [{selector}] to become absent or hidden",
**kwds,
)
return element
[docs] def wait_for_selector_absent(self, selector: str, **kwds) -> WebElement:
element = self._wait_on(
lambda driver: len(driver.find_elements(By.CSS_SELECTOR, selector)) == 0,
f"CSS selector [{selector}] to become absent",
**kwds,
)
return element
[docs] def wait_for_element_count_of_at_least(self, selector_template: Target, n: int, **kwds) -> WebElement:
element = self._wait_on(
lambda driver: len(driver.find_elements(*selector_template.element_locator)) >= n,
f"{selector_template.description} to become visible",
**kwds,
)
return element
[docs] def wait_for_absent(self, selector_template: Target, **kwds) -> WebElement:
element = self._wait_on(
lambda driver: len(driver.find_elements(*selector_template.element_locator)) == 0,
f"{selector_template.description} to become absent",
**kwds,
)
return element
[docs] def wait_for_absent_or_hidden(self, selector_template: Target, **kwds) -> WebElement:
element = self._wait_on(
ec.invisibility_of_element_located(selector_template.element_locator),
f"{selector_template.description} to become absent or hidden",
**kwds,
)
return element
[docs] def wait_for_id(self, id: str, **kwds) -> WebElement:
return self._wait_on(ec.presence_of_element_located((By.ID, id)), f"presence of DOM ID [{id}]", **kwds)
[docs] def click(self, selector_template: Target):
element = self.driver.find_element(*selector_template.element_locator)
element.click()
def _timeout_message(self, on_str: str) -> str:
return f"Timeout waiting on {on_str}."
def _wait_on(self, condition, on_str: Optional[str] = None, **kwds):
if on_str is None:
on_str = str(condition)
wait = self.wait(**kwds)
return wait.until(condition, self._timeout_message(on_str))
[docs] def action_chains(self):
return ActionChains(self.driver)
[docs] def send_enter(self, element: Optional[WebElement] = None):
self._send_key(Keys.ENTER, element)
[docs] def send_escape(self, element: Optional[WebElement] = None):
self._send_key(Keys.ESCAPE, element)
[docs] def send_backspace(self, element: Optional[WebElement] = None):
self._send_key(Keys.BACKSPACE, element)
def _send_key(self, key: str, element: Optional[WebElement] = None):
if element is None:
self.action_chains().send_keys(key)
else:
element.send_keys(key)
[docs] @abc.abstractmethod
def timeout_for(self, **kwds) -> float: ...
[docs] def wait(self, timeout=UNSPECIFIED_TIMEOUT, **kwds):
if timeout is UNSPECIFIED_TIMEOUT:
timeout = self.timeout_for(**kwds)
return WebDriverWait(self.driver, timeout)
[docs] def click_xpath(self, xpath: str):
element = self.driver.find_element(By.XPATH, xpath)
element.click()
[docs] def click_label(self, text: str):
element = self.driver.find_element(By.LINK_TEXT, text)
element.click()
[docs] def click_selector(self, selector: str):
element = self.driver.find_element(By.CSS_SELECTOR, selector)
element.click()
[docs] def fill(self, form: WebElement, info: dict):
for key, value in info.items():
try:
input_element = form.find_element(By.NAME, key)
except NoSuchElementException:
input_element = form.find_element(By.ID, key)
input_element.send_keys(value)
[docs] def click_submit(self, form: WebElement):
submit_button = form.find_element(By.CSS_SELECTOR, "input[type='submit']")
submit_button.click()
[docs] def prepend_timeout_message(
self, timeout_exception: SeleniumTimeoutException, message: str
) -> SeleniumTimeoutException:
msg = message
if timeout_msg := timeout_exception.msg:
msg += f" {timeout_msg}"
return SeleniumTimeoutException(
msg=msg,
screen=timeout_exception.screen,
stacktrace=timeout_exception.stacktrace,
)
[docs] def accept_alert(self):
try:
alert = self.driver.switch_to.alert
alert.accept()
finally:
self.driver.switch_to.default_content()
[docs] def find_element_by_link_text(self, text: str, element: Optional[WebElement] = None) -> WebElement:
return self._locator_aware(element).find_element(By.LINK_TEXT, text)
[docs] def find_element_by_xpath(self, xpath: str, element: Optional[WebElement] = None) -> WebElement:
return self._locator_aware(element).find_element(By.XPATH, xpath)
[docs] def find_element_by_id(self, id: str, element: Optional[WebElement] = None) -> WebElement:
return self._locator_aware(element).find_element(By.ID, id)
[docs] def find_element_by_selector(self, selector: str, element: Optional[WebElement] = None) -> WebElement:
return self._locator_aware(element).find_element(By.CSS_SELECTOR, selector)
[docs] def axe_eval(self, context: Optional[str] = None, write_to: Optional[str] = None) -> AxeResults:
if self.axe_skip:
return NullAxeResults()
content = get_axe_script(self.axe_script_url)
self.driver.execute_script(content)
axe = Axe(self.driver)
results = axe.run(context=context)
if write_to is not None:
axe.write_results(results, write_to)
return RealAxeResults(results)
def _locator_aware(self, element: Optional[WebElement] = None) -> HasFindElement:
if element is None:
return self.driver
else:
return element
[docs]def exception_indicates_click_intercepted(exception):
return "click intercepted" in str(exception)
[docs]def exception_indicates_not_clickable(exception):
return "not clickable" in str(exception)
[docs]def exception_indicates_stale_element(exception):
return "stale" in str(exception)
__all__ = (
"exception_indicates_click_intercepted",
"exception_indicates_not_clickable",
"exception_indicates_stale_element",
"HasDriver",
"SeleniumTimeoutException",
)