fix: Multi Select course/course run issue

Author: skumargupta83

course_discovery/apps/course_metadata/admin.py

@@ -61,6 +61,26 @@ def __str__(self):
         return f'<script src="{abs_path}" defer></script>'
 
 
+class DALAdminMixin(admin.ModelAdmin):
+    """
+    Mixin for Django admin classes using django-autocomplete-light.
+    Ensures Select2 library is properly loaded before autocomplete.js.
+    Required for Django 5.2 compatibility.
+    """
+    class Media:
+        css = {
+            'all': (
+                'admin/css/autocomplete.css',
+                'select2/dist/css/select2.css',
+                'dal_select2/dist/css/choices.css',
+            )
+        }
+        js = (
+            'select2/dist/js/select2.js',
+            'admin/js/autocomplete.js',
+        )
+
+
 class ProgramEligibilityFilter(admin.SimpleListFilter):
     title = _('eligible for one-click purchase')
     parameter_name = 'eligible_for_one_click_purchase'
@@ -138,7 +158,7 @@ class ProductValueAdmin(admin.ModelAdmin):
 
 
 @admin.register(Course)
-class CourseAdmin(DjangoObjectActions, SimpleHistoryAdmin):
+class CourseAdmin(DALAdminMixin, DjangoObjectActions, SimpleHistoryAdmin):
     form = CourseAdminForm
     list_display = ('uuid', 'key', 'key_for_reruns', 'title', 'draft',)
     list_filter = ('partner', 'product_source')
@@ -234,7 +254,16 @@ def get_urls(self):
     course_skills.label = "view course skills"
 
     class Media:
+        css = {
+            'all': (
+                'admin/css/autocomplete.css',
+                'select2/dist/css/select2.css',
+                'dal_select2/dist/css/choices.css',
+            )
+        }
         js = (
+            'select2/dist/js/select2.js',
+            'admin/js/autocomplete.js',
             'bower_components/jquery-ui/ui/minified/jquery-ui.min.js',
             'bower_components/jquery/dist/jquery.min.js',
             SortableSelectJSPath()
@@ -444,7 +473,7 @@ class ProgramLocationRestrictionAdmin(admin.ModelAdmin):
 
 
 @admin.register(Program)
-class ProgramAdmin(DjangoObjectActions, SimpleHistoryAdmin):
+class ProgramAdmin(DALAdminMixin, DjangoObjectActions, SimpleHistoryAdmin):
     form = ProgramAdminForm
     list_display = ('id', 'uuid', 'title', 'type', 'partner', 'status', 'hidden')
     list_filter = ('partner', 'type', 'product_source', 'status', ProgramEligibilityFilter, 'hidden')
@@ -585,7 +614,16 @@ def save_model(self, request, obj, form, change):
             messages.add_message(request, messages.ERROR, msg)
 
     class Media:
+        css = {
+            'all': (
+                'admin/css/autocomplete.css',
+                'select2/dist/css/select2.css',
+                'dal_select2/dist/css/choices.css',
+            )
+        }
         js = (
+            'select2/dist/js/select2.js',
+            'admin/js/autocomplete.js',
             'bower_components/jquery-ui/ui/minified/jquery-ui.min.js',
             'bower_components/jquery/dist/jquery.min.js',
             SortableSelectJSPath()

course_discovery/apps/course_metadata/tests/test_admin.py

@@ -18,12 +18,16 @@
 from selenium.webdriver.support.ui import Select
 from selenium.webdriver.support.wait import WebDriverWait
 
+from django.contrib.admin import AdminSite, ModelAdmin
+
 from course_discovery.apps.api.tests.mixins import SiteMixin
 from course_discovery.apps.api.v1.tests.test_views.mixins import FuzzyInt
 from course_discovery.apps.core.models import Partner
 from course_discovery.apps.core.tests.factories import USER_PASSWORD, PartnerFactory, UserFactory
 from course_discovery.apps.core.tests.helpers import make_image_file
-from course_discovery.apps.course_metadata.admin import DegreeAdmin, PositionAdmin, ProgramEligibilityFilter
+from course_discovery.apps.course_metadata.admin import (
+    DALAdminMixin, DegreeAdmin, PositionAdmin, ProgramEligibilityFilter
+)
 from course_discovery.apps.course_metadata.choices import PathwayStatus, ProgramStatus
 from course_discovery.apps.course_metadata.constants import PathwayType
 from course_discovery.apps.course_metadata.forms import PathwayAdminForm, ProgramAdminForm
@@ -662,3 +666,181 @@ def test_program_with_different_partner(self):
             '__all__': ['These programs are for a different partner than the pathway itself: '
                         'partner2 program - partner2-program']
         })
+
+
+class DALAdminMixinTests(TestCase):
+    """
+    Test suite for DALAdminMixin class.
+    Tests the proper configuration of django-autocomplete-light with Select2 for Django 5.2 compatibility.
+    """
+
+    def test_dal_admin_mixin_has_media_class(self):
+        """Test that DALAdminMixin has a Media class attribute."""
+        self.assertTrue(hasattr(DALAdminMixin, 'Media'))
+        self.assertIsNotNone(DALAdminMixin.Media)
+
+    def test_dal_admin_mixin_media_css(self):
+        """Test that DALAdminMixin includes required CSS files."""
+        media = DALAdminMixin.Media
+        self.assertTrue(hasattr(media, 'css'))
+        self.assertIn('all', media.css)
+
+        css_files = media.css['all']
+        expected_css = (
+            'admin/css/autocomplete.css',
+            'select2/dist/css/select2.css',
+            'dal_select2/dist/css/choices.css',
+        )
+
+        self.assertEqual(css_files, expected_css)
+        self.assertEqual(len(css_files), 3)
+
+    def test_dal_admin_mixin_media_js(self):
+        """Test that DALAdminMixin includes required JavaScript files."""
+        media = DALAdminMixin.Media
+        self.assertTrue(hasattr(media, 'js'))
+
+        js_files = media.js
+        expected_js = (
+            'select2/dist/js/select2.js',
+            'admin/js/autocomplete.js',
+        )
+
+        self.assertEqual(js_files, expected_js)
+        self.assertEqual(len(js_files), 2)
+
+    def test_dal_admin_mixin_css_files_have_correct_paths(self):
+        """Test specific CSS file paths are correct."""
+        media = DALAdminMixin.Media
+        css_files = media.css['all']
+
+        # Test each CSS file path
+        self.assertEqual(css_files[0], 'admin/css/autocomplete.css')
+        self.assertEqual(css_files[1], 'select2/dist/css/select2.css')
+        self.assertEqual(css_files[2], 'dal_select2/dist/css/choices.css')
+
+    def test_dal_admin_mixin_js_files_have_correct_order(self):
+        """
+        Test that JavaScript files are loaded in the correct order.
+        Select2 MUST be loaded before autocomplete.js for proper functionality.
+        """
+        media = DALAdminMixin.Media
+        js_files = media.js
+
+        # Select2 should come before autocomplete.js
+        select2_index = js_files.index('select2/dist/js/select2.js')
+        autocomplete_index = js_files.index('admin/js/autocomplete.js')
+
+        self.assertLess(select2_index, autocomplete_index,
+                        msg="Select2 must be loaded before autocomplete.js")
+
+    def test_dal_admin_mixin_inheritable(self):
+        """
+        Test that DALAdminMixin can be properly inherited by admin classes.
+        """
+        # Create a test admin class that inherits from DALAdminMixin
+        class TestModelAdmin(DALAdminMixin):
+            list_display = ('id', 'name')
+
+        self.assertTrue(issubclass(TestModelAdmin, DALAdminMixin))
+        self.assertTrue(hasattr(TestModelAdmin, 'Media'))
+
+    def test_dal_admin_mixin_media_inheritance(self):
+        """
+        Test that Media attributes are properly inherited when using DALAdminMixin.
+        """
+        class TestModelAdmin(DALAdminMixin):
+            list_display = ('id', 'name')
+
+        # Check that inherited admin has Media attribute
+        admin_instance = TestModelAdmin(Person, AdminSite())
+        media = admin_instance.media
+
+        # Verify CSS files are present
+        self.assertIn('select2/dist/css/select2.css', str(media))
+        self.assertIn('admin/css/autocomplete.css', str(media))
+
+        # Verify JS files are present
+        self.assertIn('select2/dist/js/select2.js', str(media))
+        self.assertIn('admin/js/autocomplete.js', str(media))
+
+    def test_dal_admin_mixin_with_additional_media(self):
+        """
+        Test that DALAdminMixin works with admin classes that define additional media.
+        """
+        class TestModelAdminWithMedia(DALAdminMixin):
+            list_display = ('id', 'name')
+
+            class Media:
+                # This would extend the parent media or override it
+                css = {
+                    'all': (
+                        'admin/css/autocomplete.css',
+                        'select2/dist/css/select2.css',
+                        'dal_select2/dist/css/choices.css',
+                        'custom/style.css',  # Custom CSS in addition to DAL
+                    )
+                }
+                js = (
+                    'select2/dist/js/select2.js',
+                    'admin/js/autocomplete.js',
+                    'custom/script.js',  # Custom JS
+                )
+
+        admin = TestModelAdminWithMedia(Person, AdminSite())
+        media_str = str(admin.media)
+
+        # Check that both DAL and custom files are included
+        self.assertIn('select2', media_str)
+        self.assertIn('autocomplete', media_str)
+
+    def test_dal_admin_mixin_docstring(self):
+        """Test that DALAdminMixin has proper documentation."""
+        self.assertIsNotNone(DALAdminMixin.__doc__)
+        self.assertIn('django-autocomplete-light', DALAdminMixin.__doc__)
+        self.assertIn('Select2', DALAdminMixin.__doc__)
+        self.assertIn('Django 5.2', DALAdminMixin.__doc__)
+
+    def test_dal_admin_mixin_is_admin_model_admin(self):
+        """Test that DALAdminMixin inherits from admin.ModelAdmin."""
+        self.assertTrue(issubclass(DALAdminMixin, ModelAdmin))
+
+    def test_multiple_css_entries_for_specific_media(self):
+        """Test that CSS entries are specifically for 'all' media query."""
+        media = DALAdminMixin.Media
+
+        # Should only have 'all' key for CSS
+        self.assertEqual(len(media.css), 1)
+        self.assertIn('all', media.css)
+
+    def test_css_and_js_are_tuples_not_lists(self):
+        """Test that CSS and JS are defined as tuples (immutable)."""
+        media = DALAdminMixin.Media
+
+        self.assertIsInstance(media.css['all'], tuple)
+        self.assertIsInstance(media.js, tuple)
+
+    def test_dal_admin_mixin_with_person_model(self):
+        """
+        Test that DALAdminMixin integrates properly with Person admin.
+        This is a real-world integration test.
+        """
+        # Verify PersonAdmin inherits from DALAdminMixin
+        # Note: This test assumes PersonAdmin uses DALAdminMixin in the actual implementation
+        admin_site = AdminSite()
+
+        # Create a test admin using DALAdminMixin
+        class PersonTestAdmin(DALAdminMixin):
+            list_display = ('uuid', 'given_name', 'family_name')
+
+        person_admin = PersonTestAdmin(Person, admin_site)
+
+        # Verify media is properly configured
+        self.assertTrue(hasattr(person_admin, 'media'))
+        media_str = str(person_admin.media)
+
+        # Check for expected Select2 and autocomplete references
+        self.assertIn('select2', media_str)
+        self.assertIn('autocomplete', media_str)
+
+