linting

tdrs-backend/tdpservice/email/helpers/admin_notifications.py

@@ -5,7 +5,7 @@ def email_admin_deactivated_user(user):
     from tdpservice.users.models import User
     from tdpservice.email.email_enums import EmailType
     from tdpservice.email.email import automated_email, log
-    from tdpservice.email.tasks import get_ofa_admin_user_emails, get_system_owner_email
+    from tdpservice.email.tasks import get_ofa_admin_user_emails
 
     recipient_emails = get_ofa_admin_user_emails()
     logger_context = {
@@ -56,7 +56,8 @@ def email_system_owner_system_admin_role_change(user, action):
         'action': action,
     }
 
-    log(f"Preparing email to System Owner for System Admin role change for user {user.username}", logger_context=logger_context)
+    log(f"Preparing email to System Owner for System Admin role change for user {user.username}",
+        logger_context=logger_context)
 
     automated_email(
         email_path=template_path,
@@ -65,4 +66,4 @@ def email_system_owner_system_admin_role_change(user, action):
         email_context=context,
         text_message=text_message,
         logger_context=logger_context
-    )
+    )

tdrs-backend/tdpservice/email/tasks.py

@@ -80,7 +80,7 @@ def get_system_owner_email():
     try:
         user_email = User.objects.filter(groups__name='System Owner').values_list('email', flat=True).distinct()
     except User.DoesNotExist:
-        user_email=[None]
+        user_email = [None]
     return user_email
 
 def get_num_access_requests():

tdrs-backend/tdpservice/users/apps.py

@@ -10,4 +10,5 @@ class UsersConfig(AppConfig):
     verbose_name = "Users"
 
     def ready(self):
-        import tdpservice.users.signals
+        """Import signals."""
+        import tdpservice.users.signals  # noqa

tdrs-backend/tdpservice/users/signals.py

@@ -1,3 +1,4 @@
+"""Signals for the users app."""
 from django.db.models.signals import m2m_changed
 from django.dispatch import receiver
 from tdpservice.users.models import User
@@ -9,11 +10,13 @@
 
 @receiver(m2m_changed, sender=User.groups.through)
 def user_group_changed(sender, instance, action, pk_set, **kwargs):
-    if pk_set:   
+    """Send an email to the System Owner when a user is assigned or removed from the System Admin role."""
+    if pk_set:
         ADMIN_GROUP_PK = Group.objects.get(name="OFA System Admin").pk
         ACTIONS = {
-            'PRE_REMOVE' : 'pre_remove',
-            'PRE_ADD' : 'pre_add',
+            'PRE_REMOVE': 'pre_remove',
+            'PRE_ADD': 'pre_add',
+            'PRE_CLEAR': 'pre_clear'
         }
         group_change_list = [pk for pk in pk_set]
         if ADMIN_GROUP_PK in group_change_list and action == ACTIONS['PRE_ADD']:
@@ -22,6 +25,6 @@ def user_group_changed(sender, instance, action, pk_set, **kwargs):
         elif ADMIN_GROUP_PK in group_change_list and action == ACTIONS['PRE_REMOVE']:
             # EMAIL ADMIN GROUP REMOVED from OFA ADMIN
             email_system_owner_system_admin_role_change(instance, "removed")
-    elif pk_set is None and action == 'pre_clear':
+    elif pk_set is None and action == ACTIONS['PRE_CLEAR']:
         # EMAIL ADMIN GROUP REMOVED from OFA ADMIN
         email_system_owner_system_admin_role_change(instance, "removed")

tdrs-backend/tdpservice/users/test/test_signals.py

@@ -0,0 +1,37 @@
+"""Test signals."""
+import pytest
+from unittest.mock import patch
+from tdpservice.users.models import User
+from tdpservice.users.test.factories import AdminUserFactory
+from django.contrib.auth.models import Group
+import logging
+import django
+
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.mark.django_db
+def test_my_signal_receiver(mocker):
+    """Test my_signal_receiver."""
+    with patch("django.db.models.signals.m2m_changed.send") as mock_receiver:
+        instance = AdminUserFactory.create()
+        instance.groups.add(Group.objects.get(name="OFA System Admin"))
+
+        mock_receiver.assert_called_with(
+            sender=User.groups.through,
+            instance=instance,
+            action="post_add",
+            pk_set={Group.objects.get(name="OFA System Admin").pk},
+            reverse=False,
+            using="default",
+            model=django.contrib.auth.models.Group,
+        )
+        mock_receiver.call_count = 2  # pre_save and post_save
+
+    with patch(
+        "tdpservice.users.signals.email_system_owner_system_admin_role_change"
+    ) as mock_email_system_owner_system_admin_role_change:
+        instance = AdminUserFactory.create()
+        instance.groups.add(Group.objects.get(name="OFA System Admin"))
+        mock_email_system_owner_system_admin_role_change.assert_called_once()