arthexis 0.1.19__py3-none-any.whl → 0.1.20__py3-none-any.whl

pages/tests.py

@@ -3,6 +3,7 @@ import os
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
 
 import django
+import pytest
 
 django.setup()
 
@@ -508,6 +509,7 @@ class InvitationTests(TestCase):
         lead = InviteLead.objects.get()
         self.assertEqual(lead.mac_address, "aa:bb:cc:dd:ee:ff")
 
+    @pytest.mark.feature("ap-router")
     @patch("pages.views.public_wifi.grant_public_access")
     @patch(
         "pages.views.public_wifi.resolve_mac_address",
@@ -1360,6 +1362,7 @@ class SiteAdminRegisterCurrentTests(TestCase):
         self.assertEqual(site.name, "")
 
 
+@pytest.mark.feature("screenshot-poll")
 class SiteAdminScreenshotTests(TestCase):
     def setUp(self):
         self.client = Client()
@@ -1479,17 +1482,17 @@ class NavAppsTests(TestCase):
         )
         app = Application.objects.create(name="Readme")
         Module.objects.create(
-            node_role=role, application=app, path="/", is_default=True, menu="Cookbook"
+            node_role=role, application=app, path="/", is_default=True, menu="Cookbooks"
         )
 
     def test_nav_pill_renders(self):
         resp = self.client.get(reverse("pages:index"))
-        self.assertContains(resp, "COOKBOOK")
+        self.assertContains(resp, "COOKBOOKS")
         self.assertContains(resp, "badge rounded-pill")
 
     def test_nav_pill_renders_with_port(self):
         resp = self.client.get(reverse("pages:index"), HTTP_HOST="127.0.0.1:8000")
-        self.assertContains(resp, "COOKBOOK")
+        self.assertContains(resp, "COOKBOOKS")
 
     def test_nav_pill_uses_menu_field(self):
         site_app = Module.objects.get()
@@ -1497,7 +1500,7 @@ class NavAppsTests(TestCase):
         site_app.save()
         resp = self.client.get(reverse("pages:index"))
         self.assertContains(resp, 'badge rounded-pill text-bg-secondary">DOCS')
-        self.assertNotContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOK')
+        self.assertNotContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOKS')
 
     def test_app_without_root_url_excluded(self):
         role = NodeRole.objects.get(name="Terminal")
@@ -1562,20 +1565,22 @@ class RoleLandingRedirectTests(TestCase):
 
     def test_satellite_redirects_to_dashboard(self):
         target = self._configure_role_landing(
-            "Satellite", "/ocpp/", "CPMS Online Dashboard"
+            "Satellite", "/ocpp/cpms/dashboard/", "CPMS Online Dashboard"
         )
         resp = self.client.get(reverse("pages:index"))
         self.assertRedirects(resp, target, fetch_redirect_response=False)
 
     def test_control_redirects_to_rfid(self):
         target = self._configure_role_landing(
-            "Control", "/ocpp/rfid/", "RFID Tag Validator"
+            "Control", "/ocpp/rfid/validator/", "RFID Tag Validator"
         )
         resp = self.client.get(reverse("pages:index"))
         self.assertRedirects(resp, target, fetch_redirect_response=False)
 
     def test_security_group_redirect_takes_priority(self):
-        self._configure_role_landing("Control", "/ocpp/rfid/", "RFID Tag Validator")
+        self._configure_role_landing(
+            "Control", "/ocpp/rfid/validator/", "RFID Tag Validator"
+        )
         role = self.node.role
         group = SecurityGroup.objects.create(name="Operators")
         group_landing = self._ensure_landing(role, "/ocpp/group/", "Group Landing")
@@ -1592,7 +1597,9 @@ class RoleLandingRedirectTests(TestCase):
         )
 
     def test_user_redirect_overrides_group_with_higher_priority(self):
-        self._configure_role_landing("Control", "/ocpp/rfid/", "RFID Tag Validator")
+        self._configure_role_landing(
+            "Control", "/ocpp/rfid/validator/", "RFID Tag Validator"
+        )
         role = self.node.role
         group = SecurityGroup.objects.create(name="Operators")
         group_landing = self._ensure_landing(role, "/ocpp/group/", "Group Landing")
@@ -1614,10 +1621,10 @@ class RoleLandingRedirectTests(TestCase):
         )
 
 
-class ConstellationNavTests(TestCase):
+class WatchtowerNavTests(TestCase):
     def setUp(self):
         self.client = Client()
-        role, _ = NodeRole.objects.get_or_create(name="Constellation")
+        role, _ = NodeRole.objects.get_or_create(name="Watchtower")
         Node.objects.update_or_create(
             mac_address=Node.get_current_mac(),
             defaults={
@@ -1627,38 +1634,56 @@ class ConstellationNavTests(TestCase):
             },
         )
         Site.objects.update_or_create(
-            id=1, defaults={"domain": "testserver", "name": ""}
+            id=1, defaults={"domain": "arthexis.com", "name": "Arthexis"}
         )
         fixtures = [
             Path(
                 settings.BASE_DIR,
                 "pages",
                 "fixtures",
-                "constellation__application_ocpp.json",
+                "default__application_pages.json",
             ),
             Path(
                 settings.BASE_DIR,
                 "pages",
                 "fixtures",
-                "constellation__module_ocpp.json",
+                "watchtower__application_ocpp.json",
             ),
             Path(
                 settings.BASE_DIR,
                 "pages",
                 "fixtures",
-                "constellation__landing_ocpp_dashboard.json",
+                "watchtower__module_ocpp.json",
             ),
             Path(
                 settings.BASE_DIR,
                 "pages",
                 "fixtures",
-                "constellation__landing_ocpp_cp_simulator.json",
+                "watchtower__landing_ocpp_dashboard.json",
             ),
             Path(
                 settings.BASE_DIR,
                 "pages",
                 "fixtures",
-                "constellation__landing_ocpp_rfid.json",
+                "watchtower__landing_ocpp_cp_simulator.json",
+            ),
+            Path(
+                settings.BASE_DIR,
+                "pages",
+                "fixtures",
+                "watchtower__landing_ocpp_rfid.json",
+            ),
+            Path(
+                settings.BASE_DIR,
+                "pages",
+                "fixtures",
+                "watchtower__module_readme.json",
+            ),
+            Path(
+                settings.BASE_DIR,
+                "pages",
+                "fixtures",
+                "watchtower__landing_readme.json",
             ),
         ]
         call_command("loaddata", *map(str, fixtures))
@@ -1671,13 +1696,13 @@ class ConstellationNavTests(TestCase):
         self.assertNotIn("RFID", nav_labels)
         self.assertTrue(
             Module.objects.filter(
-                path="/ocpp/", node_role__name="Constellation"
+                path="/ocpp/", node_role__name="Watchtower"
             ).exists()
         )
         self.assertFalse(
             Module.objects.filter(
                 path="/ocpp/rfid/",
-                node_role__name="Constellation",
+                node_role__name="Watchtower",
                 is_deleted=False,
             ).exists()
         )
@@ -1689,9 +1714,16 @@ class ConstellationNavTests(TestCase):
         landing_labels = [landing.label for landing in ocpp_module.enabled_landings]
         self.assertIn("RFID Tag Validator", landing_labels)
 
+    @override_settings(ALLOWED_HOSTS=["testserver", "arthexis.com"])
+    def test_cookbooks_pill_visible_for_arthexis(self):
+        resp = self.client.get(
+            reverse("pages:index"), HTTP_HOST="arthexis.com"
+        )
+        self.assertContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOKS')
+
     def test_ocpp_dashboard_visible(self):
         resp = self.client.get(reverse("pages:index"))
-        self.assertContains(resp, 'href="/ocpp/"')
+        self.assertContains(resp, 'href="/ocpp/cpms/dashboard/"')
 
 
 class ReleaseModuleNavTests(TestCase):
@@ -1833,7 +1865,7 @@ class ControlNavTests(TestCase):
         self.client.force_login(user)
         resp = self.client.get(reverse("pages:index"))
         self.assertEqual(resp.status_code, 200)
-        self.assertContains(resp, 'href="/ocpp/"')
+        self.assertContains(resp, 'href="/ocpp/cpms/dashboard/"')
         self.assertContains(
             resp, 'badge rounded-pill text-bg-secondary">CHARGERS'
         )
@@ -1865,10 +1897,27 @@ class ControlNavTests(TestCase):
         self.assertFalse(resp.context["header_references"])
         self.assertNotContains(resp, "https://example.com/hidden")
 
+    def test_header_link_hidden_when_only_site_matches(self):
+        terminal_role, _ = NodeRole.objects.get_or_create(name="Terminal")
+        site = Site.objects.get(domain="testserver")
+        reference = Reference.objects.create(
+            alt_text="Restricted",
+            value="https://example.com/restricted",
+            show_in_header=True,
+        )
+        reference.roles.add(terminal_role)
+        reference.sites.add(site)
+
+        resp = self.client.get(reverse("pages:index"))
+
+        self.assertIn("header_references", resp.context)
+        self.assertFalse(resp.context["header_references"])
+        self.assertNotContains(resp, "https://example.com/restricted")
+
     def test_readme_pill_visible(self):
         resp = self.client.get(reverse("pages:readme"))
         self.assertContains(resp, 'href="/read/"')
-        self.assertContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOK')
+        self.assertContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOKS')
 
     def test_cookbook_pill_has_no_dropdown(self):
         module = Module.objects.get(node_role__name="Control", path="/read/")
@@ -1883,7 +1932,7 @@ class ControlNavTests(TestCase):
 
         self.assertContains(
             resp,
-            '<a class="nav-link" href="/read/"><span class="badge rounded-pill text-bg-secondary">COOKBOOK</span></a>',
+            '<a class="nav-link" href="/read/"><span class="badge rounded-pill text-bg-secondary">COOKBOOKS</span></a>',
             html=True,
         )
         self.assertNotContains(resp, 'dropdown-item" href="/man/"')
@@ -1990,7 +2039,7 @@ class SatelliteNavTests(TestCase):
     def test_readme_pill_visible(self):
         resp = self.client.get(reverse("pages:readme"))
         self.assertContains(resp, 'href="/read/"')
-        self.assertContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOK')
+        self.assertContains(resp, 'badge rounded-pill text-bg-secondary">COOKBOOKS')
 
 
 class PowerNavTests(TestCase):
@@ -2025,9 +2074,9 @@ class PowerNavTests(TestCase):
                 power_module = module
                 break
         self.assertIsNotNone(power_module)
-        self.assertEqual(power_module.menu_label.upper(), "CALCULATE")
+        self.assertEqual(power_module.menu_label.upper(), "CALCULATORS")
         landing_labels = {landing.label for landing in power_module.enabled_landings}
-        self.assertIn("AWG Calculator", landing_labels)
+        self.assertIn("AWG Cable Calculator", landing_labels)
 
     def test_manual_pill_label(self):
         resp = self.client.get(reverse("pages:index"))
@@ -2051,9 +2100,26 @@ class PowerNavTests(TestCase):
                 break
         self.assertIsNotNone(power_module)
         landing_labels = {landing.label for landing in power_module.enabled_landings}
-        self.assertIn("AWG Calculator", landing_labels)
+        self.assertIn("AWG Cable Calculator", landing_labels)
         self.assertIn("Energy Tariff Calculator", landing_labels)
 
+    def test_locked_landing_shows_lock_icon(self):
+        resp = self.client.get(reverse("pages:index"))
+        html = resp.content.decode()
+        energy_index = html.find("Energy Tariff Calculator")
+        self.assertGreaterEqual(energy_index, 0)
+        icon_index = html.find("dropdown-lock-icon", energy_index, energy_index + 300)
+        self.assertGreaterEqual(icon_index, 0)
+
+    def test_lock_icon_disappears_after_login(self):
+        self.client.force_login(self.user)
+        resp = self.client.get(reverse("pages:index"))
+        html = resp.content.decode()
+        energy_index = html.find("Energy Tariff Calculator")
+        self.assertGreaterEqual(energy_index, 0)
+        icon_index = html.find("dropdown-lock-icon", energy_index, energy_index + 300)
+        self.assertEqual(icon_index, -1)
+
 
 class StaffNavVisibilityTests(TestCase):
     def setUp(self):
@@ -2075,12 +2141,12 @@ class StaffNavVisibilityTests(TestCase):
     def test_nonstaff_pill_hidden(self):
         self.client.login(username="user", password="pw")
         resp = self.client.get(reverse("pages:index"))
-        self.assertContains(resp, 'href="/ocpp/"')
+        self.assertContains(resp, 'href="/ocpp/cpms/dashboard/"')
 
     def test_staff_sees_pill(self):
         self.client.login(username="staff", password="pw")
         resp = self.client.get(reverse("pages:index"))
-        self.assertContains(resp, 'href="/ocpp/"')
+        self.assertContains(resp, 'href="/ocpp/cpms/dashboard/"')
 
 
 class ModuleAdminReloadActionTests(TestCase):
@@ -2093,7 +2159,7 @@ class ModuleAdminReloadActionTests(TestCase):
             password="pw",
         )
         self.client.force_login(self.superuser)
-        self.role, _ = NodeRole.objects.get_or_create(name="Constellation")
+        self.role, _ = NodeRole.objects.get_or_create(name="Watchtower")
         Application.objects.get_or_create(name="ocpp")
         Application.objects.get_or_create(name="awg")
         Site.objects.update_or_create(
@@ -2131,7 +2197,11 @@ class ModuleAdminReloadActionTests(TestCase):
         )
         self.assertSetEqual(
             charger_landings,
-            {"/ocpp/", "/ocpp/simulator/", "/ocpp/rfid/"},
+            {
+                "/ocpp/cpms/dashboard/",
+                "/ocpp/evcs/simulator/",
+                "/ocpp/rfid/validator/",
+            },
         )
 
         calculator_landings = set(
@@ -2331,12 +2401,12 @@ class LandingCreationTests(TestCase):
 
 
 class LandingFixtureTests(TestCase):
-    def test_constellation_fixture_loads_without_duplicates(self):
+    def test_watchtower_fixture_loads_without_duplicates(self):
         from glob import glob
 
-        NodeRole.objects.get_or_create(name="Constellation")
+        NodeRole.objects.get_or_create(name="Watchtower")
         fixtures = glob(
-            str(Path(settings.BASE_DIR, "pages", "fixtures", "constellation__*.json"))
+            str(Path(settings.BASE_DIR, "pages", "fixtures", "watchtower__*.json"))
         )
         fixtures = sorted(
             fixtures,
@@ -2346,9 +2416,11 @@ class LandingFixtureTests(TestCase):
         )
         call_command("loaddata", *fixtures)
         call_command("loaddata", *fixtures)
-        module = Module.objects.get(path="/ocpp/", node_role__name="Constellation")
+        module = Module.objects.get(path="/ocpp/", node_role__name="Watchtower")
         module.create_landings()
-        self.assertEqual(module.landings.filter(path="/ocpp/rfid/").count(), 1)
+        self.assertEqual(
+            module.landings.filter(path="/ocpp/rfid/validator/").count(), 1
+        )
 
 
 class AllowedHostSubnetTests(TestCase):
@@ -2501,9 +2573,9 @@ class FaviconTests(TestCase):
             )
             self.assertContains(resp, b64)
 
-    def test_constellation_nodes_use_goldenrod_favicon(self):
+    def test_watchtower_nodes_use_goldenrod_favicon(self):
         with override_settings(MEDIA_ROOT=self.tmpdir):
-            role, _ = NodeRole.objects.get_or_create(name="Constellation")
+            role, _ = NodeRole.objects.get_or_create(name="Watchtower")
             Node.objects.update_or_create(
                 mac_address=Node.get_current_mac(),
                 defaults={
@@ -2518,7 +2590,7 @@ class FaviconTests(TestCase):
             resp = self.client.get(reverse("pages:index"))
             b64 = (
                 Path(settings.BASE_DIR)
-                .joinpath("pages", "fixtures", "data", "favicon_constellation.txt")
+                .joinpath("pages", "fixtures", "data", "favicon_watchtower.txt")
                 .read_text()
                 .strip()
             )

pages/urls.py

@@ -6,6 +6,7 @@ app_name = "pages"
 
 urlpatterns = [
     path("", views.index, name="index"),
+    path("read/<path:doc>/edit/", views.readme_edit, name="readme-edit"),
     path("read/", views.readme, name="readme"),
     path("read/<path:doc>", views.readme, name="readme-document"),
     path("sitemap.xml", views.sitemap, name="pages-sitemap"),

pages/views.py

@@ -439,7 +439,7 @@ def admin_model_graph(request, app_label: str):
     return response
 
 
-def _render_readme(request, role, doc: str | None = None):
+def _locate_readme_document(role, doc: str | None, lang: str) -> SimpleNamespace:
     app = (
         Module.objects.filter(node_role=role, is_default=True)
         .select_related("application")
@@ -448,9 +448,8 @@ def _render_readme(request, role, doc: str | None = None):
     app_slug = app.path.strip("/") if app else ""
     root_base = Path(settings.BASE_DIR).resolve()
     readme_base = (root_base / app_slug).resolve() if app_slug else root_base
-    lang = getattr(request, "LANGUAGE_CODE", "")
-    lang = lang.replace("_", "-").lower()
-    candidates = []
+    candidates: list[Path] = []
+
     if doc:
         normalized = doc.strip().replace("\\", "/")
         while normalized.startswith("./"):
@@ -501,23 +500,72 @@ def _render_readme(request, role, doc: str | None = None):
                 if short != lang:
                     candidates.append(root_base / f"README.{short}.md")
             candidates.append(root_base / "README.md")
+
     readme_file = next((p for p in candidates if p.exists()), None)
     if readme_file is None:
         raise Http404("Document not found")
-    text = readme_file.read_text(encoding="utf-8")
-    html, toc_html = _render_markdown_with_toc(text)
+
     title = "README" if readme_file.name.startswith("README") else readme_file.stem
+    return SimpleNamespace(
+        file=readme_file,
+        title=title,
+        root_base=root_base,
+    )
+
+
+def _relative_readme_path(readme_file: Path, root_base: Path) -> str | None:
+    try:
+        return readme_file.relative_to(root_base).as_posix()
+    except ValueError:
+        return None
+
+
+def _render_readme(request, role, doc: str | None = None):
+    lang = getattr(request, "LANGUAGE_CODE", "")
+    lang = lang.replace("_", "-").lower()
+    document = _locate_readme_document(role, doc, lang)
+    text = document.file.read_text(encoding="utf-8")
+    html, toc_html = _render_markdown_with_toc(text)
+    relative_path = _relative_readme_path(document.file, document.root_base)
+    user = getattr(request, "user", None)
+    can_edit = bool(
+        relative_path
+        and user
+        and user.is_authenticated
+        and user.is_superuser
+    )
+    edit_url = None
+    if can_edit:
+        try:
+            edit_url = reverse("pages:readme-edit", kwargs={"doc": relative_path})
+        except NoReverseMatch:
+            edit_url = None
     context = {
         "content": html,
-        "title": title,
+        "title": document.title,
         "toc": toc_html,
         "page_url": request.build_absolute_uri(),
+        "edit_url": edit_url,
     }
     response = render(request, "pages/readme.html", context)
     patch_vary_headers(response, ["Accept-Language", "Cookie"])
     return response
 
 
+class MarkdownDocumentForm(forms.Form):
+    content = forms.CharField(
+        widget=forms.Textarea(
+            attrs={
+                "class": "form-control",
+                "rows": 24,
+                "spellcheck": "false",
+            }
+        ),
+        required=False,
+        strip=False,
+    )
+
+
 @landing("Home")
 @never_cache
 def index(request):
@@ -573,6 +621,57 @@ def readme(request, doc=None):
     return _render_readme(request, role, doc)
 
 
+def readme_edit(request, doc):
+    user = getattr(request, "user", None)
+    if not (user and user.is_authenticated and user.is_superuser):
+        raise PermissionDenied
+
+    node = Node.get_local()
+    role = node.role if node else None
+    lang = getattr(request, "LANGUAGE_CODE", "")
+    lang = lang.replace("_", "-").lower()
+    document = _locate_readme_document(role, doc, lang)
+    relative_path = _relative_readme_path(document.file, document.root_base)
+    if relative_path:
+        read_url = reverse("pages:readme-document", kwargs={"doc": relative_path})
+    else:
+        read_url = reverse("pages:readme")
+
+    if request.method == "POST":
+        form = MarkdownDocumentForm(request.POST)
+        if form.is_valid():
+            content = form.cleaned_data["content"]
+            try:
+                document.file.write_text(content, encoding="utf-8")
+            except OSError:
+                logger.exception("Failed to update markdown document %s", document.file)
+                messages.error(
+                    request,
+                    _("Unable to save changes. Please try again."),
+                )
+            else:
+                messages.success(request, _("Document saved successfully."))
+                if relative_path:
+                    return redirect("pages:readme-edit", doc=relative_path)
+                return redirect("pages:readme")
+    else:
+        try:
+            initial_text = document.file.read_text(encoding="utf-8")
+        except OSError:
+            logger.exception("Failed to read markdown document %s", document.file)
+            messages.error(request, _("Unable to load the document for editing."))
+            return redirect("pages:readme")
+        form = MarkdownDocumentForm(initial={"content": initial_text})
+
+    context = {
+        "form": form,
+        "title": document.title,
+        "relative_path": relative_path,
+        "read_url": read_url,
+    }
+    return render(request, "pages/readme_edit.html", context)
+
+
 def sitemap(request):
     site = get_site(request)
     node = Node.get_local()
@@ -1005,13 +1104,14 @@ class ClientReportForm(forms.Form):
         label=_("Month"),
         required=False,
         widget=forms.DateInput(attrs={"type": "month"}),
+        input_formats=["%Y-%m"],
         help_text=_("Generates the report for the calendar month that you select."),
     )
     owner = forms.ModelChoiceField(
         queryset=get_user_model().objects.all(),
         required=False,
         help_text=_(
-            "Sets who owns the report schedule and is listed as the requestor."
+            "Sets who owns the report schedule and is listed as the requester."
         ),
     )
     destinations = forms.CharField(