adding slack channel creation (WIP)

Author: stefdworschak

custom_slack_provider/slack.py

@@ -1,4 +1,4 @@
-import json
+import re
 import requests
 from requests.auth import AuthBase
 
@@ -24,6 +24,7 @@ class CustomSlackClient():
     identity_url = 'https://slack.com/api/users.identity'
     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'
 
     def __init__(self, token):
         self.token = token
@@ -64,3 +65,20 @@ def create_slack_channel(self, channel_name, is_private=True):
         new_channel = self._make_slack_post_request(
             self.create_conversation_url, data=data)
         return new_channel.get('channel', {})
+
+    def _extract_userid_from_username(self, username):
+        """ Extracts the Slack userid from a hackathon platform userid
+        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')
+        return username.split('_')[0]
+
+    def add_user_to_slack_channel(self, username, channel_id):
+        data = {
+            "user": self._extract_userid_from_username(username),
+            "channel": channel_id,
+        }
+        user_added = self._make_slack_post_request(
+            self.invite_conversation_url, data=data)
+        return user_added

custom_slack_provider/tests.py

@@ -7,6 +7,7 @@
 from .provider import SlackProvider
 from custom_slack_provider.slack import CustomSlackClient, SlackException
 from django.core.management import call_command
+from 
 
 
 class SlackOAuth2Tests(OAuth2TestsMixin, TestCase):
@@ -60,14 +61,37 @@ def test__make_slack_post_request(self, post):
         mock_response.json.return_value = {'ok': False,
                                            'error': 'Slack Error'}
         try:
-            client._make_slack_get_request(url='test')
+            client._make_slack_post_request(url='test', data={})
         except SlackException as e:
             self.assertTrue(isinstance(e, SlackException))
             self.assertEquals(e.message, 'Slack Error')
 
-    @patch('custom_slack_provider.slack.CustomSlackClient._make_slack_get_request')
+    @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}}
         client = CustomSlackClient(self.token)
         response = client.get_identity()
         self.assertEqual(response['user']['id'], 1)
+
+    def test__extract_userid_from_username(self):
+        valid_username = 'US123123_T123123'
+        invalid_username = 'bob@bob.com'
+        client = CustomSlackClient(self.token)
+        userid = client._extract_userid_from_username(valid_username)
+        self.assertEqual(userid, 'US123123')
+        try:
+            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')
+
+    @patch('custom_slack_provider.slack.CustomSlackClient._make_slack_post_request')  # noqa: 501
+    def test_add_user_to_slack_channel(self, _make_slack_post_request):
+        _make_slack_post_request.return_value = {
+            'ok': True,
+            'channel': {'id': 'CH123123'}
+        }
+        client = CustomSlackClient(self.token)
+        response = client.add_user_to_slack_channel(username='UA123123_T15666',
+                                                    channel_id='CH123123')
+        self.assertEqual(response['channel']['id'], 'CH123123')

hackathon/tasks.py

@@ -14,7 +14,7 @@
 
 from accounts.models import CustomUser as User
 from hackathon.models import Hackathon
-from custom_slack_provider.slack import CustomSlackClient
+from custom_slack_provider.slack import CustomSlackClient, SlackException
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
@@ -61,8 +61,10 @@ def create_new_slack_channel(hackathon_id, channel_name):
          f"{hackathon.display_name} in Slack Workspace "
          f"{settings.SLACK_WORKSPACE}({settings.SLACK_TEAM_ID})"))
     slack_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
-    channel_id = slack_client.create_slack_channel(
+    channel = slack_client.create_slack_channel(
         channel_name, is_private=True)
+
+    channel_id = channel.get('id')
     logger.info(f"Channel with id {channel_id} created.")
 
     if not channel_id:
@@ -73,3 +75,11 @@ def create_new_slack_channel(hackathon_id, channel_name):
     hackathon.channel_url = channel_url
     hackathon.save()
     logger.info(f"Hackathon {hackathon.display_name} updated successfully.")
+
+    logger.info("Adding channel admins")
+    for admin in hackathon.channel_admins.all():
+        try:
+            slack_client.add_user_to_slack_channel(admin.username, channel_id)
+        except SlackException:
+            logger.exception((f"Could not add user with id {admin.id} "
+                              f"to channel {channel_id}."))

hackathon/tests/task_tests.py

@@ -1,5 +1,46 @@
-from django.test import TestCase
+from datetime import datetime
+
+from django.conf import settings
+from django.test import TestCase, override_settings
+import responses
+from unittest.mock import patch, Mock
+
+from accounts.models import Organisation, CustomUser as User
+from hackathon.models import Hackathon
+from hackathon.tasks import create_new_slack_channel
+
 
 class TaskTests(TestCase):
-    def test_simple_task(self):
-        pass
+    def setUp(self):
+        organisation = Organisation.objects.create()
+        self.user = User.objects.create(
+            username="U213123_T123123",
+            slack_display_name="bob",
+            organisation=organisation,
+        )
+        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')
+    def test_create_new_slack_channel(self):
+        channel_id = 'CH123123'
+        responses.add(
+            responses.POST, 'https://slack.com/api/conversations.create',
+            json={'ok': True, 'channel': {'id': channel_id}}, status=200)
+        responses.add(
+            responses.POST, 'https://slack.com/api/conversations.invite',
+            json={'ok': True}, status=200)
+        create_new_slack_channel.apply_async(args=[
+            self.hackathon.id, self.user.username])
+
+        import time; time.sleep(3)
+        self.assertEquals(
+            self.hackathon.channel_url,
+            f'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel_id}')

hackathon/tests/test_models.py

@@ -36,7 +36,7 @@ def setUp(self):
             created_by=user,
             display_name="testaward",
             description="lorem ipsum")
-        
+
         hack_award = HackAward.objects.create(
             created_by=user,
             hack_award_category=award_category,

requirements.txt

@@ -52,6 +52,7 @@ pytz==2020.4
 redis==4.1.1
 requests==2.24.0
 requests-oauthlib==1.3.0
+responses==0.17.0
 retrying==1.3.3
 sentry-sdk==0.10.2
 six==1.15.0