Refactor: Class-based views - Enrollment Index (#3073)

Author: lalver1

benefits/enrollment/urls.py

@@ -11,7 +11,7 @@
 app_name = "enrollment"
 urlpatterns = [
     # /enrollment
-    path("", views.index, name=routes.name(routes.ENROLLMENT_INDEX)),
+    path("", views.IndexView.as_view(), name=routes.name(routes.ENROLLMENT_INDEX)),
     path("error/reenrollment", views.reenrollment_error, name=routes.name(routes.ENROLLMENT_REENROLLMENT_ERROR)),
     path("retry", views.retry, name=routes.name(routes.ENROLLMENT_RETRY)),
     path("success", views.success, name=routes.name(routes.ENROLLMENT_SUCCESS)),

benefits/enrollment/views.py

@@ -4,14 +4,15 @@
 
 import logging
 
-from django.shortcuts import redirect
 from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.decorators import decorator_from_middleware
+from django.views.generic import RedirectView
 
 from benefits.routes import routes
 from benefits.core import session
-from benefits.core.middleware import AgencySessionRequired, EligibleSessionRequired, FlowSessionRequired, pageview_decorator
+from benefits.core.mixins import AgencySessionRequiredMixin, EligibleSessionRequiredMixin
+from benefits.core.middleware import EligibleSessionRequired, FlowSessionRequired, pageview_decorator
 
 from . import analytics
 
@@ -22,14 +23,15 @@
 logger = logging.getLogger(__name__)
 
 
-@decorator_from_middleware(AgencySessionRequired)
-@decorator_from_middleware(EligibleSessionRequired)
-def index(request):
-    """View handler for the enrollment landing page."""
-    session.update(request, origin=reverse(routes.ENROLLMENT_INDEX))
+class IndexView(AgencySessionRequiredMixin, EligibleSessionRequiredMixin, RedirectView):
+    """CBV for the enrollment landing page."""
 
-    agency = session.agency(request)
-    return redirect(agency.enrollment_index_route)
+    def get_redirect_url(self, *args, **kwargs):
+        return reverse(self.agency.enrollment_index_route)
+
+    def get(self, request, *args, **kwargs):
+        session.update(request, origin=reverse(routes.ENROLLMENT_INDEX))
+        return super().get(request, *args, **kwargs)
 
 
 @decorator_from_middleware(EligibleSessionRequired)

tests/pytest/enrollment/test_views.py

@@ -2,7 +2,7 @@
 from django.urls import reverse
 
 from benefits.routes import routes
-import benefits.enrollment.views
+import benefits.enrollment.views as views
 import benefits.enrollment.enrollment
 from benefits.core.middleware import TEMPLATE_USER_ERROR
 from benefits.enrollment.views import TEMPLATE_RETRY, system_error
@@ -29,23 +29,25 @@ def mocked_sentry_sdk_module(mocker):
 
 
 @pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_flow", "mocked_session_eligible", "model_LittlepayConfig")
-def test_index_eligible_get_littlepay(client):
-    path = reverse(routes.ENROLLMENT_INDEX)
-    response = client.get(path)
+class TestIndexView:
 
-    assert response.status_code == 302
-    assert response.url == reverse(routes.ENROLLMENT_LITTLEPAY_INDEX)
+    @pytest.fixture
+    def view(self, app_request, model_LittlepayConfig):
+        v = views.IndexView()
+        v.setup(app_request)
+        v.agency = model_LittlepayConfig.transit_agency
+        return v
 
+    def test_get_redirect_url(self, view):
 
-@pytest.mark.django_db
-@pytest.mark.usefixtures("mocked_session_agency", "mocked_session_flow", "mocked_session_eligible", "model_SwitchioConfig")
-def test_index_eligible_get_switchio(client):
-    path = reverse(routes.ENROLLMENT_INDEX)
-    response = client.get(path)
+        assert view.get_redirect_url() == reverse(view.agency.enrollment_index_route)
+
+    def test_get(self, view, app_request, mocked_session_update):
 
-    assert response.status_code == 302
-    assert response.url == reverse(routes.ENROLLMENT_SWITCHIO_INDEX)
+        response = view.get(app_request)
+
+        assert response.status_code == 302
+        mocked_session_update.assert_called_once()
 
 
 @pytest.mark.django_db
@@ -63,16 +65,6 @@ def test_system_error(
     assert {"origin": mocked_session_agency.return_value.index_url} in mock_session.update.call_args
 
 
-@pytest.mark.django_db
-def test_index_ineligible(client):
-    path = reverse(routes.ENROLLMENT_INDEX)
-
-    response = client.get(path)
-
-    assert response.status_code == 200
-    assert response.template_name == TEMPLATE_USER_ERROR
-
-
 @pytest.mark.django_db
 def test_reenrollment_error_ineligible(client):
     path = reverse(routes.ENROLLMENT_REENROLLMENT_ERROR)