Refactor Enrollment Flow for consistent labeling across apps (#2403)

- Changes the implementation of the relationship between EnrollmentFlow and TransitAgency models. EnrollmentFlow now has a TransitAgency foreign key field (many flows to one transit agency). EnrollmentFlow's agency is not required and can be blank. - Updates EnrollmentFlow labels in fixture data, to match the names used in form fields. - Updates Admin view for EnrollmentFlow to show more relevant information. - Adds data migration, updates fixtures, tests, help text.
cal-itp · Oct 2, 2024 · 00d0009 · 00d0009
2 parents a602eb4 + 4d7f09f
commit 00d0009
Show file tree

Hide file tree

Showing 8 changed files with 245 additions and 236 deletions.
diff --git a/benefits/core/admin.py b/benefits/core/admin.py
@@ -44,6 +44,8 @@ def get_readonly_fields(self, request, obj=None):
 
 @admin.register(models.EnrollmentFlow)
 class SortableEnrollmentFlowAdmin(SortableAdminMixin, admin.ModelAdmin):  # pragma: no cover
+    list_display = ("label", "transit_agency", "supported_enrollment_methods")
+
     def get_exclude(self, request, obj=None):
         if not request.user.is_superuser:
             return [

diff --git a/benefits/core/migrations/0028_remove_transitagency_enrollment_flows_and_more.py b/benefits/core/migrations/0028_remove_transitagency_enrollment_flows_and_more.py
@@ -0,0 +1,39 @@
+# Generated by Django 5.1 on 2024-09-30 23:25
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def migrate_data(apps, schema_editor):
+    TransitAgency = apps.get_model("core", "TransitAgency")
+    for agency in TransitAgency.objects.all():
+        for flow in agency.enrollment_flows.all():
+            flow.transit_agency = agency
+            flow.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0027_enrollmentflow_supported_methods"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="enrollmentflow",
+            name="transit_agency",
+            field=models.ForeignKey(
+                blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to="core.transitagency"
+            ),
+        ),
+        migrations.RunPython(migrate_data),
+        migrations.RemoveField(
+            model_name="transitagency",
+            name="enrollment_flows",
+        ),
+        migrations.AlterField(
+            model_name="enrollmentflow",
+            name="label",
+            field=models.TextField(help_text="A human readable label, used as the display text in Admin.", null=True),
+        ),
+    ]
diff --git a/benefits/core/migrations/local_fixtures.json b/benefits/core/migrations/local_fixtures.json
@@ -48,12 +48,36 @@
       "scheme": "dev-cal-itp_benefits"
     }
   },
+  {
+    "model": "core.transitagency",
+    "pk": 1,
+    "fields": {
+      "active": true,
+      "slug": "cst",
+      "short_name": "CST (local)",
+      "long_name": "California State Transit (local)",
+      "info_url": "https://www.agency-website.com",
+      "phone": "1-800-555-5555",
+      "index_template": "core/index--cst.html",
+      "eligibility_index_template": "eligibility/index--cst.html",
+      "eligibility_api_id": "cst",
+      "eligibility_api_private_key": 2,
+      "eligibility_api_public_key": 3,
+      "eligibility_api_jws_signing_alg": "RS256",
+      "transit_processor": 1,
+      "transit_processor_audience": "",
+      "transit_processor_client_id": "",
+      "transit_processor_client_secret_name": "cst-transit-processor-client-secret",
+      "staff_group": 2,
+      "customer_service_group": 2
+    }
+  },
   {
     "model": "core.enrollmentflow",
     "pk": 1,
     "fields": {
       "system_name": "senior",
-      "label": "(CST) Senior Discount",
+      "label": "Older Adult",
       "group_id": "group123",
       "enrollment_success_template": "enrollment/success--cst.html",
       "display_order": 2,
@@ -62,15 +86,16 @@
       "eligibility_start_template": "eligibility/start--senior.html",
       "claims_scope": "verify:senior",
       "claims_claim": "senior",
-      "supported_enrollment_methods": ["digital", "in_person"]
+      "supported_enrollment_methods": ["digital", "in_person"],
+      "transit_agency": 1
     }
   },
   {
     "model": "core.enrollmentflow",
     "pk": 2,
     "fields": {
       "system_name": "veteran",
-      "label": "(CST) Veteran Discount",
+      "label": "US Veteran",
       "group_id": "group123",
       "enrollment_success_template": "enrollment/success--cst.html",
       "display_order": 4,
@@ -79,15 +104,16 @@
       "eligibility_start_template": "eligibility/start--veteran.html",
       "claims_scope": "verify:veteran",
       "claims_claim": "veteran",
-      "supported_enrollment_methods": ["digital", "in_person"]
+      "supported_enrollment_methods": ["digital", "in_person"],
+      "transit_agency": 1
     }
   },
   {
     "model": "core.enrollmentflow",
     "pk": 3,
     "fields": {
       "system_name": "agency_card",
-      "label": "(CST) Agency Card Discount",
+      "label": "Agency Card",
       "group_id": "group123",
       "enrollment_index_template": "enrollment/index--agency-card.html",
       "enrollment_success_template": "enrollment/success--cst-agency-card.html",
@@ -104,15 +130,16 @@
       "eligibility_form_class": "benefits.eligibility.forms.CSTAgencyCard",
       "eligibility_unverified_template": "eligibility/unverified--cst-agency-card.html",
       "help_template": "core/includes/help--cst-agency-card.html",
-      "supported_enrollment_methods": ["digital", "in_person"]
+      "supported_enrollment_methods": ["digital", "in_person"],
+      "transit_agency": 1
     }
   },
   {
     "model": "core.enrollmentflow",
     "pk": 4,
     "fields": {
       "system_name": "calfresh",
-      "label": "(CST) CalFresh",
+      "label": "CalFresh Cardholder",
       "group_id": "group123",
       "supports_expiration": "True",
       "expiration_days": 5,
@@ -126,15 +153,16 @@
       "help_template": "core/includes/help--calfresh.html",
       "claims_scope": "verify:calfresh",
       "claims_claim": "calfresh",
-      "supported_enrollment_methods": ["digital", "in_person"]
+      "supported_enrollment_methods": ["digital", "in_person"],
+      "transit_agency": 1
     }
   },
   {
     "model": "core.enrollmentflow",
     "pk": 5,
     "fields": {
       "system_name": "medicare",
-      "label": "(CST) Medicare Discount",
+      "label": "Medicare Cardholder",
       "group_id": "group123",
       "enrollment_success_template": "enrollment/success--cst.html",
       "display_order": 1,
@@ -144,34 +172,8 @@
       "help_template": "core/includes/help--medicare.html",
       "claims_scope": "verify:medicare",
       "claims_claim": "medicare",
-      "supported_enrollment_methods": ["digital", "in_person"]
-    }
-  },
-  {
-    "model": "core.enrollmentflow",
-    "pk": 6,
-    "fields": {
-      "system_name": "in_person_only",
-      "label": "(CST) In-person Only",
-      "group_id": "group123",
-      "supported_enrollment_methods": ["in_person"]
-    }
-  },
-  {
-    "model": "core.enrollmentflow",
-    "pk": 7,
-    "fields": {
-      "system_name": "digital_only",
-      "label": "(CST) Digital Only",
-      "group_id": "group123",
-      "enrollment_success_template": "enrollment/success--cst.html",
-      "display_order": 5,
-      "claims_provider": 1,
-      "selection_label_template": "eligibility/includes/selection-label--senior.html",
-      "eligibility_start_template": "eligibility/start--senior.html",
-      "claims_scope": "verify:senior",
-      "claims_claim": "senior",
-      "supported_enrollment_methods": ["digital"]
+      "supported_enrollment_methods": ["digital", "in_person"],
+      "transit_agency": 1
     }
   },
   {
@@ -186,31 +188,6 @@
       "portal_url": "https://www.transit-processor-portal.com"
     }
   },
-  {
-    "model": "core.transitagency",
-    "pk": 1,
-    "fields": {
-      "active": true,
-      "enrollment_flows": [1, 2, 3, 4, 5],
-      "slug": "cst",
-      "short_name": "CST (local)",
-      "long_name": "California State Transit (local)",
-      "info_url": "https://www.agency-website.com",
-      "phone": "1-800-555-5555",
-      "index_template": "core/index--cst.html",
-      "eligibility_index_template": "eligibility/index--cst.html",
-      "eligibility_api_id": "cst",
-      "eligibility_api_private_key": 2,
-      "eligibility_api_public_key": 3,
-      "eligibility_api_jws_signing_alg": "RS256",
-      "transit_processor": 1,
-      "transit_processor_audience": "",
-      "transit_processor_client_id": "",
-      "transit_processor_client_secret_name": "cst-transit-processor-client-secret",
-      "staff_group": 2,
-      "customer_service_group": 2
-    }
-  },
   {
     "model": "auth.Group",
     "pk": 2,