feat: emit the EXAM_ATTEMPT_SUBMITTED Open edX event when an exam is …

…submitted

edx_exams/apps/core/api.py

@@ -17,6 +17,7 @@
     ExamIllegalStatusTransition
 )
 from edx_exams.apps.core.models import Exam, ExamAttempt
+from edx_exams.apps.core.signals.signals import emit_exam_attempt_submitted_event
 from edx_exams.apps.core.statuses import ExamAttemptStatus
 
 log = logging.getLogger(__name__)
@@ -96,6 +97,15 @@ def update_attempt_status(attempt_id, to_status):
     if to_status == ExamAttemptStatus.submitted:
         attempt_obj.end_time = datetime.now(pytz.UTC)
 
+        course_key = CourseKey.from_string(attempt_obj.exam.course_id)
+        usage_key = UsageKey.from_string(attempt_obj.exam.content_id)
+        emit_exam_attempt_submitted_event(
+            attempt_obj.user,
+            course_key,
+            usage_key,
+            attempt_obj.exam.exam_type
+        )
+
     attempt_obj.status = to_status
     attempt_obj.save()
 

edx_exams/apps/core/apps.py

@@ -0,0 +1,18 @@
+"""
+Core Application Configuration
+"""
+
+from django.apps import AppConfig
+
+
+class CoreConfig(AppConfig):
+    """
+    Application configuration for core application.
+    """
+    name = 'edx_exams.apps.core'
+
+    def ready(self):
+        """
+        Connect handlers to signals.
+        """
+        from .signals import handlers  # pylint: disable=unused-import,import-outside-toplevel

edx_exams/apps/core/signals/handlers.py

@@ -0,0 +1,20 @@
+"""
+Signal handlers for the edx-exams application.
+"""
+from django.dispatch import receiver
+from openedx_events.event_bus import get_producer
+from openedx_events.learning.signals import EXAM_ATTEMPT_SUBMITTED
+
+
+@receiver(EXAM_ATTEMPT_SUBMITTED)
+def listen_for_exam_attempt_submitted(sender, signal, **kwargs):  # pylint: disable=unused-argument
+    """
+    Publish EXAM_ATTEMPT_SUBMITTED signals onto the event bus.
+    """
+    get_producer().send(
+        signal=EXAM_ATTEMPT_SUBMITTED,
+        topic='exam-attempt-submitted',
+        event_key_field='exam_attempt.course_key',
+        event_data={'exam_attempt': kwargs['exam_attempt']},
+        event_metadata=kwargs['metadata'],
+    )

edx_exams/apps/core/signals/signals.py

@@ -0,0 +1,32 @@
+"""
+Signal definitions and functions to send those signals for the edx-exams application.
+"""
+
+from openedx_events.learning.data import ExamAttemptData, UserData, UserPersonalData
+from openedx_events.learning.signals import EXAM_ATTEMPT_SUBMITTED
+
+
+def emit_exam_attempt_submitted_event(user, course_key, usage_key, exam_type):
+    """
+    Emit the EXAM_ATTEMPT_SUBMITTED Open edX event.
+    """
+    user_data = UserData(
+        id=user.id,
+        is_active=user.is_active,
+        pii=UserPersonalData(
+            username=user.username,
+            email=user.email,
+            name=user.full_name
+        )
+    )
+
+    # .. event_implemented_name: EXAM_ATTEMPT_SUBMITTED
+    EXAM_ATTEMPT_SUBMITTED.send_event(
+        exam_attempt=ExamAttemptData(
+            student_user=user_data,
+            course_key=course_key,
+            usage_key=usage_key,
+            exam_type=exam_type,
+            requesting_user=user_data
+        )
+    )

edx_exams/apps/core/test_utils/factories.py

@@ -37,6 +37,7 @@ class Meta:
     password = factory.PostGenerationMethodCall('set_password', _DEFAULT_PASSWORD)
     first_name = factory.Sequence('User{}'.format)
     last_name = 'Test'
+    full_name = "{} {}".format(first_name, last_name)
     is_superuser = False
     is_staff = False
 

edx_exams/apps/core/tests/test_api.py

@@ -11,6 +11,7 @@
 from django.utils import timezone
 from freezegun import freeze_time
 from opaque_keys.edx.keys import CourseKey, UsageKey
+from openedx_events.learning.data import ExamAttemptData, UserData, UserPersonalData
 
 from edx_exams.apps.api.test_utils import ExamsAPITestCase
 from edx_exams.apps.core.api import (
@@ -212,7 +213,7 @@ def setUp(self):
             resource_id=str(uuid.uuid4()),
             course_id=self.course_id,
             provider=self.test_provider,
-            content_id='abcd1234',
+            content_id='block-v1:edX+test+2023+type@sequential+block@1111111111',
             exam_name='test_exam',
             exam_type='proctored',
             time_limit_mins=30,
@@ -298,6 +299,35 @@ def test_submit_attempt(self):
             self.assertEqual(updated_attempt.status, ExamAttemptStatus.submitted)
             self.assertEqual(updated_attempt.end_time, timezone.now())
 
+    @patch('edx_exams.apps.core.signals.signals.EXAM_ATTEMPT_SUBMITTED.send_event')
+    def test_submit_attempt_event_emitted(self, mock_event_send):
+        """
+        Test that when an exam is submitted, the EXAM_ATTEMPT_SUBMITED Open edX event is emitted.
+        """
+        update_attempt_status(self.exam_attempt.id, ExamAttemptStatus.submitted)
+        self.assertEqual(mock_event_send.call_count, 1)
+
+        user_data = UserData(
+            id=self.user.id,
+            is_active=self.user.is_active,
+            pii=UserPersonalData(
+                username=self.user.username,
+                email=self.user.email,
+                name=self.user.full_name
+            )
+        )
+        course_key = CourseKey.from_string(self.exam.course_id)
+        usage_key = UsageKey.from_string(self.exam.content_id)
+
+        expected_data = ExamAttemptData(
+            student_user=user_data,
+            course_key=course_key,
+            usage_key=usage_key,
+            exam_type=self.exam.exam_type,
+            requesting_user=user_data,
+        )
+        mock_event_send.assert_called_with(exam_attempt=expected_data)
+
     def test_illegal_start(self):
         """
         Test that an already started exam cannot be started