second commit
This commit is contained in:
@@ -0,0 +1,508 @@
|
||||
# Licensed to the Software Freedom Conservancy (SFC) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The SFC licenses this file
|
||||
# to you under the Apache License, Version 2.0 (the
|
||||
# "License"); you may not use this file except in compliance
|
||||
# with the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing,
|
||||
# software distributed under the License is distributed on an
|
||||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
# KIND, either express or implied. See the License for the
|
||||
# specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
import re
|
||||
|
||||
from selenium.common.exceptions import NoSuchElementException, InvalidSelectorException
|
||||
from selenium.common.exceptions import NoSuchFrameException
|
||||
from selenium.common.exceptions import StaleElementReferenceException
|
||||
from selenium.common.exceptions import WebDriverException
|
||||
from selenium.common.exceptions import NoAlertPresentException
|
||||
from selenium.webdriver.remote.webdriver import WebElement
|
||||
|
||||
"""
|
||||
* Canned "Expected Conditions" which are generally useful within webdriver
|
||||
* tests.
|
||||
"""
|
||||
|
||||
|
||||
def title_is(title):
|
||||
"""An expectation for checking the title of a page.
|
||||
title is the expected title, which must be an exact match
|
||||
returns True if the title matches, false otherwise."""
|
||||
|
||||
def _predicate(driver):
|
||||
return driver.title == title
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def title_contains(title):
|
||||
""" An expectation for checking that the title contains a case-sensitive
|
||||
substring. title is the fragment of title expected
|
||||
returns True when the title matches, False otherwise
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
return title in driver.title
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def presence_of_element_located(locator):
|
||||
""" An expectation for checking that an element is present on the DOM
|
||||
of a page. This does not necessarily mean that the element is visible.
|
||||
locator - used to find the element
|
||||
returns the WebElement once it is located
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
return driver.find_element(*locator)
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def url_contains(url):
|
||||
""" An expectation for checking that the current url contains a
|
||||
case-sensitive substring.
|
||||
url is the fragment of url expected,
|
||||
returns True when the url matches, False otherwise
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
return url in driver.current_url
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def url_matches(pattern):
|
||||
"""An expectation for checking the current url.
|
||||
pattern is the expected pattern, which must be an exact match
|
||||
returns True if the url matches, false otherwise."""
|
||||
|
||||
def _predicate(driver):
|
||||
return bool(re.search(pattern, driver.current_url))
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def url_to_be(url):
|
||||
"""An expectation for checking the current url.
|
||||
url is the expected url, which must be an exact match
|
||||
returns True if the url matches, false otherwise."""
|
||||
|
||||
def _predicate(driver):
|
||||
return url == driver.current_url
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def url_changes(url):
|
||||
"""An expectation for checking the current url.
|
||||
url is the expected url, which must not be an exact match
|
||||
returns True if the url is different, false otherwise."""
|
||||
|
||||
def _predicate(driver):
|
||||
return url != driver.current_url
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def visibility_of_element_located(locator):
|
||||
""" An expectation for checking that an element is present on the DOM of a
|
||||
page and visible. Visibility means that the element is not only displayed
|
||||
but also has a height and width that is greater than 0.
|
||||
locator - used to find the element
|
||||
returns the WebElement once it is located and visible
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
return _element_if_visible(driver.find_element(*locator))
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def visibility_of(element):
|
||||
""" An expectation for checking that an element, known to be present on the
|
||||
DOM of a page, is visible. Visibility means that the element is not only
|
||||
displayed but also has a height and width that is greater than 0.
|
||||
element is the WebElement
|
||||
returns the (same) WebElement once it is visible
|
||||
"""
|
||||
|
||||
def _predicate(_):
|
||||
return _element_if_visible(element)
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def _element_if_visible(element, visibility=True):
|
||||
return element if element.is_displayed() == visibility else False
|
||||
|
||||
|
||||
def presence_of_all_elements_located(locator):
|
||||
""" An expectation for checking that there is at least one element present
|
||||
on a web page.
|
||||
locator is used to find the element
|
||||
returns the list of WebElements once they are located
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
return driver.find_elements(*locator)
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def visibility_of_any_elements_located(locator):
|
||||
""" An expectation for checking that there is at least one element visible
|
||||
on a web page.
|
||||
locator is used to find the element
|
||||
returns the list of WebElements once they are located
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
return [element for element in driver.find_elements(*locator) if _element_if_visible(element)]
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def visibility_of_all_elements_located(locator):
|
||||
""" An expectation for checking that all elements are present on the DOM of a
|
||||
page and visible. Visibility means that the elements are not only displayed
|
||||
but also has a height and width that is greater than 0.
|
||||
locator - used to find the elements
|
||||
returns the list of WebElements once they are located and visible
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
elements = driver.find_elements(*locator)
|
||||
for element in elements:
|
||||
if _element_if_visible(element, visibility=False):
|
||||
return False
|
||||
return elements
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def text_to_be_present_in_element(locator, text_):
|
||||
""" An expectation for checking if the given text is present in the
|
||||
specified element.
|
||||
locator, text
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
element_text = driver.find_element(*locator).text
|
||||
return text_ in element_text
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def text_to_be_present_in_element_value(locator, text_):
|
||||
"""
|
||||
An expectation for checking if the given text is present in the element's value.
|
||||
locator, text
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
element_text = driver.find_element(*locator).get_attribute("value")
|
||||
return text_ in element_text
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def text_to_be_present_in_element_attribute(locator, attribute_, text_):
|
||||
"""
|
||||
An expectation for checking if the given text is present in the element's attribute.
|
||||
locator, attribute, text
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
if not element_attribute_to_include(locator, attribute_)(driver):
|
||||
return False
|
||||
element_text = driver.find_element(*locator).get_attribute(attribute_)
|
||||
return text_ in element_text
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def frame_to_be_available_and_switch_to_it(locator):
|
||||
""" An expectation for checking whether the given frame is available to
|
||||
switch to. If the frame is available it switches the given driver to the
|
||||
specified frame.
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
if hasattr(locator, '__iter__'):
|
||||
driver.switch_to.frame(driver.find_element(*locator))
|
||||
else:
|
||||
driver.switch_to.frame(locator)
|
||||
return True
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except NoSuchFrameException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def invisibility_of_element_located(locator):
|
||||
""" An Expectation for checking that an element is either invisible or not
|
||||
present on the DOM.
|
||||
|
||||
locator used to find the element
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
target = locator
|
||||
if not isinstance(target, WebElement):
|
||||
target = driver.find_element(*target)
|
||||
return _element_if_visible(target, False)
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except (NoSuchElementException, StaleElementReferenceException):
|
||||
# In the case of NoSuchElement, returns true because the element is
|
||||
# not present in DOM. The try block checks if the element is present
|
||||
# but is invisible.
|
||||
# In the case of StaleElementReference, returns true because stale
|
||||
# element reference implies that element is no longer visible.
|
||||
return True
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def invisibility_of_element(element):
|
||||
""" An Expectation for checking that an element is either invisible or not
|
||||
present on the DOM.
|
||||
|
||||
element is either a locator (text) or an WebElement
|
||||
"""
|
||||
return invisibility_of_element_located(element)
|
||||
|
||||
|
||||
def element_to_be_clickable(mark):
|
||||
"""
|
||||
An Expectation for checking an element is visible and enabled such that
|
||||
you can click it.
|
||||
|
||||
element is either a locator (text) or an WebElement
|
||||
"""
|
||||
|
||||
# renamed argument to 'mark', to indicate that both locator
|
||||
# and WebElement args are valid
|
||||
def _predicate(driver):
|
||||
target = mark
|
||||
if not isinstance(target, WebElement): # if given locator instead of WebElement
|
||||
target = driver.find_element(*target) # grab element at locator
|
||||
target = visibility_of(target)(driver)
|
||||
if target and target.is_enabled():
|
||||
return target
|
||||
else:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def staleness_of(element):
|
||||
""" Wait until an element is no longer attached to the DOM.
|
||||
element is the element to wait for.
|
||||
returns False if the element is still attached to the DOM, true otherwise.
|
||||
"""
|
||||
|
||||
def _predicate(_):
|
||||
try:
|
||||
# Calling any method forces a staleness check
|
||||
element.is_enabled()
|
||||
return False
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return True
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def element_to_be_selected(element):
|
||||
""" An expectation for checking the selection is selected.
|
||||
element is WebElement object
|
||||
"""
|
||||
|
||||
def _predicate(_):
|
||||
return element.is_selected()
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def element_located_to_be_selected(locator):
|
||||
"""An expectation for the element to be located is selected.
|
||||
locator is a tuple of (by, path)"""
|
||||
|
||||
def _predicate(driver):
|
||||
return driver.find_element(*locator).is_selected()
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def element_selection_state_to_be(element, is_selected):
|
||||
""" An expectation for checking if the given element is selected.
|
||||
element is WebElement object
|
||||
is_selected is a Boolean."
|
||||
"""
|
||||
|
||||
def _predicate(_):
|
||||
return element.is_selected() == is_selected
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def element_located_selection_state_to_be(locator, is_selected):
|
||||
""" An expectation to locate an element and check if the selection state
|
||||
specified is in that state.
|
||||
locator is a tuple of (by, path)
|
||||
is_selected is a boolean
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
element = driver.find_element(*locator)
|
||||
return element.is_selected() == is_selected
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def number_of_windows_to_be(num_windows):
|
||||
""" An expectation for the number of windows to be a certain value."""
|
||||
|
||||
def _predicate(driver):
|
||||
return len(driver.window_handles) == num_windows
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def new_window_is_opened(current_handles):
|
||||
""" An expectation that a new window will be opened and have the number of
|
||||
windows handles increase"""
|
||||
|
||||
def _predicate(driver):
|
||||
return len(driver.window_handles) > len(current_handles)
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def alert_is_present():
|
||||
def _predicate(driver):
|
||||
try:
|
||||
return driver.switch_to.alert
|
||||
except NoAlertPresentException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def element_attribute_to_include(locator, attribute_):
|
||||
""" An expectation for checking if the given attribute is included in the
|
||||
specified element.
|
||||
locator, attribute
|
||||
"""
|
||||
|
||||
def _predicate(driver):
|
||||
try:
|
||||
element_attribute = driver.find_element(*locator).get_attribute(attribute_)
|
||||
return element_attribute is not None
|
||||
except InvalidSelectorException as e:
|
||||
raise e
|
||||
except StaleElementReferenceException:
|
||||
return False
|
||||
|
||||
return _predicate
|
||||
|
||||
|
||||
def any_of(*expected_conditions):
|
||||
""" An expectation that any of multiple expected conditions is true.
|
||||
Equivalent to a logical 'OR'.
|
||||
Returns results of the first matching condition, or False if none do. """
|
||||
|
||||
def any_of_condition(driver):
|
||||
for expected_condition in expected_conditions:
|
||||
try:
|
||||
result = expected_condition(driver)
|
||||
if result:
|
||||
return result
|
||||
except WebDriverException:
|
||||
pass
|
||||
return False
|
||||
|
||||
return any_of_condition
|
||||
|
||||
|
||||
def all_of(*expected_conditions):
|
||||
""" An expectation that all of multiple expected conditions is true.
|
||||
Equivalent to a logical 'AND'.
|
||||
Returns: When any ExpectedCondition is not met: False.
|
||||
When all ExpectedConditions are met: A List with each ExpectedCondition's return value. """
|
||||
|
||||
def all_of_condition(driver):
|
||||
results = []
|
||||
for expected_condition in expected_conditions:
|
||||
try:
|
||||
result = expected_condition(driver)
|
||||
if not result:
|
||||
return False
|
||||
results.append(result)
|
||||
except WebDriverException:
|
||||
return False
|
||||
return results
|
||||
|
||||
return all_of_condition
|
||||
|
||||
|
||||
def none_of(*expected_conditions):
|
||||
""" An expectation that none of 1 or multiple expected conditions is true.
|
||||
Equivalent to a logical 'NOT-OR'.
|
||||
Returns a Boolean """
|
||||
|
||||
def none_of_condition(driver):
|
||||
for expected_condition in expected_conditions:
|
||||
try:
|
||||
result = expected_condition(driver)
|
||||
if result:
|
||||
return False
|
||||
except WebDriverException:
|
||||
pass
|
||||
return True
|
||||
|
||||
return none_of_condition
|
||||
Reference in New Issue
Block a user