Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

testing: 100% code coverage for zerver/lib/outgoing_webhook.py.

This commit is contained in:
Adam Sah 2022-05-15 21:17:23 -04:00 committed by Tim Abbott
parent c93024cd5b
commit 04ccd8c6d8
2 changed files with 57 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
tools/test-backend
View File

@ -96,7 +96,6 @@ not_yet_fully_covered = [
"zerver/lib/import_realm.py",
"zerver/lib/logging_util.py",
"zerver/lib/migrate.py",
"zerver/lib/outgoing_webhook.py",
"zerver/lib/profile.py",
"zerver/lib/queue.py",
"zerver/lib/sqlalchemy_utils.py",

40
zerver/tests/test_outgoing_webhook_system.py
View File

@ -1,4 +1,4 @@
from typing import Any, Dict
from typing import Any, Dict, Optional
from unittest import mock
import orjson
@ -7,6 +7,7 @@ import responses
from version import ZULIP_VERSION
from zerver.actions.create_user import do_create_user
from zerver.lib.exceptions import JsonableError
from zerver.lib.outgoing_webhook import (
GenericOutgoingWebhookService,
SlackOutgoingWebhookService,
@ -75,11 +76,12 @@ class DoRestCallTests(ZulipTestCase):
mock_event = self.mock_event(bot_user)
service_handler = GenericOutgoingWebhookService("token", bot_user, "service")
def _helper(content: Optional[str]) -> None:
expect_send_response = mock.patch("zerver.lib.outgoing_webhook.send_response_message")
with mock.patch.object(
service_handler, "session"
) as session, expect_send_response as mock_send:
session.post.return_value = ResponseMock(200, orjson.dumps(dict(content="whatever")))
session.post.return_value = ResponseMock(200, orjson.dumps(dict(content=content)))
with self.assertLogs(level="INFO") as logs:
do_rest_call("", mock_event, service_handler)
self.assert_length(logs.output, 1)
@ -87,6 +89,9 @@ class DoRestCallTests(ZulipTestCase):
f"Outgoing webhook request from {bot_user.id}@zulip took ", logs.output[0]
)
if content == "":
self.assertFalse(mock_send.called)
else:
self.assertTrue(mock_send.called)
for service_class in [GenericOutgoingWebhookService, SlackOutgoingWebhookService]:
@ -101,6 +106,10 @@ class DoRestCallTests(ZulipTestCase):
)
session.post.assert_called_once()
_helper("whatever")
_helper("")
_helper(None)
def test_retry_request(self) -> None:
bot_user = self.example_user("outgoing_webhook_bot")
mock_event = self.mock_event(bot_user)
@ -129,6 +138,33 @@ The webhook got a response with status code *500*.""",
assert bot_user.bot_owner is not None
self.assertEqual(bot_owner_notification.recipient_id, bot_user.bot_owner.recipient_id)
def test_bad_msg_type(self) -> None:
bot_user = self.example_user("outgoing_webhook_bot")
mock_event = self.mock_event(bot_user)
service_handler = GenericOutgoingWebhookService("token", bot_user, "service")
mock_event["message"]["type"] = "unknown"
with mock.patch.object(service_handler, "session") as session, self.assertRaises(
JsonableError
), self.assertLogs(level="INFO"):
session.post.return_value = ResponseMock(200)
url = "http://somewhere.com/api/call"
with mock.patch("zerver.lib.outgoing_webhook.get_message_url", return_value=url):
do_rest_call("", mock_event, service_handler)
def test_response_none(self) -> None:
bot_user = self.example_user("outgoing_webhook_bot")
mock_event = self.mock_event(bot_user)
service_handler = GenericOutgoingWebhookService("token", bot_user, "service")
with mock.patch(
"zerver.lib.outgoing_webhook.GenericOutgoingWebhookService.make_request",
return_value=None,
), self.assertLogs(level="INFO") as logs:
resp = do_rest_call("", mock_event, service_handler)
self.assertEqual(resp, None)
self.assert_length(logs.output, 1)
def test_fail_request(self) -> None:
bot_user = self.example_user("outgoing_webhook_bot")
mock_event = self.mock_event(bot_user)