Merge pull request #18 from unicef/feature/improvement

Updated flags and debug toolbar

Author: srugano

src/hope_live/config/fragments/debug_toolbar.py

@@ -14,8 +14,7 @@
 def show_ddt(request: "HttpRequest") -> bool:  # pragma: no-cover
     from flags.state import flag_enabled
 
-    return True
-    if request.path in RegexList(("/api/.*", "/dal/.*", "/healthcheck/", "/autocomplete/")):
+    if request.path in RegexList(("/api/.*", "/dal/.*", "/healthcheck/", "/autocomplete/.*")):
         return False
     return bool(flag_enabled("DEVELOP_DEBUG_TOOLBAR", request=request))
 

src/hope_live/config/fragments/flags.py

@@ -4,7 +4,18 @@
 
 FLAGS_STATE_LOGGING = DEBUG
 FLAGS: dict[str, list[Any]] = {
-    "LOCAL_LOGIN": [],
-    "DEVELOP_DEBUG_TOOLBAR": [],
+    "LOCAL_LOGIN": [
+        {"condition": "hostname", "value": "localhost,127.0.0.1"},
+    ]
+    if DEBUG
+    else [],
+    "DEVELOP_DEBUG_TOOLBAR": [
+        {"condition": "hostname", "value": "localhost,127.0.0.1"},
+    ]
+    if DEBUG
+    else [],
     "DJANGO_ADMIN": [],
 }
+
+# Register flag conditions
+from hope_live.utils.flags import *  # noqa: E402 F403

src/hope_live/theme/static_src/package-lock.json

@@ -0,0 +1,43 @@
+import contextlib
+from typing import TYPE_CHECKING, Any
+
+from adminfilters.utils import parse_bool
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from flags import state as flag_state
+from flags.conditions import conditions
+
+if TYPE_CHECKING:
+    from django.http import HttpRequest
+
+
+@contextlib.contextmanager
+def enable_flag(name: str) -> Any:
+    flag_state.enable_flag(name)
+    yield
+    flag_state.disable_flag(name)
+
+
+def validate_bool(value: str) -> None:
+    if value.lower() not in ["true", "1", "yes", "t", "y", "false", "0", "no", "f", "n"]:
+        raise ValidationError("Enter a valid bool")
+
+
+@conditions.register("superuser", validator=validate_bool)
+def superuser(value: str, request: "HttpRequest | None" = None, **kwargs: Any) -> bool:
+    if request is None:
+        return False
+    return request.user.is_superuser == parse_bool(value)
+
+
+@conditions.register("debug", validator=validate_bool)
+def debug(value: str, **kwargs: Any) -> bool:
+    return parse_bool(value) == settings.DEBUG
+
+
+@conditions.register("hostname")
+def hostname(value: str, request: "HttpRequest | None" = None, **kwargs: Any) -> bool:
+    if request is None:
+        return False
+    host = request.get_host().split(":")[0]
+    return host in value.split(",")

src/hope_live/utils/flags.py

@@ -1,3 +1,4 @@
+import contextlib
 import os
 import sys
 from pathlib import Path
@@ -66,3 +67,23 @@ def user_role_factory():
     from factories import UserRoleFactory
 
     return UserRoleFactory
+
+
+@pytest.fixture
+def admin_user(db):
+    from hope_live.models import User
+
+    return User.objects.create_superuser(username="admin", email="[email protected]", password="password")
+
+
+@pytest.fixture(autouse=True)
+def cleanup_flags(db):
+    from django.db import DatabaseError, transaction
+    from flags.models import FlagState
+
+    yield
+
+    # Try to cleanup, but if it fails (e.g., due to broken transaction), just skip it
+    # The test database will be destroyed after the test run anyway
+    with contextlib.suppress(DatabaseError, transaction.TransactionManagementError):
+        FlagState.objects.all().delete()

tests/conftest.py

@@ -0,0 +1,92 @@
+from typing import TYPE_CHECKING
+from unittest import mock
+
+import pytest
+from django.core.exceptions import ValidationError
+
+from hope_live.utils.flags import debug, hostname, superuser, validate_bool
+
+if TYPE_CHECKING:
+    from django.http import HttpRequest
+
+
+@pytest.mark.parametrize("value", ["true", "1", "yes", "t", "y", "false", "0", "no", "f", "n"])
+def test_validate_bool(value):
+    validate_bool(value)  # No exception should be raised
+
+
+@pytest.mark.parametrize("value", ["a", "9"])
+def test_validate_bool_fail(value):
+    with pytest.raises(ValidationError):
+        assert validate_bool(value)
+
+
+@pytest.mark.parametrize("value", ["t", "tRue", "yes", "1"])
+def test_superuser(rf, value, admin_user):
+    request = rf.get("/")
+    request.user = admin_user
+    assert superuser(value, request)
+
+
+@pytest.mark.parametrize("value", ["t", "tRue", "yes", "1"])
+def test_debug(settings, value):
+    settings.DEBUG = True
+    assert debug(value)
+
+
+@pytest.mark.parametrize("value", ["myserver.com", "myserver.com:888", "myserver.com:443"])
+def test_hostname(value, rf):
+    request: HttpRequest = rf.get("/")
+    with mock.patch.object(request, "get_host", return_value=value):
+        assert hostname("myserver.com", request)
+
+
+def test_hostname_mismatch(rf):
+    request: HttpRequest = rf.get("/")
+    with mock.patch.object(request, "get_host", return_value="production.com"):
+        assert not hostname("localhost", request)
+
+
+@pytest.mark.parametrize("path", ["/api/data/", "/dal/autocomplete/", "/healthcheck/", "/autocomplete/user/"])
+def test_show_ddt_excluded_paths(rf, settings, path):
+    from hope_live.config.fragments.debug_toolbar import show_ddt
+
+    settings.DEBUG = True
+    request = rf.get(path)
+    with mock.patch.object(request, "get_host", return_value="localhost:8000"):
+        assert show_ddt(request) is False
+
+
+def test_show_ddt_allowed_path(rf, settings):
+    from flags.models import FlagState
+
+    from hope_live.config.fragments.debug_toolbar import show_ddt
+
+    settings.DEBUG = True
+    FlagState.objects.create(
+        name="DEVELOP_DEBUG_TOOLBAR",
+        condition="hostname",
+        value="localhost,127.0.0.1",
+    )
+
+    request = rf.get("/dashboard/")
+    with mock.patch.object(request, "get_host", return_value="localhost:8000"):
+        assert request.path == "/dashboard/"
+        assert show_ddt(request) is True
+
+
+def test_show_ddt_production_hostname(rf, settings):
+    from flags.models import FlagState
+
+    from hope_live.config.fragments.debug_toolbar import show_ddt
+
+    settings.DEBUG = True
+    FlagState.objects.create(
+        name="DEVELOP_DEBUG_TOOLBAR",
+        condition="hostname",
+        value="localhost,127.0.0.1",
+    )
+
+    request = rf.get("/dashboard/")
+    with mock.patch.object(request, "get_host", return_value="dashboard-hope-dev.unitst.org:443"):
+        assert show_ddt(request) is False