+ {% blocktrans %} + Hi {{ username }}, + {% endblocktrans %} +
++ {% blocktrans %} + Your proctored exam "{{ exam_name }}" in + {{ course_name }} was reviewed and you + met all exam requirements. You can view your grade on the course + progress page. + {% endblocktrans %} +
++ {% blocktrans %} + If you have any questions about your results, contact {{ platform }} + support at + + {{ contact_email }} + . + {% endblocktrans %} +
diff --git a/edx_proctoring/templates/emails/proctoring_attempt_status_email.html b/edx_proctoring/templates/emails/proctoring_attempt_status_email.html deleted file mode 100644 index 471984ba110..00000000000 --- a/edx_proctoring/templates/emails/proctoring_attempt_status_email.html +++ /dev/null @@ -1,9 +0,0 @@ -{% load i18n %} - -{% blocktrans %} - -This email is to let you know that the status of your proctoring session review for {{ exam_name }} in -{{ course_name }} is {{ status }}. If you have any questions about proctoring, -contact {{ platform }} support at {{ contact_email }}. - -{% endblocktrans %} \ No newline at end of file diff --git a/edx_proctoring/templates/emails/proctoring_attempt_submitted_email.html b/edx_proctoring/templates/emails/proctoring_attempt_submitted_email.html new file mode 100644 index 00000000000..7c7ccddda48 --- /dev/null +++ b/edx_proctoring/templates/emails/proctoring_attempt_submitted_email.html @@ -0,0 +1,25 @@ +{% load i18n %} + ++ {% blocktrans %} + Hi {{ username }}, + {% endblocktrans %} +
++ {% blocktrans %} + Your proctored exam "{{ exam_name }}" in + {{ course_name }} was submitted + successfully and will now be reviewed to ensure all proctoring exam + rules were followed. You should receive an email with your updated exam + status within 5 business days. + {% endblocktrans %} +
++ {% blocktrans %} + If you have any questions about proctoring, contact {{ platform }} + support at + + {{ contact_email }} + . + {% endblocktrans %} +
diff --git a/edx_proctoring/templates/emails/proctoring_attempt_unsatisfactory_email.html b/edx_proctoring/templates/emails/proctoring_attempt_unsatisfactory_email.html new file mode 100644 index 00000000000..a659bd0ef03 --- /dev/null +++ b/edx_proctoring/templates/emails/proctoring_attempt_unsatisfactory_email.html @@ -0,0 +1,27 @@ +{% load i18n %} + ++ {% blocktrans %} + Hi {{ username }}, + {% endblocktrans %} +
++ {% blocktrans %} + Your proctored exam "{{ exam_name }}" in + {{ course_name }} was reviewed and the + team found one or more violations of the proctored exam rules. Examples + of behaviors that may result in a rules violation include browsing + the internet, using a phone, or getting help from another person. As a + result of the violation(s), you did not successfully meet the proctored + exam requirements. + {% endblocktrans %} +
++ {% blocktrans %} + If you have any questions about your results, contact {{ platform }} + support at + + {{ contact_email }} + . + {% endblocktrans %} +
diff --git a/edx_proctoring/tests/test_email.py b/edx_proctoring/tests/test_email.py index d205e9e4671..8407a22dfe8 100644 --- a/edx_proctoring/tests/test_email.py +++ b/edx_proctoring/tests/test_email.py @@ -31,22 +31,25 @@ class ProctoredExamEmailTests(ProctoredExamTestCase): All tests for proctored exam emails. """ - def setUp(self): - """ - Build out test harnessing - """ - super(ProctoredExamEmailTests, self).setUp() - - # Messages for get_student_view - self.proctored_exam_email_subject = 'Proctoring Session Results Update' - self.proctored_exam_email_body = 'the status of your proctoring session review' - @ddt.data( - ProctoredExamStudentAttemptStatus.submitted, - ProctoredExamStudentAttemptStatus.verified, - ProctoredExamStudentAttemptStatus.rejected + [ + ProctoredExamStudentAttemptStatus.submitted, + 'Proctoring Review In Progress', + 'was submitted successfully', + ], + [ + ProctoredExamStudentAttemptStatus.verified, + 'Proctoring Results', + 'was reviewed and you met all exam requirements', + ], + [ + ProctoredExamStudentAttemptStatus.rejected, + 'Proctoring Results', + 'the team found one or more violations', + ] ) - def test_send_email(self, status): + @ddt.unpack + def test_send_email(self, status, expected_subject, expected_message_string): """ Assert that email is sent on the following statuses of proctoring attempt. """ @@ -59,27 +62,18 @@ def test_send_email(self, status): status ) self.assertEquals(len(mail.outbox), 1) - self.assertIn(self.proctored_exam_email_subject, mail.outbox[0].subject) - self.assertIn(self.proctored_exam_email_body, mail.outbox[0].body) - self.assertIn(ProctoredExamStudentAttemptStatus.get_status_alias(status), mail.outbox[0].body) - self.assertIn(credit_state['course_name'], mail.outbox[0].body) - @ddt.data( - ProctoredExamStudentAttemptStatus.second_review_required, - ProctoredExamStudentAttemptStatus.error - ) - def test_email_not_sent(self, status): - """ - Assert than email is not sent on the following statuses of proctoring attempt - """ + # Verify the subject + actual_subject = self._normalize_whitespace(mail.outbox[0].subject) + self.assertIn(expected_subject, actual_subject) + self.assertIn(self.exam_name, actual_subject) - exam_attempt = self._create_started_exam_attempt() - update_attempt_status( - exam_attempt.proctored_exam_id, - self.user.id, - status - ) - self.assertEquals(len(mail.outbox), 0) + # Verify the body + actual_body = self._normalize_whitespace(mail.outbox[0].body) + self.assertIn('Hi tester,', actual_body) + self.assertIn('Your proctored exam "Test Exam"', actual_body) + self.assertIn(credit_state['course_name'], actual_body) + self.assertIn(expected_message_string, actual_body) def test_send_email_unicode(self): """ @@ -97,16 +91,16 @@ def test_send_email_unicode(self): ProctoredExamStudentAttemptStatus.submitted ) self.assertEquals(len(mail.outbox), 1) - self.assertIn(self.proctored_exam_email_subject, mail.outbox[0].subject) - self.assertIn(course_name, mail.outbox[0].subject) - self.assertIn(self.proctored_exam_email_body, mail.outbox[0].body) - self.assertIn( - ProctoredExamStudentAttemptStatus.get_status_alias( - ProctoredExamStudentAttemptStatus.submitted - ), - mail.outbox[0].body - ) - self.assertIn(credit_state['course_name'], mail.outbox[0].body) + + # Verify the subject + actual_subject = self._normalize_whitespace(mail.outbox[0].subject) + self.assertIn('Proctoring Review In Progress', actual_subject) + self.assertIn(course_name, actual_subject) + + # Verify the body + actual_body = self._normalize_whitespace(mail.outbox[0].body) + self.assertIn('was submitted successfully', actual_body) + self.assertIn(credit_state['course_name'], actual_body) @ddt.data( ProctoredExamStudentAttemptStatus.eligible, @@ -117,12 +111,13 @@ def test_send_email_unicode(self): ProctoredExamStudentAttemptStatus.ready_to_submit, ProctoredExamStudentAttemptStatus.declined, ProctoredExamStudentAttemptStatus.timed_out, - ProctoredExamStudentAttemptStatus.error + ProctoredExamStudentAttemptStatus.second_review_required, + ProctoredExamStudentAttemptStatus.error, ) @patch.dict('django.conf.settings.PROCTORING_SETTINGS', {'ALLOW_TIMED_OUT_STATE': True}) - def test_not_send_email(self, status): + def test_email_not_sent(self, status): """ - Assert that email is not sent on the following statuses of proctoring attempt. + Assert that an email is not sent for the following attempt status codes. """ exam_attempt = self._create_started_exam_attempt() diff --git a/edx_proctoring/tests/utils.py b/edx_proctoring/tests/utils.py index a2fa8841de3..aa6b3d96a7e 100644 --- a/edx_proctoring/tests/utils.py +++ b/edx_proctoring/tests/utils.py @@ -341,3 +341,10 @@ def _create_started_practice_exam_attempt(self, started_at=None): status=ProctoredExamStudentAttemptStatus.started, allowed_time_limit_mins=10 ) + + @staticmethod + def _normalize_whitespace(string): + """ + Replaces newlines and multiple spaces with a single space. + """ + return ' '.join(string.replace('\n', '').split())