feat: Certificate sharing to linkedin (optionally) consider course level organization name

haftamuk · haftamuk · commit ea4686b0da44 · 2025-10-06T10:33:23.000+03:00
By adjusting social media sharing settings(specifically linkedin) certificate parameters are autopopulated to LinkedIn API. Additional setting parameters(such as CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME) are introduced to override existing(platform level parameter for organization name) parameters for an operator to configure course level organization name. This will enable learners to share certificate in to LinkedIn with an option for course associated organization to be autopopulated.
diff --git a/common/djangoapps/student/helpers.py b/common/djangoapps/student/helpers.py
@@ -589,7 +589,7 @@ def _cert_info(user, enrollment, cert_status):
             linkedin_config = LinkedInAddToProfileConfiguration.current()
             if linkedin_config.is_enabled():
                 status_dict['linked_in_url'] = linkedin_config.add_to_profile_url(
-                    course_overview.display_name, cert_status.get('mode'), cert_status['download_url'],
+                    course_overview, cert_status.get('mode'), cert_status['download_url'],
                 )
 
     if status in {'generating', 'downloadable', 'notpassing', 'restricted', 'auditing', 'unverified'}:
diff --git a/common/djangoapps/student/models/user.py b/common/djangoapps/student/models/user.py
@@ -1383,13 +1383,14 @@ def is_enabled(self, *key_fields):  # pylint: disable=arguments-differ
         share_settings = configuration_helpers.get_value('SOCIAL_SHARING_SETTINGS', settings.SOCIAL_SHARING_SETTINGS)
         return share_settings.get('CERTIFICATE_LINKEDIN', enabled)
 
-    def add_to_profile_url(self, course_name, cert_mode, cert_url, certificate=None):
+    def add_to_profile_url(self, course, cert_mode, cert_url, certificate=None):
+
         """
         Construct the URL for the "add to profile" button. This will autofill the form based on
         the params provided.
 
         Arguments:
-            course_name (str): The display name of the course.
+            course (CourseOverview): Course/CourseOverview Object.
             cert_mode (str): The course mode of the user's certificate (e.g. "verified", "honor", "professional")
             cert_url (str): The URL for the certificate.
 
@@ -1398,11 +1399,11 @@ def add_to_profile_url(self, course_name, cert_mode, cert_url, certificate=None)
                 If provided, this function will also autofill the certId and issue date for the cert.
         """
         params = {
-            'name': self._cert_name(course_name, cert_mode),
+            'name': self._cert_name(course.display_name, cert_mode),
             'certUrl': cert_url,
         }
 
-        params.update(self._organization_information())
+        params.update(self._organization_information(course))
 
         if certificate:
             params.update({
@@ -1436,19 +1437,34 @@ def _cert_name(self, course_name, cert_mode):
             course_name=course_name
         )
 
-    def _organization_information(self):
+    def _organization_information(self, course=False):
         """
-        Returns organization information for use in the URL parameters for add to profile.
+        Returns organization information for use in the URL parameters for add to
+        profile. By default when sharing to LinkedIn, Platform Name and/or Platform
+        LINKEDIN_COMPANY_ID will be used. If Course specific Organization Name is
+        prefered when sharing Certificate to linkedIn the flag for that
+        CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME should be set
+        to True alongside other LinkedIn settings
 
         Returns:
-            dict: Either the organization ID on LinkedIn or the organization's name
+            dict: Either the organization ID on LinkedIn, the organization's name or
+                organization name associated to a specific course
                 Will be used to prefill the organization on the add to profile action.
         """
-        org_id = configuration_helpers.get_value('LINKEDIN_COMPANY_ID', self.company_identifier)
-        # Prefer organization ID per documentation at https://addtoprofile.linkedin.com/
-        if org_id:
-            return {'organizationId': org_id}
-        return {'organizationName': configuration_helpers.get_value('platform_name', settings.PLATFORM_NAME)}
+        share_settings = configuration_helpers.get_value('SOCIAL_SHARING_SETTINGS', settings.SOCIAL_SHARING_SETTINGS)
+        prefer_course_organization_name = share_settings.get(
+            'CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME', False
+        )
+        if (prefer_course_organization_name and (course is not False)):
+            return {"organizationName": course.display_organization}
+        else:
+            org_id = configuration_helpers.get_value(
+                "LINKEDIN_COMPANY_ID", self.company_identifier
+            )
+            # Prefer organization ID per documentation at https://addtoprofile.linkedin.com/
+            if org_id:
+                return {"organizationId": org_id}
+            return {'organizationName': configuration_helpers.get_value('platform_name', settings.PLATFORM_NAME)}
 
 
 class EntranceExamConfiguration(models.Model):
diff --git a/common/djangoapps/student/tests/test_certificates.py b/common/djangoapps/student/tests/test_certificates.py
@@ -21,6 +21,7 @@
     GeneratedCertificateFactory,
     LinkedInAddToProfileConfigurationFactory
 )
+from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context
 
 # pylint: disable=no-member
 
@@ -156,23 +157,52 @@ def test_unverified_certificate_message(self, enrollment_mode):
             .format(platform_name=settings.PLATFORM_NAME))
 
     def test_post_to_linkedin_visibility(self):
+        """
+        Verify the LinkedIn "Add to Profile" button visibility based on configuration.
+
+        Tests that:
+        1. When CERTIFICATE_LINKEDIN is False, the LinkedIn button is not visible
+        2. When CERTIFICATE_LINKEDIN is True, the LinkedIn button appears as expected
+        """
+        self._create_certificate('honor')
+
+        # LinkedIn sharing disabled
+        # When CERTIFICATE_LINKEDIN is set to False in site configuration,
+        # the LinkedIn "Add to Profile" button should not be visible to users
+        SITE_CONFIGURATION = {
+            'SOCIAL_SHARING_SETTINGS': {
+                'CERTIFICATE_LINKEDIN': False
+            }
+        }
+        with with_site_configuration_context(configuration=SITE_CONFIGURATION):
+            # button should not be visible
+            self._check_linkedin_visibility(False)
+
+        # LinkedIn sharing enabled  
+        # When CERTIFICATE_LINKEDIN is set to True in site configuration,
+        # the LinkedIn "Add to Profile" button should be visible to users
+        # allowing them to share their certificate on LinkedIn
+        SITE_CONFIGURATION = {
+            'SOCIAL_SHARING_SETTINGS': {
+                'CERTIFICATE_LINKEDIN': True
+            }
+        }
+        with with_site_configuration_context(configuration=SITE_CONFIGURATION):
+            # now we should see it
+            self._check_linkedin_visibility(True)
+
+    def test_post_to_linkedin_is_not_default(self):
         """
         Verifies that the post certificate to linked button
         does not appear by default (when config is not set)
-        Then Verifies that the post certificate to linked button appears
-        as expected once a config is set
         """
         self._create_certificate('honor')
 
+        # button should not be visible
         # until we set up the configuration, the LinkedIn action
         # button should not be visible
         self._check_linkedin_visibility(False)
 
-        LinkedInAddToProfileConfigurationFactory()
-        # now we should see it
-        self._check_linkedin_visibility(True)
-
-
 @ddt.ddt
 @skip_unless_lms
 class CertificateDisplayTestLinkedHtmlView(CertificateDisplayTestBase):
diff --git a/common/djangoapps/student/tests/test_linkedin.py b/common/djangoapps/student/tests/test_linkedin.py
@@ -1,22 +1,21 @@
 """Tests for LinkedIn Add to Profile configuration. """
 
-
+from types import SimpleNamespace
 from urllib.parse import quote
 import ddt
-
 from django.conf import settings
 from django.test import TestCase
 
 from lms.djangoapps.certificates.tests.factories import LinkedInAddToProfileConfigurationFactory
 from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context
 
-
 @ddt.ddt
 class LinkedInAddToProfileUrlTests(TestCase):
     """Tests for URL generation of LinkedInAddToProfileConfig. """
 
     COURSE_NAME = 'Test Course ☃'
     CERT_URL = 'http://s3.edx/cert'
+    COURSE_ORGANIZATION = 'TEST+ORGANIZATION'
     SITE_CONFIGURATION = {
         'SOCIAL_SHARING_SETTINGS': {
             'CERTIFICATE_LINKEDIN_MODE_TO_CERT_NAME': {
@@ -27,6 +26,17 @@ class LinkedInAddToProfileUrlTests(TestCase):
             }
         }
     }
+    SITE_CONFIGURATION_COURSE_LEVEL_ORG = {
+        'SOCIAL_SHARING_SETTINGS': {
+            'CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME': True,
+            'CERTIFICATE_LINKEDIN_MODE_TO_CERT_NAME': {
+                'honor': '{platform_name} Honor Code Credential for {course_name}',
+                'verified': '{platform_name} Verified Credential for {course_name}',
+                'professional': '{platform_name} Professional Credential for {course_name}',
+                'no-id-professional': '{platform_name} Professional Credential for {course_name}',
+            }
+        }
+    }
 
     @ddt.data(
         ('honor', 'Honor+Code+Certificate+for+Test+Course+%E2%98%83'),
@@ -49,7 +59,13 @@ def test_linked_in_url(self, cert_mode, expected_cert_name):
             company_identifier=config.company_identifier,
         )
 
-        actual_url = config.add_to_profile_url(self.COURSE_NAME, cert_mode, self.CERT_URL)
+        course_mock_object = SimpleNamespace(
+            display_name=self.COURSE_NAME, display_organization=self.COURSE_ORGANIZATION
+        )
+
+        actual_url = config.add_to_profile_url(
+            course_mock_object, cert_mode, self.CERT_URL
+        )
 
         self.assertEqual(actual_url, expected_url)
 
@@ -74,8 +90,49 @@ def test_linked_in_url_with_cert_name_override(self, cert_mode, expected_cert_na
             cert_url=quote(self.CERT_URL, safe=''),
             company_identifier=config.company_identifier,
         )
-
         with with_site_configuration_context(configuration=self.SITE_CONFIGURATION):
-            actual_url = config.add_to_profile_url(self.COURSE_NAME, cert_mode, self.CERT_URL)
+            course_mock_object = SimpleNamespace(
+                display_name=self.COURSE_NAME,
+                display_organization=self.COURSE_ORGANIZATION,
+            )
+            actual_url = config.add_to_profile_url(
+                course_mock_object, cert_mode, self.CERT_URL
+            )
+        self.assertEqual(actual_url, expected_url)
+
+    @ddt.data(
+        ('honor', 'Honor+Code+Credential+for+Test+Course+%E2%98%83'),
+        ('verified', 'Verified+Credential+for+Test+Course+%E2%98%83'),
+        ('professional', 'Professional+Credential+for+Test+Course+%E2%98%83'),
+        ('no-id-professional', 'Professional+Credential+for+Test+Course+%E2%98%83'),
+        ('default_mode', 'Certificate+for+Test+Course+%E2%98%83')
+    )
+    @ddt.unpack
+    def test_linked_in_url_with_course_org_name_override(
+        self, cert_mode, expected_cert_name
+    ):
+        config = LinkedInAddToProfileConfigurationFactory()
+
+        expected_url = (
+            'https://www.linkedin.com/profile/add?startTask=CERTIFICATION_NAME&'
+            'name={platform}+{cert_name}&certUrl={cert_url}&'
+            'organizationName={course_organization_name}'
+        ).format(
+            platform=quote(settings.PLATFORM_NAME.encode('utf-8')),
+            cert_name=expected_cert_name,
+            cert_url=quote(self.CERT_URL, safe=''),
+            course_organization_name=quote(self.COURSE_ORGANIZATION.encode('utf-8')),
+        )
+
+        with with_site_configuration_context(
+            configuration=self.SITE_CONFIGURATION_COURSE_LEVEL_ORG
+        ):
+            course_mock_object = SimpleNamespace(
+                display_name=self.COURSE_NAME,
+                display_organization=self.COURSE_ORGANIZATION,
+            )
+            actual_url = config.add_to_profile_url(
+                course_mock_object, cert_mode, self.CERT_URL
+            )
 
         self.assertEqual(actual_url, expected_url)
diff --git a/common/djangoapps/student/tests/tests.py b/common/djangoapps/student/tests/tests.py
@@ -51,8 +51,7 @@
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, SharedModuleStoreTestCase  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.tests.factories import CourseFactory, check_mongo_calls  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.data import CertificatesDisplayBehaviors  # lint-amnesty, pylint: disable=wrong-import-order
-
-
+from openedx.core.djangoapps.site_configuration.tests.test_util import with_site_configuration_context
 log = logging.getLogger(__name__)
 
 BETA_TESTER_METHOD = 'common.djangoapps.student.helpers.access.is_beta_tester'
@@ -399,7 +398,10 @@ def test_linked_in_add_to_profile_btn_not_appearing_without_config(self):
             grade='67',
             download_url=download_url
         )
-        response = self.client.get(reverse('dashboard'))
+        # LinkedIn sharing config is not set
+        SITE_CONFIGURATION = {'SOCIAL_SHARING_SETTINGS': {}}
+        with with_site_configuration_context(configuration=SITE_CONFIGURATION):
+            response = self.client.get(reverse('dashboard'))
 
         assert response.status_code == 200
         self.assertNotContains(response, 'Add Certificate to LinkedIn')
@@ -426,6 +428,7 @@ def test_linked_in_add_to_profile_btn_with_certificate(self):
         self.course.start = datetime.now(pytz.UTC) - timedelta(days=2)
         self.course.end = datetime.now(pytz.UTC) - timedelta(days=1)
         self.course.display_name = 'Omega'
+        self.course.course_organization = 'Omega Org'
         self.course = self.update_course(self.course, self.user.id)
 
         cert = GeneratedCertificateFactory.create(
@@ -436,7 +439,18 @@ def test_linked_in_add_to_profile_btn_with_certificate(self):
             grade='67',
             download_url='https://www.edx.org'
         )
-        response = self.client.get(reverse('dashboard'))
+        # LinkedIn sharing enabled
+        # When CERTIFICATE_LINKEDIN is set to True in site configuration,
+        # the LinkedIn "Add to Profile" button should be visible to users
+        # allowing them to share their certificate on LinkedIn
+        SITE_CONFIGURATION = {
+            'SOCIAL_SHARING_SETTINGS': {
+                'CERTIFICATE_LINKEDIN': True,
+                'CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME': False
+            }
+        }
+        with with_site_configuration_context(configuration=SITE_CONFIGURATION):
+            response = self.client.get(reverse('dashboard'))
 
         assert response.status_code == 200
         self.assertContains(response, 'Add Certificate to LinkedIn')
@@ -449,7 +463,7 @@ def test_linked_in_add_to_profile_btn_with_certificate(self):
         ).format(
             platform=quote(settings.PLATFORM_NAME.encode('utf-8')),
             cert_url=quote(cert.download_url, safe=''),
-            company_identifier=linkedin_config.company_identifier
+            company_identifier=linkedin_config.company_identifier,
         )
 
         # Single assertion for the expected LinkedIn URL
diff --git a/lms/djangoapps/certificates/views/webview.py b/lms/djangoapps/certificates/views/webview.py
@@ -305,7 +305,7 @@ def _update_social_context(request, context, course, user_certificate, platform_
     linkedin_config = LinkedInAddToProfileConfiguration.current()
     if linkedin_config.is_enabled():
         context['linked_in_url'] = linkedin_config.add_to_profile_url(
-            course.display_name, user_certificate.mode, smart_str(share_url), certificate=user_certificate
+            course, user_certificate.mode, smart_str(share_url), certificate=user_certificate
         )
 
 
diff --git a/openedx/core/djangoapps/courseware_api/views.py b/openedx/core/djangoapps/courseware_api/views.py
@@ -288,7 +288,7 @@ def linkedin_add_to_profile_url(self):
                 get_certificate_url(course_id=self.course_key, uuid=user_certificate.verify_uuid)
             )
             return linkedin_config.add_to_profile_url(
-                self.course_overview.display_name, user_certificate.mode, cert_url, certificate=user_certificate,
+                self.course_overview, user_certificate.mode, cert_url, certificate=user_certificate,
             )
 
     @property

Original file line number	Diff line number	Diff line change
`@@ -589,7 +589,7 @@ def _cert_info(user, enrollment, cert_status):`
`589`	`589`	`linkedin_config = LinkedInAddToProfileConfiguration.current()`
`590`	`590`	`if linkedin_config.is_enabled():`
`591`	`591`	`status_dict['linked_in_url'] = linkedin_config.add_to_profile_url(`
`592`		`- course_overview.display_name, cert_status.get('mode'), cert_status['download_url'],`
	`592`	`+ course_overview, cert_status.get('mode'), cert_status['download_url'],`
`593`	`593`	`)`
`594`	`594`
`595`	`595`	`if status in {'generating', 'downloadable', 'notpassing', 'restricted', 'auditing', 'unverified'}:`
Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,7 @@ def _update_social_context(request, context, course, user_certificate, platform_`
`305`	`305`	`linkedin_config = LinkedInAddToProfileConfiguration.current()`
`306`	`306`	`if linkedin_config.is_enabled():`
`307`	`307`	`context['linked_in_url'] = linkedin_config.add_to_profile_url(`
`308`		`- course.display_name, user_certificate.mode, smart_str(share_url), certificate=user_certificate`
	`308`	`+ course, user_certificate.mode, smart_str(share_url), certificate=user_certificate`
`309`	`309`	`)`
`310`	`310`
`311`	`311`
Original file line number	Diff line number	Diff line change
`@@ -288,7 +288,7 @@ def linkedin_add_to_profile_url(self):`
`288`	`288`	`get_certificate_url(course_id=self.course_key, uuid=user_certificate.verify_uuid)`
`289`	`289`	`)`
`290`	`290`	`return linkedin_config.add_to_profile_url(`
`291`		`- self.course_overview.display_name, user_certificate.mode, cert_url, certificate=user_certificate,`
	`291`	`+ self.course_overview, user_certificate.mode, cert_url, certificate=user_certificate,`
`292`	`292`	`)`
`293`	`293`
`294`	`294`	`@property`