Merge pull request #201 from edx/hasnain-naveed/PHX-172

PHX-172/template added if due date for exam has passed

edx_proctoring/api.py

@@ -325,8 +325,42 @@ def update_exam_attempt(attempt_id, **kwargs):
 def _has_due_date_passed(due_datetime):
     """
     return True if due date is lesser than current datetime, otherwise False
+    and if due_datetime is None then we don't have to consider the due date for return False
     """
-    return due_datetime <= datetime.now(pytz.UTC)
+
+    if due_datetime:
+        return due_datetime <= datetime.now(pytz.UTC)
+    return False
+
+
+def _create_and_decline_attempt(exam_id, user_id):
+    """
+    It will create the exam attempt and change the attempt's status to decline.
+    it will auto-decline further exams too
+    """
+
+    create_exam_attempt(exam_id, user_id)
+    update_attempt_status(
+        exam_id,
+        user_id,
+        ProctoredExamStudentAttemptStatus.declined,
+        raise_if_not_found=False
+    )
+
+
+def _create_and_expire_attempt(exam_id, user_id):
+    """
+    It will create the exam attempt and change the attempt's status to decline.
+    it will auto-decline further exams too
+    """
+
+    create_exam_attempt(exam_id, user_id)
+    update_attempt_status(
+        exam_id,
+        user_id,
+        ProctoredExamStudentAttemptStatus.expired,
+        raise_if_not_found=False
+    )
 
 
 def create_exam_attempt(exam_id, user_id, taking_as_proctored=False):
@@ -1116,6 +1150,11 @@ STATUS_SUMMARY_MAP = {
         'short_description': _('Failed Proctoring'),
         'suggested_icon': 'fa-exclamation-triangle',
         'in_completed_state': True
+    },
+    ProctoredExamStudentAttemptStatus.expired: {
+        'short_description': _('Exam Expired'),
+        'suggested_icon': 'fa-exclamation-triangle',
+        'in_completed_state': True
     }
 }
 
@@ -1135,6 +1174,11 @@ PRACTICE_STATUS_SUMMARY_MAP = {
         'short_description': _('Practice Exam Failed'),
         'suggested_icon': 'fa-exclamation-triangle',
         'in_completed_state': True
+    },
+    ProctoredExamStudentAttemptStatus.expired: {
+        'short_description': _('Exam Expired'),
+        'suggested_icon': 'fa-exclamation-triangle',
+        'in_completed_state': True
     }
 }
 
@@ -1230,10 +1274,16 @@ def _get_timed_exam_view(exam, context, exam_id, user_id, course_id):
     attempt_status = attempt['status'] if attempt else None
 
     if not attempt_status:
-        student_view_template = 'timed_exam/entrance.html'
+        if _has_due_date_passed(exam['due_date']):
+            _create_and_expire_attempt(exam_id, user_id)
+            student_view_template = 'proctored_exam/expired.html'
+        else:
+            student_view_template = 'timed_exam/entrance.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.started:
-        # when we're taking the exam we should override the view
+        # when we're taking the exam we should not override the view
         return None
+    elif attempt_status == ProctoredExamStudentAttemptStatus.expired:
+        student_view_template = 'proctored_exam/expired.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.ready_to_submit:
         student_view_template = 'timed_exam/ready_to_submit.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.submitted:
@@ -1335,10 +1385,16 @@ def _get_practice_exam_view(exam, context, exam_id, user_id, course_id):
     attempt_status = attempt['status'] if attempt else None
 
     if not attempt_status:
-        student_view_template = 'practice_exam/entrance.html'
+        if _has_due_date_passed(exam['due_date']):
+            _create_and_expire_attempt(exam_id, user_id)
+            student_view_template = 'proctored_exam/expired.html'
+        else:
+            student_view_template = 'practice_exam/entrance.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.started:
-        # when we're taking the exam we should override the view
+        # when we're taking the exam we should not override the view
         return None
+    elif attempt_status == ProctoredExamStudentAttemptStatus.expired:
+        student_view_template = 'proctored_exam/expired.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.created:
         provider = get_backend_provider()
         student_view_template = 'proctored_exam/instructions.html'
@@ -1423,20 +1479,17 @@ def _get_proctored_exam_view(exam, context, exam_id, user_id, course_id):
             'prerequisite_status': prerequisite_status
         })
 
-        if not prerequisite_status['are_prerequisites_satisifed']:
+        # if exam due date has passed, then we can't take the exam
+        if _has_due_date_passed(exam['due_date']):
+            _create_and_expire_attempt(exam_id, user_id)
+            student_view_template = 'proctored_exam/expired.html'
+        elif not prerequisite_status['are_prerequisites_satisifed']:
             # do we have any declined prerequisites, if so, then we
             # will auto-decline this proctored exam
             if prerequisite_status['declined_prerequisites']:
                 # user hasn't a record of attempt, create one now
                 # so we can mark it as declined
-                create_exam_attempt(exam_id, user_id)
-
-                update_attempt_status(
-                    exam_id,
-                    user_id,
-                    ProctoredExamStudentAttemptStatus.declined,
-                    raise_if_not_found=False
-                )
+                _create_and_decline_attempt(exam_id, user_id)
                 return None
 
             # do we have failed prerequisites? That takes priority in terms of
@@ -1458,8 +1511,10 @@ def _get_proctored_exam_view(exam, context, exam_id, user_id, course_id):
         else:
             student_view_template = 'proctored_exam/entrance.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.started:
-        # when we're taking the exam we should override the view
+        # when we're taking the exam we should not override the view
         return None
+    elif attempt_status == ProctoredExamStudentAttemptStatus.expired:
+        student_view_template = 'proctored_exam/expired.html'
     elif attempt_status == ProctoredExamStudentAttemptStatus.created:
         provider = get_backend_provider()
         student_view_template = 'proctored_exam/instructions.html'

edx_proctoring/models.py

@@ -156,6 +156,9 @@ class ProctoredExamStudentAttemptStatus(object):
     # the exam is believed to be in error
     error = 'error'
 
+    # the exam has expired, i.e. past due date
+    expired = 'expired'
+
     # status alias for sending email
     status_alias_mapping = {
         submitted: _('pending'),
@@ -171,7 +174,7 @@ class ProctoredExamStudentAttemptStatus(object):
         """
         return status in [
             cls.declined, cls.timed_out, cls.submitted, cls.verified, cls.rejected,
-            cls.not_reviewed, cls.error
+            cls.not_reviewed, cls.error, cls.expired
         ]
 
     @classmethod
@@ -190,7 +193,7 @@ class ProctoredExamStudentAttemptStatus(object):
         """
         return to_status in [
             cls.verified, cls.rejected, cls.declined, cls.not_reviewed, cls.submitted,
-            cls.error
+            cls.error, cls.expired
         ]
 
     @classmethod

edx_proctoring/templates/proctored_exam/expired.html

+{% load i18n %}
+<div class="sequence proctored-exam completed" data-exam-id="{{exam_id}}">
+  <h3>
+    {% blocktrans %}
+      The due date for this exam has passed
+    {% endblocktrans %}
+  </h3>
+  <p>
+    {% blocktrans %}
+      Because the due date has passed, you are no longer able to take this exam.
+    {% endblocktrans %}
+  </p>
+  <hr>
+  <p>
+    {% blocktrans %}
+      View your credit eligibility status on your <a href="{{progress_page_url}}">Progress</a> page.
+    {% endblocktrans %}
+  </p>
+</div>
+{% include 'proctored_exam/footer.html' %}