upstream-zulip/zerver/webhooks/heroku/tests.py

import orjson

from zerver.lib.test_classes import WebhookTestCase
from zerver.webhooks.fixtureless_integrations import BO_EMAIL, PROJECT_NAME
from zerver.webhooks.heroku.view import IGNORED_ENTITIES, STATUS_MAP


class HerokuHookTests(WebhookTestCase):
    TOPIC_NAME = PROJECT_NAME

    def test_build_create(self) -> None:
        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":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:
        for entity in IGNORED_ENTITIES:
            with self.subTest(entity=entity):
                payload = {"resource": entity, "action": "create", "data": {}}
                last_message_id = self.get_last_message().id
                result = self.client_post(
                    self.url, orjson.dumps(payload), content_type="application/json"
                )
                self.assert_json_success(result)
                self.assertEqual(self.get_last_message().id, last_message_id)

    def test_release_create(self) -> None:
        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":check: The release(v3): Deploy 1a5f89db triggered by {BO_EMAIL} **succeeded**."
        )
        self.check_webhook("release_update", self.TOPIC_NAME, expected_message)

    def test_release_phase_update(self) -> None:
        self.subscribe(self.test_user, self.channel_name)
        payload = self.webhook_fixture_data(self.webhook_dir_name, "release_update")
        data = orjson.loads(payload)
        data["data"]["current"] = False
        last_message_id = self.get_last_message().id
        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,
        )