test: add unit tests for get_extended_profile function

Author: BryanttV

openedx/core/djangoapps/user_api/accounts/tests/test_serializers.py

@@ -2,16 +2,17 @@
 Test cases to cover Accounts-related serializers of the User API application
 """
 
-
 import logging
+from unittest.mock import Mock, patch
 
 from django.test import TestCase
 from django.test.client import RequestFactory
+from django.test.utils import override_settings
 from testfixtures import LogCapture
 
-from openedx.core.djangoapps.user_api.accounts.serializers import UserReadOnlySerializer
 from common.djangoapps.student.models import UserProfile
 from common.djangoapps.student.tests.factories import UserFactory
+from openedx.core.djangoapps.user_api.accounts.serializers import UserReadOnlySerializer, get_extended_profile
 
 LOGGER_NAME = "openedx.core.djangoapps.user_api.accounts.serializers"
 
@@ -52,3 +53,148 @@ def test_user_no_profile(self):
 
         assert data['username'] == self.user.username
         assert data['name'] is None
+
+
+class GetExtendedProfileTest(TestCase):
+    """
+    Tests for get_extended_profile function
+    """
+
+    def setUp(self):
+        super().setUp()
+        self.user = UserFactory.create()
+        self.user_profile = UserProfile.objects.get(user=self.user)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_from_model(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test getting extended profile from a custom model
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title", "company"]
+        mock_model = Mock()
+        mock_instance = Mock()
+        mock_instance.department = "Engineering"
+        mock_instance.title = "Software Engineer"
+        mock_instance.company = "EdX"
+        mock_instance.user = self.user
+        mock_model.objects.get.return_value = mock_instance
+        mock_get_model.return_value = mock_model
+
+        with patch("openedx.core.djangoapps.user_api.accounts.serializers.model_to_dict") as mock_model_to_dict:
+            mock_model_to_dict.return_value = {
+                "department": "Engineering",
+                "title": "Software Engineer",
+                "company": "EdX",
+                "user": self.user.id,
+            }
+
+            result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 3)
+        self.assertIn({"field_name": "department", "field_value": "Engineering"}, result)
+        self.assertIn({"field_name": "title", "field_value": "Software Engineer"}, result)
+        self.assertIn({"field_name": "company", "field_value": "EdX"}, result)
+
+    @override_settings(REGISTRATION_EXTENSION_FORM=None)
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    def test_get_extended_profile_model_does_not_exist(self, mock_config_helpers: Mock):
+        """
+        Test fallback to meta field when model instance doesn't exist
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title"]
+        self.user_profile.set_meta({"department": "Sales", "title": "Manager"})
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 2)
+        self.assertIn({"field_name": "department", "field_value": "Sales"}, result)
+        self.assertIn({"field_name": "title", "field_value": "Manager"}, result)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_no_model_configured(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test fallback to meta field when no model is configured
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title"]
+        mock_get_model.return_value = None
+        meta_data = {"department": "Marketing", "title": "Director"}
+        self.user_profile.set_meta(meta_data)
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 2)
+        self.assertIn({"field_name": "department", "field_value": "Marketing"}, result)
+        self.assertIn({"field_name": "title", "field_value": "Director"}, result)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_empty_meta(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test getting extended profile with empty meta field
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title"]
+        mock_get_model.return_value = None
+        self.user_profile.meta = ""
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 2)
+        self.assertIn({"field_name": "department", "field_value": ""}, result)
+        self.assertIn({"field_name": "title", "field_value": ""}, result)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_invalid_json_in_meta(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test getting extended profile with invalid JSON in meta field
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title"]
+        mock_get_model.return_value = None
+        self.user_profile.meta = "invalid json {"
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 2)
+        self.assertIn({"field_name": "department", "field_value": ""}, result)
+        self.assertIn({"field_name": "title", "field_value": ""}, result)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_missing_fields(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test getting extended profile when some configured fields are missing
+        """
+        mock_config_helpers.get_value.return_value = ["department", "title", "location"]
+        mock_get_model.return_value = None
+        meta_data = {"department": "HR", "title": "Recruiter"}
+        self.user_profile.set_meta(meta_data)
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 3)
+        self.assertIn({"field_name": "department", "field_value": "HR"}, result)
+        self.assertIn({"field_name": "title", "field_value": "Recruiter"}, result)
+        self.assertIn({"field_name": "location", "field_value": ""}, result)
+
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.configuration_helpers")
+    @patch("openedx.core.djangoapps.user_api.accounts.serializers.get_extended_profile_model")
+    def test_get_extended_profile_no_configured_fields(self, mock_get_model: Mock, mock_config_helpers: Mock):
+        """
+        Test getting extended profile when no fields are configured
+        """
+        mock_config_helpers.get_value.return_value = []
+        mock_get_model.return_value = None
+        meta_data = {"department": "Finance", "title": "Analyst"}
+        self.user_profile.set_meta(meta_data)
+        self.user_profile.save()
+
+        result = get_extended_profile(self.user_profile)
+
+        self.assertEqual(len(result), 0)