"""authentik e2e testing utilities""" import socket from collections.abc import Callable from functools import cached_property, lru_cache, wraps from json import JSONDecodeError, dumps, loads from os import environ, getenv from pathlib import Path from sys import stderr from tempfile import gettempdir from time import sleep from typing import Any from urllib.parse import urlencode from django.apps import apps from django.contrib.staticfiles.testing import StaticLiveServerTestCase from django.db import connection from django.db.migrations.loader import MigrationLoader from django.test.testcases import TransactionTestCase from django.urls import reverse from docker.models.containers import Container from dramatiq import get_broker from requests import RequestException from selenium import webdriver from selenium.common.exceptions import ( DetachedShadowRootException, NoSuchElementException, NoSuchShadowRootException, StaleElementReferenceException, TimeoutException, WebDriverException, ) from selenium.webdriver.common.by import By from selenium.webdriver.common.keys import Keys from selenium.webdriver.remote.command import Command from selenium.webdriver.remote.webdriver import WebDriver from selenium.webdriver.remote.webelement import WebElement from selenium.webdriver.support import expected_conditions as ec from selenium.webdriver.support.wait import WebDriverWait from structlog.stdlib import get_logger from authentik.core.api.users import UserSerializer from authentik.core.models import User from authentik.core.tests.utils import create_test_admin_user from authentik.lib.utils.http import get_http_session from authentik.tasks.test import use_test_broker from tests.docker import DockerTestCase IS_CI = "CI" in environ RETRIES = int(environ.get("RETRIES", "3")) if IS_CI else 1 SHADOW_ROOT_RETRIES = 5 JSONType = dict[str, Any] | list[Any] | str | int | float | bool | None def get_local_ip(override=True) -> str: """Get the local machine's IP""" if (local_ip := getenv("LOCAL_IP")) and override: return local_ip hostname = socket.gethostname() ip_addr = socket.gethostbyname(hostname) return ip_addr class SeleniumTestCase(DockerTestCase, StaticLiveServerTestCase): """StaticLiveServerTestCase which automatically creates a Webdriver instance""" host = get_local_ip() wait_timeout: int user: User def setUp(self): if IS_CI: print("::group::authentik Logs", file=stderr) apps.get_app_config("authentik_tenants").ready() self.wait_timeout = 60 self.logger = get_logger() self.driver = self._get_driver() self.driver.implicitly_wait(30) self.wait = WebDriverWait(self.driver, self.wait_timeout) self.user = create_test_admin_user() super().setUp() def _get_driver(self) -> WebDriver: count = 0 opts = webdriver.ChromeOptions() opts.accept_insecure_certs = True opts.add_argument("--disable-search-engine-choice-screen") opts.add_extension(self._get_chrome_extension()) # This breaks selenium when running remotely...? # opts.set_capability("goog:loggingPrefs", {"browser": "ALL"}) opts.add_experimental_option( "prefs", { "profile.password_manager_leak_detection": False, }, ) while count < RETRIES: try: driver = webdriver.Remote( command_executor="http://localhost:4444/wd/hub", options=opts, ) driver.maximize_window() return driver except WebDriverException as exc: self.logger.warning("Failed to setup webdriver", exc=exc) count += 1 raise ValueError(f"Webdriver failed after {RETRIES}.") def _get_chrome_extension(self): path = Path(gettempdir()) / "ak-chrome.crx" try: self.logger.info("Downloading chrome extension...", path=path) res = get_http_session().get( "https://pkg.goauthentik.io/packages/authentik_browser-ext/browser-ext/authentik_chrome.zip", stream=True, ) with open(path, "w+b") as _ext: for chunk in res.iter_content(chunk_size=1024): if chunk: _ext.write(chunk) except RequestException as exc: if path.exists() and not IS_CI: self.logger.info( "Failed to download chrome extension, using cached copy", path=path ) return path raise exc return path @cached_property def driver_container(self) -> Container: return self.docker_client.containers.list(filters={"label": "io.goauthentik.tests"})[0] @classmethod def _pre_setup(cls): use_test_broker() return super()._pre_setup() def _post_teardown(self): broker = get_broker() broker.flush_all() broker.close() return super()._post_teardown() def tearDown(self): if IS_CI: print("::endgroup::", file=stderr) super().tearDown() if IS_CI: print("::group::Browser logs") # Very verbose way to get browser logs # https://github.com/SeleniumHQ/selenium/pull/15641 # for some reason this removes the `get_log` API from Remote Webdriver # and only keeps it on the local Chrome web driver, even when using # a remote chrome driver...? (nvm the fact this was released as a minor version) for line in self.driver.execute(Command.GET_LOG, {"type": "browser"})["value"]: print(line["message"]) if IS_CI: print("::endgroup::") self.driver.quit() def wait_for_url(self, desired_url: str): """Wait until URL is `desired_url`.""" def waiter(driver: WebDriver): current = driver.current_url return current == desired_url # We catch and re-throw the exception from `wait.until`, as we can supply it # an error message, however that message is evaluated when we call `.until()`, # not when the error is thrown, so the URL in the error message will be incorrect. try: self.wait.until(waiter) except TimeoutException as exc: raise TimeoutException( f"URL {self.driver.current_url} doesn't match expected URL {desired_url}. " f"HTML: {self.driver.page_source[:1000]}" ) from exc def url(self, view: str, query: dict | None = None, **kwargs) -> str: """reverse `view` with `**kwargs` into full URL using live_server_url""" url = self.live_server_url + reverse(view, kwargs=kwargs) if query: return url + "?" + urlencode(query) return url def if_user_url(self, path: str | None = None) -> str: """same as self.url() but show URL in shell""" url = self.url("authentik_core:if-user") if path: return f"{url}#{path}" return url def parse_json_content( self, context: WebElement | None = None, timeout: float | None = 10 ) -> JSONType: """ Parse JSON from a Selenium element's text content. If `context` is not provided, defaults to the
element. Raises a clear test failure if the element isn't found, the text doesn't appear within `timeout` seconds, or the text is not valid JSON. """ use_body = context is None wait_timeout = timeout or self.wait_timeout def get_context() -> WebElement: """Get or refresh the context element.""" if use_body: return self.driver.find_element(By.TAG_NAME, "body") return context def get_text_safely() -> str: """Get element text, re-finding element if stale.""" for _ in range(5): try: return get_context().text.strip() except StaleElementReferenceException: sleep(0.5) return get_context().text.strip() def get_inner_html_safely() -> str: """Get innerHTML, re-finding element if stale.""" for _ in range(5): try: return get_context().get_attribute("innerHTML") or "" except StaleElementReferenceException: sleep(0.5) return get_context().get_attribute("innerHTML") or "" try: get_context() except NoSuchElementException: self.fail( f"No element found (defaulted to ). Current URL: {self.driver.current_url}" ) wait = WebDriverWait(self.driver, wait_timeout) try: wait.until(lambda d: len(get_text_safely()) != 0) except TimeoutException: snippet = get_text_safely()[:500].replace("\n", " ") self.fail( f"Timed out waiting for element text to appear at {self.driver.current_url}. " f"Current content: {snippet or '