Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
webhooks/heroku: Add severity emoji mapping.
sathwikshetty33e4097a005e09
diff --git a/zerver/webhooks/heroku/tests.py b/zerver/webhooks/heroku/tests.pyindex 9db3c9a8e9e..e562dd16f99 100644--- a/zerver/webhooks/heroku/tests.py+++ b/zerver/webhooks/heroku/tests.py@@ -2,18 +2,18 @@ import orjsonfrom zerver.lib.test_classes import WebhookTestCasefrom zerver.webhooks.fixtureless_integrations import BO_EMAIL, PROJECT_NAME-from zerver.webhooks.heroku.view import IGNORED_ENTITIES+from zerver.webhooks.heroku.view import IGNORED_ENTITIES, STATUS_MAPclass HerokuHookTests(WebhookTestCase):TOPIC_NAME = PROJECT_NAMEdef test_build_create(self) -> None:- expected_message = f"{BO_EMAIL} triggered a [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113737Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f0cac0426f4898d9bdcd214401027af128935b9e9618eeb6f83a3546b142d2)."+ expected_message = f":time_ticking: {BO_EMAIL} triggered a [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113737Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f0cac0426f4898d9bdcd214401027af128935b9e9618eeb6f83a3546b142d2)."self.check_webhook("build_create", self.TOPIC_NAME, expected_message)def test_build_update(self) -> None:- expected_message = f"The [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c) triggered by {BO_EMAIL} **succeeded**."+ expected_message = f":check: The [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c) triggered by {BO_EMAIL} **succeeded**."self.check_webhook("build_update", self.TOPIC_NAME, expected_message)def test_ignored_entities(self) -> None:@@ -28,12 +28,12 @@ class HerokuHookTests(WebhookTestCase):self.assertEqual(self.get_last_message().id, last_message_id)def test_release_create(self) -> None:- expected_message = f"{BO_EMAIL} triggered a release(v3): Deploy 1a5f89db."+ expected_message = f":check: {BO_EMAIL} triggered a release(v3): Deploy 1a5f89db."self.check_webhook("release_create", self.TOPIC_NAME, expected_message)def test_release_update(self) -> None:expected_message = (- f"The release(v3): Deploy 1a5f89db triggered by {BO_EMAIL} **succeeded**."+ f":check: The release(v3): Deploy 1a5f89db triggered by {BO_EMAIL} **succeeded**.")self.check_webhook("release_update", self.TOPIC_NAME, expected_message)@@ -46,3 +46,48 @@ class HerokuHookTests(WebhookTestCase):result = self.client_post(self.url, orjson.dumps(data), content_type="application/json")self.assert_json_success(result)self.assertEqual(self.get_last_message().id, last_message_id)++ def test_all_status_emojis(self) -> None:+ self.subscribe(self.test_user, self.channel_name)+ expected_message_template = "{emoji} The [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c) triggered by {email} **{status}**."+ payload = self.webhook_fixture_data(self.webhook_dir_name, "build_update")+ data = orjson.loads(payload)++ for status, emoji in STATUS_MAP.items():+ with self.subTest(status=status):+ data["data"]["status"] = status+ expected_message = expected_message_template.format(+ emoji=emoji, status=status, email=BO_EMAIL+ )+ msg = self.send_webhook_payload(+ self.test_user,+ self.url,+ orjson.dumps(data).decode(),+ content_type="application/json",+ )++ self.assert_channel_message(+ message=msg,+ channel_name=self.channel_name,+ topic_name=self.TOPIC_NAME,+ content=expected_message,+ )++ def test_status_not_in_map(self) -> None:+ self.subscribe(self.test_user, self.channel_name)+ expected_message = f"The [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c) triggered by {BO_EMAIL} **building**."+ payload = self.webhook_fixture_data(self.webhook_dir_name, "build_update")+ data = orjson.loads(payload)+ data["data"]["status"] = "building"+ msg = self.send_webhook_payload(+ self.test_user,+ self.url,+ orjson.dumps(data).decode(),+ content_type="application/json",+ )+ self.assert_channel_message(+ message=msg,+ channel_name=self.channel_name,+ topic_name=self.TOPIC_NAME,+ content=expected_message,+ )diff --git a/zerver/webhooks/heroku/view.py b/zerver/webhooks/heroku/view.pyindex 8da51e5c804..a3e2bc7f4eb 100644--- a/zerver/webhooks/heroku/view.py+++ b/zerver/webhooks/heroku/view.py@@ -8,8 +8,8 @@ from zerver.lib.validator import WildValue, check_bool, check_int, check_none_orfrom zerver.lib.webhooks.common import check_send_webhook_messagefrom zerver.models import UserProfile-ENTITY_CREATED_MESSAGE = "{actor} triggered a {entity}."-ENTITY_UPDATED_MESSAGE = "The {entity} triggered by {actor} **{status}**."+ENTITY_CREATED_MESSAGE = "{status_emoji}{actor} triggered a {entity}."+ENTITY_UPDATED_MESSAGE = "{status_emoji}The {entity} triggered by {actor} **{status}**."# The events here are ignored not because they are noisy.# But we do not have accurate fixtures for them.@@ -27,6 +27,13 @@ IGNORED_ENTITIES = ["sni-endpoint",]+STATUS_MAP = {+ "succeeded": ":check:",+ "failed": ":warning:",+ "pending": ":time_ticking:",+ "expired": ":times_up:",+}+def get_body(payload: WildValue, entity: str) -> str:data = payload["data"]@@ -42,9 +49,12 @@ def get_body(payload: WildValue, entity: str) -> str:action = payload["action"].tame(check_string)status = data["status"].tame(check_string)+ status_emoji = f"{STATUS_MAP[status]} " if status in STATUS_MAP else ""template = ENTITY_UPDATED_MESSAGE if action == "update" else ENTITY_CREATED_MESSAGE- body = template.format(entity=display_entity, actor=actor, status=status)+ body = template.format(+ entity=display_entity, actor=actor, status=status, status_emoji=status_emoji+ )return body