Warning
This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
Source code for galaxy.selenium.has_driver
"""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.
"""
from selenium.common.exceptions import TimeoutException
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.support import expected_conditions as ec
from selenium.webdriver.support.ui import WebDriverWait
UNSPECIFIED_TIMEOUT = object()
[docs]class HasDriver:
TimeoutException = TimeoutException
[docs] def assert_selector(self, selector):
assert self.driver.find_element_by_css_selector(selector)
[docs] def selector_is_displayed(self, selector):
element = self.driver.find_element_by_css_selector(selector)
return element.is_displayed()
[docs] def is_displayed(self, selector_template):
element = self.driver.find_element(*selector_template.element_locator)
return element.is_displayed()
[docs] def assert_selector_absent(self, selector):
assert len(self.driver.find_elements_by_css_selector(selector)) == 0
[docs] def find_elements(self, selector_template):
return self.driver.find_elements(*selector_template.element_locator)
[docs] def assert_absent(self, selector_template):
assert len(self.find_elements(selector_template)) == 0
[docs] def wait_for_xpath(self, xpath, **kwds):
element = self._wait_on(
ec.presence_of_element_located((By.XPATH, xpath)),
"XPATH selector [%s] to become present" % xpath,
**kwds
)
return element
[docs] def wait_for_xpath_visible(self, xpath, **kwds):
element = self._wait_on(
ec.visibility_of_element_located((By.XPATH, xpath)),
"XPATH selector [%s] to become visible" % xpath,
**kwds
)
return element
[docs] def wait_for_selector(self, selector, **kwds):
element = self._wait_on(
ec.presence_of_element_located((By.CSS_SELECTOR, selector)),
"CSS selector [%s] to become present" % selector,
**kwds
)
return element
[docs] def wait_for_present(self, selector_template, **kwds):
element = self._wait_on(
ec.presence_of_element_located(selector_template.element_locator),
"%s to become present" % selector_template.description,
**kwds
)
return element
[docs] def wait_for_visible(self, selector_template, **kwds):
element = self._wait_on(
ec.visibility_of_element_located(selector_template.element_locator),
"%s to become visible" % selector_template.description,
**kwds
)
return element
[docs] def wait_for_selector_visible(self, selector, **kwds):
element = self._wait_on(
ec.visibility_of_element_located((By.CSS_SELECTOR, selector)),
"CSS selector [%s] to become visible" % selector,
**kwds
)
return element
[docs] def wait_for_selector_clickable(self, selector, **kwds):
element = self._wait_on(
ec.element_to_be_clickable((By.CSS_SELECTOR, selector)),
"CSS selector [%s] to become clickable" % selector,
**kwds
)
return element
[docs] def wait_for_clickable(self, selector_template, **kwds):
element = self._wait_on(
ec.element_to_be_clickable(selector_template.element_locator),
"%s to become clickable" % selector_template.description,
**kwds
)
return element
[docs] def wait_for_selector_absent(self, selector, **kwds):
element = self._wait_on(
lambda driver: len(driver.find_elements_by_css_selector(selector)) == 0,
"CSS selector [%s] to become absent" % selector,
**kwds
)
return element
[docs] def wait_for_absent(self, selector_template, **kwds):
element = self._wait_on(
lambda driver: len(driver.find_elements(*selector_template.element_locator)) == 0,
"%s to become absent" % selector_template.description,
**kwds
)
return element
[docs] def wait_for_id(self, id, **kwds):
return self._wait_on(
ec.presence_of_element_located((By.ID, id)),
"presence of DOM ID [%s]" % id,
**kwds
)
[docs] def click(self, selector_template):
element = self.driver.find_element(*selector_template.element_locator)
element.click()
def _timeout_message(self, on_str):
return "Timeout waiting on %s." % on_str
def _wait_on(self, condition, on_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 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):
element = self.driver.find_element_by_xpath(xpath)
element.click()
[docs] def click_label(self, text):
element = self.driver.find_element_by_link_text(text)
element.click()
[docs] def click_selector(self, selector):
element = self.driver.find_element_by_css_selector(selector)
element.click()
[docs] def fill(self, form, info):
for key, value in info.items():
input_element = form.find_element_by_name(key)
input_element.send_keys(value)
[docs] def click_submit(self, form):
submit_button = form.find_element_by_css_selector("input[type='submit']")
submit_button.click()
[docs] def prepend_timeout_message(self, timeout_exception, message):
return TimeoutException(
msg=message + (timeout_exception.msg or ''),
screen=timeout_exception.screen,
stacktrace=timeout_exception.stacktrace,
)
__all__ = (
"exception_indicates_not_clickable",
"exception_indicates_stale_element",
"HasDriver",
"TimeoutException",
)