#!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# Selenium Tests
#
# Copyright 2017-2022 Univention GmbH
#
# https://www.univention.de/
#
# All rights reserved.
#
# The source code of this program is made available
# under the terms of the GNU Affero General Public License version 3
# (GNU AGPL V3) as published by the Free Software Foundation.
#
# Binary versions of this program provided by Univention to you as
# well as other copyrighted, protected or trademarked materials like
# Logos, graphics, fonts, specific documentations and configurations,
# cryptographic keys etc. are subject to a license agreement between
# you and Univention and not subject to the GNU AGPL V3.
#
# In the case you use this program under the terms of the GNU AGPL V3,
# the program is provided in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License with the Debian GNU/Linux or Univention distribution in file
# /usr/share/common-licenses/AGPL-3; if not, see
# <https://www.gnu.org/licenses/>.
from __future__ import absolute_import
import logging
from typing import Any, Callable, Iterable, List # noqa: F401
import selenium.common.exceptions as selenium_exceptions
from selenium import webdriver
from selenium.webdriver.support import expected_conditions
from univention.testing.selenium.utils import expand_path
logger = logging.getLogger(__name__)
[docs]class ChecksAndWaits(object):
[docs] def wait_for_text(self, text, timeout=60):
# type: (str, int) -> None
logger.info("Waiting for text: %r", text)
xpath = '//*[contains(text(), "%s")]' % (text,)
webdriver.support.ui.WebDriverWait([xpath], timeout).until(
self.get_all_visible_elements, 'waited %s seconds for text %r' % (timeout, text)
)
[docs] def wait_for_any_text_in_list(self, texts, timeout=60):
# type: (Iterable[str], int) -> None
logger.info("Waiting until any of those texts is visible: %r", texts)
xpaths = ['//*[contains(text(), "%s")]' % (text,) for text in texts]
webdriver.support.ui.WebDriverWait(xpaths, timeout).until(
self.get_all_visible_elements, 'waited %s seconds for texts %r' % (timeout, texts)
)
[docs] def wait_for_text_to_disappear(self, text, timeout=60):
# type: (object, int) -> None
xpath = '//*[contains(text(), "%s")]' % (text,)
webdriver.support.ui.WebDriverWait(xpath, timeout).until(
self.elements_invisible, 'waited %s seconds for text %r to disappear' % (timeout, text)
)
[docs] def wait_until_all_dialogues_closed(self):
# type: () -> None
logger.info("Waiting for all dialogues to close.")
xpath = '//*[contains(concat(" ", normalize-space(@class), " "), " dijitDialogUnderlay ")]'
webdriver.support.ui.WebDriverWait(xpath, timeout=60).until(
self.elements_invisible, 'wait_until_all_dialogues_closed() timeout=60'
)
[docs] def wait_until_all_standby_animations_disappeared(self, timeout=60):
# type: (int) -> None
logger.info("Waiting for all standby animations to disappear.")
xpath = expand_path('//*[contains(@id, "_Standby_")]//*[@containsClass="umcStandbySvgWrapper"]')
webdriver.support.ui.WebDriverWait(xpath, timeout).until(
self.elements_invisible, 'wait_until_all_standby_animations_disappeared(timeout=%r)' % (timeout,)
)
[docs] def wait_until_standby_animation_appears(self, timeout=5):
# type: (int) -> None
logger.info("Waiting for standby animation to appear.")
xpath = expand_path('//*[contains(@id, "_Standby_")]//*[@containsClass="umcStandbySvgWrapper"]')
try:
webdriver.support.ui.WebDriverWait(xpath, timeout).until(
self.elements_visible, 'wait_until_standby_animation_appears(timeout=%r)' % (timeout,)
)
except selenium_exceptions.TimeoutException:
logger.info("No standby animation appeared during timeout. Ignoring")
else:
logger.info("Found standby animation")
[docs] def wait_until_standby_animation_appears_and_disappears(self, appear_timeout=5, disappear_timeout=60):
# type: (int, int) -> None
self.wait_until_standby_animation_appears(timeout=appear_timeout)
self.wait_until_all_standby_animations_disappeared(timeout=disappear_timeout)
[docs] def wait_until_progress_bar_finishes(self, timeout=300):
# type: (int) -> None
logger.info("Waiting for all progress bars to disappear.")
xpath = '//*[contains(concat(" ", normalize-space(@class), " "), " umcProgressBar ")]'
webdriver.support.ui.WebDriverWait(xpath, timeout=timeout).until(
self.elements_invisible, 'waited %s seconds for progress bar' % (timeout,)
)
[docs] def wait_until_element_visible(self, xpath, timeout=60):
# type: (str, int) -> None
logger.info('Waiting for the element with the xpath %r to be visible.' % (xpath,))
self.wait_until(
expected_conditions.visibility_of_element_located(
(webdriver.common.by.By.XPATH, xpath)
),
timeout=timeout
)
[docs] def wait_until(self, check_function, timeout=60):
# type: (Callable[..., Any], int) -> None
webdriver.support.ui.WebDriverWait(self.driver, timeout).until(
check_function, 'wait_until(%r, timeout=%r)' % (check_function, timeout)
)
[docs] def get_gallery_items(self):
# type: () -> List[str]
items = self.get_all_visible_elements(['//div[contains(concat(" ", normalize-space(@class), " "), " umcGalleryName ")]'])
return [item.text for item in items]
[docs] def get_all_visible_elements(self, xpaths):
# type: (Iterable[str]) -> List[Any]
try:
return [
elem
for xpath in xpaths
for elem in self.driver.find_elements_by_xpath(xpath)
if elem.is_displayed()
]
except selenium_exceptions.StaleElementReferenceException:
pass
return []
[docs] def elements_invisible(self, xpath):
# type: (Iterable[str]) -> bool
elems = self.driver.find_elements_by_xpath(xpath)
try:
return all(not elem.is_displayed() for elem in elems)
except selenium_exceptions.StaleElementReferenceException:
pass
return False
[docs] def elements_visible(self, xpath):
# type: (Iterable[str]) -> bool
elems = self.driver.find_elements_by_xpath(xpath)
try:
return any(elem.is_displayed() for elem in elems)
except selenium_exceptions.StaleElementReferenceException:
pass
return False
[docs] def wait_for_element_by_css_selector(self, css_selector, message='', timeout=60):
# type: (str, str, int) -> Any
return webdriver.support.ui.WebDriverWait(self.driver, timeout).until(
expected_conditions.presence_of_element_located((webdriver.common.by.By.CSS_SELECTOR, css_selector)),
message
)
