copilot-swe-agent[bot]
8098856186
Enable Zammad settings via mock and verify user data appears in the rendered HTML. Add tests for chat widget, email-only fallback, and display_name fallback. Also improve JS variable naming in help.html. Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
315 lines
12 KiB
Python
315 lines
12 KiB
Python
"""Tests for app/views/help.py module – user-facing Help Center."""
|
||
|
||
import pytest
|
||
|
||
|
||
@pytest.mark.integration
|
||
class TestHelpViews:
|
||
"""Tests for the Help Center view routes."""
|
||
|
||
def test_help_returns_200(self, client):
|
||
"""GET /help should return the Help Center page."""
|
||
response = client.get("/help")
|
||
assert response.status_code == 200
|
||
|
||
def test_help_contains_help_center_title(self, client):
|
||
"""The page should contain the Help Center heading."""
|
||
response = client.get("/help")
|
||
assert b"Help Center" in response.content
|
||
|
||
def test_help_contains_quick_start_section(self, client):
|
||
"""The page should contain the Quick Start section."""
|
||
response = client.get("/help")
|
||
assert b"Quick Start" in response.content
|
||
|
||
def test_help_contains_sources_section(self, client):
|
||
"""The page should contain the Sources section."""
|
||
response = client.get("/help")
|
||
assert b"Sources" in response.content
|
||
|
||
def test_help_contains_destinations_section(self, client):
|
||
"""The page should contain the Destinations section."""
|
||
response = client.get("/help")
|
||
assert b"Destinations" in response.content
|
||
|
||
def test_help_contains_faq_section(self, client):
|
||
"""The page should contain the FAQ section."""
|
||
response = client.get("/help")
|
||
assert b"Frequently Asked Questions" in response.content
|
||
|
||
def test_help_contains_support_section(self, client):
|
||
"""The page should contain the Contact Support section."""
|
||
response = client.get("/help")
|
||
assert b"Contact Support" in response.content
|
||
|
||
def test_help_route_is_registered(self, client):
|
||
"""Verify the /help route exists in the app router."""
|
||
response = client.get("/help")
|
||
assert response.status_code != 405
|
||
|
||
|
||
@pytest.mark.unit
|
||
class TestHelpViewUnit:
|
||
"""Unit tests for the help view module."""
|
||
|
||
def test_help_returns_200(self):
|
||
"""Verify the help center returns HTTP 200."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
with TestClient(app) as tc:
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
|
||
def test_help_page_has_seo_meta(self):
|
||
"""Verify SEO meta tags are present in the response."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
with TestClient(app) as tc:
|
||
resp = tc.get("/help")
|
||
assert b'name="description"' in resp.content
|
||
assert b'name="robots"' in resp.content
|
||
|
||
def test_help_page_has_structured_data(self):
|
||
"""Verify JSON-LD structured data is present."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
with TestClient(app) as tc:
|
||
resp = tc.get("/help")
|
||
assert b"application/ld+json" in resp.content
|
||
assert b"FAQPage" in resp.content
|
||
|
||
def test_docs_build_path_constant(self):
|
||
"""Verify _DOCS_BUILD_DIR is resolved relative to the app package."""
|
||
import pathlib
|
||
|
||
from app.views.help import _DOCS_BUILD_DIR
|
||
|
||
assert isinstance(_DOCS_BUILD_DIR, pathlib.Path)
|
||
# Should point to <repo_root>/docs_build
|
||
assert _DOCS_BUILD_DIR.name == "docs_build"
|
||
|
||
def test_zammad_chat_hidden_when_disabled(self):
|
||
"""Chat widget markup should not appear when Zammad chat is disabled."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
with TestClient(app) as tc:
|
||
resp = tc.get("/help")
|
||
# Default settings: zammad_chat_enabled=False → no chat script
|
||
assert b"ZammadChat" not in resp.content
|
||
|
||
def test_zammad_form_hidden_when_disabled(self):
|
||
"""Ticket form markup should not appear when Zammad form is disabled."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
with TestClient(app) as tc:
|
||
resp = tc.get("/help")
|
||
# Default settings: zammad_form_enabled=False → no form script
|
||
assert b"ZammadForm" not in resp.content
|
||
|
||
|
||
@pytest.mark.unit
|
||
class TestHelpViewUserContext:
|
||
"""Tests that user context is passed to Zammad widgets."""
|
||
|
||
@staticmethod
|
||
def _make_app_with_session(user_data: dict | None = None):
|
||
"""Build a minimal FastAPI app with session middleware and optional user session."""
|
||
from fastapi import FastAPI
|
||
from fastapi.testclient import TestClient
|
||
from starlette.middleware.sessions import SessionMiddleware
|
||
|
||
from app.views.help import router
|
||
|
||
app = FastAPI()
|
||
app.add_middleware(SessionMiddleware, secret_key="test-secret")
|
||
app.include_router(router)
|
||
tc = TestClient(app)
|
||
|
||
if user_data is not None:
|
||
# Seed a session by setting the cookie through a helper endpoint
|
||
from fastapi import Request as _Req
|
||
from fastapi.responses import JSONResponse
|
||
|
||
@app.get("/_test_set_session")
|
||
async def _set_session(request: _Req):
|
||
request.session["user"] = user_data
|
||
return JSONResponse({"ok": True})
|
||
|
||
tc.get("/_test_set_session")
|
||
|
||
return tc
|
||
|
||
def test_user_context_not_in_page_when_anonymous(self):
|
||
"""Anonymous visitors should not see user context variables in the output."""
|
||
tc = self._make_app_with_session(user_data=None)
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
# No user context metadata should appear
|
||
assert b"DocuElevate User Context" not in resp.content
|
||
|
||
def test_user_context_rendered_in_zammad_form_when_logged_in(self):
|
||
"""With Zammad form enabled, logged-in user's name/email should appear in the script block."""
|
||
from unittest.mock import patch
|
||
|
||
tc = self._make_app_with_session(
|
||
user_data={
|
||
"name": "Test User",
|
||
"email": "test@example.com",
|
||
"preferred_username": "testuser",
|
||
}
|
||
)
|
||
with patch("app.views.help.settings") as mock_settings:
|
||
mock_settings.external_hostname = "localhost"
|
||
mock_settings.zammad_url = "https://zammad.example.com"
|
||
mock_settings.zammad_form_enabled = True
|
||
mock_settings.zammad_chat_enabled = False
|
||
mock_settings.zammad_chat_id = 1
|
||
mock_settings.support_email = None
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
assert b"Test User" in resp.content
|
||
assert b"test@example.com" in resp.content
|
||
assert b"testuser" in resp.content
|
||
assert b"DocuElevate User Context" in resp.content
|
||
|
||
def test_user_context_rendered_in_zammad_chat_when_logged_in(self):
|
||
"""With Zammad chat enabled, user's name/email should appear in the ZammadChat constructor."""
|
||
from unittest.mock import patch
|
||
|
||
tc = self._make_app_with_session(
|
||
user_data={
|
||
"name": "Chat User",
|
||
"email": "chat@example.com",
|
||
"preferred_username": "chatuser",
|
||
}
|
||
)
|
||
with patch("app.views.help.settings") as mock_settings:
|
||
mock_settings.external_hostname = "localhost"
|
||
mock_settings.zammad_url = "https://zammad.example.com"
|
||
mock_settings.zammad_form_enabled = False
|
||
mock_settings.zammad_chat_enabled = True
|
||
mock_settings.zammad_chat_id = 1
|
||
mock_settings.support_email = None
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
assert b"Chat User" in resp.content
|
||
assert b"chat@example.com" in resp.content
|
||
|
||
def test_user_id_falls_back_to_email(self):
|
||
"""When preferred_username is absent, user_id should resolve to email."""
|
||
from unittest.mock import patch
|
||
|
||
tc = self._make_app_with_session(
|
||
user_data={
|
||
"email": "only-email@example.com",
|
||
}
|
||
)
|
||
with patch("app.views.help.settings") as mock_settings:
|
||
mock_settings.external_hostname = "localhost"
|
||
mock_settings.zammad_url = "https://zammad.example.com"
|
||
mock_settings.zammad_form_enabled = True
|
||
mock_settings.zammad_chat_enabled = False
|
||
mock_settings.zammad_chat_id = 1
|
||
mock_settings.support_email = None
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
# user_id falls back to email; check it appears in the Username metadata line
|
||
content = resp.text
|
||
assert "only-email@example.com" in content
|
||
assert "DocuElevate User Context" in content
|
||
|
||
def test_user_name_falls_back_to_display_name(self):
|
||
"""When 'name' is absent, display_name should be used as the user_name fallback."""
|
||
from unittest.mock import patch
|
||
|
||
tc = self._make_app_with_session(
|
||
user_data={
|
||
"display_name": "Display Only",
|
||
"email": "display@example.com",
|
||
"id": "user-123",
|
||
}
|
||
)
|
||
with patch("app.views.help.settings") as mock_settings:
|
||
mock_settings.external_hostname = "localhost"
|
||
mock_settings.zammad_url = "https://zammad.example.com"
|
||
mock_settings.zammad_form_enabled = True
|
||
mock_settings.zammad_chat_enabled = False
|
||
mock_settings.zammad_chat_id = 1
|
||
mock_settings.support_email = None
|
||
resp = tc.get("/help")
|
||
assert resp.status_code == 200
|
||
# display_name used as fallback for user_name
|
||
assert b"Display Only" in resp.content
|
||
|
||
|
||
@pytest.mark.integration
|
||
class TestHelpNavigationLink:
|
||
"""Tests that the Help link appears in the navigation."""
|
||
|
||
def test_help_link_in_nav(self, client):
|
||
"""The Help navigation link should appear in the base template."""
|
||
response = client.get("/about")
|
||
assert response.status_code == 200
|
||
# The Help link should be present somewhere in the rendered page
|
||
assert b"/help" in response.content
|
||
|
||
def test_help_link_has_accessible_text(self, client):
|
||
"""The Help link should have visible text for accessibility."""
|
||
response = client.get("/about")
|
||
assert response.status_code == 200
|
||
content = response.text
|
||
# Should include the word "Help" associated with /help
|
||
assert "Help" in content
|
||
|
||
|
||
@pytest.mark.integration
|
||
class TestAdminDocsLinks:
|
||
"""Tests that admin doc links are in the admin menu markup."""
|
||
|
||
def test_api_docs_link_in_admin_menu(self, client):
|
||
"""The admin menu HTML should contain the API Docs link."""
|
||
response = client.get("/about")
|
||
assert response.status_code == 200
|
||
assert b"/admin/api-docs" in response.content
|
||
|
||
def test_developer_docs_link_in_admin_menu(self, client):
|
||
"""The admin menu HTML should contain the Developer Docs link."""
|
||
response = client.get("/about")
|
||
assert response.status_code == 200
|
||
assert b"/developer-docs/" in response.content
|