feat: add html message (#367)

varshamenon4 · web-flow · commit 314cba1d2049 · 2023-05-15T16:26:18.000-04:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,10 @@ Please See the `releases tab <https://github.com/openedx/xblock-lti-consumer/rel
 Unreleased
 ~~~~~~~~~~
 
+9.5.0 - 2023-05-08
+------------------
+* Return HTML message telling user that exam is ready to start on start assessment response to LTI proctoring launch.
+
 9.4.0 - 2023-05-08
 ------------------
 * Fix broken call to LMS `get_block_for_descriptor_internal` due to descriptor->block rename.
diff --git a/lti_consumer/__init__.py b/lti_consumer/__init__.py
@@ -4,4 +4,4 @@
 from .apps import LTIConsumerApp
 from .lti_xblock import LtiConsumerXBlock
 
-__version__ = '9.4.0'
+__version__ = '9.5.0'
diff --git a/lti_consumer/plugin/views.py b/lti_consumer/plugin/views.py
@@ -21,7 +21,7 @@
 from rest_framework import status, viewsets
 from rest_framework.decorators import action
 from rest_framework.response import Response
-from rest_framework.status import HTTP_400_BAD_REQUEST, HTTP_403_FORBIDDEN, HTTP_404_NOT_FOUND
+from rest_framework.status import HTTP_200_OK, HTTP_400_BAD_REQUEST, HTTP_403_FORBIDDEN, HTTP_404_NOT_FOUND
 
 from lti_consumer.api import get_lti_pii_sharing_state_for_course, validate_lti_1p3_launch_data
 from lti_consumer.exceptions import LtiError
@@ -834,4 +834,4 @@ def start_proctoring_assessment_endpoint(request):
         user_id=request.user.id,
     )
 
-    return JsonResponse(data={})
+    return render(request, 'html/lti_start_assessment.html', status=HTTP_200_OK)
diff --git a/lti_consumer/templates/html/lti_start_assessment.html b/lti_consumer/templates/html/lti_start_assessment.html
@@ -0,0 +1,21 @@
+{% load i18n %}
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" >
+        <title>LTI</title>
+    </head>
+    <body>
+        <p>
+            <b>{% trans "Sending you back to your exam." %}</b>
+        </p>
+        <script>
+            setTimeout(function () {window.close()}, 5000);
+        </script>
+        <p>
+            <a href="javascript:window.close();">
+                {% trans "Return to exam." %}
+            </a>
+        </p>
+    </body>
+</html>
diff --git a/lti_consumer/tests/unit/plugin/test_proctoring.py b/lti_consumer/tests/unit/plugin/test_proctoring.py
@@ -280,3 +280,17 @@ def test_lti_1p3_proctoring_assessment_started_signal(self, mock_assessment_star
             user_id=self.user.id,
         )
         self.assertEqual(mock_assessment_started_signal.call_args, expected_call_args)
+
+    def test_start_assessment_endpoint_returns_valid_html(self):
+        """
+        Tests that a successful call to the start_assessment_endpoint returns the correct html response.
+        """
+        response = self.client.post(
+            self.url,
+            {
+                "JWT": self.create_tool_jwt_token()
+            },
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertIn('window.close', response.content.decode('utf-8'))
