Merge pull request #775 from jono-booth/jono-booth/ENT-10570_expired_credit_requests

ENT-10570 Expire credit requests when an assignment expires

Author: sameenfatima78

enterprise_access/apps/content_assignments/api.py

@@ -23,6 +23,7 @@
 )
 from enterprise_access.apps.core.models import User
 from enterprise_access.apps.subsidy_access_policy.content_metadata_api import get_and_cache_content_metadata
+from enterprise_access.apps.subsidy_request.constants import SubsidyRequestStates
 from enterprise_access.utils import (
     chunks,
     get_automatic_expiration_date_and_reason,
@@ -996,7 +997,16 @@ def expire_assignment(
         if automatic_expiration_reason == AssignmentAutomaticExpiredReason.NINETY_DAYS_PASSED:
             assignment.clear_pii()
 
+        credit_request = getattr(assignment, 'credit_request', None)
+
+        if credit_request:
+            logger.info('Modifying credit request %s to expired', credit_request.uuid)
+            credit_request.state = SubsidyRequestStates.EXPIRED
+            credit_request.save()
+
         assignment.save()
-        send_assignment_automatically_expired_email.delay(assignment.uuid)
+
+        if not credit_request:
+            send_assignment_automatically_expired_email.delay(assignment.uuid)
 
     return automatic_expiration_reason

enterprise_access/apps/content_assignments/tests/test_api.py

@@ -10,6 +10,8 @@
 
 from enterprise_access.apps.core.tests.factories import UserFactory
 from enterprise_access.apps.subsidy_access_policy.tests.factories import AssignedLearnerCreditAccessPolicyFactory
+from enterprise_access.apps.subsidy_request.constants import SubsidyRequestStates
+from enterprise_access.apps.subsidy_request.tests.factories import LearnerCreditRequestFactory
 
 from ..api import (
     AllocationException,
@@ -1124,3 +1126,54 @@ def test_expire_assignments_with_expired_subsidy(
         self.assertEqual(assignment.learner_email, 'larry@stooges.com')
         self.assertEqual(assignment.lms_user_id, 12345)
         mock_expired_email.delay.assert_called_once_with(assignment.uuid)
+
+    @ddt.data(
+        *LearnerContentAssignmentStateChoices.EXPIRABLE_STATES
+    )
+    @mock.patch('enterprise_access.apps.content_assignments.api.send_assignment_automatically_expired_email')
+    def test_expire_credit_request_when_assigment_expires(self, expirable_assignment_state, mock_expired_email):
+        """
+        Tests that we expire any open credit requests when we expire an assignment.
+        """
+        course_key = 'edX+DemoX'
+        course_run_key = 'course-v1:edX+DemoX+T2024'
+        content_key = course_key
+
+        assignment = LearnerContentAssignmentFactory.create(
+            assignment_configuration=self.assignment_configuration,
+            content_key=content_key,
+            parent_content_key=content_key,
+            is_assigned_course_run=True,
+            state=expirable_assignment_state,
+            learner_email='larry@stooges.com',
+            lms_user_id=12345,
+        )
+
+        credit_request = LearnerCreditRequestFactory.create(
+            assignment=assignment
+        )
+
+        assignment.add_successful_notified_action()
+
+        # create non-expired content metadata
+        mock_content_metadata = self.mock_content_metadata(
+            content_key=content_key,
+            course_run_key=course_run_key,
+            enroll_by_date=delta_t(days=100, as_string=True),
+        )
+
+        # set a policy-subsidy expiration date in the past
+        mock_subsidy_record = {'expiration_datetime': delta_t(days=-1, as_string=True)}
+        with mock.patch.object(self.policy, 'subsidy_record', return_value=mock_subsidy_record):
+            expire_assignment(
+                assignment,
+                content_metadata=mock_content_metadata,
+                modify_assignment=True,
+            )
+
+        credit_request.refresh_from_db()
+        assignment.refresh_from_db()
+
+        self.assertEqual(assignment.state, LearnerContentAssignmentStateChoices.EXPIRED)
+        self.assertEqual(credit_request.state, SubsidyRequestStates.EXPIRED)
+        mock_expired_email.delay.assert_not_called()