622d56026c
feat: reimagine certificate display settings The course settings `certificate_available_date` (CAD) and `certificates_display_behavior` (CDB) were previously acting indedependantly of one another. They now work in tandem. This change: - limits CDB to a dropdown - removes "early_with_info" and adds "end_with_date" - only takes CAD into account if "end_with_date" is selected - Moves CDB to the main course schedule settings page - updates CourseOverview model and CourseDetails objects to validate these fields and choose sane defaults if they aren't expected values This work was previously done in bd9e7dd (complete with bugs), so this version is toggleable via the ENABLE_V2_CERT_DISPLAY_SETTINGS setting
133 lines
5.3 KiB
Python
133 lines
5.3 KiB
Python
"""
|
|
Tests for Certificates app utility functions
|
|
"""
|
|
from datetime import datetime, timedelta
|
|
from unittest.mock import patch
|
|
|
|
import ddt
|
|
from django.conf import settings
|
|
from django.test import TestCase
|
|
from pytz import utc
|
|
|
|
from lms.djangoapps.certificates.utils import has_html_certificates_enabled, should_certificate_be_visible
|
|
from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory
|
|
from xmodule.data import CertificatesDisplayBehaviors
|
|
|
|
_TODAY = datetime.now(utc)
|
|
_LAST_MONTH = _TODAY - timedelta(days=30)
|
|
_LAST_WEEK = _TODAY - timedelta(days=7)
|
|
_NEXT_WEEK = _TODAY + timedelta(days=7)
|
|
|
|
|
|
@ddt.ddt
|
|
class CertificateUtilityTests(TestCase):
|
|
"""
|
|
Tests for course certificate utility functions
|
|
"""
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.course_overview = CourseOverviewFactory.create()
|
|
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': False})
|
|
def test_has_html_certificates_enabled_from_course_overview_cert_html_view_disabled(self):
|
|
"""
|
|
Test to ensure we return the correct value when the `CERTIFICATES_HTML_VIEW` setting is disabled.
|
|
"""
|
|
assert not has_html_certificates_enabled(self.course_overview)
|
|
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True})
|
|
def test_has_html_certificates_enabled_from_course_overview_enabled(self):
|
|
"""
|
|
Test to ensure we return the correct value when the HTML certificates are enabled in a course-run.
|
|
"""
|
|
self.course_overview.cert_html_view_enabled = True
|
|
self.course_overview.save()
|
|
|
|
assert has_html_certificates_enabled(self.course_overview)
|
|
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True})
|
|
def test_has_html_certificates_enabled_from_course_overview_disabled(self):
|
|
"""
|
|
Test to ensure we return the correct value when the HTML certificates are disabled in a course-run.
|
|
"""
|
|
self.course_overview.cert_html_view_enabled = False
|
|
self.course_overview.save()
|
|
|
|
assert not has_html_certificates_enabled(self.course_overview)
|
|
|
|
@ddt.data(
|
|
# Test certificates_show_before_end
|
|
(CertificatesDisplayBehaviors.EARLY_NO_INFO, True, False, _LAST_MONTH, False, True),
|
|
(CertificatesDisplayBehaviors.END, True, False, _LAST_MONTH, False, True),
|
|
(CertificatesDisplayBehaviors.END_WITH_DATE, True, False, _NEXT_WEEK, False, True),
|
|
|
|
# Test that EARLY_NO_INFO
|
|
(CertificatesDisplayBehaviors.EARLY_NO_INFO, True, True, _LAST_MONTH, False, True),
|
|
(CertificatesDisplayBehaviors.EARLY_NO_INFO, False, False, _LAST_MONTH, False, True),
|
|
|
|
# Test END_WITH_DATE
|
|
(CertificatesDisplayBehaviors.END_WITH_DATE, False, False, _LAST_MONTH, False, True),
|
|
(CertificatesDisplayBehaviors.END_WITH_DATE, False, False, _LAST_WEEK, False, True),
|
|
(CertificatesDisplayBehaviors.END_WITH_DATE, False, False, _NEXT_WEEK, False, False),
|
|
(CertificatesDisplayBehaviors.END_WITH_DATE, False, False, None, False, False),
|
|
|
|
# Test END
|
|
(CertificatesDisplayBehaviors.END, False, False, _LAST_MONTH, False, False),
|
|
(CertificatesDisplayBehaviors.END, False, True, _LAST_MONTH, False, True),
|
|
|
|
# Test self_paced
|
|
(CertificatesDisplayBehaviors.END, False, False, _LAST_MONTH, False, False),
|
|
(CertificatesDisplayBehaviors.END, False, False, _LAST_MONTH, True, True),
|
|
)
|
|
@ddt.unpack
|
|
@patch.dict(settings.FEATURES, ENABLE_V2_CERT_DISPLAY_SETTINGS=True)
|
|
def test_should_certificate_be_visible_v2(
|
|
self,
|
|
certificates_display_behavior,
|
|
certificates_show_before_end,
|
|
has_ended,
|
|
certificate_available_date,
|
|
self_paced,
|
|
expected_value
|
|
):
|
|
"""Test whether the certificate should be visible to user given multiple usecases"""
|
|
assert should_certificate_be_visible(
|
|
certificates_display_behavior,
|
|
certificates_show_before_end,
|
|
has_ended,
|
|
certificate_available_date,
|
|
self_paced
|
|
) == expected_value
|
|
|
|
@ddt.data(
|
|
('early_with_info', True, True, _LAST_MONTH, False, True),
|
|
('early_no_info', False, False, _LAST_MONTH, False, True),
|
|
('end', True, False, _LAST_MONTH, False, True),
|
|
('end', False, True, _LAST_MONTH, False, True),
|
|
('end', False, False, _NEXT_WEEK, False, False),
|
|
('end', False, False, _LAST_WEEK, False, True),
|
|
('end', False, False, None, False, False),
|
|
('early_with_info', False, False, None, False, True),
|
|
('end', False, False, _NEXT_WEEK, False, False),
|
|
('end', False, False, _NEXT_WEEK, True, True),
|
|
)
|
|
@ddt.unpack
|
|
@patch.dict(settings.FEATURES, ENABLE_V2_CERT_DISPLAY_SETTINGS=False)
|
|
def test_should_certificate_be_visible_v1(
|
|
self,
|
|
certificates_display_behavior,
|
|
certificates_show_before_end,
|
|
has_ended,
|
|
certificate_available_date,
|
|
self_paced,
|
|
expected_value
|
|
):
|
|
"""Test whether the certificate should be visible to user given multiple usecases"""
|
|
assert should_certificate_be_visible(
|
|
certificates_display_behavior,
|
|
certificates_show_before_end,
|
|
has_ended,
|
|
certificate_available_date,
|
|
self_paced
|
|
) == expected_value
|