import os import threading import time from typing import List import pytest from selenium import webdriver from selenium.common.exceptions import ElementNotInteractableException, NoSuchElementException from selenium.webdriver import ActionChains from selenium.webdriver.common.by import By from selenium.webdriver.remote.webelement import WebElement from nicegui import globals, ui PORT = 3392 IGNORED_CLASSES = ['row', 'column', 'q-card', 'q-field', 'q-field__label', 'q-input'] def remove_prefix(text: str, prefix: str) -> str: if prefix and text.startswith(prefix): return text[len(prefix):] return text class Screen: SCREENSHOT_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'screenshots') UI_RUN_KWARGS = {'port': PORT, 'show': False, 'reload': False} def __init__(self, selenium: webdriver.Chrome, caplog: pytest.LogCaptureFixture) -> None: self.selenium = selenium self.caplog = caplog self.server_thread = None def start_server(self) -> None: '''Start the webserver in a separate thread. This is the equivalent of `ui.run()` in a normal script.''' self.server_thread = threading.Thread(target=ui.run, kwargs=self.UI_RUN_KWARGS) self.server_thread.start() @property def is_open(self) -> None: # https://stackoverflow.com/a/66150779/3419103 try: self.selenium.current_url return True except: return False def stop_server(self) -> None: '''Stop the webserver.''' self.close() globals.server.should_exit = True self.server_thread.join() def open(self, path: str) -> None: if self.server_thread is None: self.start_server() start = time.time() while True: try: self.selenium.get(f'http://localhost:{PORT}{path}') break except Exception: if time.time() - start > 3: raise time.sleep(0.1) if not self.server_thread.is_alive(): raise RuntimeError('The NiceGUI server has stopped running') def close(self) -> None: if self.is_open: self.selenium.close() def should_contain(self, text: str) -> None: assert self.selenium.title == text or self.find(text), f'could not find "{text}"' def should_not_contain(self, text: str) -> None: assert self.selenium.title != text with pytest.raises(AssertionError): self.find(text) def click(self, target_text: str) -> WebElement: element = self.find(target_text) try: element.click() except ElementNotInteractableException: raise AssertionError(f'Could not click on "{target_text}" on:\n{element.get_attribute("outerHTML")}') return element def click_at_position(self, element: WebElement, x: int, y: int) -> None: action = ActionChains(self.selenium) action.move_to_element_with_offset(element, x, y).click().perform() def find(self, text: str) -> WebElement: try: query = f'//*[not(self::script) and not(self::style) and contains(text(), "{text}")]' return self.selenium.find_element(By.XPATH, query) except NoSuchElementException: raise AssertionError(f'Could not find "{text}"') def render_js_logs(self) -> str: console = '\n'.join(l['message'] for l in self.selenium.get_log('browser')) return f'-- console logs ---\n{console}\n---------------------' def get_tags(self, name: str) -> List[WebElement]: return self.selenium.find_elements(By.TAG_NAME, name) def get_attributes(self, tag: str, attribute: str) -> List[str]: return [t.get_attribute(attribute) for t in self.get_tags(tag)] def wait(self, t: float) -> None: time.sleep(t) def wait_for(self, text: str, *, timeout: float = 1.0) -> None: deadline = time.time() + timeout while time.time() < deadline: try: self.find(text) return except: self.wait(0.1) raise TimeoutError() def shot(self, name: str) -> None: os.makedirs(self.SCREENSHOT_DIR, exist_ok=True) filename = f'{self.SCREENSHOT_DIR}/{name}.png' print(f'Storing screenshot to {filename}') self.selenium.get_screenshot_as_file(filename) def assert_py_logger(self, *logs: str) -> None: self.wait(1.0) # NOTE: wait for caplog assert len(self.caplog.records) == len(logs), \ f'Expected {len(logs)} log message(s) but got {len(self.caplog.records)}' for log, record in zip(logs, self.caplog.records): print(record.levelname, record.message) level, message = map(str.strip, log.split(': ')) assert record.levelname.strip() == level, f'Expected "{level}" but got "{record.levelname}"' assert record.message.strip() == message, f'Expected "{message}" but got "{record.message}"' self.caplog.records.clear()