# -*- coding: utf-8 -*- import ujson import logging import mock import requests from typing import Any, Optional from zerver.lib.outgoing_webhook import ( do_rest_call, GenericOutgoingWebhookService, SlackOutgoingWebhookService, ) from zerver.lib.test_classes import ZulipTestCase from zerver.lib.topic import TOPIC_NAME from zerver.models import get_realm, get_user, UserProfile, get_display_recipient from version import ZULIP_VERSION class ResponseMock: def __init__(self, status_code: int, content: Optional[Any]=None) -> None: self.status_code = status_code self.content = content self.text = ujson.dumps(content) def request_exception_error(http_method: Any, final_url: Any, data: Any, **request_kwargs: Any) -> Any: raise requests.exceptions.RequestException("I'm a generic exception :(") def timeout_error(http_method: Any, final_url: Any, data: Any, **request_kwargs: Any) -> Any: raise requests.exceptions.Timeout("Time is up!") def connection_error(http_method: Any, final_url: Any, data: Any, **request_kwargs: Any) -> Any: raise requests.exceptions.ConnectionError() service_handler = GenericOutgoingWebhookService(None, None, None) class DoRestCallTests(ZulipTestCase): def setUp(self) -> None: super().setUp() realm = get_realm("zulip") user_profile = get_user("outgoing-webhook@zulip.com", realm) self.mock_event = { # In the tests there is no active queue processor, so retries don't get processed. # Therefore, we need to emulate `retry_event` in the last stage when the maximum # retries have been exceeded. 'failed_tries': 3, 'message': {'display_recipient': 'Verona', 'stream_id': 999, TOPIC_NAME: 'Foo', 'id': '', 'type': 'stream'}, 'user_profile_id': user_profile.id, 'command': '', 'service_name': ''} self.bot_user = self.example_user('outgoing_webhook_bot') logging.disable(logging.WARNING) @mock.patch('zerver.lib.outgoing_webhook.send_response_message') def test_successful_request(self, mock_send: mock.Mock) -> None: response = ResponseMock(200, dict(content='whatever')) with mock.patch('requests.request', return_value=response): do_rest_call('', None, self.mock_event, service_handler) self.assertTrue(mock_send.called) for service_class in [GenericOutgoingWebhookService, SlackOutgoingWebhookService]: handler = service_class(None, None, None) with mock.patch('requests.request', return_value=response): do_rest_call('', None, self.mock_event, handler) self.assertTrue(mock_send.called) def test_retry_request(self: mock.Mock) -> None: response = ResponseMock(500) self.mock_event['failed_tries'] = 3 with mock.patch('requests.request', return_value=response): do_rest_call('', None, self.mock_event, service_handler) bot_owner_notification = self.get_last_message() self.assertEqual(bot_owner_notification.content, '''[A message](http://zulip.testserver/#narrow/stream/999-Verona/topic/Foo/near/) triggered an outgoing webhook. The webhook got a response with status code *500*.''') self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id) self.mock_event['failed_tries'] = 0 @mock.patch('zerver.lib.outgoing_webhook.fail_with_message') def test_fail_request(self, mock_fail_with_message: mock.Mock) -> None: response = ResponseMock(400) with mock.patch('requests.request', return_value=response): do_rest_call('', None, self.mock_event, service_handler) bot_owner_notification = self.get_last_message() self.assertTrue(mock_fail_with_message.called) self.assertEqual(bot_owner_notification.content, '''[A message](http://zulip.testserver/#narrow/stream/999-Verona/topic/Foo/near/) triggered an outgoing webhook. The webhook got a response with status code *400*.''') self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id) def test_headers(self) -> None: with mock.patch('requests.request') as mock_request: do_rest_call('', 'payload-stub', self.mock_event, service_handler) kwargs = mock_request.call_args[1] self.assertEqual(kwargs['data'], 'payload-stub') user_agent = 'ZulipOutgoingWebhook/' + ZULIP_VERSION headers = { 'content-type': 'application/json', 'User-Agent': user_agent, } self.assertEqual(kwargs['headers'], headers) def test_error_handling(self) -> None: def helper(side_effect: Any, error_text: str) -> None: with mock.patch('logging.info'): with mock.patch('requests.request', side_effect=side_effect): do_rest_call('', None, self.mock_event, service_handler) bot_owner_notification = self.get_last_message() self.assertIn(error_text, bot_owner_notification.content) self.assertIn('triggered', bot_owner_notification.content) self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id) helper(side_effect=timeout_error, error_text='A timeout occurred.') helper(side_effect=connection_error, error_text='A connection error occurred.') @mock.patch('logging.exception') @mock.patch('requests.request', side_effect=request_exception_error) @mock.patch('zerver.lib.outgoing_webhook.fail_with_message') def test_request_exception(self, mock_fail_with_message: mock.Mock, mock_requests_request: mock.Mock, mock_logger: mock.Mock) -> None: do_rest_call('', None, self.mock_event, service_handler) bot_owner_notification = self.get_last_message() self.assertTrue(mock_fail_with_message.called) self.assertEqual(bot_owner_notification.content, '''[A message](http://zulip.testserver/#narrow/stream/999-Verona/topic/Foo/near/) triggered an outgoing webhook. When trying to send a request to the webhook service, an exception of type RequestException occurred: ``` I'm a generic exception :( ```''') self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id) class TestOutgoingWebhookMessaging(ZulipTestCase): def setUp(self) -> None: super().setUp() self.user_profile = self.example_user("othello") self.bot_profile = self.create_test_bot('outgoing-webhook', self.user_profile, full_name='Outgoing Webhook bot', bot_type=UserProfile.OUTGOING_WEBHOOK_BOT, service_name='foo-service') @mock.patch('requests.request', return_value=ResponseMock(200, {"response_string": "Hidley ho, I'm a webhook responding!"})) def test_pm_to_outgoing_webhook_bot(self, mock_requests_request: mock.Mock) -> None: self.send_personal_message(self.user_profile, self.bot_profile, content="foo") last_message = self.get_last_message() self.assertEqual(last_message.content, "Hidley ho, I'm a webhook responding!") self.assertEqual(last_message.sender_id, self.bot_profile.id) display_recipient = get_display_recipient(last_message.recipient) # The next two lines error on mypy because the display_recipient is of type Union[str, List[Dict[str, Any]]]. # In this case, we know that display_recipient will be of type List[Dict[str, Any]]. # Otherwise this test will error, which is wanted behavior anyway. self.assert_length(display_recipient, 1) # type: ignore self.assertEqual(display_recipient[0]['email'], self.user_profile.email) # type: ignore @mock.patch('requests.request', return_value=ResponseMock(200, {"response_string": "Hidley ho, I'm a webhook responding!"})) def test_stream_message_to_outgoing_webhook_bot(self, mock_requests_request: mock.Mock) -> None: self.send_stream_message(self.user_profile, "Denmark", content="@**{}** foo".format(self.bot_profile.full_name), topic_name="bar") last_message = self.get_last_message() self.assertEqual(last_message.content, "Hidley ho, I'm a webhook responding!") self.assertEqual(last_message.sender_id, self.bot_profile.id) self.assertEqual(last_message.topic_name(), "bar") display_recipient = get_display_recipient(last_message.recipient) self.assertEqual(display_recipient, "Denmark")