feat: add back button to settings/enable-2fa page to allow user to abort

Dockerfile.dev

@@ -21,7 +21,11 @@ RUN apt-get update && \
 RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 ENV PATH="/root/.cargo/bin:${PATH}"
 
-RUN pip install poetry
+RUN pip install poetry pytest-playwright
+
+# Playwright dependencies to run browsers
+RUN playwright install
+RUN playwright install-deps
 
 WORKDIR /app
 

Makefile

@@ -50,8 +50,13 @@ ifndef message
 endif
 	poetry run flask db revision -m "$(message)" --autogenerate
 
-TESTS ?= ./tests/
+TESTS ?= ./tests
 .PHONY: test
 test: ## Run the test suite
 	docker compose run --rm app \
 		poetry run pytest --cov hushline --cov-report term --cov-report html -vv $(PYTEST_ADDOPTS) $(TESTS)
+
+.PHONY: test/ui
+test/ui: # Only run the ui tests
+	docker compose run --rm app \
+		poetry run pytest --cov hushline --cov-report term --cov-report html -vv $(PYTEST_ADDOPTS) $(TESTS)/ui

hushline/templates/enable_2fa.html

@@ -2,6 +2,7 @@
 {% block title %}Settings{% endblock %}
 
 {% block content %}
+  <a href="{{ url_for('.auth') }}" class="back-button"><span class="icon chevron back"></span> Back to Authentication</a>
   <h2>Enable Two-Factor Authentication</h2>
   <p>
     Scan the QR code with your 2FA app or enter the text code below to enable

pyproject.toml

@@ -29,6 +29,8 @@ stripe = "^10.9.0"
 types-requests = "^2.32.0.20240712"
 types-setuptools = "^71.1.0.20240813"
 python = "^3.11"
+pytest-playwright = "^0.6.2"
+tenacity = "^9.0.0"
 
 [tool.poetry.group.dev.dependencies]
 beautifulsoup4 = "^4.12.3"

tests/ui/test_settings_enable_2fa.py

@@ -0,0 +1,43 @@
+import re
+
+from playwright.sync_api import Page, expect
+from tenacity import RetryCallState, retry, stop_after_attempt, wait_random_exponential
+
+BASE_URL = "http://127.0.0.1:8080"
+
+
+def log_retry_error(retry_state: RetryCallState) -> None:
+    if retry_state is None or retry_state.outcome is None:
+        return
+    print(f"Retrying due to error: {retry_state.outcome.exception()}")
+
+
+@retry(
+    wait=wait_random_exponential(min=1, max=60),
+    stop=stop_after_attempt(3),
+    retry_error_callback=log_retry_error,
+)
+def test_enable_2fa_has_back_button(page: Page, user_password: str) -> None:
+    page.goto(f"{BASE_URL}/login", wait_until="domcontentloaded")
+    page.get_by_label("Username").fill("test")
+    page.get_by_label("Password").fill(user_password)
+    page.get_by_role("button", name="Login").click()
+
+    page.goto(f"{BASE_URL}/settings/enable-2fa", wait_until="domcontentloaded")
+    expect(page.get_by_text("Back to Authentication")).to_be_visible()
+
+
+@retry(
+    wait=wait_random_exponential(min=1, max=60),
+    stop=stop_after_attempt(3),
+    retry_error_callback=log_retry_error,
+)
+def test_enable_2fa_back_button_returns(page: Page, user_password: str) -> None:
+    page.goto(f"{BASE_URL}/login", wait_until="domcontentloaded")
+    page.get_by_label("Username").fill("test")
+    page.get_by_label("Password").fill(user_password)
+    page.get_by_role("button", name="Login").click()
+
+    page.goto(f"{BASE_URL}/settings/enable-2fa", wait_until="domcontentloaded")
+    page.get_by_text("Back to Authentication").click()
+    expect(page).to_have_url(re.compile(".*auth"))