snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/papertrail/tests.py

@@ -0,0 +1,76 @@
+from urllib.parse import urlencode
+
+from typing_extensions import override
+
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class PapertrailHookTests(WebhookTestCase):
+    def test_short_message(self) -> None:
+        expected_topic_name = "logs"
+        expected_message = """
+[Search for "Important stuff"](https://papertrailapp.com/searches/42) found **2** matches:
+
+<time:2011-05-18T20:30:02-07:00> - abc - cron OR server1:
+``` quote
+message body
+```
+<time:2011-05-18T20:30:02-07:00> - 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:
+
+<time:2011-05-18T20:30:02-07:00> - abc - cron OR server1:
+``` quote
+message body 1
+```
+<time:2011-05-18T20:30:02-07:00> - abc - cron OR server1:
+``` quote
+message body 2
+```
+<time:2011-05-18T20:30:02-07:00> - abc - cron OR server1:
+``` quote
+message body 3
+```
+<time:2011-05-18T20:30:02-07:00> - 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})