fix unit tests

Author: Ostap-Zherebetskyi

api/institutions/authentication.py

@@ -20,10 +20,10 @@
 
 from osf import features
 from osf.exceptions import InstitutionAffiliationStateError
-from osf.models import Institution
+from osf.models import Institution, NotificationType
 from osf.models.institution import SsoFilterCriteriaAction
 
-from website.mails import send_mail, WELCOME_OSF4I, DUPLICATE_ACCOUNTS_OSF4I, ADD_SSO_EMAIL_OSF4I
+from website.mails import send_mail, DUPLICATE_ACCOUNTS_OSF4I, ADD_SSO_EMAIL_OSF4I
 from website.settings import OSF_SUPPORT_EMAIL, DOMAIN
 from website.util.metrics import institution_source_tag
 
@@ -334,14 +334,13 @@ def authenticate(self, request):
             user.save()
 
             # Send confirmation email for all three: created, confirmed and claimed
-            send_mail(
-                to_addr=user.username,
-                mail=WELCOME_OSF4I,
-                user=user,
-                domain=DOMAIN,
-                osf_support_email=OSF_SUPPORT_EMAIL,
-                storage_flag_is_active=flag_is_active(request, features.STORAGE_I18N),
-            )
+            notification_type = NotificationType.objects.filter(name='welcome_osf4i')
+            if not notification_type.exists():
+                raise NotificationType.DoesNotExist(
+                    'NotificationType with name welcome_osf4i does not exist.',
+                )
+            notification_type = notification_type.first()
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'domain': DOMAIN, 'osf_support_email': OSF_SUPPORT_EMAIL, 'storage_flag_is_active': flag_is_active(request, features.STORAGE_I18N)})
 
         # Add the email to the user's account if it is identified by the eppn
         if email_to_add:

api/users/views.py

@@ -99,7 +99,7 @@
     OSFUser,
     Email,
     Tag,
-    NotificationType
+    NotificationType,
 )
 from osf.utils.tokens import TokenHandler
 from osf.utils.tokens.handlers import sanction_handler
@@ -847,10 +847,10 @@ def get(self, request, *args, **kwargs):
                 notification_type = NotificationType.objects.filter(name=mail_template)
                 if not notification_type.exists():
                     raise NotificationType.DoesNotExist(
-                        f'NotificationType with name {mail_template} does not exist.'
+                        f'NotificationType with name {mail_template} does not exist.',
                     )
                 notification_type = notification_type.first()
-                notification_type.emit(user=user_obj, event_context={'can_change_preferences': False, 'reset_link': reset_link})
+                notification_type.emit(user=user_obj, message_frequency='instantly', event_context={'can_change_preferences': False, 'reset_link': reset_link})
 
         return Response(status=status.HTTP_200_OK, data={'message': status_message, 'kind': kind, 'institutional': institutional})
 
@@ -1066,10 +1066,10 @@ def _process_external_identity(self, user, external_identity, service_url):
             notification_type = NotificationType.objects.filter(name='external_confirm_success')
             if not notification_type.exists():
                 raise NotificationType.DoesNotExist(
-                    'NotificationType with name external_confirm_success does not exist.'
+                    'NotificationType with name external_confirm_success does not exist.',
                 )
             notification_type = notification_type.first()
-            notification_type.emit(user=user, event_context={'can_change_preferences': False, 'external_id_provider': provider})
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'can_change_preferences': False, 'external_id_provider': provider})
 
         enqueue_task(update_affiliation_for_orcid_sso_users.s(user._id, provider_id))
 
@@ -1387,10 +1387,10 @@ def post(self, request, *args, **kwargs):
             notification_type = NotificationType.objects.filter(name='external_confirm_success')
             if not notification_type.exists():
                 raise NotificationType.DoesNotExist(
-                    'NotificationType with name external_confirm_success does not exist.'
+                    'NotificationType with name external_confirm_success does not exist.',
                 )
             notification_type = notification_type.first()
-            notification_type.emit(user=user, event_context={'can_change_preferences': False, 'external_id_provider': provider})
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'can_change_preferences': False, 'external_id_provider': provider})
 
         enqueue_task(update_affiliation_for_orcid_sso_users.s(user._id, provider_id))
 

api_tests/institutions/views/test_institution_auth.py

@@ -183,6 +183,7 @@ def type_2_ineligible_user_roles():
 
 
 @pytest.mark.django_db
+@pytest.mark.usefixtures('mock_notification_send')
 class TestInstitutionAuth:
 
     def test_invalid_payload(self, app, url_auth_institution):
@@ -280,7 +281,7 @@ def test_new_user_names_used_when_provided(self, app, institution, url_auth_inst
         assert user.given_name == 'Foo'
         assert user.family_name == 'Bar'
 
-    def test_user_active(self, app, institution, url_auth_institution):
+    def test_user_active(self, mock_notification_send, app, institution, url_auth_institution):
 
         username, fullname, password = '[email protected]', 'Foo Bar', 'FuAsKeEr'
         user = make_user(username, fullname)
@@ -316,7 +317,7 @@ def test_user_active(self, app, institution, url_auth_institution):
         # Confirm affiliation
         assert institution in user.get_affiliated_institutions()
 
-    def test_user_unclaimed(self, app, institution, url_auth_institution):
+    def test_user_unclaimed(self, mock_notification_send, app, institution, url_auth_institution):
 
         username, fullname = '[email protected]', 'Foo Bar'
         project = ProjectFactory()
@@ -399,7 +400,7 @@ def test_user_unconfirmed(self, app, institution, url_auth_institution):
         # Confirm affiliation
         assert institution in user.get_affiliated_institutions()
 
-    def test_user_inactive(self, app, institution, url_auth_institution):
+    def test_user_inactive(self, mock_notification_send, app, institution, url_auth_institution):
 
         username, fullname, password = '[email protected]', 'Foo Bar', 'FuAsKeEr'
         user = make_user(username, fullname)

api_tests/users/views/test_user_confirm.py

@@ -6,6 +6,7 @@
 
 
 @pytest.mark.django_db
+@pytest.mark.usefixtures('mock_notification_send')
 class TestConfirmEmail:
 
     @pytest.fixture()
@@ -147,8 +148,7 @@ def test_post_success_create(self, mock_send_mail, app, confirm_url, user_with_e
         assert user.external_identity == {'ORCID': {'0002-0001-0001-0001': 'VERIFIED'}}
         assert user.emails.filter(address=email.lower()).exists()
 
-    @mock.patch('website.mails.send_mail')
-    def test_post_success_link(self, mock_send_mail, app, confirm_url, user_with_email_verification):
+    def test_post_success_link(self, mock_notification_send, app, confirm_url, user_with_email_verification):
         user, token, email = user_with_email_verification
         user.external_identity['ORCID']['0000-0000-0000-0000'] = 'LINK'
         user.save()
@@ -168,14 +168,13 @@ def test_post_success_link(self, mock_send_mail, app, confirm_url, user_with_ema
         )
         assert res.status_code == 201
 
-        assert mock_send_mail.called
+        assert mock_notification_send.called
 
         user.reload()
         assert user.external_identity['ORCID']['0000-0000-0000-0000'] == 'VERIFIED'
 
-    @mock.patch('website.mails.send_mail')
     def test_post_success_link_with_email_verification_none(
-            self, mock_send_mail, app, confirm_url, user_with_none_identity
+            self, mock_notification_send, app, confirm_url, user_with_none_identity
     ):
         user, token, email = user_with_none_identity
         user.save()
@@ -195,15 +194,14 @@ def test_post_success_link_with_email_verification_none(
         )
         assert res.status_code == 201
 
-        assert not mock_send_mail.called  # no orcid sso message
+        assert not mock_notification_send.called  # no orcid sso message
 
         user.reload()
         assert not user.external_identity
 
-    @mock.patch('website.mails.send_mail')
     def test_post_success_link_with_email_already_exists(
             self,
-            mock_send_mail,
+            mock_notification_send,
             app,
             confirm_url,
             user_with_email_verification

api_tests/users/views/test_user_external_login.py

@@ -13,6 +13,7 @@
 
 
 @pytest.mark.django_db
+@pytest.mark.usefixtures('mock_notification_send')
 class TestExternalLogin:
 
     @pytest.fixture()
@@ -73,7 +74,7 @@ def test_invalid_payload(self, app, url, session_data, csrf_token):
         res = app.post_json_api(url, payload, expect_errors=True, headers={'X-CSRFToken': csrf_token})
         assert res.status_code == 400
 
-    def test_existing_user(self, app, payload, url, user_one, session_data, csrf_token):
+    def test_existing_user(self, mock_notification_send, app, payload, url, user_one, session_data, csrf_token):
         app.set_cookie(CSRF_COOKIE_NAME, csrf_token)
         app.set_cookie(settings.COOKIE_NAME, str(session_data))
         payload['data']['attributes']['email'] = user_one.username

api_tests/users/views/test_user_settings.py

@@ -28,6 +28,7 @@ def unconfirmed_address():
 
 
 @pytest.mark.django_db
+@pytest.mark.usefixtures('mock_notification_send')
 @pytest.mark.usefixtures('mock_send_grid')
 class TestUserRequestExport:
 
@@ -48,7 +49,7 @@ def test_get(self, app, user_one, url):
         res = app.get(url, auth=user_one.auth, expect_errors=True)
         assert res.status_code == 405
 
-    def test_post(self, mock_send_grid, app, user_one, user_two, url, payload):
+    def test_post(self, mock_send_grid, mock_notification_send, app, user_one, user_two, url, payload):
         # Logged out
         res = app.post_json_api(url, payload, expect_errors=True)
         assert res.status_code == 401
@@ -65,14 +66,14 @@ def test_post(self, mock_send_grid, app, user_one, user_two, url, payload):
         assert user_one.email_last_sent is not None
         assert mock_send_grid.call_count == 1
 
-    def test_post_invalid_type(self, mock_send_grid, app, user_one, url, payload):
+    def test_post_invalid_type(self, mock_notification_send, app, user_one, url, payload):
         assert user_one.email_last_sent is None
         payload['data']['type'] = 'Invalid Type'
         res = app.post_json_api(url, payload, auth=user_one.auth, expect_errors=True)
         assert res.status_code == 409
         user_one.reload()
         assert user_one.email_last_sent is None
-        assert mock_send_grid.call_count == 0
+        assert mock_notification_send.call_count == 0
 
     def test_exceed_throttle(self, app, user_one, url, payload):
         assert user_one.email_last_sent is None
@@ -87,6 +88,7 @@ def test_exceed_throttle(self, app, user_one, url, payload):
 
 
 @pytest.mark.django_db
+@pytest.mark.usefixtures('mock_notification_send')
 class TestUserChangePassword:
 
     @pytest.fixture()
@@ -168,7 +170,7 @@ def test_multiple_errors(self, app, user_one, url, payload):
 
 
 @pytest.mark.django_db
-@pytest.mark.usefixtures('mock_send_grid')
+@pytest.mark.usefixtures('mock_notification_send')
 class TestResetPassword:
 
     @pytest.fixture()
@@ -187,22 +189,22 @@ def url(self):
     def csrf_token(self):
         return csrf._mask_cipher_secret(csrf._get_new_csrf_string())
 
-    def test_get(self, mock_send_grid, app, url, user_one):
+    def test_get(self, mock_notification_send, app, url, user_one):
         encoded_email = urllib.parse.quote(user_one.email)
         url = f'{url}?email={encoded_email}'
         res = app.get(url)
         assert res.status_code == 200
 
         user_one.reload()
-        assert mock_send_grid.call_args[1]['to_addr'] == user_one.username
+        assert mock_notification_send.called
 
-    def test_get_invalid_email(self, mock_send_grid, app, url):
+    def test_get_invalid_email(self, mock_notification_send, app, url):
         url = f'{url}?email={'invalid_email'}'
         res = app.get(url)
         assert res.status_code == 200
-        assert not mock_send_grid.called
+        assert not mock_notification_send.called
 
-    def test_post(self, app, url, user_one, csrf_token):
+    def test_post(self, mock_notification_send, app, url, user_one, csrf_token):
         app.set_cookie(CSRF_COOKIE_NAME, csrf_token)
         encoded_email = urllib.parse.quote(user_one.email)
         url = f'{url}?email={encoded_email}'
@@ -222,6 +224,7 @@ def test_post(self, app, url, user_one, csrf_token):
         user_one.reload()
         assert res.status_code == 200
         assert user_one.check_password('password2')
+        assert mock_notification_send.called
 
     def test_post_empty_payload(self, app, url, csrf_token):
         app.set_cookie(CSRF_COOKIE_NAME, csrf_token)

conftest.py

@@ -18,6 +18,7 @@
 from framework.celery_tasks import app as celery_app
 from osf.external.spam import tasks as spam_tasks
 from website import settings as website_settings
+from osf.management.commands.migrate_notifications import update_notification_types
 
 
 logger = logging.getLogger(__name__)
@@ -374,3 +375,25 @@ def start_mock_send_grid(test_case):
     test_case.addCleanup(patcher.stop)
     mocked_send.return_value = True
     return mocked_send
+
+
+@pytest.fixture()
+def mock_notification_send():
+    with mock.patch.object(website_settings, 'USE_EMAIL', True):
+        with mock.patch.object(website_settings, 'USE_CELERY', False):
+            with mock.patch('osf.models.notification.Notification.send') as mock_emit:
+                mock_emit.return_value = None  # Or True, if needed
+                yield mock_emit
+
+
+def start_mock_notification_send(test_case):
+    patcher = mock.patch('osf.models.notification.Notification.send')
+    mocked_emit = patcher.start()
+    test_case.addCleanup(patcher.stop)
+    mocked_emit.return_value = None
+    return mocked_emit
+
+
+@pytest.fixture(autouse=True)
+def load_notification_types(*args, **kwargs):
+    update_notification_types(*args, **kwargs)

framework/auth/views.py

@@ -33,7 +33,7 @@
 from osf.exceptions import ValidationValueError, BlockedEmailError
 from osf.models.provider import PreprintProvider
 from osf.models.tag import Tag
-from osf.models.notification import NotificationType
+from osf.models.notification_type import NotificationType
 from osf.utils.requests import check_select_for_update
 from website.util.metrics import CampaignClaimedTags, CampaignSourceTags
 from website.ember_osf_web.decorators import ember_flag_is_active
@@ -279,7 +279,7 @@ def _forgot_password_post(mail_template, reset_route, institutional=False):
                         f'NotificationType with name {mail_template} does not exist.'
                     )
                 notification_type = notification_type.first()
-                notification_type.emit(user=user_obj, event_context={'can_change_preferences': False, 'reset_link': reset_link})
+                notification_type.emit(user=user_obj, message_frequency='instantly', event_context={'can_change_preferences': False, 'reset_link': reset_link})
 
         # institutional forgot password page displays the message as main text, not as an alert
         if institutional:

notifications.yaml

@@ -14,6 +14,52 @@ notification_types:
     object_content_type_model_name: osfuser
     template: 'website/templates/emails/new_pending_submissions.html.mako'
     notification_freq_default: instantly
+  - name: password_reset
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/password_reset.html.mako'
+    notification_freq_default: instantly
+  - name: forgot_password
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/forgot_password.html.mako'
+    notification_freq_default: instantly
+  - name: welcome_osf4i
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/welcome_osf4i.html.mako'
+    notification_freq_default: instantly
+  - name: invite_preprints_osf
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_preprints_osf.html.mako'
+    notification_freq_default: instantly
+  - name: invite_preprints
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_preprints.html.mako'
+    notification_freq_default: instantly
+  - name: invite_draft_registration
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_draft_registration.html.mako'
+    notification_freq_default: instantly
+  - name: invite_default
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_default.html.mako'
+    notification_freq_default: instantly
+  - name: pending_invite
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/pending_invite.html.mako'
+    notification_freq_default: instantly
+  - name: forward_invite
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/forward_invite.html.mako'
+    notification_freq_default: instantly
+
   #### PROVIDER
   - name: new_pending_submissions
     __docs__: ...