Files
zulip/zerver/webhooks/deskdotcom/tests.py
Prakhar Pratyush 3afc8ed7ae webhooks: Rename *topic local variables to *topic_name.
This is preparatory work towards adding a Topic model.
We plan to use the local variable name as 'topic' for
the Topic model objects.

Currently, we use *topic as the local variable name for
topic names.

We rename local variables of the form *topic to *topic_name
so that we don't need to think about type collisions in
individual code paths where we might want to talk about both
Topic objects and strings for the topic name.
2024-01-17 08:35:29 -08:00

84 lines
2.6 KiB
Python

from typing_extensions import override
from zerver.lib.test_classes import WebhookTestCase
# Tests for the Desk.com webhook integration.
#
# The stream name must be provided in the URL-encoded test fixture data,
# and must match STREAM_NAME set here.
#
# Example:
#
# stream=deskdotcom&topic=static%20text%20notification&data=This%20is%20a%20custom%20action.
#
class DeskDotComHookTests(WebhookTestCase):
STREAM_NAME = "deskdotcom"
URL_TEMPLATE = "/api/v1/external/deskdotcom?stream={stream}"
WEBHOOK_DIR_NAME = "deskdotcom"
def test_static_text_message(self) -> None:
expected_topic_name = "static text notification"
expected_message = "This is a custom action."
self.api_stream_message(
self.test_user,
"static_text",
expected_topic_name,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_case_updated_message(self) -> None:
expected_topic_name = "case updated notification"
expected_message = (
"Case 2 updated. "
"Link: <a href='https://deskdotcomtest.desk.com/web/agent/case/2'>"
"I have a question</a>"
)
self.api_stream_message(
self.test_user,
"case_updated",
expected_topic_name,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_unicode_text_italian(self) -> None:
expected_topic_name = "case updated notification"
expected_message = (
"Case 2 updated. "
"Link: <a href='https://deskdotcomtest.desk.com/web/agent/case/2'>"
"Il mio hovercraft è pieno di anguille.</a>"
)
self.api_stream_message(
self.test_user,
"unicode_text_italian",
expected_topic_name,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_unicode_text_japanese(self) -> None:
expected_topic_name = "case updated notification"
expected_message = (
"Case 2 updated. "
"Link: <a href='https://deskdotcomtest.desk.com/web/agent/case/2'>"
"私のホバークラフトは鰻でいっぱいです</a>"
)
self.api_stream_message(
self.test_user,
"unicode_text_japanese",
expected_topic_name,
expected_message,
content_type="application/x-www-form-urlencoded",
)
@override
def get_body(self, fixture_name: str) -> str:
return self.webhook_fixture_data("deskdotcom", fixture_name, file_type="txt")