280 lines
10 KiB
Python
280 lines
10 KiB
Python
"""Tests for display of certificates on the student dashboard. """
|
|
|
|
|
|
import datetime
|
|
import unittest
|
|
from unittest.mock import patch
|
|
|
|
import ddt
|
|
from django.conf import settings
|
|
from django.test.utils import override_settings
|
|
from django.urls import reverse
|
|
from pytz import UTC
|
|
|
|
from common.djangoapps.course_modes.models import CourseMode
|
|
from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory
|
|
from lms.djangoapps.certificates.api import get_certificate_url
|
|
from lms.djangoapps.certificates.models import CertificateStatuses
|
|
from lms.djangoapps.certificates.tests.factories import (
|
|
GeneratedCertificateFactory,
|
|
LinkedInAddToProfileConfigurationFactory
|
|
)
|
|
from xmodule.modulestore import ModuleStoreEnum
|
|
from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase
|
|
from xmodule.modulestore.tests.factories import CourseFactory
|
|
|
|
# pylint: disable=no-member
|
|
|
|
PAST_DATE = datetime.datetime.now(UTC) - datetime.timedelta(days=2)
|
|
FUTURE_DATE = datetime.datetime.now(UTC) + datetime.timedelta(days=2)
|
|
|
|
|
|
class CertificateDisplayTestBase(SharedModuleStoreTestCase):
|
|
"""Tests display of certificates on the student dashboard. """
|
|
|
|
USERNAME = "test_user"
|
|
PASSWORD = "password"
|
|
DOWNLOAD_URL = "http://www.example.com/certificate.pdf"
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.course = CourseFactory()
|
|
cls.course.certificates_display_behavior = "early_with_info"
|
|
|
|
with cls.store.branch_setting(ModuleStoreEnum.Branch.draft_preferred, cls.course.id):
|
|
cls.store.update_item(cls.course, cls.USERNAME)
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.user = UserFactory.create(username=self.USERNAME, password=self.PASSWORD)
|
|
result = self.client.login(username=self.USERNAME, password=self.PASSWORD)
|
|
assert result, 'Could not log in'
|
|
|
|
def _check_linkedin_visibility(self, is_visible):
|
|
"""
|
|
Performs assertions on the Dashboard
|
|
"""
|
|
response = self.client.get(reverse('dashboard'))
|
|
if is_visible:
|
|
self.assertContains(response, 'Add Certificate to LinkedIn Profile')
|
|
else:
|
|
self.assertNotContains(response, 'Add Certificate to LinkedIn Profile')
|
|
|
|
def _create_certificate(self, enrollment_mode, download_url=DOWNLOAD_URL):
|
|
"""Simulate that the user has a generated certificate. """
|
|
CourseEnrollmentFactory.create(
|
|
user=self.user,
|
|
course_id=self.course.id,
|
|
mode=enrollment_mode)
|
|
return GeneratedCertificateFactory(
|
|
user=self.user,
|
|
course_id=self.course.id,
|
|
mode=enrollment_mode,
|
|
download_url=download_url,
|
|
status=CertificateStatuses.downloadable,
|
|
grade=0.98,
|
|
)
|
|
|
|
def _check_can_download_certificate(self):
|
|
"""
|
|
Inspect the dashboard to see if a certificate can be downloaded.
|
|
"""
|
|
response = self.client.get(reverse('dashboard'))
|
|
self.assertContains(response, 'Download Your ID Verified')
|
|
self.assertContains(response, self.DOWNLOAD_URL)
|
|
|
|
def _check_can_download_certificate_no_id(self):
|
|
"""
|
|
Inspects the dashboard to see if a certificate for a non verified course enrollment
|
|
is present
|
|
"""
|
|
response = self.client.get(reverse('dashboard'))
|
|
self.assertContains(response, 'Download')
|
|
self.assertContains(response, '(PDF)')
|
|
self.assertContains(response, self.DOWNLOAD_URL)
|
|
|
|
def _check_can_not_download_certificate(self):
|
|
"""
|
|
Make sure response does not have any of the download certificate buttons
|
|
"""
|
|
response = self.client.get(reverse('dashboard'))
|
|
self.assertNotContains(response, 'View Test_Certificate')
|
|
self.assertNotContains(response, 'Download Your Test_Certificate (PDF)')
|
|
self.assertNotContains(response, 'Download Test_Certificate (PDF)')
|
|
self.assertNotContains(response, self.DOWNLOAD_URL)
|
|
|
|
|
|
@ddt.ddt
|
|
@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
|
|
class CertificateDashboardMessageDisplayTest(CertificateDisplayTestBase):
|
|
"""
|
|
Tests the certificates messages for a course in the dashboard.
|
|
"""
|
|
|
|
ENABLED_SIGNALS = ['course_published']
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.course.certificates_display_behavior = "end"
|
|
cls.course.save()
|
|
cls.store.update_item(cls.course, cls.USERNAME)
|
|
|
|
def _check_message(self, certificate_available_date): # lint-amnesty, pylint: disable=missing-function-docstring
|
|
response = self.client.get(reverse('dashboard'))
|
|
|
|
if certificate_available_date is None:
|
|
self.assertNotContains(response, "Your certificate will be available on")
|
|
self.assertNotContains(response, "View Test_Certificate")
|
|
elif datetime.datetime.now(UTC) < certificate_available_date:
|
|
self.assertContains(response, "Your certificate will be available on")
|
|
self.assertNotContains(response, "View Test_Certificate")
|
|
else:
|
|
self._check_can_download_certificate()
|
|
|
|
@ddt.data(True, False, None)
|
|
def test_certificate_available_date(self, past_certificate_available_date):
|
|
cert = self._create_certificate('verified')
|
|
cert.status = CertificateStatuses.downloadable
|
|
cert.save()
|
|
|
|
if past_certificate_available_date is None:
|
|
certificate_available_date = None
|
|
elif past_certificate_available_date:
|
|
certificate_available_date = PAST_DATE
|
|
elif not past_certificate_available_date:
|
|
certificate_available_date = FUTURE_DATE
|
|
|
|
self.course.certificate_available_date = certificate_available_date
|
|
self.course.save()
|
|
self.store.update_item(self.course, self.USERNAME)
|
|
|
|
self._check_message(certificate_available_date)
|
|
|
|
|
|
@ddt.ddt
|
|
@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
|
|
class CertificateDisplayTest(CertificateDisplayTestBase):
|
|
"""
|
|
Tests of certificate display.
|
|
"""
|
|
|
|
@ddt.data('verified', 'professional')
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': False})
|
|
def test_display_verified_certificate(self, enrollment_mode):
|
|
self._create_certificate(enrollment_mode)
|
|
self._check_can_download_certificate()
|
|
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': False})
|
|
def test_no_certificate_status_no_problem(self):
|
|
with patch('common.djangoapps.student.views.dashboard.cert_info', return_value={}):
|
|
self._create_certificate('honor')
|
|
self._check_can_not_download_certificate()
|
|
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': False})
|
|
def test_display_verified_certificate_no_id(self):
|
|
"""
|
|
Confirm that if we get a certificate with a no-id-professional mode
|
|
we still can download our certificate
|
|
"""
|
|
self._create_certificate(CourseMode.NO_ID_PROFESSIONAL_MODE)
|
|
self._check_can_download_certificate_no_id()
|
|
|
|
@ddt.data('verified', 'honor', 'professional')
|
|
def test_unverified_certificate_message(self, enrollment_mode):
|
|
cert = self._create_certificate(enrollment_mode)
|
|
cert.status = CertificateStatuses.unverified
|
|
cert.save()
|
|
response = self.client.get(reverse('dashboard'))
|
|
self.assertContains(
|
|
response,
|
|
'do not have a current verified identity with {platform_name}'
|
|
.format(platform_name=settings.PLATFORM_NAME))
|
|
|
|
def test_post_to_linkedin_visibility(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')
|
|
|
|
# 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
|
|
@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
|
|
class CertificateDisplayTestHtmlView(CertificateDisplayTestBase):
|
|
"""
|
|
Tests of webview certificate display
|
|
"""
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.course.cert_html_view_enabled = True
|
|
cls.course.save()
|
|
cls.store.update_item(cls.course, cls.USERNAME)
|
|
|
|
@ddt.data('verified', 'honor')
|
|
@override_settings(CERT_NAME_SHORT='Test_Certificate')
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True})
|
|
def test_display_download_certificate_button(self, enrollment_mode):
|
|
"""
|
|
Tests if CERTIFICATES_HTML_VIEW is True
|
|
and course has enabled web certificates via cert_html_view_enabled setting
|
|
and no active certificate configuration available
|
|
then any of the web view certificate Download button should not be visible.
|
|
"""
|
|
self._create_certificate(enrollment_mode, download_url='')
|
|
self._check_can_not_download_certificate()
|
|
|
|
|
|
@ddt.ddt
|
|
@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
|
|
class CertificateDisplayTestLinkedHtmlView(CertificateDisplayTestBase):
|
|
"""
|
|
Tests of linked student certificates.
|
|
"""
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
super().setUpClass()
|
|
cls.course.cert_html_view_enabled = True
|
|
|
|
certificates = [
|
|
{
|
|
'id': 0,
|
|
'name': 'Test Name',
|
|
'description': 'Test Description',
|
|
'is_active': True,
|
|
'signatories': [],
|
|
'version': 1
|
|
}
|
|
]
|
|
cls.course.certificates = {'certificates': certificates}
|
|
|
|
cls.course.save()
|
|
cls.store.update_item(cls.course, cls.USERNAME)
|
|
|
|
@ddt.data('verified')
|
|
@override_settings(CERT_NAME_SHORT='Test_Certificate')
|
|
@patch.dict('django.conf.settings.FEATURES', {'CERTIFICATES_HTML_VIEW': True})
|
|
def test_linked_student_to_web_view_credential(self, enrollment_mode):
|
|
|
|
cert = self._create_certificate(enrollment_mode)
|
|
test_url = get_certificate_url(course_id=self.course.id, uuid=cert.verify_uuid)
|
|
|
|
response = self.client.get(reverse('dashboard'))
|
|
|
|
self.assertContains(response, 'View Test_Certificate')
|
|
self.assertContains(response, test_url)
|