Fix: set TransitAgency for in-person eligibility URL (#3079)

Author: lalver1

benefits/in_person/urls.py

@@ -7,7 +7,9 @@
 
 app_name = "in_person"
 urlpatterns = [
-    path("eligibility/", admin.site.admin_view(views.eligibility), name=routes.name(routes.IN_PERSON_ELIGIBILITY)),
+    path(
+        "eligibility/", admin.site.admin_view(views.EligibilityView.as_view()), name=routes.name(routes.IN_PERSON_ELIGIBILITY)
+    ),
     path("token/", admin.site.admin_view(views.token), name=routes.name(routes.IN_PERSON_ENROLLMENT_TOKEN)),
     path("enrollment/", admin.site.admin_view(views.enrollment), name=routes.name(routes.IN_PERSON_ENROLLMENT)),
     path(

benefits/in_person/views.py

@@ -5,9 +5,11 @@
 from django.template.response import TemplateResponse
 from django.shortcuts import redirect
 from django.urls import reverse
+from django.views.generic import FormView
 import sentry_sdk
 
 
+from benefits.core.models.transit import TransitAgency
 from benefits.routes import routes
 from benefits.core import models, session
 from benefits.eligibility import analytics as eligibility_analytics
@@ -21,35 +23,51 @@
 logger = logging.getLogger(__name__)
 
 
-def eligibility(request):
-    """View handler for the in-person eligibility flow selection form."""
+class EligibilityView(FormView):
+    """CBV for the in-person eligibility flow selection form."""
 
-    agency = session.agency(request)
-    context = {
-        **admin_site.each_context(request),
-        "form": forms.InPersonEligibilityForm(agency=agency),
-        "title": f"{agency.long_name} | In-person enrollment | {admin_site.site_title}",
-    }
+    template_name = "in_person/eligibility.html"
+    form_class = forms.InPersonEligibilityForm
 
-    if request.method == "POST":
-        form = forms.InPersonEligibilityForm(data=request.POST, agency=agency)
-
-        if form.is_valid():
-            flow_id = form.cleaned_data.get("flow")
-            flow = models.EnrollmentFlow.objects.get(id=flow_id)
-            session.update(request, flow=flow)
-            eligibility_analytics.selected_flow(request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
-            eligibility_analytics.started_eligibility(request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
-
-            in_person_enrollment = reverse(routes.IN_PERSON_ENROLLMENT)
-            response = redirect(in_person_enrollment)
-        else:
-            context["form"] = form
-            response = TemplateResponse(request, "in_person/eligibility.html", context)
-    else:
-        response = TemplateResponse(request, "in_person/eligibility.html", context)
+    def dispatch(self, request, *args, **kwargs):
+        """Initialize session state before handling the request."""
+
+        agency = session.agency(request)
+        if not agency:
+            agency = TransitAgency.for_user(request.user)
+            session.update(request, agency=agency)
+        self.agency = agency
+        return super().dispatch(request, *args, **kwargs)
+
+    def get_context_data(self, **kwargs):
+        """Add in-person specific context data."""
+
+        context = super().get_context_data(**kwargs)
+        context.update(
+            {
+                **admin_site.each_context(self.request),
+                "title": f"{self.agency.long_name} | In-person enrollment | {admin_site.site_title}",
+            }
+        )
+        return context
+
+    def get_form_kwargs(self):
+        """Return the keyword arguments for instantiating the form."""
+
+        kwargs = super().get_form_kwargs()
+        kwargs["agency"] = self.agency
+        return kwargs
+
+    def form_valid(self, form):
+        """If the form is valid, set enrollment flow, eligible session, and redirect."""
 
-    return response
+        flow_id = form.cleaned_data.get("flow")
+        flow = models.EnrollmentFlow.objects.get(id=flow_id)
+        session.update(self.request, flow=flow, eligible=True)
+        eligibility_analytics.selected_flow(self.request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
+        eligibility_analytics.started_eligibility(self.request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
+        eligibility_analytics.returned_success(self.request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
+        return redirect(routes.IN_PERSON_ENROLLMENT)
 
 
 def token(request):
@@ -91,7 +109,6 @@ def enrollment(request):
             raise Exception("Invalid card token form")
 
         flow = session.flow(request)
-        eligibility_analytics.returned_success(request, flow, enrollment_method=models.EnrollmentMethods.IN_PERSON)
         card_token = form.cleaned_data.get("card_token")
         status, exception = enroll(request, card_token)
 

tests/pytest/in_person/test_forms.py

@@ -0,0 +1,27 @@
+import pytest
+
+from benefits.core import models
+from benefits.in_person.forms import InPersonEligibilityForm
+
+
+@pytest.mark.django_db
+def test_eligibility_logged_in_filtering_flows(model_TransitAgency):
+    digital = models.EnrollmentFlow.objects.create(
+        transit_agency=model_TransitAgency, supported_enrollment_methods=[models.EnrollmentMethods.DIGITAL], label="Digital"
+    )
+    in_person = models.EnrollmentFlow.objects.create(
+        transit_agency=model_TransitAgency,
+        supported_enrollment_methods=[models.EnrollmentMethods.IN_PERSON],
+        label="In-Person",
+    )
+    both = models.EnrollmentFlow.objects.create(
+        transit_agency=model_TransitAgency,
+        supported_enrollment_methods=[models.EnrollmentMethods.DIGITAL, models.EnrollmentMethods.IN_PERSON],
+        label="Both",
+    )
+    form = InPersonEligibilityForm(agency=model_TransitAgency)
+
+    filtered_flow_ids = [choice[0] for choice in form.fields["flow"].choices]
+
+    assert in_person.id, both.id in filtered_flow_ids
+    assert digital.id not in filtered_flow_ids

tests/pytest/in_person/test_views.py

@@ -39,6 +39,16 @@ def mocked_sentry_sdk_module(mocker):
     return mocker.patch.object(benefits.in_person.views, "sentry_sdk")
 
 
+@pytest.fixture
+def mocked_session_module(mocker):
+    return mocker.patch.object(benefits.in_person.views, "session")
+
+
+@pytest.fixture
+def mocked_transit_agency_class(mocker):
+    return mocker.patch.object(benefits.in_person.views, "TransitAgency")
+
+
 @pytest.mark.django_db
 @pytest.mark.parametrize("viewname", [routes.IN_PERSON_ELIGIBILITY, routes.IN_PERSON_ENROLLMENT])
 def test_view_not_logged_in(client, viewname):
@@ -49,84 +59,60 @@ def test_view_not_logged_in(client, viewname):
     assert response.url == "/admin/login/?next=" + path
 
 
-# admin_client is a fixture from pytest
-# https://pytest-django.readthedocs.io/en/latest/helpers.html#admin-client-django-test-client-logged-in-as-admin
-@pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency")
-def test_eligibility_logged_in(admin_client):
-    path = reverse(routes.IN_PERSON_ELIGIBILITY)
-
-    response = admin_client.get(path)
-    assert response.status_code == 200
-    assert response.template_name == "in_person/eligibility.html"
-
-
 @pytest.mark.django_db
-def test_eligibility_logged_in_filtering_flows(mocker, model_TransitAgency, admin_client):
-    digital = models.EnrollmentFlow.objects.create(
-        transit_agency=model_TransitAgency, supported_enrollment_methods=[models.EnrollmentMethods.DIGITAL], label="Digital"
-    )
-    in_person = models.EnrollmentFlow.objects.create(
-        transit_agency=model_TransitAgency,
-        supported_enrollment_methods=[models.EnrollmentMethods.IN_PERSON],
-        label="In-Person",
-    )
-    both = models.EnrollmentFlow.objects.create(
-        transit_agency=model_TransitAgency,
-        supported_enrollment_methods=[models.EnrollmentMethods.DIGITAL, models.EnrollmentMethods.IN_PERSON],
-        label="Both",
-    )
-    mocker.patch("benefits.core.session.agency", autospec=True, return_value=model_TransitAgency)
-
-    path = reverse(routes.IN_PERSON_ELIGIBILITY)
-    response = admin_client.get(path)
-    filtered_flow_ids = [choice[0] for choice in response.context_data["form"].fields["flow"].choices]
-
-    assert in_person.id, both.id in filtered_flow_ids
-    assert digital.id not in filtered_flow_ids
-
-
-@pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_flow")
-def test_eligibility_post_no_flow_selected(admin_client):
-
-    path = reverse(routes.IN_PERSON_ELIGIBILITY)
-    form_data = {}
-    response = admin_client.post(path, form_data)
-
-    # should return user back to the in-person eligibility index
-    assert response.status_code == 200
-    assert response.template_name == "in_person/eligibility.html"
-
-
-@pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_flow")
-def test_eligibility_post_flow_selected_and_verified(
-    admin_client, model_EnrollmentFlow, mocked_session_update, mocked_eligibility_analytics_module
-):
-
-    path = reverse(routes.IN_PERSON_ELIGIBILITY)
-    form_data = {"flow": 1, "verified_1": True}
-    response = admin_client.post(path, form_data)
-
-    assert response.status_code == 302
-    assert response.url == reverse(routes.IN_PERSON_ENROLLMENT)
-    assert mocked_session_update.call_args.kwargs["flow"] == model_EnrollmentFlow
-    mocked_eligibility_analytics_module.selected_flow.assert_called_once()
-    mocked_eligibility_analytics_module.started_eligibility.assert_called_once()
-
-
-@pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_flow")
-def test_eligibility_post_flow_selected_and_unverified(admin_client):
-
-    path = reverse(routes.IN_PERSON_ELIGIBILITY)
-    form_data = {"flow": 1, "verified_1": False}
-    response = admin_client.post(path, form_data)
-
-    # should return user back to the in-person eligibility index
-    assert response.status_code == 200
-    assert response.template_name == "in_person/eligibility.html"
+class TestEligibilityView:
+    @pytest.fixture
+    def view(self, model_User, app_request, mocked_session_agency):
+        # manually attach a logged-in user to the request
+        app_request.user = model_User
+
+        v = benefits.in_person.views.EligibilityView()
+        v.setup(app_request)
+        v.agency = mocked_session_agency(app_request)
+        return v
+
+    def test_get_form_kwargs(self, view):
+        kwargs = view.get_form_kwargs()
+        assert kwargs["agency"] == view.agency
+
+    def test_get_context_data(self, view):
+        context_data = view.get_context_data()
+        assert "title" in context_data
+
+    def test_dispatch_no_agency_in_session(
+        self, view, mocked_session_module, mocked_transit_agency_class, model_TransitAgency
+    ):
+        view.agency = None
+        mocked_session_module.agency.return_value = None
+        mocked_transit_agency_class.for_user.return_value = model_TransitAgency
+
+        view.dispatch(view.request)
+
+        mocked_session_module.update.assert_called_once()
+        assert view.agency == model_TransitAgency
+
+    def test_form_valid(self, view, mocker, model_EnrollmentFlow, mocked_session_module, mocked_eligibility_analytics_module):
+        mock_enrollment_flow_model = mocker.patch.object(models.EnrollmentFlow.objects, "get")
+        mock_enrollment_flow_model.return_value = model_EnrollmentFlow
+
+        mock_form = mocker.Mock()
+        mock_form.cleaned_data = {"flow": model_EnrollmentFlow.id}
+
+        response = view.form_valid(mock_form)
+
+        mock_enrollment_flow_model.assert_called_once_with(id=model_EnrollmentFlow.id)
+        mocked_session_module.update.assert_called_once_with(view.request, flow=model_EnrollmentFlow, eligible=True)
+        mocked_eligibility_analytics_module.selected_flow.assert_called_once_with(
+            view.request, model_EnrollmentFlow, enrollment_method=models.EnrollmentMethods.IN_PERSON
+        )
+        mocked_eligibility_analytics_module.started_eligibility.assert_called_once_with(
+            view.request, model_EnrollmentFlow, enrollment_method=models.EnrollmentMethods.IN_PERSON
+        )
+        mocked_eligibility_analytics_module.returned_success.assert_called_once_with(
+            view.request, model_EnrollmentFlow, enrollment_method=models.EnrollmentMethods.IN_PERSON
+        )
+        assert response.status_code == 302
+        assert response.url == reverse(routes.IN_PERSON_ENROLLMENT)
 
 
 @pytest.mark.django_db
@@ -343,7 +329,6 @@ def test_enrollment_post_valid_form_success(
 
     assert response.status_code == 302
     assert response.url == reverse(routes.IN_PERSON_ENROLLMENT_SUCCESS)
-    mocked_eligibility_analytics_module.returned_success.assert_called_once()
     mocked_enrollment_analytics_module.returned_success.assert_called_once()