mirror of
https://github.com/zulip/zulip.git
synced 2025-11-08 16:01:58 +00:00
3afc8ed7ae
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.
81 lines
2.3 KiB
Python
81 lines
2.3 KiB
Python
from urllib.parse import urlencode
|
|
|
|
from typing_extensions import override
|
|
|
|
from zerver.lib.test_classes import WebhookTestCase
|
|
|
|
|
|
class PapertrailHookTests(WebhookTestCase):
|
|
STREAM_NAME = "papertrail"
|
|
URL_TEMPLATE = "/api/v1/external/papertrail?&api_key={api_key}&stream={stream}"
|
|
WEBHOOK_DIR_NAME = "papertrail"
|
|
|
|
def test_short_message(self) -> None:
|
|
expected_topic_name = "logs"
|
|
expected_message = """
|
|
[Search for "Important stuff"](https://papertrailapp.com/searches/42) found **2** matches:
|
|
|
|
May 18 20:30:02 - abc - cron OR server1:
|
|
``` quote
|
|
message body
|
|
```
|
|
May 18 20:30:02 - server1 - cron OR server1:
|
|
``` quote
|
|
A short event
|
|
```
|
|
""".strip()
|
|
|
|
self.check_webhook(
|
|
"short_post",
|
|
expected_topic_name,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_long_message(self) -> None:
|
|
expected_topic = "logs"
|
|
expected_message = """
|
|
[Search for "Important stuff"](https://papertrailapp.com/searches/42) found **5** matches:
|
|
|
|
May 18 20:30:02 - abc - cron OR server1:
|
|
``` quote
|
|
message body 1
|
|
```
|
|
May 18 20:30:02 - abc - cron OR server1:
|
|
``` quote
|
|
message body 2
|
|
```
|
|
May 18 20:30:02 - abc - cron OR server1:
|
|
``` quote
|
|
message body 3
|
|
```
|
|
May 18 20:30:02 - abc - cron OR server1:
|
|
``` quote
|
|
message body 4
|
|
```
|
|
[See more](https://papertrailapp.com/searches/42)
|
|
""".strip()
|
|
|
|
self.check_webhook(
|
|
"long_post",
|
|
expected_topic,
|
|
expected_message,
|
|
content_type="application/x-www-form-urlencoded",
|
|
)
|
|
|
|
def test_incorrect_message(self) -> None:
|
|
with self.assertRaises(AssertionError) as e:
|
|
self.check_webhook(
|
|
"incorrect_post", "", "", content_type="application/x-www-form-urlencoded"
|
|
)
|
|
|
|
self.assertIn("Events key is missing from payload", e.exception.args[0])
|
|
|
|
@override
|
|
def get_body(self, fixture_name: str) -> str:
|
|
# Papertrail webhook sends a POST request with payload parameter
|
|
# containing the JSON body. Documented here:
|
|
# https://help.papertrailapp.com/kb/how-it-works/web-hooks#encoding
|
|
body = self.webhook_fixture_data("papertrail", fixture_name, file_type="json")
|
|
return urlencode({"payload": body})
|