mirror of
https://github.com/zulip/zulip.git
synced 2025-10-25 00:53:56 +00:00
2dab5cbd03
This commit strengthens types by typing the Solano webhook's incoming payload as WildValue, which eradicates the use of Any within the incoming webhook integration. The KeyError exception has been replaced to catch a ValidationError instead now, since the incoming payload's keys will be tamed before usage and the non-existence of the key is raised as a ValidationError in the taming function.
80 lines
2.7 KiB
Python
80 lines
2.7 KiB
Python
# Webhooks for external integrations.
|
|
from django.core.exceptions import ValidationError
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.validator import WildValue, check_string, to_wild_value
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
MESSAGE_TEMPLATE = """
|
|
Build update (see [build log]({build_log_url})):
|
|
* **Author**: {author}
|
|
* **Commit**: [{commit_id}]({commit_url})
|
|
* **Status**: {status} {emoji}
|
|
""".strip()
|
|
|
|
ALL_EVENT_TYPES = ["first-fail", "stop", "received"]
|
|
|
|
|
|
@webhook_view("SolanoLabs", all_event_types=ALL_EVENT_TYPES)
|
|
@has_request_variables
|
|
def api_solano_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
payload: WildValue = REQ(argument_type="body", converter=to_wild_value),
|
|
) -> HttpResponse:
|
|
event = payload["event"].tame(check_string)
|
|
topic = "build update"
|
|
if event == "test":
|
|
return handle_test_event(request, user_profile, topic)
|
|
try:
|
|
author = payload["committers"][0].tame(check_string)
|
|
except ValidationError:
|
|
author = "Unknown"
|
|
status = payload["status"].tame(check_string)
|
|
build_log = payload["url"].tame(check_string)
|
|
repository = payload["repository"]["url"].tame(check_string)
|
|
commit_id = payload["commit_id"].tame(check_string)
|
|
|
|
good_status = ["passed"]
|
|
bad_status = ["failed", "error"]
|
|
neutral_status = ["running"]
|
|
emoji = ""
|
|
if status in good_status:
|
|
emoji = ":thumbs_up:"
|
|
elif status in bad_status:
|
|
emoji = ":thumbs_down:"
|
|
elif status in neutral_status:
|
|
emoji = ":arrows_counterclockwise:"
|
|
|
|
# If the service is not one of the following, the URL is of the repository home, not the individual
|
|
# commit itself.
|
|
commit_url = repository.split("@")[1]
|
|
if "github" in repository:
|
|
commit_url += f"/commit/{commit_id}"
|
|
elif "bitbucket" in repository:
|
|
commit_url += f"/commits/{commit_id}"
|
|
elif "gitlab" in repository:
|
|
commit_url += f"/pipelines/{commit_id}"
|
|
|
|
body = MESSAGE_TEMPLATE.format(
|
|
author=author,
|
|
build_log_url=build_log,
|
|
commit_id=commit_id[:7],
|
|
commit_url=commit_url,
|
|
status=status,
|
|
emoji=emoji,
|
|
)
|
|
|
|
check_send_webhook_message(request, user_profile, topic, body, event)
|
|
return json_success(request)
|
|
|
|
|
|
def handle_test_event(request: HttpRequest, user_profile: UserProfile, topic: str) -> HttpResponse:
|
|
body = "Solano webhook set up correctly."
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
return json_success(request)
|