From 4fe60eb1e4a789e460f3237954b5b7202c81110d Mon Sep 17 00:00:00 2001
From: Michael Terry <mterry@edx.org>
Date: Mon, 18 Dec 2017 14:01:41 -0500
Subject: [PATCH] Show programs for expired entitlements

The dashboard was not showing related programs for expired but
fulfilled entitlements.

LEARNER-3608
---
 common/djangoapps/student/tests/test_views.py | 22 +++++++++++++++----
 lms/templates/dashboard.html                  |  2 +-
 openedx/core/djangoapps/programs/utils.py     |  1 -
 themes/edx.org/lms/templates/dashboard.html   |  2 +-
 4 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/common/djangoapps/student/tests/test_views.py b/common/djangoapps/student/tests/test_views.py
index 933ce59cdd..f14c1a334d 100644
--- a/common/djangoapps/student/tests/test_views.py
+++ b/common/djangoapps/student/tests/test_views.py
@@ -395,16 +395,18 @@ class StudentDashboardTests(SharedModuleStoreTestCase, MilestonesTestCaseMixin):
         self.assertIn('You can no longer select a session', response.content)
         self.assertNotIn('<div class="course-entitlement-selection-container ">', response.content)
 
+    @patch('openedx.core.djangoapps.programs.utils.get_programs')
     @patch('student.views.get_course_runs_for_course')
     @patch.object(CourseOverview, 'get_from_id')
     @patch('opaque_keys.edx.keys.CourseKey.from_string')
-    def test_fulfilled_entitlement(self, mock_course_key, mock_course_overview, mock_course_runs):
+    def test_fulfilled_entitlement(self, mock_course_key, mock_course_overview, mock_course_runs, mock_get_programs):
         """
         When a learner has a fulfilled entitlement, their course dashboard should have:
             - exactly one course item, meaning it:
                 - has an entitlement card
                 - does NOT have a course card referencing the selected session
             - an unhidden Change Session button
+            - a related programs message
         """
         mocked_course_overview = CourseOverviewFactory(
             start=self.TOMORROW, self_paced=True, enrollment_end=self.TOMORROW
@@ -420,20 +422,27 @@ class StudentDashboardTests(SharedModuleStoreTestCase, MilestonesTestCaseMixin):
                 'type': 'verified'
             }
         ]
-        CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment)
+        entitlement = CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment)
+        program = ProgramFactory()
+        program['courses'][0]['course_runs'] = [{'key': unicode(mocked_course_overview.id)}]
+        program['courses'][0]['uuid'] = entitlement.course_uuid
+        mock_get_programs.return_value = [program]
         response = self.client.get(self.path)
         self.assertEqual(response.content.count('<li class="course-item">'), 1)
         self.assertIn('<button class="change-session btn-link "', response.content)
+        self.assertIn('Related Programs:', response.content)
 
+    @patch('openedx.core.djangoapps.programs.utils.get_programs')
     @patch('student.views.get_course_runs_for_course')
     @patch.object(CourseOverview, 'get_from_id')
     @patch('opaque_keys.edx.keys.CourseKey.from_string')
-    def test_fulfilled_expired_entitlement(self, mock_course_key, mock_course_overview, mock_course_runs):
+    def test_fulfilled_expired_entitlement(self, mock_course_key, mock_course_overview, mock_course_runs, mock_get_programs):
         """
         When a learner has a fulfilled entitlement that is expired, their course dashboard should have:
             - exactly one course item, meaning it:
                 - has an entitlement card
             - Message that the learner can no longer change sessions
+            - a related programs message
         """
         mocked_course_overview = CourseOverviewFactory(
             start=self.TOMORROW, self_paced=True, enrollment_end=self.TOMORROW
@@ -449,10 +458,15 @@ class StudentDashboardTests(SharedModuleStoreTestCase, MilestonesTestCaseMixin):
                 'type': 'verified'
             }
         ]
-        CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment, created=self.THREE_YEARS_AGO)
+        entitlement = CourseEntitlementFactory(user=self.user, enrollment_course_run=course_enrollment, created=self.THREE_YEARS_AGO)
+        program = ProgramFactory()
+        program['courses'][0]['course_runs'] = [{'key': unicode(mocked_course_overview.id)}]
+        program['courses'][0]['uuid'] = entitlement.course_uuid
+        mock_get_programs.return_value = [program]
         response = self.client.get(self.path)
         self.assertEqual(response.content.count('<li class="course-item">'), 1)
         self.assertIn('You can no longer change sessions.', response.content)
+        self.assertIn('Related Programs:', response.content)
 
 
 @unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
diff --git a/lms/templates/dashboard.html b/lms/templates/dashboard.html
index a9d179f5e8..008163e623 100644
--- a/lms/templates/dashboard.html
+++ b/lms/templates/dashboard.html
@@ -176,7 +176,7 @@ from student.models import CourseEnrollment
                 is_course_blocked = (session_id in block_courses)
                 course_verification_status = verification_status_by_course.get(session_id, {})
                 course_requirements = courses_requirements_not_met.get(session_id)
-                related_programs = inverted_programs.get(unicode(entitlement.course_uuid if entitlement else session_id))
+                related_programs = inverted_programs.get(unicode(entitlement.course_uuid if is_unfulfilled_entitlement else session_id))
                 show_consent_link = (session_id in consent_required_courses)
                 course_overview = enrollment.course_overview
               %>
diff --git a/openedx/core/djangoapps/programs/utils.py b/openedx/core/djangoapps/programs/utils.py
index e8be8bfcd6..e916aae6ac 100644
--- a/openedx/core/djangoapps/programs/utils.py
+++ b/openedx/core/djangoapps/programs/utils.py
@@ -120,7 +120,6 @@ class ProgramProgressMeter(object):
                     program_list = inverted_programs[course_uuid]
                     if program not in program_list:
                         program_list.append(program)
-                    continue
                 for course_run in course['course_runs']:
                     course_run_id = course_run['key']
                     if course_run_id in self.course_run_ids:
diff --git a/themes/edx.org/lms/templates/dashboard.html b/themes/edx.org/lms/templates/dashboard.html
index b93f1d0b3f..b453019e08 100644
--- a/themes/edx.org/lms/templates/dashboard.html
+++ b/themes/edx.org/lms/templates/dashboard.html
@@ -172,7 +172,7 @@ from student.models import CourseEnrollment
             is_course_blocked = (session_id in block_courses)
             course_verification_status = verification_status_by_course.get(session_id, {})
             course_requirements = courses_requirements_not_met.get(session_id)
-            related_programs = inverted_programs.get(unicode(entitlement.course_uuid if entitlement else session_id))
+            related_programs = inverted_programs.get(unicode(entitlement.course_uuid if is_unfulfilled_entitlement else session_id))
             show_consent_link = (session_id in consent_required_courses)
             course_overview = enrollment.course_overview
           %>