Adding tasks to create general Slack channel and automate invite and kick users

stefdworschak · stefdworschak · commit 5033a7a4e660 · 2024-10-11T17:04:09.000+01:00
diff --git a/accounts/models.py b/accounts/models.py
@@ -193,7 +193,9 @@ def user_type(self):
             else:
                 # A non-specified group
                 return None
-
+    @property
+    def is_admin(self):
+        return self.user_type in [UserType.SUPERUSER, UserType.STAFF, UserType.PARTNER_ADMIN, UserType.FACILITATOR_ADMIN]
 
 class SlackSiteSettings(SingletonModel):
     """ Model to set how the showcase should be constructed"""
diff --git a/custom_slack_provider/slack.py b/custom_slack_provider/slack.py
@@ -28,6 +28,7 @@ class CustomSlackClient():
     user_detail_url = 'https://slack.com/api/users.info'
     create_conversation_url = 'https://slack.com/api/conversations.create'
     invite_conversation_url = 'https://slack.com/api/conversations.invite'
+    kick_conversation_url = 'https://slack.com/api/conversations.kick'
     leave_conversation_url = 'https://slack.com/api/conversations.leave'
 
     def __init__(self, token):
@@ -55,7 +56,10 @@ def _make_slack_post_request(self, url, data):
         return resp.json()
 
     def get_identity(self):
-        return self._make_slack_get_request(self.identity_url)
+        identity = self._make_slack_get_request(self.identity_url)
+        if not identity.get('ok'):
+            raise SlackException(identity.get("error"))
+        return identity
 
     def leave_channel(self, channel):
         data = {
@@ -65,7 +69,7 @@ def leave_channel(self, channel):
             self.leave_conversation_url, data=data)
 
         if not leave_channel.get('ok'):
-            print(('An error occurred leaving a Slack Channel. '
+            logger.error(('An error occurred leaving a Slack Channel. '
                    f'Error code: {leave_channel.get("error")}'))
 
         return leave_channel
@@ -107,7 +111,7 @@ def _extract_userid_from_username(self, username):
         when Slack is enabled and the account was created with a valid userid
         schema: [SLACK_USER_ID]_[WORKSPACE_TEAM_ID]"""
         if not re.match(r'[A-Z0-9]*[_]T[A-Z0-9]*', username):
-            raise SlackException('Error adding user to channel')
+            raise SlackException('Error adding user %s to channel' % username)
         return username.split('_')[0]
 
     def invite_users_to_slack_channel(self, users, channel):
@@ -133,7 +137,7 @@ def kick_user_from_slack_channel(self, user, channel):
             "channel": channel,
         }
         user_added = self._make_slack_post_request(
-            self.invite_conversation_url, data=data)
+            self.kick_conversation_url, data=data)
 
         if not user_added.get('ok'):
             return {
diff --git a/custom_slack_provider/tests.py b/custom_slack_provider/tests.py
@@ -69,7 +69,7 @@ def test__make_slack_post_request(self, post):
 
     @patch('custom_slack_provider.slack.CustomSlackClient._make_slack_get_request')  # noqa: 501
     def test_get_identity(self, _make_slack_get_request):
-        _make_slack_get_request.return_value = {'user': {'id': 1}}
+        _make_slack_get_request.return_value = {'user': {'id': 1}, 'ok': True}
         client = CustomSlackClient(self.token)
         response = client.get_identity()
         self.assertEqual(response['user']['id'], 1)
@@ -84,7 +84,7 @@ def test__extract_userid_from_username(self):
             userid = client._extract_userid_from_username(invalid_username)
         except SlackException as e:
             self.assertTrue(isinstance(e, SlackException))
-            self.assertEquals(e.message, 'Error adding user to channel')
+            self.assertEquals(e.message, 'Error adding user bob@bob.com to channel')
 
     @patch('custom_slack_provider.slack.CustomSlackClient._make_slack_post_request')  # noqa: 501
     def test_invite_users_to_slack_channel(self, _make_slack_post_request):
diff --git a/hackathon/forms.py b/hackathon/forms.py
@@ -1,4 +1,5 @@
 from django import forms
+from django.db.models import Q
 from easy_select2 import Select2Multiple
 
 from accounts.models import Organisation
@@ -125,7 +126,7 @@ class HackathonForm(forms.ModelForm):
     channel_admins = forms.ModelMultipleChoiceField(
         label="Channel Admins",
         required=False,
-        queryset=User.objects.all(),
+        queryset=User.objects.filter(Q(is_superuser=True) | Q(is_staff=True)),
         widget=Select2Multiple(select2attrs={'width': '100%'})
     )
 
@@ -286,4 +287,4 @@ def save(self, commit=True):
         event.body += f'<br><br><b>Meeting Join Link:</b> <a href="{webinar_link}" target="_blank">Click here to join</a><br><b>Meeting Join Code:</b> {webinar_code}'
         if commit:
             event.save()
-        return event
+        return event
diff --git a/hackathon/migrations/0051_auto_20240911_1306.py b/hackathon/migrations/0051_auto_20240911_1306.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.1.13 on 2024-09-11 13:06
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('hackathon', '0050_hackathon_google_registrations_form'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='hackathon',
+            old_name='google_registrations_form',
+            new_name='google_registration_form',
+        ),
+    ]
diff --git a/hackathon/migrations/0052_auto_20240912_1324.py b/hackathon/migrations/0052_auto_20240912_1324.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.1.13 on 2024-09-12 13:24
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('hackathon', '0051_auto_20240911_1306'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='hackathon',
+            old_name='google_registration_form',
+            new_name='registration_form',
+        ),
+    ]
diff --git a/hackathon/migrations/0053_auto_20240912_1527.py b/hackathon/migrations/0053_auto_20240912_1527.py
@@ -0,0 +1,22 @@
+# Generated by Django 3.1.13 on 2024-09-12 15:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('hackathon', '0052_auto_20240912_1324'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='hackathon',
+            name='is_register',
+        ),
+        migrations.AddField(
+            model_name='hackathon',
+            name='allow_external_registrations',
+            field=models.BooleanField(default=False),
+        ),
+    ]
diff --git a/hackathon/migrations/0056_auto_20241011_1357.py b/hackathon/migrations/0056_auto_20241011_1357.py
@@ -1,4 +1,4 @@
-# Generated by Django 3.1.13 on 2024-09-27 15:39
+# Generated by Django 3.1.13 on 2024-10-11 13:57
 
 from django.conf import settings
 from django.db import migrations, models
@@ -8,24 +8,10 @@ class Migration(migrations.Migration):
 
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
-        ('hackathon', '0050_hackathon_google_registrations_form'),
+        ('hackathon', '0055_remove_event_isreadonly'),
     ]
 
     operations = [
-        migrations.RenameField(
-            model_name='hackathon',
-            old_name='google_registrations_form',
-            new_name='registration_form',
-        ),
-        migrations.RemoveField(
-            model_name='hackathon',
-            name='is_register',
-        ),
-        migrations.AddField(
-            model_name='hackathon',
-            name='allow_external_registrations',
-            field=models.BooleanField(default=False),
-        ),
         migrations.AddField(
             model_name='hackathon',
             name='channel_admins',
diff --git a/hackathon/tasks.py b/hackathon/tasks.py
@@ -7,6 +7,7 @@
 from django.core.mail import send_mail
 from smtplib import SMTPException
 
+from accounts.models import CustomUser as User
 from accounts.models import EmailTemplate, SlackSiteSettings
 
 from celery import shared_task
@@ -60,56 +61,76 @@ def create_new_hackathon_slack_channel(hackathon_id, channel_name):
          f"{hackathon.display_name} in Slack Workspace "
          f"{settings.SLACK_WORKSPACE}({settings.SLACK_TEAM_ID})"))
 
+    # Use a workspace admin's User Token to create the channel
+    # This is required because a bot is seen as a Slack member and
+    # if a workspace is set to only allow admins to create channels
+    # creating the channel with a Bot Token will give an error
     admin_client = CustomSlackClient(settings.SLACK_ADMIN_TOKEN)
     channel_response = admin_client.create_slack_channel(
         team_id=settings.SLACK_TEAM_ID,
         channel_name=channel_name,
         is_private=True,
     )
 
-    if not channel_response['ok']:
-        logger.error(channel_response['error'])
-
     channel = channel_response.get('channel', {}).get('id')
     channel_url = f'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel}'
     hackathon.channel_url = channel_url
     hackathon.save()
     logger.info(f"Channel with id {channel} created.")
-
+    
     # Add admins to channel for administration purposes
-    users = [admin.username for admin in hackathon.channel_admins.all()]
-    # First need to add Slack Bot to then add users to channel
-    response = admin_client.invite_users_to_slack_channel(
-        users=settings.SLACK_BOT_ID,
-        channel=channel,
-    )
-    if not response['ok']:
-        logger.error(response['error'])
-        return
-
-    bot_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
+    admin_usernames = [admin.username for admin in hackathon.channel_admins.all()]
     pattern = re.compile(r'^U[a-zA-Z0-9]*[_]T[a-zA-Z0-9]*$')
-    users_to_invite = ','.join([user.split('_')[0]
-                                for user in users if pattern.match(user)])
-    bot_client.invite_users_to_slack_channel(
-        users=users_to_invite,
+    admin_user_ids = ','.join([username.split('_')[0]
+                               for username in admin_usernames
+                               if pattern.match(username)])
+    admin_client.invite_users_to_slack_channel(
+        users=admin_user_ids,
         channel=channel,
     )
 
-    if not response['ok']:
-        logger.error(response['error'])
-        return
-
-    if slack_site_settings.remove_admin_from_channel:
-#        remove_admin_from_channel(users_to_invite, channel)
-        pass
-
 
 @shared_task
 def invite_user_to_hackathon_slack_channel(hackathon_id, user_id):
-    bot_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
+    slack_site_settings = SlackSiteSettings.objects.first()
+    if (not (settings.SLACK_ENABLED or settings.SLACK_BOT_TOKEN or settings.SLACK_ADMIN_TOKEN
+             or settings.SLACK_WORKSPACE or not slack_site_settings)):
+        logger.info("This feature is not enabeled.")
+        return
+    
+    hackathon = Hackathon.objects.get(id=hackathon_id)
+    user = User.objects.get(id=user_id)
+    logger.info(f"Inviting user {user_id} to hackathon {hackathon_id}'s slack channel")
+
+    admin_client = CustomSlackClient(settings.SLACK_ADMIN_TOKEN)
+    channel = hackathon.channel_url.split('/')[-1]
+    pattern = re.compile(r'^U[a-zA-Z0-9]*[_]T[a-zA-Z0-9]*$')
+    slack_user_id = admin_client._extract_userid_from_username(user.username) 
+    admin_client.invite_users_to_slack_channel(
+            users=[slack_user_id],
+            channel=channel
+    )
+    logger.info(f"Successfully invited user {user_id} to hackathon {hackathon_id}'s slack channel")   
 
 
 @shared_task
-def kick_user_to_hackathon_slack_channel(user, channel):
-    pass
+def kick_user_from_hackathon_slack_channel(hackathon_id, user_id):
+    slack_site_settings = SlackSiteSettings.objects.first()
+    if (not (settings.SLACK_ENABLED or settings.SLACK_BOT_TOKEN or settings.SLACK_ADMIN_TOKEN
+             or settings.SLACK_WORKSPACE or not slack_site_settings)):
+        logger.info("This feature is not enabeled.")
+        return
+        
+    hackathon = Hackathon.objects.get(id=hackathon_id)
+    user = User.objects.get(id=user_id)
+    logger.info(f"Kicking user {user_id} to hackathon {hackathon_id}'s slack channel")
+    admin_client = CustomSlackClient(settings.SLACK_ADMIN_TOKEN)
+    channel = hackathon.channel_url.split('/')[-1]
+    pattern = re.compile(r'^U[a-zA-Z0-9]*[_]T[a-zA-Z0-9]*$')
+    slack_user_id = admin_client._extract_userid_from_username(user.username)
+    kicked = admin_client.kick_user_from_slack_channel(
+            user=slack_user_id,
+            channel=channel
+    )
+    logger.info(f"Successfully kicked user {user_id} to hackathon {hackathon_id}'s slack channel")
+
diff --git a/hackathon/tests/task_tests.py b/hackathon/tests/task_tests.py
@@ -6,8 +6,11 @@
 from unittest.mock import patch, Mock
 
 from accounts.models import Organisation, CustomUser as User
+from accounts.models import SlackSiteSettings
 from hackathon.models import Hackathon
-from hackathon.tasks import create_new_hackathon_slack_channel
+from hackathon.tasks import create_new_hackathon_slack_channel, \
+                            invite_user_to_hackathon_slack_channel, \
+                            kick_user_from_hackathon_slack_channel
 
 
 class TaskTests(TestCase):
@@ -18,17 +21,18 @@ def setUp(self):
             slack_display_name="bob",
             organisation=organisation,
         )
+        self.slack_site_settings = SlackSiteSettings.objects.create(
+            remove_admin_from_channel=True
+        )
         self.hackathon = Hackathon.objects.create(
             created_by=self.user,
             display_name="hacktest",
             description="lorem ipsum",
             start_date=f'{datetime.now()}',
             end_date=f'{datetime.now()}')
         self.hackathon.channel_admins.add(self.user)
-
-    @override_settings(CELERY_EAGER_PROPAGATES_EXCEPTIONS=True,
-                       CELERY_ALWAYS_EAGER=True,
-                       BROKER_BACKEND='memory')
+    
+    @responses.activate
     def test_create_new_hackathon_slack_channel(self):
         channel_id = 'CH123123'
         responses.add(
@@ -37,10 +41,45 @@ def test_create_new_hackathon_slack_channel(self):
         responses.add(
             responses.POST, 'https://slack.com/api/conversations.invite',
             json={'ok': True}, status=200)
-        create_new_hackathon_slack_channel.apply_async(args=[
-            self.hackathon.id, self.user.username])
+        responses.add(
+            responses.POST, 'https://slack.com/api/users.identity',
+            json={'ok': True}, status=200)
+        responses.add(
+            responses.POST, 'https://slack.com/api/conversations.leave',
+            json={'ok': True}, status=200)
 
-        import time; time.sleep(3)
+        create_new_hackathon_slack_channel(self.hackathon.id, self.user.username)
+        
         self.assertEquals(
-            self.hackathon.channel_url,
+            Hackathon.objects.first().channel_url,
             f'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel_id}')
+       
+    @responses.activate
+    def test_invite_user_to_channel(self):
+        channel_id = 'CH123123'
+        self.hackathon.channel_url = 'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel_id}'
+        self.hackathon.save()
+
+        responses.add(
+            responses.POST, 'https://slack.com/api/conversations.invite',
+            json={'ok': True}, status=200)
+        
+        try:
+            invite_user_to_hackathon_slack_channel(self.hackathon.id, self.user.id)
+        except:
+            raise Exception("Inviting user to channel failed")
+
+    @responses.activate
+    def test_kick_user_from_channel(self):
+        channel_id = 'CH123123'
+        self.hackathon.channel_url = 'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel_id}'
+        self.hackathon.save()
+
+        responses.add(
+            responses.POST, 'https://slack.com/api/conversations.kick',
+            json={'ok': True}, status=200)
+
+        try:
+            kick_user_from_hackathon_slack_channel(self.hackathon.id, self.user.id)
+        except:
+            raise Exception("Kicking user from channel failed")
diff --git a/hackathon/views.py b/hackathon/views.py
diff --git a/runtests.sh b/runtests.sh
