b353ed2ea2
The existing pattern of using `override_settings(MODULESTORE=...)` prevented
us from having more than one layer of subclassing in modulestore tests.
In a structure like:
@override_settings(MODULESTORE=store_a)
class BaseTestCase(ModuleStoreTestCase):
def setUp(self):
# use store
@override_settings(MODULESTORE=store_b)
class ChildTestCase(BaseTestCase):
def setUp(self):
# use store
In this case, the store actions performed in `BaseTestCase` on behalf of
`ChildTestCase` would still use `store_a`, even though the `ChildTestCase`
had specified to use `store_b`. This is because the `override_settings`
decorator would be the innermost wrapper around the `BaseTestCase.setUp` method,
no matter what `ChildTestCase` does.
To remedy this, we move the call to `override_settings` into the
`ModuleStoreTestCase.setUp` method, and use a cleanup to remove the override.
Subclasses can just defined the `MODULESTORE` class attribute to specify which
modulestore to use _for the entire `setUp` chain_.
[PLAT-419]
356 lines
15 KiB
Python
356 lines
15 KiB
Python
"""
|
|
Unit tests for enrollment methods in views.py
|
|
|
|
"""
|
|
|
|
import ddt
|
|
from mock import patch
|
|
|
|
from django.test.utils import override_settings
|
|
from django.contrib.auth.models import User
|
|
from django.core.urlresolvers import reverse
|
|
from courseware.tests.helpers import LoginEnrollmentTestCase
|
|
from xmodule.modulestore.tests.django_utils import TEST_DATA_MOCK_MODULESTORE
|
|
from xmodule.modulestore.tests.factories import CourseFactory
|
|
from student.tests.factories import UserFactory, CourseEnrollmentFactory, AdminFactory
|
|
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
|
|
from student.models import CourseEnrollment, CourseEnrollmentAllowed
|
|
from instructor.views.legacy import get_and_clean_student_list, send_mail_to_student
|
|
from django.core import mail
|
|
|
|
USER_COUNT = 4
|
|
|
|
|
|
@ddt.ddt
|
|
class TestInstructorEnrollsStudent(ModuleStoreTestCase, LoginEnrollmentTestCase):
|
|
"""
|
|
Check Enrollment/Unenrollment with/without auto-enrollment on activation and with/without email notification
|
|
"""
|
|
|
|
def setUp(self):
|
|
super(TestInstructorEnrollsStudent, self).setUp()
|
|
|
|
instructor = AdminFactory.create()
|
|
self.client.login(username=instructor.username, password='test')
|
|
|
|
self.course = CourseFactory.create()
|
|
|
|
self.users = [
|
|
UserFactory.create(username="student%d" % i, email="student%d@test.com" % i)
|
|
for i in xrange(USER_COUNT)
|
|
]
|
|
|
|
for user in self.users:
|
|
CourseEnrollmentFactory.create(user=user, course_id=self.course.id)
|
|
|
|
# Empty the test outbox
|
|
mail.outbox = []
|
|
|
|
def test_unenrollment_email_off(self):
|
|
"""
|
|
Do un-enrollment email off test
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
# Run the Un-enroll students command
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
response = self.client.post(
|
|
url,
|
|
{
|
|
'action': 'Unenroll multiple students',
|
|
'multiple_students': 'student0@test.com student1@test.com'
|
|
}
|
|
)
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student0@test.com</td>')
|
|
self.assertContains(response, '<td>student1@test.com</td>')
|
|
self.assertContains(response, '<td>un-enrolled</td>')
|
|
|
|
# Check the enrollment table
|
|
user = User.objects.get(email='student0@test.com')
|
|
self.assertFalse(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
user = User.objects.get(email='student1@test.com')
|
|
self.assertFalse(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 0)
|
|
|
|
def test_enrollment_new_student_autoenroll_on_email_off(self):
|
|
"""
|
|
Do auto-enroll on, email off test
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
# Run the Enroll students command
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
response = self.client.post(url, {'action': 'Enroll multiple students', 'multiple_students': 'student1_1@test.com, student1_2@test.com', 'auto_enroll': 'on'})
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student1_1@test.com</td>')
|
|
self.assertContains(response, '<td>student1_2@test.com</td>')
|
|
self.assertContains(response, '<td>user does not exist, enrollment allowed, pending with auto enrollment on</td>')
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 0)
|
|
|
|
# Check the enrollmentallowed db entries
|
|
cea = CourseEnrollmentAllowed.objects.filter(email='student1_1@test.com', course_id=course.id)
|
|
self.assertEqual(1, cea[0].auto_enroll)
|
|
cea = CourseEnrollmentAllowed.objects.filter(email='student1_2@test.com', course_id=course.id)
|
|
self.assertEqual(1, cea[0].auto_enroll)
|
|
|
|
# Check there is no enrollment db entry other than for the other students
|
|
ce = CourseEnrollment.objects.filter(course_id=course.id, is_active=1)
|
|
self.assertEqual(4, len(ce))
|
|
|
|
# Create and activate student accounts with same email
|
|
self.student1 = 'student1_1@test.com'
|
|
self.password = 'bar'
|
|
self.create_account('s1_1', self.student1, self.password)
|
|
self.activate_user(self.student1)
|
|
|
|
self.student2 = 'student1_2@test.com'
|
|
self.create_account('s1_2', self.student2, self.password)
|
|
self.activate_user(self.student2)
|
|
|
|
# Check students are enrolled
|
|
user = User.objects.get(email='student1_1@test.com')
|
|
self.assertTrue(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
user = User.objects.get(email='student1_2@test.com')
|
|
self.assertTrue(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
def test_repeat_enroll(self):
|
|
"""
|
|
Try to enroll an already enrolled student
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
response = self.client.post(url, {'action': 'Enroll multiple students', 'multiple_students': 'student0@test.com', 'auto_enroll': 'on'})
|
|
self.assertContains(response, '<td>student0@test.com</td>')
|
|
self.assertContains(response, '<td>already enrolled</td>')
|
|
|
|
def test_enrollmemt_new_student_autoenroll_off_email_off(self):
|
|
"""
|
|
Do auto-enroll off, email off test
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
# Run the Enroll students command
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
response = self.client.post(url, {'action': 'Enroll multiple students', 'multiple_students': 'student2_1@test.com, student2_2@test.com'})
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student2_1@test.com</td>')
|
|
self.assertContains(response, '<td>student2_2@test.com</td>')
|
|
self.assertContains(response, '<td>user does not exist, enrollment allowed, pending with auto enrollment off</td>')
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 0)
|
|
|
|
# Check the enrollmentallowed db entries
|
|
cea = CourseEnrollmentAllowed.objects.filter(email='student2_1@test.com', course_id=course.id)
|
|
self.assertEqual(0, cea[0].auto_enroll)
|
|
cea = CourseEnrollmentAllowed.objects.filter(email='student2_2@test.com', course_id=course.id)
|
|
self.assertEqual(0, cea[0].auto_enroll)
|
|
|
|
# Check there is no enrollment db entry other than for the setup instructor and students
|
|
ce = CourseEnrollment.objects.filter(course_id=course.id, is_active=1)
|
|
self.assertEqual(4, len(ce))
|
|
|
|
# Create and activate student accounts with same email
|
|
self.student = 'student2_1@test.com'
|
|
self.password = 'bar'
|
|
self.create_account('s2_1', self.student, self.password)
|
|
self.activate_user(self.student)
|
|
|
|
self.student = 'student2_2@test.com'
|
|
self.create_account('s2_2', self.student, self.password)
|
|
self.activate_user(self.student)
|
|
|
|
# Check students are not enrolled
|
|
user = User.objects.get(email='student2_1@test.com')
|
|
self.assertFalse(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
user = User.objects.get(email='student2_2@test.com')
|
|
self.assertFalse(CourseEnrollment.is_enrolled(user, course.id))
|
|
|
|
def test_get_and_clean_student_list(self):
|
|
"""
|
|
Clean user input test
|
|
"""
|
|
|
|
string = "abc@test.com, def@test.com ghi@test.com \n \n jkl@test.com \n mno@test.com "
|
|
cleaned_string, cleaned_string_lc = get_and_clean_student_list(string)
|
|
self.assertEqual(cleaned_string, ['abc@test.com', 'def@test.com', 'ghi@test.com', 'jkl@test.com', 'mno@test.com'])
|
|
|
|
@ddt.data('http', 'https')
|
|
def test_enrollment_email_on(self, protocol):
|
|
"""
|
|
Do email on enroll test
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
# Create activated, but not enrolled, user
|
|
UserFactory.create(username="student3_0", email="student3_0@test.com", first_name='Autoenrolled')
|
|
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
params = {'action': 'Enroll multiple students', 'multiple_students': 'student3_0@test.com, student3_1@test.com, student3_2@test.com', 'auto_enroll': 'on', 'email_students': 'on'}
|
|
environ = {'wsgi.url_scheme': protocol}
|
|
response = self.client.post(url, params, **environ)
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student3_0@test.com</td>')
|
|
self.assertContains(response, '<td>student3_1@test.com</td>')
|
|
self.assertContains(response, '<td>student3_2@test.com</td>')
|
|
self.assertContains(response, '<td>added, email sent</td>')
|
|
self.assertContains(response, '<td>user does not exist, enrollment allowed, pending with auto enrollment on, email sent</td>')
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 3)
|
|
self.assertEqual(
|
|
mail.outbox[0].subject,
|
|
'You have been enrolled in {}'.format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[0].body,
|
|
"Dear Autoenrolled Test\n\nYou have been enrolled in {} "
|
|
"at edx.org by a member of the course staff. "
|
|
"The course should now appear on your edx.org dashboard.\n\n"
|
|
"To start accessing course materials, please visit "
|
|
"{}://edx.org/courses/{}/\n\n"
|
|
"----\nThis email was automatically sent from edx.org to Autoenrolled Test".format(
|
|
course.display_name, protocol, unicode(course.id)
|
|
)
|
|
)
|
|
|
|
self.assertEqual(
|
|
mail.outbox[1].subject,
|
|
'You have been invited to register for {}'.format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[1].body,
|
|
"Dear student,\n\nYou have been invited to join "
|
|
"{display_name} at edx.org by a member of the "
|
|
"course staff.\n\n"
|
|
"To finish your registration, please visit "
|
|
"{}://edx.org/register and fill out the registration form "
|
|
"making sure to use student3_1@test.com in the E-mail field.\n"
|
|
"Once you have registered and activated your account, you will "
|
|
"see {display_name} listed on your dashboard.\n\n"
|
|
"----\nThis email was automatically sent from edx.org to "
|
|
"student3_1@test.com".format(protocol, display_name=course.display_name)
|
|
)
|
|
|
|
def test_unenrollment_email_on(self):
|
|
"""
|
|
Do email on unenroll test
|
|
"""
|
|
|
|
course = self.course
|
|
|
|
# Create invited, but not registered, user
|
|
cea = CourseEnrollmentAllowed(email='student4_0@test.com', course_id=course.id)
|
|
cea.save()
|
|
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
response = self.client.post(url, {'action': 'Unenroll multiple students', 'multiple_students': 'student4_0@test.com, student2@test.com, student3@test.com', 'email_students': 'on'})
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student2@test.com</td>')
|
|
self.assertContains(response, '<td>student3@test.com</td>')
|
|
self.assertContains(response, '<td>un-enrolled, email sent</td>')
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 3)
|
|
self.assertEqual(
|
|
mail.outbox[0].subject,
|
|
'You have been un-enrolled from {}'.format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[0].body,
|
|
"Dear Student,\n\nYou have been un-enrolled from course "
|
|
"{} by a member of the course staff. "
|
|
"Please disregard the invitation previously sent.\n\n"
|
|
"----\nThis email was automatically sent from edx.org "
|
|
"to student4_0@test.com".format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[1].subject,
|
|
'You have been un-enrolled from {}'.format(course.display_name)
|
|
)
|
|
|
|
def test_send_mail_to_student(self):
|
|
"""
|
|
Do invalid mail template test
|
|
"""
|
|
|
|
d = {'message': 'message_type_that_doesn\'t_exist'}
|
|
|
|
send_mail_ret = send_mail_to_student('student0@test.com', d)
|
|
self.assertFalse(send_mail_ret)
|
|
|
|
@ddt.data('http', 'https')
|
|
@patch('instructor.views.legacy.uses_shib')
|
|
def test_enrollment_email_on_shib_on(self, protocol, mock_uses_shib):
|
|
# Do email on enroll, shibboleth on test
|
|
|
|
course = self.course
|
|
mock_uses_shib.return_value = True
|
|
|
|
# Create activated, but not enrolled, user
|
|
UserFactory.create(username="student5_0", email="student5_0@test.com", first_name="ShibTest", last_name="Enrolled")
|
|
|
|
url = reverse('instructor_dashboard_legacy', kwargs={'course_id': course.id.to_deprecated_string()})
|
|
params = {'action': 'Enroll multiple students', 'multiple_students': 'student5_0@test.com, student5_1@test.com', 'auto_enroll': 'on', 'email_students': 'on'}
|
|
environ = {'wsgi.url_scheme': protocol}
|
|
response = self.client.post(url, params, **environ)
|
|
|
|
# Check the page output
|
|
self.assertContains(response, '<td>student5_0@test.com</td>')
|
|
self.assertContains(response, '<td>student5_1@test.com</td>')
|
|
self.assertContains(response, '<td>added, email sent</td>')
|
|
self.assertContains(response, '<td>user does not exist, enrollment allowed, pending with auto enrollment on, email sent</td>')
|
|
|
|
# Check the outbox
|
|
self.assertEqual(len(mail.outbox), 2)
|
|
self.assertEqual(
|
|
mail.outbox[0].subject,
|
|
'You have been enrolled in {}'.format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[0].body,
|
|
"Dear ShibTest Enrolled\n\nYou have been enrolled in {} "
|
|
"at edx.org by a member of the course staff. "
|
|
"The course should now appear on your edx.org dashboard.\n\n"
|
|
"To start accessing course materials, please visit "
|
|
"{}://edx.org/courses/{}/\n\n"
|
|
"----\nThis email was automatically sent from edx.org to ShibTest Enrolled".format(
|
|
course.display_name, protocol, unicode(course.id)
|
|
)
|
|
)
|
|
|
|
self.assertEqual(
|
|
mail.outbox[1].subject,
|
|
'You have been invited to register for {}'.format(course.display_name)
|
|
)
|
|
self.assertEqual(
|
|
mail.outbox[1].body,
|
|
"Dear student,\n\nYou have been invited to join "
|
|
"{} at edx.org by a member of the "
|
|
"course staff.\n\n"
|
|
"To access the course visit {}://edx.org/courses/{}/ and login.\n\n"
|
|
"----\nThis email was automatically sent from edx.org to "
|
|
"student5_1@test.com".format(
|
|
course.display_name, protocol, course.id
|
|
)
|
|
)
|