"""passbook e2e testing utilities""" from glob import glob from importlib.util import module_from_spec, spec_from_file_location from inspect import getmembers, isfunction from os import environ, makedirs from time import sleep, time from typing import Any, Dict, Optional from django.apps import apps from django.contrib.staticfiles.testing import StaticLiveServerTestCase from django.db import connection, transaction from django.db.utils import IntegrityError from django.shortcuts import reverse from docker import DockerClient, from_env from docker.models.containers import Container from selenium import webdriver from selenium.webdriver.common.desired_capabilities import DesiredCapabilities from selenium.webdriver.remote.webdriver import WebDriver from selenium.webdriver.support.ui import WebDriverWait from structlog import get_logger from passbook.core.models import User # pylint: disable=invalid-name def USER() -> User: # noqa """Cached function that always returns pbadmin""" return User.objects.get(username="pbadmin") class SeleniumTestCase(StaticLiveServerTestCase): """StaticLiveServerTestCase which automatically creates a Webdriver instance""" container: Optional[Container] = None def setUp(self): super().setUp() makedirs("selenium_screenshots/", exist_ok=True) self.driver = self._get_driver() self.driver.maximize_window() self.driver.implicitly_wait(10) self.wait = WebDriverWait(self.driver, 30) self.apply_default_data() self.logger = get_logger() if specs := self.get_container_specs(): self.container = self._start_container(specs) def _start_container(self, specs: Dict[str, Any]) -> Container: client: DockerClient = from_env() client.images.pull(specs['image']) container = client.containers.run(**specs) if "healthcheck" not in specs: return container while True: container.reload() status = container.attrs.get("State", {}).get("Health", {}).get("Status") if status == "healthy": return container self.logger.info("Container failed healthcheck") sleep(1) def get_container_specs(self) -> Optional[Dict[str, Any]]: """Optionally get container specs which will launched on setup, wait for the container to be healthy, and deleted again on tearDown""" return None def _get_driver(self) -> WebDriver: return webdriver.Remote( command_executor="http://localhost:4444/wd/hub", desired_capabilities=DesiredCapabilities.CHROME, ) def tearDown(self): if "TF_BUILD" in environ: screenshot_file = ( f"selenium_screenshots/{self.__class__.__name__}_{time()}.png" ) self.driver.save_screenshot(screenshot_file) self.logger.warning("Saved screenshot", file=screenshot_file) for line in self.driver.get_log("browser"): self.logger.warning( line["message"], source=line["source"], level=line["level"] ) if self.container: self.container.kill() self.driver.quit() super().tearDown() def wait_for_url(self, desired_url): """Wait until URL is `desired_url`.""" self.wait.until( lambda driver: driver.current_url == desired_url, f"URL {self.driver.current_url} doesn't match expected URL {desired_url}", ) def url(self, view, **kwargs) -> str: """reverse `view` with `**kwargs` into full URL using live_server_url""" return self.live_server_url + reverse(view, kwargs=kwargs) def apply_default_data(self): """apply objects created by migrations after tables have been truncated""" # Find all migration files # load all functions migration_files = glob("**/migrations/*.py", recursive=True) matches = [] for migration in migration_files: with open(migration, "r+") as migration_file: # Check if they have a `RunPython` if "RunPython" in migration_file.read(): matches.append(migration) with connection.schema_editor() as schema_editor: for match in matches: # Load module from file path spec = spec_from_file_location("", match) migration_module = module_from_spec(spec) # pyright: reportGeneralTypeIssues=false spec.loader.exec_module(migration_module) # Call all functions from module for _, func in getmembers(migration_module, isfunction): with transaction.atomic(): try: func(apps, schema_editor) except IntegrityError: pass