Merge pull request #10184 from edx/tasawer/story/ecom-2552-turn-off-mail-for-icrv

New Model added for Configuration of ICRV status emails.

lms/djangoapps/verify_student/admin.py

+# encoding: utf-8
+"""
+Admin site configurations for verify_student.
+"""
+
+from config_models.admin import ConfigurationModelAdmin
 from ratelimitbackend import admin
 from verify_student.models import (
+    IcrvStatusEmailsConfiguration,
+    SkippedReverification,
     SoftwareSecurePhotoVerification,
     VerificationStatus,
-    SkippedReverification,
 )
 
 
@@ -54,3 +61,4 @@ class SkippedReverificationAdmin(admin.ModelAdmin):
 admin.site.register(SoftwareSecurePhotoVerification, SoftwareSecurePhotoVerificationAdmin)
 admin.site.register(SkippedReverification, SkippedReverificationAdmin)
 admin.site.register(VerificationStatus, VerificationStatusAdmin)
+admin.site.register(IcrvStatusEmailsConfiguration, ConfigurationModelAdmin)

lms/djangoapps/verify_student/models.py

@@ -1308,6 +1308,15 @@ class InCourseReverificationConfiguration(ConfigurationModel):
     pass
 
 
+class IcrvStatusEmailsConfiguration(ConfigurationModel):
+    """Toggle in-course reverification (ICRV) status emails
+
+    Disabled by default. When disabled, ICRV status emails will not be sent.
+    When enabled, ICRV status emails are sent.
+    """
+    pass
+
+
 class SkippedReverification(models.Model):
     """Model for tracking skipped Reverification of a user against a specific
     course.

lms/djangoapps/verify_student/tests/test_views.py

@@ -48,7 +48,8 @@ from verify_student.views import (
 )
 from verify_student.models import (
     VerificationDeadline, SoftwareSecurePhotoVerification,
-    VerificationCheckpoint, VerificationStatus
+    VerificationCheckpoint, VerificationStatus,
+    IcrvStatusEmailsConfiguration,
 )
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
 from xmodule.modulestore.tests.factories import CourseFactory, ItemFactory
@@ -1716,6 +1717,8 @@ class TestPhotoVerificationResultsCallback(ModuleStoreTestCase):
         """
         Test for verification passed.
         """
+        # Verify that ICRV status email was sent when config is enabled
+        IcrvStatusEmailsConfiguration.objects.create(enabled=True)
         self.create_reverification_xblock()
 
         data = {
@@ -1737,16 +1740,47 @@ class TestPhotoVerificationResultsCallback(ModuleStoreTestCase):
 
         self.assertEqual(attempt.status, u'approved')
         self.assertEquals(response.content, 'OK!')
-        # Verify that photo re-verification status email was sent
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual("Re-verification Status", mail.outbox[0].subject)
 
+    @mock.patch('verify_student.ssencrypt.has_valid_signature', mock.Mock(side_effect=mocked_has_valid_signature))
+    def test_icrv_status_email_with_disable_config(self):
+        """
+        Verify that photo re-verification status email was not sent when config is disable
+        """
+        IcrvStatusEmailsConfiguration.objects.create(enabled=False)
+
+        self.create_reverification_xblock()
+
+        data = {
+            "EdX-ID": self.receipt_id,
+            "Result": "PASS",
+            "Reason": "",
+            "MessageType": "You have been verified."
+        }
+
+        json_data = json.dumps(data)
+
+        response = self.client.post(
+            reverse('verify_student_results_callback'), data=json_data,
+            content_type='application/json',
+            HTTP_AUTHORIZATION='test BBBBBBBBBBBBBBBBBBBB:testing',
+            HTTP_DATE='testdate'
+        )
+        attempt = SoftwareSecurePhotoVerification.objects.get(receipt_id=self.receipt_id)
+
+        self.assertEqual(attempt.status, u'approved')
+        self.assertEquals(response.content, 'OK!')
+        self.assertEqual(len(mail.outbox), 0)
+
     @mock.patch('verify_student.views._send_email')
     @mock.patch('verify_student.ssencrypt.has_valid_signature', mock.Mock(side_effect=mocked_has_valid_signature))
     def test_reverification_on_callback(self, mock_send_email):
         """
         Test software secure callback flow for re-verification.
         """
+        IcrvStatusEmailsConfiguration.objects.create(enabled=True)
+
         # Create the 'edx-reverification-block' in course tree
         self.create_reverification_xblock()
 

lms/djangoapps/verify_student/views.py

@@ -52,6 +52,7 @@ from verify_student.models import (
     SoftwareSecurePhotoVerification,
     VerificationCheckpoint,
     VerificationStatus,
+    IcrvStatusEmailsConfiguration,
 )
 from verify_student.image import decode_image_data, InvalidImageData
 from util.json_request import JsonResponse
@@ -1312,8 +1313,9 @@ def results_callback(request):
     checkpoints = VerificationCheckpoint.objects.filter(photo_verification=attempt).all()
     VerificationStatus.add_status_from_checkpoints(checkpoints=checkpoints, user=attempt.user, status=status)
 
-    # If this is re-verification then send the update email
-    if checkpoints:
+    # Trigger ICRV email only if ICRV status emails config is enabled
+    icrv_status_emails = IcrvStatusEmailsConfiguration.current()
+    if icrv_status_emails.enabled and checkpoints:
         user_id = attempt.user.id
         course_key = checkpoints[0].course_id
         related_assessment_location = checkpoints[0].checkpoint_location