Skip to content

fix: adding enterprise branding for the unit tests #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
subhashree-sahu31 wants to merge 2 commits into
base: release-ulmo
Choose a base branch
from
Open

fix: adding enterprise branding for the unit tests #143

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96a4f09
fix: adding enterprise branding for the unit tests
subhashree-sahu31 Feb 23, 2026
1f54071
fix: adding enterprise branding for the unit tests.
subhashree-sahu31 Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 81 additions & 1 deletion openedx/core/djangoapps/user_authn/api/tests/test_serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
SERIALIZED_MFE_CONTEXT_WITH_TPA_DATA,
SERIALIZED_MFE_CONTEXT_WITHOUT_TPA_DATA,
)
from openedx.core.djangoapps.user_authn.serializers import MFEContextSerializer
from openedx.core.djangoapps.user_authn.serializers import ContextDataSerializer, MFEContextSerializer


class TestMFEContextSerializer(TestCase):
Expand Down Expand Up @@ -44,3 +44,83 @@ def test_mfe_context_serializer_default_response(self):
serialized_data,
SERIALIZED_MFE_CONTEXT_WITHOUT_TPA_DATA
)

def test_context_data_serializer_includes_enterprise_branding_when_present(self):
context_data = {
'currentProvider': None,
'platformName': 'Open edX',
'providers': [],
'secondaryProviders': [],
'finishAuthUrl': None,
'errorMessage': None,
'registerFormSubmitButtonText': None,
'autoSubmitRegForm': False,
'syncLearnerProfileData': False,
'countryCode': None,
'welcomePageRedirectUrl': None,
'pipeline_user_details': {
'username': 'jdoe',
'email': 'jdoe@example.com',
'fullname': 'Jane Doe',
'first_name': 'Jane',
'last_name': 'Doe',
},
'enterpriseBranding': {
'enterpriseName': 'Example Enterprise',
'enterpriseLogoUrl': 'https://example.com/logo.png',
'enterpriseBrandedWelcomeString': 'Welcome, Enterprise Learner',
'enterpriseSlug': 'example-enterprise',
'platformWelcomeString': 'Welcome to the Platform',
},
}

serialized = ContextDataSerializer(context_data).data

self.assertDictEqual(
serialized['enterpriseBranding'],
{
'enterpriseName': 'Example Enterprise',
'enterpriseLogoUrl': 'https://example.com/logo.png',
'enterpriseBrandedWelcomeString': 'Welcome, Enterprise Learner',
'enterpriseSlug': 'example-enterprise',
'platformWelcomeString': 'Welcome to the Platform',
}
)

self.assertDictEqual(
serialized['pipelineUserDetails'],
{
'username': 'jdoe',
'email': 'jdoe@example.com',
'name': 'Jane Doe',
'firstName': 'Jane',
'lastName': 'Doe',
}
)

def test_context_data_serializer_omits_enterprise_branding_when_absent(self):
context_data = {
'currentProvider': None,
'platformName': 'Open edX',
'providers': [],
'secondaryProviders': [],
'finishAuthUrl': None,
'errorMessage': None,
'registerFormSubmitButtonText': None,
'autoSubmitRegForm': False,
'syncLearnerProfileData': False,
'countryCode': None,
'welcomePageRedirectUrl': None,
'pipeline_user_details': {
'username': 'jdoe',
'email': 'jdoe@example.com',
'fullname': 'Jane Doe',
'first_name': 'Jane',
'last_name': 'Doe',
},
}

serialized = ContextDataSerializer(context_data).data

self.assertNotIn('enterpriseBranding', serialized)

Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new tests cover the cases where enterpriseBranding is present (dict) and where it is entirely absent, but they don't cover the production-shaped case where the key exists with a None value (the MFE context builder sets enterpriseBranding to None when no enterprise is detected). Consider adding an assertion for the enterpriseBranding=None input to lock down whether the serializer should emit enterpriseBranding: None or omit the key in that scenario.

Suggested change
def test_context_data_serializer_includes_enterprise_branding_when_none(self):
"""
When enterpriseBranding is explicitly provided as None, the serializer
should emit the key with a None value rather than omitting it.
This matches the production MFE context builder behavior.
"""
context_data = {
'currentProvider': None,
'platformName': 'Open edX',
'providers': [],
'secondaryProviders': [],
'finishAuthUrl': None,
'errorMessage': None,
'registerFormSubmitButtonText': None,
'autoSubmitRegForm': False,
'syncLearnerProfileData': False,
'countryCode': None,
'welcomePageRedirectUrl': None,
'pipeline_user_details': {
'username': 'jdoe',
'email': 'jdoe@example.com',
'fullname': 'Jane Doe',
'first_name': 'Jane',
'last_name': 'Doe',
},
'enterpriseBranding': None,
}
serialized = ContextDataSerializer(context_data).data
self.assertIn('enterpriseBranding', serialized)
self.assertIsNone(serialized['enterpriseBranding'])

Copilot uses AI. Check for mistakes.
4 changes: 4 additions & 0 deletions openedx/core/djangoapps/user_authn/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ class ContextDataSerializer(serializers.Serializer):
countryCode = serializers.CharField(allow_null=True)
welcomePageRedirectUrl = serializers.CharField(allow_null=True)
pipelineUserDetails = serializers.SerializerMethodField()
enterpriseBranding = EnterpriseBrandingSerializer(
allow_null=True,
required=False,
)

Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding enterpriseBranding as a nested serializer will cause the API to start emitting an enterpriseBranding key whenever the upstream context includes it. In openedx/core/djangoapps/user_authn/views/utils.py:get_mfe_context the context is updated with 'enterpriseBranding': enterprise_branding even when enterprise_branding is None, so this change will likely introduce "enterpriseBranding": null in many responses where the key was previously absent. If the desired contract is to omit the key when there is no enterprise branding, consider either (a) only adding the key upstream when a branding dict exists, or (b) overriding ContextDataSerializer.to_representation to drop enterpriseBranding when it is None.

Suggested change
def to_representation(self, instance):
"""
Customize representation to omit the 'enterpriseBranding' key
when there is no enterprise branding data.
"""
data = super().to_representation(instance)
if data.get('enterpriseBranding') is None:
data.pop('enterpriseBranding', None)
return data

Copilot uses AI. Check for mistakes.
def get_pipelineUserDetails(self, obj):
if obj.get('pipeline_user_details'):
Expand Down
Loading