refactor: renaming emailSES to email_via_smtp

Author: sharad-sharma

Access/base_email_access/access.py

@@ -4,7 +4,7 @@
 
 from Access.models import UserAccessMapping, GroupAccessMapping
 from EnigmaAutomation.settings import ACCESS_APPROVE_EMAIL, PERMISSION_CONSTANTS
-from bootprocess.general import emailSES
+from bootprocess.general import email_via_smtp
 
 logger = logging.getLogger(__name__)
 
@@ -149,7 +149,7 @@ def approve(
                     " by %s" % (label_desc, self.access_desc(), user.email, approver)
                 )
 
-                emailSES(email_targets, email_subject, email_body)
+                self.email_via_smtp(email_targets, email_subject, email_body)
                 return True, ""
         except Exception as e:
             logger.error(
@@ -166,7 +166,7 @@ def revoke(self, user, label):
         email_body = ""
 
         try:
-            emailSES(email_targets, email_subject, email_body)
+            self.email_via_smtp(email_targets, email_subject, email_body)
         except Exception as e:
             logger.error("Could not send email for error %s", str(e))
 
@@ -205,3 +205,6 @@ def fetch_access_approve_email(self, request, data):
 
     def fetch_access_request_form_path(self):
         return "base_email_access/accessRequest.html"
+
+    def email_via_smtp(self, destination, subject, body):
+        email_via_smtp(destination, subject, body)

Access/notifications.py

@@ -39,7 +39,7 @@ def send_new_group_create_notification(auth_user, date_time, new_group, member_l
         reason=new_group.description,
         needsAccessApprove=new_group.needsAccessApprove,
     )
-    general.emailSES(MAIL_APPROVER_GROUPS, subject, body)
+    general.email_via_smtp(MAIL_APPROVER_GROUPS, subject, body)
     logger.debug("Email sent for " + subject + " to " + str(MAIL_APPROVER_GROUPS))
 
 
@@ -55,7 +55,7 @@ def send_new_group_approved_notification(group, group_id, initial_member_names):
     destination.append(group.requester.email)
     # TODO send a mail to initial members
     logger.debug(group_id + " -- Approved email sent to - " + str(destination))
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
 
 
 def send_membership_accepted_notification(user, group, membership):
@@ -69,7 +69,7 @@ def send_membership_accepted_notification(user, group, membership):
     destination = []
     destination.append(membership.requested_by.email)
     destination.append(user.email)
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
 
 
 def send_mulitple_membership_accepted_notification(all_user_emails, group_name, membership):
@@ -84,7 +84,7 @@ def send_mulitple_membership_accepted_notification(all_user_emails, group_name,
         destination = []
         destination.append(membership.requested_by.email)
         destination.append(each_user_email)
-        general.emailSES(destination, subject, body)
+        general.email_via_smtp(destination, subject, body)
 
 
 def generateGroupMemberTable(memberList):
@@ -100,7 +100,7 @@ def send_group_owners_update_mail(destination, group_name, updated_by):
             group_name, ", ".join(destination), updated_by
         )
 
-        general.emailSES(destination, subject, body)
+        general.email_via_smtp(destination, subject, body)
     except Exception as e:
         logger.exception(str(e))
         logger.error("Something when wrong while sending Email.")
@@ -120,7 +120,7 @@ def send_group_access_add_email(
         ),
     )
     subject = GROUP_ACCESS_ADDED_SUBJECT.format(group_name=group_name)
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
     return ""
 
 
@@ -138,7 +138,7 @@ def send_revoke_failure_mail(
             access_tag=access_tag,
         )
 
-        general.emailSES(targets, subject, body)
+        general.email_via_smtp(targets, subject, body)
     except Exception as e:
         logger.error("Something when wrong while sending membership revoke email")
         logger.exception(str(e))
@@ -159,7 +159,7 @@ def send_mail_for_request_decline(
         approver=request.user.username,
         reason=reason,
     )
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
     logger.debug("Email sent for " + subject + " to " + str(destination))
 
 
@@ -173,7 +173,7 @@ def send_mail_for_request_granted_failure(user, approver, access_type, request_i
         str(user.email),
         request_id,
     )
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
     logger.debug("Email sent for " + subject + " to " + str(destination))
 
 
@@ -199,7 +199,7 @@ def send_mail_for_member_approval(userEmail, requester, group_name, reason):
             reason,
         ),
     )
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
 
 
 def generate_user_add_to_group_email_body(
@@ -223,7 +223,7 @@ def send_mail_for_access_grant_failed(
     subject = str("Access Grant Failed - ") + access_type.upper()
     body = ACCESS_GRANT_FAILED_MESSAGE.format(user_email, request_id)
     body = body + "Failure Reason - " + message
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
 
 
 def send_group_access_declined(
@@ -240,7 +240,7 @@ def send_group_access_declined(
     )
 
     subject = subject = "Declined Request " + request_id
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
 
 
 def send_accept_group_access_failed(destination, request_id, error):
@@ -250,7 +250,7 @@ def send_accept_group_access_failed(destination, request_id, error):
         )
 
         subject = subject = "Failed Request " + request_id
-        general.emailSES(destination, subject, body)
+        general.email_via_smtp(destination, subject, body)
     except Exception as e:
         logger.exception(str(e))
         logger.error("Something when wrong while sending Email.")
@@ -263,7 +263,7 @@ def send_decline_group_access_failed(destination, request_id, error):
         )
 
         subject = subject = "Declined Failed Request " + request_id
-        general.emailSES(destination, subject, body)
+        general.email_via_smtp(destination, subject, body)
     except Exception as e:
         logger.exception(str(e))
         logger.error("Something when wrong while sending Email.")
@@ -278,5 +278,5 @@ def send_mail_for_request_resolve(auth_user, access_type, request_id):
         request_id=request_id,
         access_type=access_type,
     )
-    general.emailSES(destination, subject, body)
+    general.email_via_smtp(destination, subject, body)
     logger.debug("Email sent for " + subject + " to " + str(destination))

Access/tests/test_access_views_helper.py

@@ -289,7 +289,7 @@ def test_run_access_grant(
         mockAccessModule1.tag.return_value = accessType
         mockAccessModule1.approve.return_value = [False, "Cannot be approved"]
         mockAccessModule1.access_mark_revoke_permission.return_value = "destination"
-        mocker.patch("bootprocess.general.emailSES", return_value=True)
+        mocker.patch("bootprocess.general.email_via_smtp", return_value=True)
         views_helper.all_access_modules = [mockAccessModule1]
 
     elif testName == test_run_access_grant_approveException:
@@ -302,7 +302,7 @@ def test_run_access_grant(
         mockAccessModule1.approve.return_value = True
         mockAccessModule1.approve.side_effect = Exception("Approve Exception")
         mockAccessModule1.access_mark_revoke_permission.return_value = "destination"
-        mocker.patch("bootprocess.general.emailSES", return_value=True)
+        mocker.patch("bootprocess.general.email_via_smtp", return_value=True)
         views_helper.all_access_modules = [mockAccessModule1]
 
     val = views_helper.run_access_grant(
@@ -312,4 +312,4 @@ def test_run_access_grant(
     assert val == response
     assert requestObject.status == response_status
     if response_status == "GrantFailed":
-        general.emailSES.call_count == 1
+        general.email_via_smtp.call_count == 1

Access/tests/test_group_helper.py

@@ -107,7 +107,7 @@ def test_approve_new_group_request(
         mocker.patch(
             "Access.helpers.generateStringFromTemplate", return_value="email body"
         )
-        mocker.patch("bootprocess.general.emailSES", return_value=True)
+        mocker.patch("bootprocess.general.email_via_smtp", return_value=True)
 
     elif testname == test_approve_new_group_request_ThrowsException:
         request.user.username = "username1"
@@ -131,7 +131,7 @@ def test_approve_new_group_request(
             "Access.helpers.generateStringFromTemplate", return_value="email body"
         )
         mocker.patch(
-            "bootprocess.general.emailSES",
+            "bootprocess.general.email_via_smtp",
             return_value=True,
             side_effect=Exception("sendEmailError"),
         )
@@ -143,7 +143,7 @@ def test_approve_new_group_request(
     assert models.GroupV2.objects.get.call_count == 1
 
     if testname != test_approve_new_group_request_ProcessReq and requestApproved:
-        assert general.emailSES.call_count == 1
+        assert general.email_via_smtp.call_count == 1
         assert models.MembershipV2.objects.filter.call_count == 2
         assert helpers.generateStringFromTemplate.call_count == 2
 

bootprocess/general.py

@@ -6,7 +6,7 @@
 logger = logging.getLogger(__name__)
 
 
-def emailSES(destination, subject, body):   # noqa: C0103
+def email_via_smtp(destination, subject, body):
     """ method to send email to destination with given subject and body """
     if destination and subject and body:
         with mail.get_connection(backend=EMAIL_BACKEND) as connection: