PPHA-266: Add ethnicity question page

jamiefalcus · jamiefalcus · commit f8de6e2f66b8 · 2025-11-03T15:07:26.000Z
diff --git a/lung_cancer_screening/core/tests/acceptance/helpers/user_interaction_helpers.py b/lung_cancer_screening/core/tests/acceptance/helpers/user_interaction_helpers.py
@@ -68,3 +68,11 @@ def fill_in_and_submit_gender(page, gender):
     page.get_by_label(gender, exact=True).check()
 
     page.click("text=Continue")
+
+def fill_in_and_submit_ethnicity(page, ethnicity):
+    expect(page.locator("legend")).to_have_text(
+        "What is your ethnic background?")
+
+    page.get_by_label(ethnicity, exact=True).check()
+
+    page.click("text=Continue")
diff --git a/lung_cancer_screening/core/tests/acceptance/test_cannot_change_answers_after_submission.py b/lung_cancer_screening/core/tests/acceptance/test_cannot_change_answers_after_submission.py
@@ -12,6 +12,7 @@
     fill_in_and_submit_date_of_birth,
     fill_in_and_submit_sex_at_birth,
     fill_in_and_submit_gender,
+    fill_in_and_submit_ethnicity
 )
 
 class TestQuestionnaire(StaticLiveServerTestCase):
@@ -44,6 +45,7 @@ def test_cannot_change_responses_once_checked_and_submitted(self):
         fill_in_and_submit_weight_metric(page, "25.4")
         fill_in_and_submit_sex_at_birth(page, "Male")
         fill_in_and_submit_gender(page, "Male")
+        fill_in_and_submit_ethnicity(page, "White")
 
         page.click("text=Submit")
 
diff --git a/lung_cancer_screening/core/tests/acceptance/test_questionnaire.py b/lung_cancer_screening/core/tests/acceptance/test_questionnaire.py
@@ -13,7 +13,8 @@
     fill_in_and_submit_weight_metric,
     fill_in_and_submit_weight_imperial,
     fill_in_and_submit_sex_at_birth,
-    fill_in_and_submit_gender
+    fill_in_and_submit_gender,
+    fill_in_and_submit_ethnicity
 )
 
 from .helpers.assertion_helpers import expect_back_link_to_have_url
@@ -84,9 +85,14 @@ def test_full_questionnaire_user_journey(self):
         expect_back_link_to_have_url(page, "/sex-at-birth")
         fill_in_and_submit_gender(page, "Male")
 
-        expect(page).to_have_url(f"{self.live_server_url}/responses")
+        expect(page).to_have_url(f"{self.live_server_url}/ethnicity")
         expect_back_link_to_have_url(page, "/gender")
 
+        fill_in_and_submit_ethnicity(page, "White")
+
+        expect(page).to_have_url(f"{self.live_server_url}/responses")
+        expect_back_link_to_have_url(page, "/ethnicity")
+
         responses = page.locator(".responses")
         expect(responses).to_contain_text("Have you ever smoked? Yes, I used to smoke regularly")
         expect(responses).to_contain_text(
@@ -95,6 +101,7 @@ def test_full_questionnaire_user_journey(self):
         expect(responses).to_contain_text(f"What is your weight? {weight_stone} stone {weight_pound} pound")
         expect(responses).to_contain_text("What was your sex at birth? Male")
         expect(responses).to_contain_text("Which of these best describes you? Male")
+        expect(responses).to_contain_text("What is your ethnic background? White")
 
         page.click("text=Submit")
 
diff --git a/lung_cancer_screening/questions/forms/ethnicity_form.py b/lung_cancer_screening/questions/forms/ethnicity_form.py
@@ -0,0 +1,26 @@
+from django import forms
+
+from ...nhsuk_forms.typed_choice_field import TypedChoiceField
+from ..models.response_set import ResponseSet, EthnicityValues
+
+class EthnicityForm(forms.ModelForm):
+    
+    def __init__(self, *args, **kwargs):
+        self.participant = kwargs.pop('participant')
+        super().__init__(*args, **kwargs)
+        self.instance.participant = self.participant
+    
+        self.fields["ethnicity"] = TypedChoiceField(
+            choices=EthnicityValues.choices,
+            label="What is your ethnic background?",
+            widget=forms.RadioSelect,
+            label_classes="nhsuk-fieldset__legend--m",
+            hint="Your ethnicity may impact your chances of developing lung cancer.",
+            error_messages={
+                'required': 'Select your ethnic background.'
+            }
+        )
+
+    class Meta:
+        model = ResponseSet
+        fields = ['ethnicity']
diff --git a/lung_cancer_screening/questions/jinja2/ethnicity.jinja b/lung_cancer_screening/questions/jinja2/ethnicity.jinja
@@ -0,0 +1,28 @@
+{% extends 'layout.jinja' %}
+{% from 'nhsuk/components/button/macro.jinja' import button %}
+{% from 'nhsuk/components/back-link/macro.jinja' import backLink %}
+
+{% block beforeContent %}
+  {{
+    backLink({
+      "href": url("questions:gender"),
+      "text": "Back"
+    })
+  }}
+{% endblock beforeContent %}
+
+{% block page_content %}
+  <div class="nhsuk-grid-row">
+    <div class="nhsuk-grid-column-two-thirds">
+      <form action="{{ request.path }}" method="POST">
+        {{ csrf_input }}
+
+        {{ form }}
+
+        {{ button({
+          "text": "Continue"
+        }) }}
+      </form>
+    </div>
+  </div>
+{% endblock %}
diff --git a/lung_cancer_screening/questions/jinja2/responses.jinja b/lung_cancer_screening/questions/jinja2/responses.jinja
@@ -5,7 +5,7 @@
 {% block beforeContent %}
   {{
     backLink({
-      "href": url("questions:gender"),
+      "href": url("questions:ethnicity"),
       "text": "Back"
     })
   }}
@@ -22,6 +22,7 @@
         <li>What is your weight? {{ response_set.formatted_weight }}</li>
         <li>What was your sex at birth? {{ response_set.get_sex_at_birth_display() }}</li>
         <li>Which of these best describes you? {{ response_set.get_gender_display() }}</li>
+        <li>What is your ethnic background? {{ response_set.get_ethnicity_display() }}</li>
       </ul>
 
       <form action="{{ request.path }}" method="post">
diff --git a/lung_cancer_screening/questions/migrations/0015_responseset_ethnicity_alter_responseset_gender.py b/lung_cancer_screening/questions/migrations/0015_responseset_ethnicity_alter_responseset_gender.py
@@ -0,0 +1,23 @@
+# Generated by Django 5.2.7 on 2025-11-03 14:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0014_responseset_gender'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='responseset',
+            name='ethnicity',
+            field=models.CharField(blank=True, choices=[('A', 'Asian or Asian British'), ('B', 'Black, African, Caribbean or Black British'), ('M', 'Mixed or multiple ethnic groups'), ('W', 'White'), ('O', 'Other ethnic group'), ('N', "I'd prefer not to say")], max_length=1, null=True),
+        ),
+        migrations.AlterField(
+            model_name='responseset',
+            name='gender',
+            field=models.CharField(blank=True, choices=[('F', 'Female'), ('M', 'Male'), ('N', 'Non-binary'), ('P', 'Prefer not to say'), ('G', 'How I describe myself may not match my GP record')], max_length=1, null=True),
+        ),
+    ]
diff --git a/lung_cancer_screening/questions/models/response_set.py b/lung_cancer_screening/questions/models/response_set.py
@@ -25,6 +25,14 @@ class GenderValues(models.TextChoices):
     PREFER_NOT_TO_SAY = "P", 'Prefer not to say'
     GP = "G", 'How I describe myself may not match my GP record'
 
+class EthnicityValues(models.TextChoices):
+    ASIAN = "A", "Asian or Asian British"
+    BLACK = "B", "Black, African, Caribbean or Black British"
+    MIXED = "M", "Mixed or multiple ethnic groups"
+    WHITE = "W", "White"
+    OTHER = "O", "Other ethnic group"
+    PREFER_NOT_TO_SAY = "N", "I'd prefer not to say"
+
 class ResponseSet(BaseModel):
     participant = models.ForeignKey(Participant, on_delete=models.CASCADE)
 
@@ -80,6 +88,13 @@ class ResponseSet(BaseModel):
         blank=True
     )
 
+    ethnicity = models.CharField(
+        max_length=1,
+        choices=EthnicityValues.choices,
+        null=True,
+        blank=True
+    )
+
     submitted_at = models.DateTimeField(null=True, blank=True)
 
     class Meta:
diff --git a/lung_cancer_screening/questions/tests/unit/forms/test_ethnicity_form.py b/lung_cancer_screening/questions/tests/unit/forms/test_ethnicity_form.py
@@ -0,0 +1,48 @@
+from django.test import TestCase
+
+from ....models.response_set import EthnicityValues
+from ....models.participant import Participant
+from ....forms.ethnicity_form import EthnicityForm
+
+class TestEthnicityForm(TestCase):
+    def setUp(self):
+        self.participant = Participant.objects.create(unique_id="1234567890")
+
+    def test_is_valid_with_a_valid_value(self):
+        form = EthnicityForm(
+            participant=self.participant,
+            data={
+                'ethnicity': EthnicityValues.WHITE
+            }
+        )
+        self.assertTrue(form.is_valid())
+        self.assertEqual(
+          form.cleaned_data['ethnicity'],
+          EthnicityValues.WHITE
+        )
+    
+    def test_is_invalid_with_an_invalid_value(self):
+        form = EthnicityForm(
+            participant=self.participant,
+            data={
+                "ethnicity": "invalid"
+            }
+        )
+        self.assertFalse(form.is_valid())
+        self.assertEqual(
+            form.errors["ethnicity"],
+            ["Select a valid choice. invalid is not one of the available choices."]
+        )
+
+    def test_is_invalid_when_no_option_is_selected(self):
+        form = EthnicityForm(
+            participant=self.participant,
+            data={
+                "ethnicity": None
+            }
+        )
+        self.assertFalse(form.is_valid())
+        self.assertEqual(
+            form.errors["ethnicity"],
+            ["Select your ethnic background."]
+        )
diff --git a/lung_cancer_screening/questions/tests/unit/models/test_response_set.py b/lung_cancer_screening/questions/tests/unit/models/test_response_set.py
@@ -5,7 +5,7 @@
 
 from django.core.exceptions import ValidationError
 
-from ....models.response_set import ResponseSet, HaveYouEverSmokedValues, SexAtBirthValues, GenderValues
+from ....models.response_set import ResponseSet, HaveYouEverSmokedValues, SexAtBirthValues, GenderValues, EthnicityValues
 from ....models.participant import Participant
 
 class TestResponseSet(TestCase):
@@ -109,6 +109,15 @@ def test_has_gender_as_string(self):
             str
         )
 
+    def test_has_ethnicity_as_string(self):
+        self.response_set.ethnicity = EthnicityValues.WHITE
+        self.response_set.save()
+
+        self.assertIsInstance(
+            self.response_set.ethnicity,
+            str
+        )
+
     # VALIDATIONS
 
     def test_is_invalid_if_another_unsubmitted_response_set_exists(self):
@@ -259,3 +268,22 @@ def test_is_invalid_if_gender_is_not_an_accepted_value(self):
             context.exception.messages[0],
             "Value 'X' is not a valid choice."
         )
+
+    def test_is_valid_if_ethnicity_is_null(self):
+        self.response_set.ethnicity = None
+        self.response_set.save()
+
+        self.assertIsNone(
+            self.response_set.ethnicity
+        )
+
+    def test_is_invalid_if_ethnicity_is_not_an_accepted_value(self):
+        self.response_set.ethnicity = "X"
+
+        with self.assertRaises(ValidationError) as context:
+            self.response_set.full_clean()
+
+        self.assertEqual(
+            context.exception.messages[0],
+            "Value 'X' is not a valid choice."
+        )
diff --git a/lung_cancer_screening/questions/tests/unit/views/test_ethnicity.py b/lung_cancer_screening/questions/tests/unit/views/test_ethnicity.py
@@ -0,0 +1,96 @@
+from django.test import TestCase
+from django.urls import reverse
+
+from lung_cancer_screening.questions.models.participant import Participant
+from lung_cancer_screening.questions.models.response_set import EthnicityValues
+
+
+class TestEthnicity(TestCase):
+    def setUp(self):
+        self.participant = Participant.objects.create(unique_id="12345")
+        self.participant.responseset_set.create()
+        self.valid_params = { "ethnicity": EthnicityValues.WHITE }
+
+        session = self.client.session
+        session['participant_id'] = self.participant.unique_id
+        session.save()
+
+### Test GET request
+
+    def test_get_redirects_if_the_participant_does_not_exist(self):
+        session = self.client.session
+        session['participant_id'] = "somebody none existant participant"
+        session.save()
+
+        response = self.client.get(
+            reverse("questions:ethnicity")
+        )
+
+        self.assertRedirects(response, reverse("questions:start"))
+
+    def test_get_responds_successfully(self):
+        response = self.client.get(reverse("questions:ethnicity"))
+
+        self.assertEqual(response.status_code, 200)
+
+    def test_get_contains_the_correct_form_fields(self):
+        response = self.client.get(reverse("questions:ethnicity"))
+
+        self.assertContains(response, "What is your ethnic background?")
+
+### Test POST request
+
+    def test_post_redirects_if_the_participant_does_not_exist(self):
+        session = self.client.session
+        session['participant_id'] = "somebody none existant participant"
+        session.save()
+
+        response = self.client.post(
+            reverse("questions:ethnicity"),
+            self.valid_params
+        )
+
+        self.assertRedirects(response, reverse("questions:start"))
+
+    def test_post_stores_a_valid_response_for_the_participant(self):
+        self.client.post(
+            reverse("questions:ethnicity"),
+            self.valid_params
+        )
+
+        response_set = self.participant.responseset_set.first()
+        self.assertEqual(response_set.ethnicity, self.valid_params["ethnicity"])
+        self.assertEqual(response_set.participant, self.participant)
+
+    def test_post_sets_the_participant_id_in_session(self):
+        self.client.post(
+            reverse("questions:ethnicity"),
+            self.valid_params
+        )
+
+        self.assertEqual(self.client.session["participant_id"], "12345")
+
+    def test_post_redirects_to_the_responses_path(self):
+        response = self.client.post(
+            reverse("questions:ethnicity"),
+            self.valid_params
+        )
+
+        self.assertRedirects(response, reverse("questions:responses"))
+
+    def test_post_responds_with_422_if_the_date_response_fails_to_create(self):
+        response = self.client.post(
+            reverse("questions:ethnicity"),
+            {"ethnicity": "something not in list"}
+        )
+
+        self.assertEqual(response.status_code, 422)
+
+    def test_post_renders_the_ethnicity_page_with_an_error_if_the_form_is_invalid(self):
+        response = self.client.post(
+            reverse("questions:ethnicity"),
+            {"ethnicity": "something not in list"}
+        )
+
+        self.assertContains(response, "What is your ethnic background?", status_code=422)
+        self.assertContains(response, "nhsuk-error-message", status_code=422)
diff --git a/lung_cancer_screening/questions/tests/unit/views/test_gender.py b/lung_cancer_screening/questions/tests/unit/views/test_gender.py
diff --git a/lung_cancer_screening/questions/urls.py b/lung_cancer_screening/questions/urls.py
diff --git a/lung_cancer_screening/questions/views/ethnicity.py b/lung_cancer_screening/questions/views/ethnicity.py
diff --git a/lung_cancer_screening/questions/views/gender.py b/lung_cancer_screening/questions/views/gender.py
