mirror of
https://github.com/zulip/zulip.git
synced 2025-10-31 03:53:50 +00:00
365fe0b3d5
Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
218 lines
8.1 KiB
Python
218 lines
8.1 KiB
Python
import json
|
|
from typing import Any, Dict, cast
|
|
from unittest import mock
|
|
|
|
import requests
|
|
|
|
from zerver.lib.avatar import get_gravatar_url
|
|
from zerver.lib.message import MessageDict
|
|
from zerver.lib.outgoing_webhook import get_service_interface_class, process_success_response
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.timestamp import datetime_to_timestamp
|
|
from zerver.lib.topic import TOPIC_NAME
|
|
from zerver.models import SLACK_INTERFACE, Message, get_realm, get_stream, get_user
|
|
|
|
|
|
class TestGenericOutgoingWebhookService(ZulipTestCase):
|
|
|
|
def setUp(self) -> None:
|
|
super().setUp()
|
|
|
|
bot_user = get_user("outgoing-webhook@zulip.com", get_realm("zulip"))
|
|
service_class = get_service_interface_class('whatever') # GenericOutgoingWebhookService
|
|
self.handler = service_class(service_name='test-service',
|
|
token='abcdef',
|
|
user_profile=bot_user)
|
|
|
|
def test_process_success_response(self) -> None:
|
|
class Stub:
|
|
def __init__(self, text: str) -> None:
|
|
self.text = text
|
|
|
|
def make_response(text: str) -> requests.Response:
|
|
return cast(requests.Response, Stub(text=text))
|
|
|
|
event = dict(
|
|
user_profile_id=99,
|
|
message=dict(type='private'),
|
|
)
|
|
service_handler = self.handler
|
|
|
|
response = make_response(text=json.dumps(dict(content='whatever')))
|
|
|
|
with mock.patch('zerver.lib.outgoing_webhook.send_response_message') as m:
|
|
process_success_response(
|
|
event=event,
|
|
service_handler=service_handler,
|
|
response=response,
|
|
)
|
|
self.assertTrue(m.called)
|
|
|
|
response = make_response(text='unparsable text')
|
|
|
|
with mock.patch('zerver.lib.outgoing_webhook.fail_with_message') as m:
|
|
process_success_response(
|
|
event=event,
|
|
service_handler=service_handler,
|
|
response=response,
|
|
)
|
|
self.assertTrue(m.called)
|
|
|
|
def test_build_bot_request(self) -> None:
|
|
othello = self.example_user('othello')
|
|
stream = get_stream('Denmark', othello.realm)
|
|
message_id = self.send_stream_message(
|
|
othello,
|
|
stream.name,
|
|
content="@**test**",
|
|
)
|
|
|
|
message = Message.objects.get(id=message_id)
|
|
|
|
gravatar_url = get_gravatar_url(
|
|
othello.delivery_email,
|
|
othello.avatar_version,
|
|
)
|
|
|
|
expected_message_data = {
|
|
'avatar_url': gravatar_url,
|
|
'client': 'test suite',
|
|
'content': '@**test**',
|
|
'content_type': 'text/x-markdown',
|
|
'display_recipient': 'Denmark',
|
|
'id': message.id,
|
|
'is_me_message': False,
|
|
'reactions': [],
|
|
'recipient_id': message.recipient_id,
|
|
'rendered_content': '<p>@<strong>test</strong></p>',
|
|
'sender_email': othello.email,
|
|
'sender_full_name': 'Othello, the Moor of Venice',
|
|
'sender_id': othello.id,
|
|
'sender_realm_str': 'zulip',
|
|
'sender_short_name': 'othello',
|
|
'stream_id': stream.id,
|
|
TOPIC_NAME: 'test',
|
|
'submessages': [],
|
|
'timestamp': datetime_to_timestamp(message.date_sent),
|
|
'topic_links': [],
|
|
'type': 'stream',
|
|
}
|
|
|
|
wide_message_dict = MessageDict.wide_dict(message)
|
|
|
|
event = {
|
|
'command': '@**test**',
|
|
'message': wide_message_dict,
|
|
'trigger': 'mention',
|
|
}
|
|
|
|
request_data = self.handler.build_bot_request(event)
|
|
request_data = json.loads(request_data)
|
|
self.assertEqual(request_data['data'], "@**test**")
|
|
self.assertEqual(request_data['token'], "abcdef")
|
|
self.assertEqual(request_data['message'], expected_message_data)
|
|
|
|
# Make sure we didn't accidentally mutate wide_message_dict.
|
|
self.assertEqual(wide_message_dict['sender_realm_id'], othello.realm_id)
|
|
|
|
def test_process_success(self) -> None:
|
|
response: Dict[str, Any] = dict(response_not_required=True)
|
|
success_response = self.handler.process_success(response)
|
|
self.assertEqual(success_response, None)
|
|
|
|
response = dict(response_string='test_content')
|
|
success_response = self.handler.process_success(response)
|
|
self.assertEqual(success_response, dict(content='test_content'))
|
|
|
|
response = dict(
|
|
content='test_content',
|
|
widget_content='test_widget_content',
|
|
red_herring='whatever',
|
|
)
|
|
success_response = self.handler.process_success(response)
|
|
expected_response = dict(
|
|
content='test_content',
|
|
widget_content='test_widget_content',
|
|
)
|
|
self.assertEqual(success_response, expected_response)
|
|
|
|
response = dict()
|
|
success_response = self.handler.process_success(response)
|
|
self.assertEqual(success_response, None)
|
|
|
|
class TestSlackOutgoingWebhookService(ZulipTestCase):
|
|
|
|
def setUp(self) -> None:
|
|
super().setUp()
|
|
self.stream_message_event = {
|
|
'command': '@**test**',
|
|
'user_profile_id': 12,
|
|
'service_name': 'test-service',
|
|
'trigger': 'mention',
|
|
'message': {
|
|
'content': 'test_content',
|
|
'type': 'stream',
|
|
'sender_realm_str': 'zulip',
|
|
'sender_email': 'sampleuser@zulip.com',
|
|
'stream_id': '123',
|
|
'display_recipient': 'integrations',
|
|
'timestamp': 123456,
|
|
'sender_id': 21,
|
|
'sender_full_name': 'Sample User',
|
|
},
|
|
}
|
|
|
|
self.private_message_event = {
|
|
'user_profile_id': 24,
|
|
'service_name': 'test-service',
|
|
'command': 'test content',
|
|
'trigger': 'private_message',
|
|
'message': {
|
|
'sender_id': 3,
|
|
'sender_realm_str': 'zulip',
|
|
'timestamp': 1529821610,
|
|
'sender_email': 'cordelia@zulip.com',
|
|
'type': 'private',
|
|
'sender_realm_id': 1,
|
|
'id': 219,
|
|
TOPIC_NAME: 'test',
|
|
'content': 'test content',
|
|
},
|
|
}
|
|
|
|
service_class = get_service_interface_class(SLACK_INTERFACE)
|
|
self.handler = service_class(token="abcdef",
|
|
user_profile=None,
|
|
service_name='test-service')
|
|
|
|
def test_build_bot_request_stream_message(self) -> None:
|
|
request_data = self.handler.build_bot_request(self.stream_message_event)
|
|
|
|
self.assertEqual(request_data[0][1], "abcdef") # token
|
|
self.assertEqual(request_data[1][1], "zulip") # team_id
|
|
self.assertEqual(request_data[2][1], "zulip.com") # team_domain
|
|
self.assertEqual(request_data[3][1], "123") # channel_id
|
|
self.assertEqual(request_data[4][1], "integrations") # channel_name
|
|
self.assertEqual(request_data[5][1], 123456) # timestamp
|
|
self.assertEqual(request_data[6][1], 21) # user_id
|
|
self.assertEqual(request_data[7][1], "Sample User") # user_name
|
|
self.assertEqual(request_data[8][1], "@**test**") # text
|
|
self.assertEqual(request_data[9][1], "mention") # trigger_word
|
|
self.assertEqual(request_data[10][1], 12) # user_profile_id
|
|
|
|
@mock.patch('zerver.lib.outgoing_webhook.fail_with_message')
|
|
def test_build_bot_request_private_message(self, mock_fail_with_message: mock.Mock) -> None:
|
|
|
|
request_data = self.handler.build_bot_request(self.private_message_event)
|
|
self.assertIsNone(request_data)
|
|
self.assertTrue(mock_fail_with_message.called)
|
|
|
|
def test_process_success(self) -> None:
|
|
response: Dict[str, Any] = dict(response_not_required=True)
|
|
success_response = self.handler.process_success(response)
|
|
self.assertEqual(success_response, None)
|
|
|
|
response = dict(text='test_content')
|
|
success_response = self.handler.process_success(response)
|
|
self.assertEqual(success_response, dict(content='test_content'))
|