mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 14:35:27 +00:00
93678e89cd
These are the straightforward ones. Note that there is a line in zerver.lib.test_classes.build_webhook_url that lost test coverage. That's because most of our tests test using stream messages so the webhook URLs being tested always have a query parameter. So the line that accounts for there being no query parameters never gets called, which is fine, but we should still keep it.
54 lines
1.8 KiB
Python
54 lines
1.8 KiB
Python
# Webhooks for external integrations.
|
|
|
|
from typing import Any, Dict
|
|
|
|
import ujson
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import ugettext as _
|
|
|
|
from zerver.decorator import api_key_only_webhook_view
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_error, json_success
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
CODESHIP_SUBJECT_TEMPLATE = '{project_name}'
|
|
CODESHIP_MESSAGE_TEMPLATE = '[Build]({build_url}) triggered by {committer} on {branch} branch {status}.'
|
|
|
|
CODESHIP_DEFAULT_STATUS = 'has {status} status'
|
|
CODESHIP_STATUS_MAPPER = {
|
|
'testing': 'started',
|
|
'error': 'failed',
|
|
'success': 'succeeded',
|
|
}
|
|
|
|
|
|
@api_key_only_webhook_view('Codeship')
|
|
@has_request_variables
|
|
def api_codeship_webhook(request: HttpRequest, user_profile: UserProfile,
|
|
payload: Dict[str, Any]=REQ(argument_type='body')) -> HttpResponse:
|
|
payload = payload['build']
|
|
subject = get_subject_for_http_request(payload)
|
|
body = get_body_for_http_request(payload)
|
|
|
|
check_send_webhook_message(request, user_profile, subject, body)
|
|
return json_success()
|
|
|
|
|
|
def get_subject_for_http_request(payload: Dict[str, Any]) -> str:
|
|
return CODESHIP_SUBJECT_TEMPLATE.format(project_name=payload['project_name'])
|
|
|
|
|
|
def get_body_for_http_request(payload: Dict[str, Any]) -> str:
|
|
return CODESHIP_MESSAGE_TEMPLATE.format(
|
|
build_url=payload['build_url'],
|
|
committer=payload['committer'],
|
|
branch=payload['branch'],
|
|
status=get_status_message(payload)
|
|
)
|
|
|
|
|
|
def get_status_message(payload: Dict[str, Any]) -> str:
|
|
build_status = payload['status']
|
|
return CODESHIP_STATUS_MAPPER.get(build_status, CODESHIP_DEFAULT_STATUS.format(status=build_status))
|