From 0900364e1fca1d9efae2e16a4707e472ce05aa3c Mon Sep 17 00:00:00 2001
From: sandeepsajan0 <sandeepsajan0@gmail.com>
Date: Tue, 7 Jun 2022 18:53:35 +0530
Subject: [PATCH] Update token settings, messaging returns, and tests related
to slack adapters
---
hypha/apply/activity/messaging.py | 13 +-
hypha/apply/activity/tests/test_messaging.py | 152 ++++++++-----------
hypha/settings/base.py | 2 +-
3 files changed, 77 insertions(+), 90 deletions(-)
diff --git a/hypha/apply/activity/messaging.py b/hypha/apply/activity/messaging.py
index 956aac839..4a08bb273 100644
--- a/hypha/apply/activity/messaging.py
+++ b/hypha/apply/activity/messaging.py
@@ -467,7 +467,7 @@ class SlackAdapter(AdapterBase):
def __init__(self):
super().__init__()
- self.destination = settings.SLACK_DESTINATION_URL
+ self.destination = settings.SLACK_ENDPOINT_URL
self.target_room = settings.SLACK_DESTINATION_ROOM
self.comments_room = settings.SLACK_DESTINATION_ROOM_COMMENTS
self.comments_type = settings.SLACK_TYPE_COMMENTS
@@ -716,12 +716,14 @@ class SlackAdapter(AdapterBase):
def send_message(self, message, recipient, source, **kwargs):
target_rooms = self.slack_channels(source, **kwargs)
- if not self.destination or not any(target_rooms):
+ if not self.destination or not any(target_rooms) or not settings.SLACK_TOKEN:
errors = list()
if not self.destination:
errors.append('Destination URL')
if not target_rooms:
errors.append('Room ID')
+ if not settings.SLACK_TOKEN:
+ errors.append('Slack Token')
return 'Missing configuration: {}'.format(', '.join(errors))
message = ' '.join([recipient, message]).strip()
@@ -730,7 +732,12 @@ class SlackAdapter(AdapterBase):
"message": message,
}
for room in target_rooms:
- slack_message('messages/slack_message.html', data, channel=room)
+ try:
+ slack_message('messages/slack_message.html', data, channel=room)
+ except Exception as e:
+ logger.exception(e)
+ return '400: Bad Request'
+ return '200: OK'
class EmailAdapter(AdapterBase):
diff --git a/hypha/apply/activity/tests/test_messaging.py b/hypha/apply/activity/tests/test_messaging.py
index bd716ec62..07475b3c1 100644
--- a/hypha/apply/activity/tests/test_messaging.py
+++ b/hypha/apply/activity/tests/test_messaging.py
@@ -7,6 +7,7 @@ import responses
from django.contrib.messages import get_messages
from django.core import mail
from django.test import TestCase, override_settings
+from django_slack.utils import get_backend
from hypha.apply.funds.tests.factories import (
ApplicationSubmissionFactory,
@@ -334,95 +335,90 @@ class TestSlackAdapter(AdapterMixin, TestCase):
target_room = '#<ROOM ID>'
@override_settings(
- SLACK_DESTINATION_URL=target_url,
+ SLACK_ENDPOINT_URL=target_url,
SLACK_DESTINATION_ROOM=None,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_cant_send_with_no_room(self):
+ error_message = "Missing configuration: Room ID"
adapter = SlackAdapter()
submission = ApplicationSubmissionFactory()
- adapter.send_message('my message', '', source=submission)
- self.assertEqual(len(responses.calls), 0)
+ messages = adapter.send_message('my message', '', source=submission)
+ self.assertEqual(messages, error_message)
@override_settings(
- SLACK_DESTINATION_URL=None,
+ SLACK_ENDPOINT_URL=None,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_cant_send_with_no_url(self):
+ error_message = "Missing configuration: Destination URL"
adapter = SlackAdapter()
submission = ApplicationSubmissionFactory()
- adapter.send_message('my message', '', source=submission)
- self.assertEqual(len(responses.calls), 0)
+ messages = adapter.send_message('my message', '', source=submission)
+ self.assertEqual(messages, error_message)
@override_settings(
- SLACK_DESTINATION_URL=target_url,
+ SLACK_ENDPOINT_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_correct_payload(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
+ backend = get_backend()
+ backend.reset_messages()
submission = ApplicationSubmissionFactory()
adapter = SlackAdapter()
message = 'my message'
adapter.send_message(message, '', source=submission)
- self.assertEqual(len(responses.calls), 1)
- self.assertDictEqual(
- json.loads(responses.calls[0].request.body),
- {
- 'room': [self.target_room],
- 'message': message,
- }
- )
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 1)
+ message_payload = json.loads(messages[0]['payload'])
+ self.assertEqual(message_payload['text'], message)
@override_settings(
- SLACK_DESTINATION_URL=target_url,
+ SLACK_ENDPOINT_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_fund_custom_slack_channel(self):
+ backend = get_backend()
+ backend.reset_messages()
responses.add(responses.POST, self.target_url, status=200, body='OK')
submission = ApplicationSubmissionFactory(round__parent__slack_channel='dummy')
adapter = SlackAdapter()
message = 'my message'
adapter.send_message(message, '', source=submission)
- self.assertEqual(len(responses.calls), 1)
- self.assertDictEqual(
- json.loads(responses.calls[0].request.body),
- {
- 'room': ['#dummy'],
- 'message': message,
- }
- )
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 1)
+ message_payload = json.loads(messages[0]['payload'])
+ self.assertEqual(message_payload['text'], message)
+ self.assertEqual(message_payload['channel'], '#dummy')
@override_settings(
- SLACK_DESTINATION_URL=target_url,
+ SLACK_ENDPOINT_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_fund_multiple_custom_slack_channel(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
+ backend = get_backend()
+ backend.reset_messages()
submission = ApplicationSubmissionFactory(round__parent__slack_channel='dummy1, dummy2')
adapter = SlackAdapter()
message = 'my message'
adapter.send_message(message, '', source=submission)
- self.assertEqual(len(responses.calls), 1)
- self.assertDictEqual(
- json.loads(responses.calls[0].request.body),
- {
- 'room': ['#dummy1', '#dummy2'],
- 'message': message,
- }
- )
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 2)
+ for index, sent_message in enumerate(messages):
+ message_payload = json.loads(sent_message['payload'])
+ self.assertEqual(message_payload['text'], message)
+ self.assertEqual(message_payload['channel'], '#dummy' + str(index + 1))
- @responses.activate
def test_gets_lead_if_slack_set(self):
adapter = SlackAdapter()
submission = ApplicationSubmissionFactory()
recipients = adapter.recipients(MESSAGES.COMMENT, source=submission, related=None)
self.assertTrue(submission.lead.slack in recipients[0])
- @responses.activate
def test_gets_blank_if_slack_not_set(self):
adapter = SlackAdapter()
submission = ApplicationSubmissionFactory(lead__slack='')
@@ -430,13 +426,11 @@ class TestSlackAdapter(AdapterMixin, TestCase):
self.assertTrue(submission.lead.slack in recipients[0])
@override_settings(
- SLACK_DESTINATION_URL=target_url,
+ SLACK_ENDPOINT_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_message_with_good_response(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
-
self.adapter = SlackAdapter()
self.adapter_process(MESSAGES.NEW_SUBMISSION)
self.assertEqual(Message.objects.count(), 1)
@@ -444,21 +438,6 @@ class TestSlackAdapter(AdapterMixin, TestCase):
self.assertEqual(sent_message.content[0:10], self.adapter.messages[MESSAGES.NEW_SUBMISSION][0:10])
self.assertEqual(sent_message.status, '200: OK')
- @override_settings(
- SLACK_DESTINATION_URL=target_url,
- SLACK_DESTINATION_ROOM=target_room,
- )
- @responses.activate
- def test_message_with_bad_response(self):
- responses.add(responses.POST, self.target_url, status=400, body='Bad Request')
-
- self.adapter = SlackAdapter()
- self.adapter_process(MESSAGES.NEW_SUBMISSION)
- self.assertEqual(Message.objects.count(), 1)
- sent_message = Message.objects.first()
- self.assertEqual(sent_message.content[0:10], self.adapter.messages[MESSAGES.NEW_SUBMISSION][0:10])
- self.assertEqual(sent_message.status, '400: Bad Request')
-
@override_settings(SEND_MESSAGES=True)
class TestEmailAdapter(AdapterMixin, TestCase):
@@ -637,10 +616,11 @@ class TestAdaptersForProject(AdapterMixin, TestCase):
@override_settings(
SLACK_DESTINATION_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_slack_created(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
+ backend = get_backend()
+ backend.reset_messages()
project = self.source_factory()
user = UserFactory()
self.adapter_process(
@@ -650,18 +630,19 @@ class TestAdaptersForProject(AdapterMixin, TestCase):
source=project,
related=project.submission,
)
- self.assertEqual(len(responses.calls), 1)
- data = json.loads(responses.calls[0].request.body)
- self.assertIn(str(user), data['message'])
- self.assertIn(str(project), data['message'])
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 1)
+ self.assertIn(str(user), messages[0]['text'])
+ self.assertIn(str(project), messages[0]['text'])
@override_settings(
SLACK_DESTINATION_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_slack_lead_change(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
+ backend = get_backend()
+ backend.reset_messages()
project = self.source_factory()
user = UserFactory()
self.adapter_process(
@@ -671,19 +652,19 @@ class TestAdaptersForProject(AdapterMixin, TestCase):
source=project,
related=project.submission,
)
- self.assertEqual(len(responses.calls), 1)
- data = json.loads(responses.calls[0].request.body)
- self.assertIn(str(user), data['message'])
- self.assertIn(str(project), data['message'])
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 1)
+ self.assertIn(str(user), messages[0]['text'])
+ self.assertIn(str(project), messages[0]['text'])
@override_settings(
SLACK_DESTINATION_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_slack_applicant_update_invoice(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
-
+ backend = get_backend()
+ backend.reset_messages()
project = self.source_factory()
invoice = InvoiceFactory(project=project)
applicant = ApplicantFactory()
@@ -695,21 +676,20 @@ class TestAdaptersForProject(AdapterMixin, TestCase):
source=project,
related=invoice,
)
+ messages = backend.retrieve_messages()
- self.assertEqual(len(responses.calls), 1)
-
- data = json.loads(responses.calls[0].request.body)
- self.assertIn(str(applicant), data['message'])
- self.assertIn(str(project), data['message'])
+ self.assertEqual(len(messages), 1)
+ self.assertIn(str(applicant), messages[0]['text'])
+ self.assertIn(str(project), messages[0]['text'])
@override_settings(
SLACK_DESTINATION_URL=target_url,
SLACK_DESTINATION_ROOM=target_room,
+ SLACK_BACKEND="django_slack.backends.TestBackend",
)
- @responses.activate
def test_slack_staff_update_invoice(self):
- responses.add(responses.POST, self.target_url, status=200, body='OK')
-
+ backend = get_backend()
+ backend.reset_messages()
project = self.source_factory()
invoice = InvoiceFactory(project=project)
staff = StaffFactory()
@@ -721,8 +701,8 @@ class TestAdaptersForProject(AdapterMixin, TestCase):
source=project,
related=invoice,
)
-
- self.assertEqual(len(responses.calls), 1)
+ messages = backend.retrieve_messages()
+ self.assertEqual(len(messages), 1)
@override_settings(SEND_MESSAGES=True)
def test_email_staff_update_invoice(self):
diff --git a/hypha/settings/base.py b/hypha/settings/base.py
index b0bb036f5..15e5e87b8 100644
--- a/hypha/settings/base.py
+++ b/hypha/settings/base.py
@@ -545,7 +545,7 @@ SLACK_DESTINATION_ROOM_COMMENTS = env.str('SLACK_DESTINATION_ROOM_COMMENTS', Non
SLACK_TYPE_COMMENTS = env.list('SLACK_TYPE_COMMENTS', [])
# Django Slack settings
-SLACK_TOKEN = env.str('SLACK_TOKEN')
+SLACK_TOKEN = env.str('SLACK_TOKEN', None)
SLACK_BACKEND = 'django_slack.backends.UrllibBackend' # CeleryBackend can be used for async
if SLACK_DESTINATION_URL:
SLACK_ENDPOINT_URL = SLACK_DESTINATION_URL
--
GitLab