Merge pull request #78 from edx/cdodge/allow-for-simulating-callback

allow for simulated postbacks for exam verification

edx_proctoring/backends/software_secure.py

@@ -12,6 +12,8 @@ import datetime
 import json
 import logging
 
+from django.conf import settings
+
 from edx_proctoring.backends.backend import ProctoringBackendProvider
 from edx_proctoring.exceptions import (
     BackendProvideCannotRegisterAttempt,
@@ -170,7 +172,11 @@ class SoftwareSecureBackendProvider(ProctoringBackendProvider):
         # note that SoftwareSecure might send a case insensitive
         # ssiRecordLocator than what it returned when we registered the
         # exam
-        if attempt_obj.external_id.lower() != external_id.lower():
+        match = (
+            attempt_obj.external_id.lower() == external_id.lower() or
+            settings.PROCTORING_SETTINGS.get('ALLOW_CALLBACK_SIMULATION', False)
+        )
+        if not match:
             err_msg = (
                 'Found attempt_code {attempt_code}, but the recorded external_id did not '
                 'match the ssiRecordLocator that had been recorded previously. Has {existing} '

edx_proctoring/backends/tests/test_software_secure.py

@@ -30,6 +30,7 @@ from edx_proctoring.exceptions import (
 from edx_proctoring. models import (
     ProctoredExamSoftwareSecureReview,
     ProctoredExamSoftwareSecureComment,
+    ProctoredExamStudentAttemptStatus,
 )
 from edx_proctoring.backends.tests.test_review_payload import TEST_REVIEW_PAYLOAD
 
@@ -349,6 +350,46 @@ class SoftwareSecureTests(TestCase):
         with self.assertRaises(ProctoredExamSuspiciousLookup):
             provider.on_review_callback(json.loads(test_payload))
 
+    @patch.dict('django.conf.settings.PROCTORING_SETTINGS', {'ALLOW_CALLBACK_SIMULATION': True})
+    def test_allow_simulated_callbacks(self):
+        """
+        Verify that the configuration switch to
+        not do confirmation of external_id/ssiRecordLocators
+        """
+
+        provider = get_backend_provider()
+
+        exam_id = create_exam(
+            course_id='foo/bar/baz',
+            content_id='content',
+            exam_name='Sample Exam',
+            time_limit_mins=10,
+            is_proctored=True
+        )
+
+        # be sure to use the mocked out SoftwareSecure handlers
+        with HTTMock(mock_response_content):
+            attempt_id = create_exam_attempt(
+                exam_id,
+                self.user.id,
+                taking_as_proctored=True
+            )
+
+        attempt = get_exam_attempt_by_id(attempt_id)
+        self.assertIsNotNone(attempt['external_id'])
+
+        test_payload = Template(TEST_REVIEW_PAYLOAD).substitute(
+            attempt_code=attempt['attempt_code'],
+            external_id='bogus'
+        )
+
+        # this should not raise an exception since we have
+        # the ALLOW_CALLBACK_SIMULATION override
+        provider.on_review_callback(json.loads(test_payload))
+
+        attempt = get_exam_attempt_by_id(attempt_id)
+        self.assertEqual(attempt['status'], ProctoredExamStudentAttemptStatus.verified)
+
     def test_review_on_archived_attempt(self):
         """
         Make sure we can process a review report for

settings.py

@@ -88,5 +88,6 @@ PROCTORING_SETTINGS = {
         'faq': '',
         'contact_us': '',
         'tech_requirements': '',
-    }
+    },
+    'ALLOW_CALLBACK_SIMULATION': False
 }