use LASTNAME, firstname (Role) format in header

This format is a convention used across clinical applications.
It used to be mandated as part of the common interface standard.
Although it is not mandated any more, we don't want to diverge from the
convention without a good reason.

Constructing `role_and_text` in the template itself is a bit awkward.
We can't put it in jinja_env.py because we need access to `request.user`.
We could create a context processor for this, but the
django docs discourage using context processors with jinja:
https://docs.djangoproject.com/en/5.2/topics/templates/#django.template.backends.jinja2.Jinja2

Author: MatMoore

manage_breast_screening/config/jinja2_env.py

@@ -2,49 +2,14 @@
 from django.templatetags.static import static
 from django.urls import reverse
 from jinja2 import ChoiceLoader, Environment, PackageLoader
-from markupsafe import Markup, escape
 
-
-def no_wrap(value):
-    """
-    Wrap a string in a span with class app-no-wrap
-
-    >>> no_wrap('a really long string')
-    Markup('<span class="nhsuk-u-nowrap">a really long string</span>')
-    """
-    return Markup(
-        f'<span class="nhsuk-u-nowrap">{escape(value)}</span>' if value else ""
-    )
-
-
-def nl2br(value):
-    """
-    Convert newline characters to html line breaks
-
-    >>> nl2br('foo\\nbar\\nbaz')
-    Markup('foo<br>bar<br>baz')
-
-    >>> nl2br('<script>\\n</script>')
-    Markup('&lt;script&gt;<br>&lt;/script&gt;')
-    """
-    lines = value.splitlines()
-    return Markup("<br>".join([escape(line) for line in lines]))
-
-
-def as_hint(value):
-    """
-    Wrap a string in a span with class nhsuk-u-secondary-text-color
-
-    >>> as_hint('Not provided')
-    Markup('<span class=nhsuk-u-secondary-text-color">Not provided</span>')
-    """
-    return Markup(
-        f'<span class=nhsuk-u-secondary-text-color">{value}</span>' if value else ""
-    )
-
-
-def raise_helper(msg):
-    raise Exception(msg)
+from manage_breast_screening.core.template_helpers import (
+    as_hint,
+    header_account_items,
+    nl2br,
+    no_wrap,
+    raise_helper,
+)
 
 
 def autoescape(template_name):
@@ -82,10 +47,17 @@ def environment(**options):
         )
 
     env.globals.update(
-        {"static": static, "url": reverse, "STATIC_URL": settings.STATIC_URL}
+        {
+            "STATIC_URL": settings.STATIC_URL,
+            "header_account_items": header_account_items,
+            "raise": raise_helper,
+            "static": static,
+            "url": reverse,
+        }
     )
+
     env.filters["no_wrap"] = no_wrap
     env.filters["as_hint"] = as_hint
     env.filters["nl2br"] = nl2br
-    env.globals["raise"] = raise_helper
+
     return env

manage_breast_screening/core/jinja2/layout-app.jinja

@@ -6,28 +6,15 @@
   <link rel="stylesheet" href="{{ static('css/main.css' )}}">
 {% endblock %}
 
-{% block pageTitle %}{% if form and form.errors %}Error: {% endif %}{% if page_title %}{{page_title}} – {% endif %}Manage breast screening – NHS{% endblock %}
+{% block pageTitle %}{% if form and form.errors %}Error: {% endif %}{% if page_title %}{{ page_title }} – {% endif %}Manage breast screening – NHS{% endblock %}
 
 {% block header %}
-  {% set account_items = [] %}
-  {% if request.user.is_authenticated %}
-    {% do account_items.append({
-      "text": request.user.first_name ~ ' ' ~ request.user.last_name,
-      "icon": true
-    }) %}
-  {% endif %}
-
-  {% do account_items.append({
-      "href": url('auth:logout') if request and request.user.is_authenticated else url('auth:login'),
-      "text": "Log out" if request and request.user.is_authenticated else "Log in",
-  }) %}
-
   {{ header({
     "service": {
       "name": "Manage breast screening"
     },
     "account": {
-      "items": account_items
+      "items": header_account_items(request.user)
     },
     "navigation": {
       "items": [

manage_breast_screening/core/template_helpers.py

@@ -0,0 +1,75 @@
+from django.urls import reverse
+from markupsafe import Markup, escape
+
+
+def no_wrap(value):
+    """
+    Wrap a string in a span with class app-no-wrap
+
+    >>> no_wrap('a really long string')
+    Markup('<span class="nhsuk-u-nowrap">a really long string</span>')
+    """
+    return Markup(
+        f'<span class="nhsuk-u-nowrap">{escape(value)}</span>' if value else ""
+    )
+
+
+def nl2br(value):
+    """
+    Convert newline characters to html line breaks
+
+    >>> nl2br('foo\\nbar\\nbaz')
+    Markup('foo<br>bar<br>baz')
+
+    >>> nl2br('<script>\\n</script>')
+    Markup('&lt;script&gt;<br>&lt;/script&gt;')
+    """
+    lines = value.splitlines()
+    return Markup("<br>".join([escape(line) for line in lines]))
+
+
+def as_hint(value):
+    """
+    Wrap a string in a span with class nhsuk-u-secondary-text-color
+
+    >>> as_hint('Not provided')
+    Markup('<span class=nhsuk-u-secondary-text-color">Not provided</span>')
+    """
+    return Markup(
+        f'<span class=nhsuk-u-secondary-text-color">{value}</span>' if value else ""
+    )
+
+
+def raise_helper(msg):
+    raise Exception(msg)
+
+
+def _user_name_and_role_item(user):
+    if user.is_authenticated:
+        name_and_role_text = f"{user.last_name.upper()}, {user.first_name}"
+        roles = list(user.groups.all())
+        if roles:
+            name_and_role_text += f" ({', '.join(role.name for role in roles)})"
+
+        return {"text": name_and_role_text, "icon": True}
+
+
+def header_account_items(user):
+    items = []
+
+    user_name_and_role = _user_name_and_role_item(user)
+    if user_name_and_role:
+        items.append(user_name_and_role)
+
+    items.append(
+        {
+            "href": (
+                reverse("auth:logout")
+                if user.is_authenticated
+                else reverse("auth:login")
+            ),
+            "text": "Log out" if user.is_authenticated else "Log in",
+        }
+    )
+
+    return items

manage_breast_screening/core/tests/test_template_helpers.py

@@ -0,0 +1,30 @@
+import pytest
+from django.contrib.auth.models import AnonymousUser
+
+from manage_breast_screening.auth.tests.factories import UserFactory
+from manage_breast_screening.core.template_helpers import header_account_items
+
+
+@pytest.mark.django_db
+class TestHeaderAccountItems:
+    def test_user_with_no_role(self):
+        user = UserFactory.create(first_name="Firstname", last_name="Lastname")
+        assert header_account_items(user) == [
+            {"text": "LASTNAME, Firstname", "icon": True},
+            {"href": "/auth/log-out/", "text": "Log out"},
+        ]
+
+    def test_user_with_role(self):
+        user = UserFactory.create(
+            first_name="Firstname", last_name="Lastname", groups__clinical=True
+        )
+        assert header_account_items(user) == [
+            {"text": "LASTNAME, Firstname (Clinical)", "icon": True},
+            {"href": "/auth/log-out/", "text": "Log out"},
+        ]
+
+    def test_anonymous_user(self):
+        user = AnonymousUser()
+        assert header_account_items(user) == [
+            {"href": "/auth/log-in/", "text": "Log in"},
+        ]