mirror of
https://github.com/zulip/zulip.git
synced 2025-11-10 00:46:03 +00:00
762b6b5817
Improve English grammar in comment messages in git integrations by adding 'on' between comment action and noun (PR, Issue, Commit).
318 lines
12 KiB
Python
318 lines
12 KiB
Python
# Webhooks for external integrations.
|
|
from __future__ import absolute_import
|
|
import re
|
|
from functools import partial
|
|
from six import text_type
|
|
from typing import Any, Callable
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import ugettext as _
|
|
from zerver.lib.actions import check_send_message
|
|
from zerver.lib.response import json_success, json_error
|
|
from zerver.decorator import REQ, has_request_variables, api_key_only_webhook_view
|
|
from zerver.models import Client, UserProfile
|
|
from zerver.lib.webhooks.git import get_push_commits_event_message, SUBJECT_WITH_BRANCH_TEMPLATE,\
|
|
get_force_push_commits_event_message, get_remove_branch_event_message, get_pull_request_event_message,\
|
|
SUBJECT_WITH_PR_OR_ISSUE_INFO_TEMPLATE, get_issue_event_message
|
|
|
|
|
|
BITBUCKET_SUBJECT_TEMPLATE = '{repository_name}'
|
|
USER_PART = 'User {display_name}(login: {username})'
|
|
|
|
BITBUCKET_FORK_BODY = USER_PART + ' forked the repository into [{fork_name}]({fork_url}).'
|
|
BITBUCKET_COMMIT_COMMENT_BODY = USER_PART + ' added [comment]({url_to_comment}) to commit.'
|
|
BITBUCKET_COMMIT_STATUS_CHANGED_BODY = '[System {key}]({system_url}) changed status of {commit_info} to {status}.'
|
|
|
|
|
|
PULL_REQUEST_SUPPORTED_ACTIONS = [
|
|
'approved',
|
|
'unapproved',
|
|
'created',
|
|
'updated',
|
|
'rejected',
|
|
'merged',
|
|
'comment_created',
|
|
'comment_updated',
|
|
'comment_deleted',
|
|
]
|
|
|
|
class UnknownTriggerType(Exception):
|
|
pass
|
|
|
|
|
|
@api_key_only_webhook_view('Bitbucket2')
|
|
@has_request_variables
|
|
def api_bitbucket2_webhook(request, user_profile, client, payload=REQ(argument_type='body'),
|
|
stream=REQ(default='bitbucket')):
|
|
# type: (HttpRequest, UserProfile, Client, Dict[str, Any], str) -> HttpResponse
|
|
try:
|
|
type = get_type(request, payload)
|
|
subject = get_subject_based_on_type(payload, type)
|
|
body = get_body_based_on_type(type)(payload)
|
|
except KeyError as e:
|
|
return json_error(_("Missing key {} in JSON").format(str(e)))
|
|
|
|
check_send_message(user_profile, client, 'stream', [stream], subject, body)
|
|
return json_success()
|
|
|
|
def get_subject_for_branch_specified_events(payload):
|
|
# type: (Dict[str, Any]) -> text_type
|
|
return SUBJECT_WITH_BRANCH_TEMPLATE.format(
|
|
repo=get_repository_name(payload['repository']),
|
|
branch=get_branch_name_for_push_event(payload)
|
|
)
|
|
|
|
def get_subject(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return BITBUCKET_SUBJECT_TEMPLATE.format(repository_name=get_repository_name(payload['repository']))
|
|
|
|
def get_subject_based_on_type(payload, type):
|
|
# type: (Dict[str, Any], str) -> text_type
|
|
if type == 'push':
|
|
return get_subject_for_branch_specified_events(payload)
|
|
if type.startswith('pull_request'):
|
|
return SUBJECT_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format(
|
|
repo=get_repository_name(payload.get('repository')),
|
|
type='PR',
|
|
id=payload['pullrequest']['id'],
|
|
title=payload['pullrequest']['title']
|
|
)
|
|
if type.startswith('issue'):
|
|
return SUBJECT_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format(
|
|
repo=get_repository_name(payload.get('repository')),
|
|
type='Issue',
|
|
id=payload['issue']['id'],
|
|
title=payload['issue']['title']
|
|
)
|
|
return get_subject(payload)
|
|
|
|
def get_type(request, payload):
|
|
# type: (HttpRequest, Dict[str, Any]) -> str
|
|
event_key = request.META.get("HTTP_X_EVENT_KEY")
|
|
if payload.get('push'):
|
|
return 'push'
|
|
elif payload.get('fork'):
|
|
return 'fork'
|
|
elif payload.get('comment') and payload.get('commit'):
|
|
return 'commit_comment'
|
|
elif payload.get('commit_status'):
|
|
return 'change_commit_status'
|
|
elif payload.get('issue'):
|
|
if payload.get('changes'):
|
|
return "issue_updated"
|
|
if payload.get('comment'):
|
|
return 'issue_commented'
|
|
return "issue_created"
|
|
elif payload.get('pullrequest'):
|
|
pull_request_template = 'pull_request_{}'
|
|
action = re.match('pullrequest:(?P<action>.*)$', event_key)
|
|
if action:
|
|
action = action.group('action')
|
|
if action in PULL_REQUEST_SUPPORTED_ACTIONS:
|
|
return pull_request_template.format(action)
|
|
raise UnknownTriggerType()
|
|
|
|
def get_body_based_on_type(type):
|
|
# type: (str) -> Any
|
|
return GET_BODY_DEPENDING_ON_TYPE_MAPPER.get(type)
|
|
|
|
def get_push_body(payload):
|
|
# type: (Dict[str, Any]) -> text_type
|
|
change = payload['push']['changes'][-1]
|
|
if change.get('closed'):
|
|
return get_remove_branch_push_body(payload, change)
|
|
elif change.get('forced'):
|
|
return get_force_push_body(payload, change)
|
|
else:
|
|
return get_normal_push_body(payload, change)
|
|
|
|
def get_remove_branch_push_body(payload, change):
|
|
# type: (Dict[str, Any], Dict[str, Any]) -> text_type
|
|
return get_remove_branch_event_message(
|
|
get_user_username(payload),
|
|
change['old']['name'],
|
|
)
|
|
|
|
def get_force_push_body(payload, change):
|
|
# type: (Dict[str, Any], Dict[str, Any]) -> text_type
|
|
return get_force_push_commits_event_message(
|
|
get_user_username(payload),
|
|
change['links']['html']['href'],
|
|
change['new']['name'],
|
|
change['new']['target']['hash']
|
|
)
|
|
|
|
def get_normal_push_body(payload, change):
|
|
# type: (Dict[str, Any], Dict[str, Any]) -> text_type
|
|
commits_data = [{
|
|
'sha': commit.get('hash'),
|
|
'url': commit.get('links').get('html').get('href'),
|
|
'message': commit.get('message'),
|
|
} for commit in change['commits']]
|
|
|
|
return get_push_commits_event_message(
|
|
get_user_username(payload),
|
|
change['links']['html']['href'],
|
|
change['new']['name'],
|
|
commits_data
|
|
)
|
|
|
|
def get_fork_body(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return BITBUCKET_FORK_BODY.format(
|
|
display_name=get_user_display_name(payload),
|
|
username=get_user_username(payload),
|
|
fork_name=get_repository_full_name(payload['fork']),
|
|
fork_url=get_repository_url(payload['fork'])
|
|
)
|
|
|
|
def get_commit_comment_body(payload):
|
|
# type: (Dict[str, Any]) -> text_type
|
|
comment = payload.get('comment')
|
|
action = u'[commented]({}) on'.format(comment['links']['html']['href'])
|
|
return get_pull_request_event_message(
|
|
get_user_username(payload),
|
|
action,
|
|
comment['commit']['links']['html']['href'],
|
|
message=comment['content']['raw'],
|
|
type='Commit'
|
|
)
|
|
|
|
def get_commit_status_changed_body(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
commit_id = re.match('.*/commit/(?P<commit_id>[A-Za-z0-9]*$)', payload['commit_status']['links']['commit']['href'])
|
|
if commit_id:
|
|
commit_info = "{}/{}".format(get_repository_url(payload['repository']), commit_id.group('commit_id'))
|
|
else:
|
|
commit_info = 'commit'
|
|
|
|
return BITBUCKET_COMMIT_STATUS_CHANGED_BODY.format(
|
|
key=payload['commit_status']['key'],
|
|
system_url=payload['commit_status']['url'],
|
|
commit_info=commit_info,
|
|
status=payload['commit_status']['state']
|
|
)
|
|
|
|
def get_issue_commented_body(payload):
|
|
# type: (Dict[str, Any]) -> text_type
|
|
action = '[commented]({}) on'.format(payload['comment']['links']['html']['href'])
|
|
return get_issue_action_body(payload, action)
|
|
|
|
def get_issue_action_body(payload, action):
|
|
# type: (Dict[str, Any], str) -> text_type
|
|
issue = payload['issue']
|
|
assignee = None
|
|
message = None
|
|
if action == 'created':
|
|
if issue['assignee']:
|
|
assignee = issue['assignee'].get('username')
|
|
message = issue['content']['raw']
|
|
|
|
return get_issue_event_message(
|
|
get_user_username(payload),
|
|
action,
|
|
issue['links']['html']['href'],
|
|
message,
|
|
assignee
|
|
)
|
|
|
|
def get_pull_request_action_body(payload, action):
|
|
# type: (Dict[str, Any], str) -> text_type
|
|
pull_request = payload['pullrequest']
|
|
return get_pull_request_event_message(
|
|
get_user_username(payload),
|
|
action,
|
|
get_pull_request_url(pull_request),
|
|
)
|
|
|
|
def get_pull_request_created_or_updated_body(payload, action):
|
|
# type: (Dict[str, Any], str) -> text_type
|
|
pull_request = payload['pullrequest']
|
|
assignee = None
|
|
if pull_request.get('reviewers'):
|
|
assignee = pull_request.get('reviewers')[0]['username']
|
|
|
|
return get_pull_request_event_message(
|
|
get_user_username(payload),
|
|
action,
|
|
get_pull_request_url(pull_request),
|
|
target_branch=pull_request['source']['branch']['name'],
|
|
base_branch=pull_request['destination']['branch']['name'],
|
|
message=pull_request['description'],
|
|
assignee=assignee
|
|
)
|
|
|
|
def get_pull_request_comment_created_action_body(payload):
|
|
# type: (Dict[str, Any]) -> text_type
|
|
action = '[commented]({})'.format(payload['comment']['links']['html']['href'])
|
|
return get_pull_request_comment_action_body(payload, action)
|
|
|
|
def get_pull_request_deleted_or_updated_comment_action_body(payload, action):
|
|
# type: (Dict[str, Any], text_type) -> text_type
|
|
action = "{} [comment]({})".format(action, payload['comment']['links']['html']['href'])
|
|
return get_pull_request_comment_action_body(payload, action)
|
|
|
|
def get_pull_request_comment_action_body(payload, action):
|
|
# type: (Dict[str, Any], str) -> text_type
|
|
action += ' on'
|
|
return get_pull_request_event_message(
|
|
get_user_username(payload),
|
|
action,
|
|
payload['pullrequest']['links']['html']['href'],
|
|
message=payload['comment']['content']['raw']
|
|
)
|
|
|
|
def get_pull_request_title(pullrequest_payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return pullrequest_payload['title']
|
|
|
|
def get_pull_request_url(pullrequest_payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return pullrequest_payload['links']['html']['href']
|
|
|
|
def get_repository_url(repository_payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return repository_payload['links']['html']['href']
|
|
|
|
def get_repository_name(repository_payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return repository_payload['name']
|
|
|
|
def get_repository_full_name(repository_payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return repository_payload['full_name']
|
|
|
|
def get_user_display_name(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return payload['actor']['display_name']
|
|
|
|
def get_user_username(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
return payload['actor']['username']
|
|
|
|
def get_branch_name_for_push_event(payload):
|
|
# type: (Dict[str, Any]) -> str
|
|
change = payload['push']['changes'][-1]
|
|
if change.get('new'):
|
|
return change['new']['name']
|
|
else:
|
|
return change['old']['name']
|
|
|
|
GET_BODY_DEPENDING_ON_TYPE_MAPPER = {
|
|
'push': get_push_body,
|
|
'fork': get_fork_body,
|
|
'commit_comment': get_commit_comment_body,
|
|
'change_commit_status': get_commit_status_changed_body,
|
|
'issue_updated': partial(get_issue_action_body, action='updated'),
|
|
'issue_created': partial(get_issue_action_body, action='created'),
|
|
'issue_commented': get_issue_commented_body,
|
|
'pull_request_created': partial(get_pull_request_created_or_updated_body, action='created'),
|
|
'pull_request_updated': partial(get_pull_request_created_or_updated_body, action='updated'),
|
|
'pull_request_approved': partial(get_pull_request_action_body, action='approved'),
|
|
'pull_request_unapproved': partial(get_pull_request_action_body, action='unapproved'),
|
|
'pull_request_merged': partial(get_pull_request_action_body, action='merged'),
|
|
'pull_request_rejected': partial(get_pull_request_action_body, action='rejected'),
|
|
'pull_request_comment_created': get_pull_request_comment_created_action_body,
|
|
'pull_request_comment_updated': partial(get_pull_request_deleted_or_updated_comment_action_body, action='updated'),
|
|
'pull_request_comment_deleted': partial(get_pull_request_deleted_or_updated_comment_action_body, action='deleted')
|
|
}
|