Merge pull request #246 from NHSDigital/banner

Align environment banner with Mavis

Author: mikejamesthompson

mavis/reporting/__init__.py

@@ -6,7 +6,6 @@
 from werkzeug.exceptions import Unauthorized
 
 from mavis.reporting.helpers import mavis_helper, url_helper
-from mavis.reporting.helpers.environment_helper import EnvType
 from mavis.reporting.jinja2_config import configure_jinja2
 
 if dsn := os.environ.get("SENTRY_DSN"):
@@ -43,7 +42,6 @@ def create_app(config_name=None):
     app.config["SECRET_KEY"] = os.environ["SECRET_KEY"]
 
     app.config["DEBUG"] = False
-    app.config["ENVIRONMENT"] = EnvType.PROD
     app.config["LOG_LEVEL"] = "INFO"
     app.config["SEND_FILE_MAX_AGE_DEFAULT"] = 31536000
     app.config["SESSION_TTL_SECONDS"] = 600
@@ -52,16 +50,12 @@ def create_app(config_name=None):
 
     if config_name == "development":
         app.config["DEBUG"] = True
-        app.config["ENVIRONMENT"] = EnvType.DEV
         app.config["LOG_LEVEL"] = "DEBUG"
         app.config["MAVIS_BACKEND_URL"] = os.environ["MAVIS_BACKEND_URL"]
     elif config_name == "test":
         app.config["DEBUG"] = True
-        app.config["ENVIRONMENT"] = EnvType.TEST
         app.config["LOG_LEVEL"] = "DEBUG"
         app.config["TESTING"] = True
-    elif config_name == "staging":
-        app.config["ENVIRONMENT"] = EnvType.STAGING
 
     configure_jinja2(app)
 

mavis/reporting/helpers/environment_helper.py

@@ -1,48 +1,49 @@
-from enum import Enum
-
-
-class EnvType(Enum):
-    PROD = "production"
-    DEV = "development"
-    REVIEW = "review"
-    STAGING = "staging"
-    TEST = "test"
-    QA = "qa"
-    PREVIEW = "preview"
-
-    def __str__(self):
-        return str(self.value)
-
-
-ENV_COLOUR = {
-    EnvType.PROD: "blue",
-    EnvType.DEV: "white",
-    EnvType.REVIEW: "purple",
-    EnvType.STAGING: "purple",
-    EnvType.TEST: "red",
-    EnvType.QA: "orange",
-    EnvType.PREVIEW: "yellow",
+import os
+
+ENVIRONMENT_COLOUR = {
+    "production": "blue",
+    "development": "white",
+    "review": "purple",
+    "test": "red",
+    "qa": "orange",
+    "preview": "yellow",
 }
 
+ENVIRONMENT_THEME_COLOUR = {
+    "production": "#005eb8",
+    "development": "#fff",
+    "review": "#d6cce3",
+    "test": "#f7d4d1",
+    "qa": "#ffdc8e",
+    "preview": "#fff59d",
+}
+
+
+class HostingEnvironment:
+    @classmethod
+    def name(cls) -> str:
+        return os.environ["SENTRY_ENVIRONMENT"]
 
-class Environment:
-    def __init__(self, type: EnvType):
-        self.type = type
+    @classmethod
+    def colour(cls) -> str:
+        return ENVIRONMENT_COLOUR.get(cls.name(), "white")
 
-    def is_production(self):
-        return self.type == EnvType.PROD
+    @classmethod
+    def theme_colour(cls) -> str:
+        return ENVIRONMENT_THEME_COLOUR.get(cls.name(), "#fff")
 
-    @property
-    def colour(self):
-        return ENV_COLOUR[self.type]
+    @classmethod
+    def title(cls) -> str:
+        if cls.name() == "qa":
+            return "QA"
+        return cls.name().capitalize()
 
-    @property
-    def title(self):
-        return str(self.type).capitalize()
+    @classmethod
+    def title_in_sentence(cls) -> str:
+        if cls.name() == "qa":
+            return "QA"
+        return cls.name()
 
-    @property
-    def title_in_sentence(self):
-        return (
-            f"This is a {self.type} environment."
-            + " Do not use it to make clinical decisions."
-        )
+    @classmethod
+    def is_production(cls) -> bool:
+        return cls.name() == "production"

mavis/reporting/templates/components/environment.jinja

@@ -7,7 +7,7 @@
       "classes": "nhsuk-tag--" + params.colour,
       "text": params.title,
     }) }}
-    <span>{{ params.title_in_sentence | safe }}</span>
+    <span>This is a {{ params.title_in_sentence }} environment. Do not use it to make clinical decisions.</span>
   </div>
 </div>
 {% endmacro %}

mavis/reporting/templates/layouts/base.jinja

@@ -17,9 +17,9 @@
 
 {% block header %}
 {{ environment({
-  "colour": app_environment.colour,
-  "title": app_environment.title,
-  "title_in_sentence": app_environment.title_in_sentence,
+  "colour": app_environment.colour(),
+  "title": app_environment.title(),
+  "title_in_sentence": app_environment.title_in_sentence(),
 }) if not app_environment.is_production() }}
 
 {{ header({

mavis/reporting/views.py

@@ -23,7 +23,7 @@
     get_current_academic_year_range,
     get_last_updated_time,
 )
-from mavis.reporting.helpers.environment_helper import Environment
+from mavis.reporting.helpers.environment_helper import HostingEnvironment
 from mavis.reporting.helpers.navigation_helper import build_navigation_items
 from mavis.reporting.helpers.secondary_nav_helper import generate_secondary_nav_items
 from mavis.reporting.models.team import Team
@@ -41,11 +41,9 @@ def stub_mavis_data():
 @main.context_processor
 def inject_mavis_data():
     """Inject common data into the template context."""
-    env = Environment(current_app.config["ENVIRONMENT"])
-
     return {
         "app_title": "Manage vaccinations in schools",
-        "app_environment": env,
+        "app_environment": HostingEnvironment,
         "navigation_items": build_navigation_items(request),
         "service_guide_url": "https://guide.manage-vaccinations-in-schools.nhs.uk",
     }

mise.development.toml

@@ -11,6 +11,7 @@ SOPS_AGE_KEY_FILE = "{{vars.secret_file}}"
 _.file = "{{vars.credentials_file}}"
 
 FLASK_ENV = "development"
+SENTRY_ENVIRONMENT = "development"
 MAVIS_BACKEND_URL = "http://localhost:4000"
 MAVIS_ROOT_URL = "http://localhost:4001/"
 ROOT_URL = "http://localhost:{{vars.port}}/"

mise.staging.toml

@@ -11,5 +11,6 @@ SOPS_AGE_KEY_FILE = "{{vars.secret_file}}"
 _.file = "{{vars.credentials_file}}"
 
 FLASK_ENV = "staging"
+# SENTRY_ENVIRONMENT = "configured by terraform/app/variables.tf in the mavis repo"
 MAVIS_ROOT_URL = "http://web:4000/"
 # ROOT_URL = "configured by terraform/app/variables.tf in the mavis repo"

tests/helpers/test_environment_helper.py

@@ -1,37 +1,94 @@
-from mavis.reporting.helpers.environment_helper import (
-    Environment,
-    EnvType,
-)
+import pytest
 
+from mavis.reporting.helpers.environment_helper import HostingEnvironment
 
-def test_environment_is_production_behaviour():
+
+def test_name_reads_from_sentry_environment(monkeypatch):
+    """Test that name reads from SENTRY_ENVIRONMENT env var."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.name() == "qa"
+
+
+def test_name_raises_when_sentry_environment_not_set(monkeypatch):
+    """Test that name raises KeyError when SENTRY_ENVIRONMENT is not set."""
+    monkeypatch.delenv("SENTRY_ENVIRONMENT", raising=False)
+    with pytest.raises(KeyError):
+        HostingEnvironment.name()
+
+
+def test_is_production_behaviour(monkeypatch):
     """Test that is_production behaves correctly for different environments."""
-    assert Environment(EnvType.PROD).is_production() is True
-    assert Environment(EnvType.DEV).is_production() is False
-    assert Environment(EnvType.STAGING).is_production() is False
-    assert Environment(EnvType.TEST).is_production() is False
-
-
-def test_environment_colour_property():
-    """Test that colour property returns correct color for each environment."""
-    assert Environment(EnvType.PROD).colour == "blue"
-    assert Environment(EnvType.DEV).colour == "white"
-    assert Environment(EnvType.STAGING).colour == "purple"
-    assert Environment(EnvType.TEST).colour == "red"
-
-
-def test_environment_title_property():
-    """Test that title property returns capitalized environment type."""
-    assert Environment(EnvType.PROD).title == "Production"
-    assert Environment(EnvType.DEV).title == "Development"
-    assert Environment(EnvType.STAGING).title == "Staging"
-
-
-def test_environment_title_in_sentence_property():
-    """Test that title_in_sentence property returns correct warning message."""
-    title_in_sentence = Environment(EnvType.DEV).title_in_sentence
-    assert (
-        title_in_sentence
-        == "This is a development environment."
-        + " Do not use it to make clinical decisions."
-    )
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "production")
+    assert HostingEnvironment.is_production() is True
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "development")
+    assert HostingEnvironment.is_production() is False
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.is_production() is False
+
+
+def test_colour(monkeypatch):
+    """Test that colour returns correct color for each environment."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "production")
+    assert HostingEnvironment.colour() == "blue"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "development")
+    assert HostingEnvironment.colour() == "white"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.colour() == "orange"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "test")
+    assert HostingEnvironment.colour() == "red"
+
+
+def test_colour_defaults_to_white_for_unknown(monkeypatch):
+    """Test that colour defaults to white for unknown environments."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "unknown")
+    assert HostingEnvironment.colour() == "white"
+
+
+def test_title(monkeypatch):
+    """Test that title returns capitalized environment name."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "production")
+    assert HostingEnvironment.title() == "Production"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "development")
+    assert HostingEnvironment.title() == "Development"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.title() == "QA"
+
+
+def test_title_in_sentence(monkeypatch):
+    """Test that title_in_sentence returns the environment name for sentences."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "development")
+    assert HostingEnvironment.title_in_sentence() == "development"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.title_in_sentence() == "QA"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "production")
+    assert HostingEnvironment.title_in_sentence() == "production"
+
+
+def test_theme_colour(monkeypatch):
+    """Test that theme_colour returns correct hex colour for each environment."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "production")
+    assert HostingEnvironment.theme_colour() == "#005eb8"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "development")
+    assert HostingEnvironment.theme_colour() == "#fff"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "qa")
+    assert HostingEnvironment.theme_colour() == "#ffdc8e"
+
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "test")
+    assert HostingEnvironment.theme_colour() == "#f7d4d1"
+
+
+def test_theme_colour_defaults_for_unknown(monkeypatch):
+    """Test that theme_colour defaults to white for unknown environments."""
+    monkeypatch.setenv("SENTRY_ENVIRONMENT", "unknown")
+    assert HostingEnvironment.theme_colour() == "#fff"