Update send_mail mocks

Author: Ostap-Zherebetskyi

addons/boa/tests/test_tasks.py

@@ -53,7 +53,7 @@ def test_boa_error_code(self):
         assert BoaErrorCode.JOB_TIME_OUT_ERROR == 7
 
     def test_handle_boa_error(self):
-        with mock.patch('addons.boa.tasks.send_mail', return_value=None) as mock_send_mail, \
+        with mock.patch('addons.boa.tasks.execute_email_send', return_value=None) as mock_send_mail, \
                 mock.patch('addons.boa.tasks.sentry.log_message', return_value=None) as mock_sentry_log_message, \
                 mock.patch('addons.boa.tasks.logger.error', return_value=None) as mock_logger_error:
             return_value = handle_boa_error(
@@ -179,7 +179,7 @@ async def test_submit_success(self):
                 mock.patch('boaapi.boa_client.BoaClient.query', return_value=self.mock_job), \
                 mock.patch('boaapi.boa_client.BoaClient.close', return_value=None) as mock_close, \
                 mock.patch('asyncio.sleep', new_callable=AsyncMock, return_value=None) as mock_async_sleep, \
-                mock.patch('addons.boa.tasks.send_mail', return_value=None) as mock_send_mail, \
+                mock.patch('addons.boa.tasks.execute_email_send', return_value=None) as mock_send_mail, \
                 mock.patch('addons.boa.tasks.handle_boa_error', return_value=None) as mock_handle_boa_error:
             return_value = await submit_to_boa_async(
                 self.host,

api_tests/crossref/views/test_crossref_email_response.py

@@ -158,7 +158,7 @@ def test_wrong_request_context_raises_permission_error(self, app, url, error_xml
     def test_error_response_sends_message_does_not_set_doi(self, app, url, preprint, error_xml):
         assert not preprint.get_identifier_value('doi')
 
-        with mock.patch('framework.auth.views.mails.send_mail') as mock_send_mail:
+        with mock.patch('framework.auth.views.mails.execute_email_send') as mock_send_mail:
             context_data = self.make_mailgun_payload(crossref_response=error_xml)
             app.post(url, context_data)
         assert mock_send_mail.called
@@ -167,7 +167,7 @@ def test_error_response_sends_message_does_not_set_doi(self, app, url, preprint,
     def test_success_response_sets_doi(self, app, url, preprint, success_xml):
         assert not preprint.get_identifier_value('doi')
 
-        with mock.patch('framework.auth.views.mails.send_mail') as mock_send_mail:
+        with mock.patch('framework.auth.views.mails.execute_email_send') as mock_send_mail:
             context_data = self.make_mailgun_payload(crossref_response=success_xml)
             app.post(url, context_data)
 
@@ -181,7 +181,7 @@ def test_update_success_response(self, app, preprint, url):
         preprint.set_identifier_value(category='doi', value=initial_value)
         update_xml = self.update_success_xml(preprint)
 
-        with mock.patch('framework.auth.views.mails.send_mail') as mock_send_mail:
+        with mock.patch('framework.auth.views.mails.execute_email_send') as mock_send_mail:
             context_data = self.make_mailgun_payload(crossref_response=update_xml)
             app.post(url, context_data)
 
@@ -195,7 +195,7 @@ def test_update_success_does_not_set_preprint_doi_created(self, app, preprint, u
         update_xml = self.update_success_xml(preprint)
 
         pre_created = preprint.preprint_doi_created
-        with mock.patch('framework.auth.views.mails.send_mail'):
+        with mock.patch('framework.auth.views.mails.execute_email_send'):
             context_data = self.make_mailgun_payload(crossref_response=update_xml)
             app.post(url, context_data)
 
@@ -219,7 +219,7 @@ def test_confirmation_marks_legacy_doi_as_deleted(self, app, url, preprint):
         preprint.set_identifier_value(category='legacy_doi', value=legacy_value)
         update_xml = self.update_success_xml(preprint)
 
-        with mock.patch('framework.auth.views.mails.send_mail') as mock_send_mail:
+        with mock.patch('framework.auth.views.mails.execute_email_send') as mock_send_mail:
             context_data = self.make_mailgun_payload(crossref_response=update_xml)
             app.post(url, context_data)
 

api_tests/draft_registrations/views/test_draft_registration_contributor_list.py

@@ -214,7 +214,7 @@ def url_project_contribs(self, project_public):
         # Overrides TestNodeContributorCreateEmail
         return f'/{API_BASE}draft_registrations/{project_public._id}/contributors/'
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_sends_email(
             self, mock_mail, app, user, user_two,
             url_project_contribs):
@@ -264,7 +264,7 @@ def test_add_contributor_signal_if_default(
         assert res.json['errors'][0]['detail'] == 'default is not a valid email preference.'
 
     # Overrides TestNodeContributorCreateEmail
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_sends_email(
             self, mock_mail, app, user, url_project_contribs):
         url = f'{url_project_contribs}?send_email=draft_registration'
@@ -301,7 +301,7 @@ def test_add_unregistered_contributor_signal_if_default(
         assert 'draft_registration' == kwargs['email_template']
 
     # Overrides TestNodeContributorCreateEmail
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_without_email_no_email(
             self, mock_mail, app, user, url_project_contribs):
         url = f'{url_project_contribs}?send_email=draft_registration'

api_tests/draft_registrations/views/test_draft_registration_list.py

@@ -337,7 +337,7 @@ def test_logged_in_non_contributor_cannot_create_draft(
         assert res.status_code == 403
 
     def test_create_project_based_draft_does_not_email_initiator(self, app, user, url_draft_registrations, payload):
-        with mock.patch.object(mails, 'send_mail') as mock_send_mail:
+        with mock.patch.object(mails, 'execute_email_send') as mock_send_mail:
             app.post_json_api(f'{url_draft_registrations}?embed=branched_from&embed=initiator', payload, auth=user.auth)
 
         assert not mock_send_mail.called
@@ -430,7 +430,7 @@ def test_admin_can_create_draft(
 
     def test_create_no_project_draft_emails_initiator(self, app, user, url_draft_registrations, payload):
         # Intercepting the send_mail call from website.project.views.contributor.notify_added_contributor
-        with mock.patch.object(mails, 'send_mail') as mock_send_mail:
+        with mock.patch.object(mails, 'execute_email_send') as mock_send_mail:
             resp = app.post_json_api(
                 f'{url_draft_registrations}?embed=branched_from&embed=initiator',
                 payload,

api_tests/institutions/views/test_institution_relationship_nodes.py

@@ -378,7 +378,7 @@ def test_email_sent_on_affiliation_addition(self, app, user, institution, node_w
         current_institution = InstitutionFactory()
         node_without_institution.affiliated_institutions.add(current_institution)
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.post_json_api(
                 url_institution_nodes,
                 {
@@ -398,7 +398,7 @@ def test_email_sent_on_affiliation_removal(self, app, admin, institution, node_p
         current_institution = InstitutionFactory()
         node_public.affiliated_institutions.add(current_institution)
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.delete_json_api(
                 url_institution_nodes,
                 {

api_tests/nodes/views/test_node_contributors_list.py

@@ -1208,7 +1208,7 @@ class TestNodeContributorCreateEmail(NodeCRUDTestCase):
     def url_project_contribs(self, project_public):
         return f'/{API_BASE}nodes/{project_public._id}/contributors/'
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_no_email_if_false(
         self, mock_mail, app, user, url_project_contribs
     ):
@@ -1223,7 +1223,7 @@ def test_add_contributor_no_email_if_false(
         assert res.status_code == 201
         assert mock_mail.call_count == 0
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_sends_email(
         self, mock_mail, app, user, user_two, url_project_contribs
     ):
@@ -1281,7 +1281,7 @@ def test_add_contributor_signal_preprint_email_disallowed(
             == 'preprint is not a valid email preference.'
         )
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_sends_email(
         self, mock_mail, app, user, url_project_contribs
     ):
@@ -1329,7 +1329,7 @@ def test_add_unregistered_contributor_signal_preprint_email_disallowed(
             == 'preprint is not a valid email preference.'
         )
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_invalid_send_email_param(
         self, mock_mail, app, user, url_project_contribs
     ):
@@ -1347,7 +1347,7 @@ def test_add_contributor_invalid_send_email_param(
         )
         assert mock_mail.call_count == 0
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_without_email_no_email(
         self, mock_mail, app, user, url_project_contribs
     ):

api_tests/nodes/views/test_node_forks_list.py

@@ -421,7 +421,7 @@ def test_send_email_success(
             self, app, user, public_project_url,
             fork_data_with_title, public_project):
 
-        with mock.patch.object(mails, 'send_mail', return_value=None) as mock_send_mail:
+        with mock.patch.object(mails, 'execute_email_send', return_value=None) as mock_send_mail:
             res = app.post_json_api(
                 public_project_url,
                 fork_data_with_title,
@@ -440,7 +440,7 @@ def test_send_email_failed(
             fork_data_with_title, public_project):
 
         with mock.patch.object(NodeForksSerializer, 'save', side_effect=Exception()):
-            with mock.patch.object(mails, 'send_mail', return_value=None) as mock_send_mail:
+            with mock.patch.object(mails, 'execute_email_send', return_value=None) as mock_send_mail:
                 with pytest.raises(Exception):
                     app.post_json_api(
                         public_project_url,

api_tests/nodes/views/test_node_relationship_institutions.py

@@ -206,7 +206,7 @@ def test_user_with_institution_and_permissions(
     @mock.patch('website.mails.settings.USE_EMAIL', True)
     def test_user_with_institution_and_permissions_through_patch(self, app, user, institution_one, institution_two,
                                                                  node, node_institutions_url):
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.patch_json_api(
                 node_institutions_url,
                 self.create_payload([institution_one, institution_two]),
@@ -237,7 +237,7 @@ def test_remove_institutions_with_affiliated_user(self, app, user, institution_o
         node.save()
         assert institution_one in node.affiliated_institutions.all()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.put_json_api(
                 node_institutions_url,
                 {
@@ -262,7 +262,7 @@ def test_using_post_making_no_changes_returns_201(self, app, user, institution_o
         node.save()
         assert institution_one in node.affiliated_institutions.all()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.post_json_api(
                 node_institutions_url,
                 self.create_payload([institution_one]),
@@ -297,7 +297,7 @@ def test_add_through_patch_one_inst_to_node_with_inst(
         assert institution_one in node.affiliated_institutions.all()
         assert institution_two not in node.affiliated_institutions.all()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.patch_json_api(
                 node_institutions_url,
                 self.create_payload([institution_one, institution_two]),
@@ -324,7 +324,7 @@ def test_add_through_patch_one_inst_while_removing_other(
         assert institution_one in node.affiliated_institutions.all()
         assert institution_two not in node.affiliated_institutions.all()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.patch_json_api(
                 node_institutions_url,
                 self.create_payload([institution_two]),
@@ -358,7 +358,7 @@ def test_add_one_inst_with_post_to_node_with_inst(
         assert institution_one in node.affiliated_institutions.all()
         assert institution_two not in node.affiliated_institutions.all()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.post_json_api(
                 node_institutions_url,
                 self.create_payload([institution_two]),
@@ -388,7 +388,7 @@ def test_delete_existing_inst(self, app, user, institution_one, node, node_insti
         node.affiliated_institutions.add(institution_one)
         node.save()
 
-        with mock.patch('osf.models.mixins.mails.send_mail') as mocked_send_mail:
+        with mock.patch('osf.models.mixins.mails.execute_email_send') as mocked_send_mail:
             res = app.delete_json_api(
                 node_institutions_url,
                 self.create_payload([institution_one]),

api_tests/preprints/views/test_preprint_contributors_list.py

@@ -1351,7 +1351,7 @@ class TestPreprintContributorCreateEmail(NodeCRUDTestCase):
     def url_preprint_contribs(self, preprint_published):
         return f'/{API_BASE}preprints/{preprint_published._id}/contributors/'
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_no_email_if_false(
             self, mock_mail, app, user, url_preprint_contribs):
         url = f'{url_preprint_contribs}?send_email=false'
@@ -1368,7 +1368,7 @@ def test_add_contributor_no_email_if_false(
         assert res.status_code == 201
         assert mock_mail.call_count == 0
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_needs_preprint_filter_to_send_email(
             self, mock_mail, app, user, user_two,
             url_preprint_contribs):
@@ -1419,7 +1419,7 @@ def test_add_contributor_signal_if_preprint(
         assert mock_send.call_count == 1
         assert 'preprint' == kwargs['email_template']
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_sends_email(
             self, mock_mail, app, user, url_preprint_contribs):
         url = f'{url_preprint_contribs}?send_email=preprint'
@@ -1455,7 +1455,7 @@ def test_add_unregistered_contributor_signal_if_preprint(
         assert 'preprint' == kwargs['email_template']
         assert mock_send.call_count == 1
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_contributor_invalid_send_email_param(
             self, mock_mail, app, user, url_preprint_contribs):
         url = f'{url_preprint_contribs}?send_email=true'
@@ -1475,7 +1475,7 @@ def test_add_contributor_invalid_send_email_param(
         assert res.json['errors'][0]['detail'] == 'true is not a valid email preference.'
         assert mock_mail.call_count == 0
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_add_unregistered_contributor_without_email_no_email(
             self, mock_mail, app, user, url_preprint_contribs):
         url = f'{url_preprint_contribs}?send_email=preprint'
@@ -1494,7 +1494,7 @@ def test_add_unregistered_contributor_without_email_no_email(
         assert res.status_code == 201
         assert mock_mail.call_count == 0
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     @mock.patch('osf.models.preprint.update_or_enqueue_on_preprint_updated')
     def test_publishing_preprint_sends_emails_to_contributors(
             self, mock_update, mock_mail, app, user, url_preprint_contribs, preprint_unpublished):
@@ -1535,7 +1535,7 @@ def test_contributor_added_signal_not_specified(
         assert 'preprint' == kwargs['email_template']
         assert mock_send.call_count == 1
 
-    @mock.patch('framework.auth.views.mails.send_mail')
+    @mock.patch('framework.auth.views.mails.execute_email_send')
     def test_contributor_added_not_sent_if_unpublished(
             self, mock_mail, app, user, preprint_unpublished):
         url = f'/{API_BASE}preprints/{preprint_unpublished._id}/contributors/?send_email=preprint'