Merge branch 'master' into mohtamba/get_bulk_allowances_endpoint

CHANGELOG.rst

@@ -18,6 +18,11 @@ Unreleased
 ~~~~~~~~~~~~~~~~~~~~~
 * Created a GET api endpoint which groups course allowances by users.
 
+[3.15.1] - 2021-06-16
+~~~~~~~~~~~~~~~~~~~~~
+* Fix a bug in exam attempt API where total time allowed for the exam would not include allowance time.
+* Add `test_plan` document to describe key features and test cases
+
 [3.15.0] - 2021-06-15
 ~~~~~~~~~~~~~~~~~~~~~
 * Created a POST api endpoint to add allowances for multiple students and multiple exams at the same time.

docs/developing.rst

@@ -269,3 +269,10 @@ Release a new version of edx-proctoring
     * In edx-platform, create a branch and update the requirements/edx/base.in file to reflect the new tagged branch.
 * create a PR of this branch in edx-platform onto edx-platform:master
 * Once the PR onto edx-platform has been merged, the updated edx-proctoring will be live in production when the normally scheduled release completes.
+
+How do I validate my changes in stage or production?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* See `test plan`_ for manual tests and data setup
+
+.. _test plan: ./testing/test_plan.md

edx_proctoring/api.py

@@ -81,6 +81,14 @@
 USER_MODEL = get_user_model()
 
 
+def get_total_allowed_time_for_exam(exam, user_id):
+    """
+    Returns total allowed time in humanized form for exam including allowance time.
+    """
+    total_allowed_time = _calculate_allowed_mins(exam, user_id)
+    return humanized_time(total_allowed_time)
+
+
 def get_proctoring_settings_by_exam_id(exam_id):
     """
     Return proctoring settings and exam proctoring backend for proctored exam by exam_id.
@@ -744,7 +752,6 @@ def get_exam_attempt_data(exam_id, attempt_id, is_learning_mfe=False):
     # a same process as the LMS
     if is_learning_mfe:
         exam_url_path = resolve_exam_url_for_learning_mfe(exam['course_id'], exam['content_id'])
-
     else:
         exam_url_path = reverse('jump_to', args=[exam['course_id'], exam['content_id']])
 

edx_proctoring/locale/ar/LC_MESSAGES/django.po

@@ -18,7 +18,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: edx-proctoring\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2021-06-13 18:34+0000\n"
+"POT-Creation-Date: 2021-06-20 18:34+0000\n"
 "PO-Revision-Date: 2016-12-20 19:52+0000\n"
 "Last-Translator: Karam Hawari <[email protected]>, 2021\n"
 "Language-Team: Arabic (https://www.transifex.com/open-edx/teams/6205/ar/)\n"
@@ -120,75 +120,75 @@ msgstr ""
 msgid "Onboarding Expired"
 msgstr ""
 
-#: api.py:642 views.py:969
+#: api.py:770 views.py:977
 #, python-brace-format
 msgid "you have {remaining_time} remaining"
 msgstr "بقي لديك  {remaining_time} "
 
-#: api.py:1373
+#: api.py:1501
 msgid "your course"
 msgstr "دورتك التعليمية"
 
-#: api.py:1442
+#: api.py:1570
 #, python-brace-format
 msgid "Proctoring Results For {course_name} {exam_name}"
 msgstr ""
 
-#: api.py:1451
+#: api.py:1579
 #, python-brace-format
 msgid "Proctoring Review In Progress For {course_name} {exam_name}"
 msgstr ""
 
-#: api.py:1485
+#: api.py:1613
 #, python-brace-format
 msgid "Proctored exam {exam_name} in {course_name} for user {username}"
 msgstr ""
 
-#: api.py:1967
+#: api.py:2095
 msgid "Taking As Proctored Exam"
 msgstr "امتحان مراقب"
 
-#: api.py:1972
+#: api.py:2100
 msgid "Proctored Option Available"
 msgstr "خيار المراقبة متاح"
 
-#: api.py:1977
+#: api.py:2105
 msgid "Taking As Open Exam"
 msgstr "امتحان مفتوح"
 
-#: api.py:1982 api.py:1987
+#: api.py:2110 api.py:2115
 msgid "Pending Session Review"
 msgstr "مراجعة جلسة المعلقة"
 
-#: api.py:1992
+#: api.py:2120
 msgid "Passed Proctoring"
 msgstr "عبر المراقبة"
 
-#: api.py:1997 api.py:2002
+#: api.py:2125 api.py:2130
 msgid "Failed Proctoring"
 msgstr "فشل المراقبة"
 
-#: api.py:2007
+#: api.py:2135
 msgid "Proctored Option No Longer Available"
 msgstr "خيار المراقبة لم يعد متوفراً"
 
-#: api.py:2016
+#: api.py:2144
 msgid "Ungraded Practice Exam"
 msgstr "امتحان تمرين دون علامة"
 
-#: api.py:2021
+#: api.py:2149
 msgid "Practice Exam Completed"
 msgstr "امتحان تمرين مكتمل"
 
-#: api.py:2026
+#: api.py:2154
 msgid "Practice Exam Failed"
 msgstr "امتحان تمرين راسب"
 
-#: api.py:2034
+#: api.py:2162
 msgid "Timed Exam"
 msgstr "امتحان موقوت"
 
-#: api.py:2614
+#: api.py:2742
 msgid "Onboarding status question"
 msgstr ""
 
@@ -1442,50 +1442,50 @@ msgstr ""
 msgid "a practice exam"
 msgstr ""
 
-#: views.py:135
+#: views.py:138
 msgid "could not determine the course_id"
 msgstr "لم نتمكن من تحديد معرف الدورة التعليمية"
 
-#: views.py:144 views.py:517
+#: views.py:147 views.py:525 views.py:1455
 msgid "Must be a Staff User to Perform this request."
 msgstr "يجب أن تكون عضو طاقم من أجل القيام بهذا الطلب."
 
-#: views.py:507
+#: views.py:515
 msgid "Missing required query parameter course_id"
 msgstr ""
 
-#: views.py:525 views.py:742
+#: views.py:533 views.py:750
 msgid "There is no onboarding exam related to this course id."
 msgstr ""
 
-#: views.py:557
+#: views.py:565
 msgid "There is no onboarding exam accessible to this user."
 msgstr ""
 
-#: views.py:607
+#: views.py:615
 #, python-brace-format
 msgid "No onboarding status API for {proctor_service}"
 msgstr ""
 
-#: views.py:975
+#: views.py:983
 msgid "you have less than a minute remaining"
 msgstr "بقي لديك أقل من دقيقة"
 
-#: views.py:1425
+#: views.py:1492
 msgid "Cannot update attempt review status"
 msgstr ""
 
-#: views.py:1707
+#: views.py:1774
 #, python-brace-format
 msgid "No exams in course {course_id}."
 msgstr ""
 
-#: views.py:1713
+#: views.py:1780
 #, python-brace-format
 msgid "No proctored exams in course {course_id}"
 msgstr ""
 
-#: views.py:1732
+#: views.py:1799
 #, python-brace-format
 msgid "No instructor dashboard for {proctor_service}"
 msgstr ""

edx_proctoring/locale/ar/LC_MESSAGES/djangojs.po

@@ -17,7 +17,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: edx-proctoring\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2021-06-13 18:34+0000\n"
+"POT-Creation-Date: 2021-06-20 18:34+0000\n"
 "PO-Revision-Date: 2016-12-20 19:55+0000\n"
 "Last-Translator: Karam Hawari <[email protected]>, 2021\n"
 "Language-Team: Arabic (https://www.transifex.com/open-edx/teams/6205/ar/)\n"
@@ -119,75 +119,75 @@ msgstr ""
 msgid "Onboarding Expired"
 msgstr ""
 
-#: api.py:642 views.py:969
+#: api.py:770 views.py:977
 #, python-brace-format
 msgid "you have {remaining_time} remaining"
 msgstr "بقي لديك  {remaining_time} "
 
-#: api.py:1373
+#: api.py:1501
 msgid "your course"
 msgstr "مساقك التعليمي"
 
-#: api.py:1442
+#: api.py:1570
 #, python-brace-format
 msgid "Proctoring Results For {course_name} {exam_name}"
 msgstr ""
 
-#: api.py:1451
+#: api.py:1579
 #, python-brace-format
 msgid "Proctoring Review In Progress For {course_name} {exam_name}"
 msgstr ""
 
-#: api.py:1485
+#: api.py:1613
 #, python-brace-format
 msgid "Proctored exam {exam_name} in {course_name} for user {username}"
 msgstr ""
 
-#: api.py:1967
+#: api.py:2095
 msgid "Taking As Proctored Exam"
 msgstr "امتحان مراقب"
 
-#: api.py:1972
+#: api.py:2100
 msgid "Proctored Option Available"
 msgstr "خيار المراقبة متاح"
 
-#: api.py:1977
+#: api.py:2105
 msgid "Taking As Open Exam"
 msgstr "امتحان مفتوح"
 
-#: api.py:1982 api.py:1987
+#: api.py:2110 api.py:2115
 msgid "Pending Session Review"
 msgstr "مراجعة جلسة المعلقة"
 
-#: api.py:1992
+#: api.py:2120
 msgid "Passed Proctoring"
 msgstr "عبر المراقبة"
 
-#: api.py:1997 api.py:2002
+#: api.py:2125 api.py:2130
 msgid "Failed Proctoring"
 msgstr "فشل المراقبة"
 
-#: api.py:2007
+#: api.py:2135
 msgid "Proctored Option No Longer Available"
 msgstr "خيار المراقبة لم يعد متوفراً"
 
-#: api.py:2016
+#: api.py:2144
 msgid "Ungraded Practice Exam"
 msgstr "امتحان تمرين دون علامة"
 
-#: api.py:2021
+#: api.py:2149
 msgid "Practice Exam Completed"
 msgstr "امتحان تدريبي مكتمل"
 
-#: api.py:2026
+#: api.py:2154
 msgid "Practice Exam Failed"
 msgstr "امتحان تدريبي راسب"
 
-#: api.py:2034
+#: api.py:2162
 msgid "Timed Exam"
 msgstr "امتحان مؤقت"
 
-#: api.py:2614
+#: api.py:2742
 msgid "Onboarding status question"
 msgstr ""
 
@@ -1440,50 +1440,50 @@ msgstr ""
 msgid "a practice exam"
 msgstr ""
 
-#: views.py:135
+#: views.py:138
 msgid "could not determine the course_id"
 msgstr "لم نتمكن من تحديد رمز المساق التعليمي"
 
-#: views.py:144 views.py:517
+#: views.py:147 views.py:525 views.py:1455
 msgid "Must be a Staff User to Perform this request."
 msgstr "يجب أن تكون عضو طاقم من أجل القيام بهذا الطلب."
 
-#: views.py:507
+#: views.py:515
 msgid "Missing required query parameter course_id"
 msgstr ""
 
-#: views.py:525 views.py:742
+#: views.py:533 views.py:750
 msgid "There is no onboarding exam related to this course id."
 msgstr ""
 
-#: views.py:557
+#: views.py:565
 msgid "There is no onboarding exam accessible to this user."
 msgstr ""
 
-#: views.py:607
+#: views.py:615
 #, python-brace-format
 msgid "No onboarding status API for {proctor_service}"
 msgstr ""
 
-#: views.py:975
+#: views.py:983
 msgid "you have less than a minute remaining"
 msgstr "بقي لديك أقل من دقيقة"
 
-#: views.py:1425
+#: views.py:1492
 msgid "Cannot update attempt review status"
 msgstr ""
 
-#: views.py:1707
+#: views.py:1774
 #, python-brace-format
 msgid "No exams in course {course_id}."
 msgstr ""
 
-#: views.py:1713
+#: views.py:1780
 #, python-brace-format
 msgid "No proctored exams in course {course_id}"
 msgstr ""
 
-#: views.py:1732
+#: views.py:1799
 #, python-brace-format
 msgid "No instructor dashboard for {proctor_service}"
 msgstr ""