Merge pull request #12210 from edx/waheed/ecom-3437-enable-self-gen-certs-by-default-for-self-paced

Automatically enable Self Generating Certificates for Self Paced Courses.

lms/djangoapps/certificates/__init__.py

+""" Certificates app """
+# this is here to support registering the signals in signals.py
+from . import signals

lms/djangoapps/certificates/signals.py

+""" Signal handler for enabling self-generated certificates by default
+for self-paced courses.
+"""
+from celery.task import task
+from django.dispatch.dispatcher import receiver
+
+from certificates.models import CertificateGenerationCourseSetting
+from xmodule.modulestore.django import SignalHandler, modulestore
+
+
+@receiver(SignalHandler.course_published)
+def _listen_for_course_publish(sender, course_key, **kwargs):  # pylint: disable=unused-argument
+    """ Catches the signal that a course has been published in Studio and
+    enable the self-generated certificates by default for self-paced
+    courses.
+    """
+    enable_self_generated_certs.delay(course_key)
+
+
+@task()
+def enable_self_generated_certs(course_key):
+    """Enable the self-generated certificates by default for self-paced courses."""
+    course = modulestore().get_course(course_key)
+    is_enabled_for_course = CertificateGenerationCourseSetting.is_enabled_for_course(course_key)
+    if course.self_paced and not is_enabled_for_course:
+        CertificateGenerationCourseSetting.set_enabled_for_course(course_key, True)

lms/djangoapps/certificates/tests/test_signals.py

+""" Unit tests for enabling self-generated certificates by default
+for self-paced courses.
+"""
+from certificates import api as certs_api
+from certificates.models import CertificateGenerationConfiguration
+from certificates.signals import _listen_for_course_publish
+from openedx.core.djangoapps.self_paced.models import SelfPacedConfiguration
+from xmodule.modulestore.tests.factories import CourseFactory
+from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
+
+
+class SelfGeneratedCertsSignalTest(ModuleStoreTestCase):
+    """ Tests for enabling self-generated certificates by default
+    for self-paced courses.
+    """
+
+    def setUp(self):
+        super(SelfGeneratedCertsSignalTest, self).setUp()
+        SelfPacedConfiguration(enabled=True).save()
+        self.course = CourseFactory.create(self_paced=True)
+        # Enable the feature
+        CertificateGenerationConfiguration.objects.create(enabled=True)
+
+    def test_cert_generation_enabled_for_self_paced(self):
+        """ Verify the signal enable the self-generated certificates by default for
+        self-paced courses.
+        """
+        self.assertFalse(certs_api.cert_generation_enabled(self.course.id))
+
+        _listen_for_course_publish('store', self.course.id)
+        self.assertTrue(certs_api.cert_generation_enabled(self.course.id))

lms/djangoapps/instructor/views/instructor_dashboard.py

@@ -327,6 +327,7 @@ def _section_certificates(course):
         'example_certificate_status': example_cert_status,
         'can_enable_for_course': can_enable_for_course,
         'enabled_for_course': certs_api.cert_generation_enabled(course.id),
+        'is_self_paced': course.self_paced,
         'instructor_generation_enabled': instructor_generation_enabled,
         'html_cert_enabled': html_cert_enabled,
         'active_certificate': certs_api.get_active_web_certificate(course),

lms/templates/instructor/instructor_dashboard_2/certificates.html

@@ -50,27 +50,29 @@ from openedx.core.djangolib.js_utils import dump_js_escaped_json, js_escaped_str
         % endif
     </div>
 
-    <hr />
-
-    <div class="enable-certificates">
-        <h2>${_("Student-Generated Certificates")}</h2>
-        % if section_data['enabled_for_course']:
-            <form id="enable-certificates-form" method="post" action="${section_data['urls']['enable_certificate_generation']}">
-                <input type="hidden" name="csrfmiddlewaretoken" value="${csrf_token}">
-                <input type="hidden" id="certificates-enabled" name="certificates-enabled" value="false" />
-                <input type="submit" class="btn-blue" id="disable-certificates-submit" value="${_('Disable Student-Generated Certificates')}"/>
-            </form>
-        % elif section_data['can_enable_for_course']:
-            <form id="enable-certificates-form" method="post" action="${section_data['urls']['enable_certificate_generation']}">
-                <input type="hidden" name="csrfmiddlewaretoken" value="${csrf_token}">
-                <input type="hidden" id="certificates-enabled" name="certificates-enabled" value="true" />
-                <input type="submit" class="btn-blue" id="enable-certificates-submit" value="${_('Enable Student-Generated Certificates')}"/>
-            </form>
-        % else:
-            <p>${_("You must successfully generate example certificates before you enable student-generated certificates.")}</p>
-            <button class="is-disabled" disabled>${_('Enable Student-Generated Certificates')}</button>
-        % endif
-    </div>
+    % if not section_data['is_self_paced']:
+        <hr />
+
+        <div class="enable-certificates">
+            <h2>${_("Student-Generated Certificates")}</h2>
+            % if section_data['enabled_for_course']:
+                <form id="enable-certificates-form" method="post" action="${section_data['urls']['enable_certificate_generation']}">
+                    <input type="hidden" name="csrfmiddlewaretoken" value="${csrf_token}">
+                    <input type="hidden" id="certificates-enabled" name="certificates-enabled" value="false" />
+                    <input type="submit" class="btn-blue" id="disable-certificates-submit" value="${_('Disable Student-Generated Certificates')}"/>
+                </form>
+            % elif section_data['can_enable_for_course']:
+                <form id="enable-certificates-form" method="post" action="${section_data['urls']['enable_certificate_generation']}">
+                    <input type="hidden" name="csrfmiddlewaretoken" value="${csrf_token}">
+                    <input type="hidden" id="certificates-enabled" name="certificates-enabled" value="true" />
+                    <input type="submit" class="btn-blue" id="enable-certificates-submit" value="${_('Enable Student-Generated Certificates')}"/>
+                </form>
+            % else:
+                <p>${_("You must successfully generate example certificates before you enable student-generated certificates.")}</p>
+                <button class="is-disabled" disabled>${_('Enable Student-Generated Certificates')}</button>
+            % endif
+        </div>
+    % endif
 
     % if section_data['instructor_generation_enabled'] and not (section_data['enabled_for_course'] and section_data['html_cert_enabled']):
         <hr class="section-divider" />