api: expose owner to create_pull_request API. Fixes #5537
api: expose owner to create_pull_request API. Fixes #5537

File last commit:

r3474:e9c81a05 default
r3474:e9c81a05 default
Show More
pull_request_api.py
996 lines | 37.3 KiB | text/x-python | PythonLexer
/ rhodecode / api / views / pull_request_api.py
project: added all source files and assets
r1 # -*- coding: utf-8 -*-
docs: updated copyrights to 2019
r3363 # Copyright (C) 2011-2019 RhodeCode GmbH
project: added all source files and assets
r1 #
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/
import logging
pull-request-api: updated logic of closing a PR via API call....
r1792 from rhodecode import events
pull-request: extended default reviewers functionality....
r1769 from rhodecode.api import jsonrpc_method, JSONRPCError, JSONRPCValidationError
project: added all source files and assets
r1 from rhodecode.api.utils import (
has_superadmin_permission, Optional, OAttr, get_repo_or_error,
get_pull_request_or_error, get_commit_or_error, get_user_or_error,
api: expose owner to create_pull_request API. Fixes #5537
r3474 validate_repo_permissions, resolve_ref_or_error, validate_set_owner_permissions)
project: added all source files and assets
r1 from rhodecode.lib.auth import (HasRepoPermissionAnyApi)
from rhodecode.lib.base import vcs_operation_context
from rhodecode.lib.utils2 import str2bool
from rhodecode.model.changeset_status import ChangesetStatusModel
comments: renamed ChangesetCommentsModel to CommentsModel to reflect what it actually does....
r1323 from rhodecode.model.comment import CommentsModel
pull-requests: introduce operation state for pull requests to prevent from...
r3371 from rhodecode.model.db import Session, ChangesetStatus, ChangesetComment, PullRequest
pull-requests: unified merge checks....
r1335 from rhodecode.model.pull_request import PullRequestModel, MergeCheck
project: added all source files and assets
r1 from rhodecode.model.settings import SettingsModel
pull-request: extended default reviewers functionality....
r1769 from rhodecode.model.validation_schema import Invalid
pull-request-api: updated logic of closing a PR via API call....
r1792 from rhodecode.model.validation_schema.schemas.reviewer_schema import(
ReviewerListSchema)
project: added all source files and assets
r1
log = logging.getLogger(__name__)
@jsonrpc_method()
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 def get_pull_request(request, apiuser, pullrequestid, repoid=Optional(None)):
project: added all source files and assets
r1 """
Get a pull request based on the given ID.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 :param repoid: Optional, repository name or repository ID from where
the pull request was opened.
project: added all source files and assets
r1 :type repoid: str or int
:param pullrequestid: ID of the requested pull request.
:type pullrequestid: int
Example output:
.. code-block:: bash
"id": <id_given_in_input>,
"result":
{
"pull_request_id": "<pull_request_id>",
"url": "<url>",
"title": "<title>",
"description": "<description>",
"status" : "<status>",
"created_on": "<date_time_created>",
"updated_on": "<date_time_updated>",
"commit_ids": [
...
"<commit_id>",
"<commit_id>",
...
],
"review_status": "<review_status>",
"mergeable": {
"status": "<bool>",
"message": "<message>",
},
"source": {
"clone_url": "<clone_url>",
"repository": "<repository_name>",
"reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
},
"target": {
"clone_url": "<clone_url>",
"repository": "<repository_name>",
"reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
},
Martin Bornhold
api: Include merge reference into API data of a PR.
r1054 "merge": {
Martin Bornhold
api: Add an entry for pr shadow repositories to api functions.
r893 "clone_url": "<clone_url>",
Martin Bornhold
api: Include merge reference into API data of a PR.
r1054 "reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
Martin Bornhold
api: Add an entry for pr shadow repositories to api functions.
r893 },
project: added all source files and assets
r1 "author": <user_obj>,
"reviewers": [
...
{
"user": "<user_obj>",
"review_status": "<review_status>",
}
...
]
},
"error": null
"""
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395
project: added all source files and assets
r1 pull_request = get_pull_request_or_error(pullrequestid)
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 if Optional.extract(repoid):
repo = get_repo_or_error(repoid)
else:
repo = pull_request.target_repo
pull-requests: introduce operation state for pull requests to prevent from...
r3371 if not PullRequestModel().check_user_read(pull_request, apiuser, api=True):
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 raise JSONRPCError('repository `%s` or pull request `%s` '
'does not exist' % (repoid, pullrequestid))
pull-requests: introduce operation state for pull requests to prevent from...
r3371
# NOTE(marcink): only calculate and return merge state if the pr state is 'created'
# otherwise we can lock the repo on calculation of merge state while update/merge
# is happening.
merge_state = pull_request.pull_request_state == pull_request.STATE_CREATED
data = pull_request.get_api_data(with_merge_state=merge_state)
project: added all source files and assets
r1 return data
@jsonrpc_method()
api: pull-requests get_all now sortes the results and have a flag to show/hide merge result state
r3445 def get_pull_requests(request, apiuser, repoid, status=Optional('new'),
merge_state=Optional(True)):
project: added all source files and assets
r1 """
Get all pull requests from the repository specified in `repoid`.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 :param repoid: Optional repository name or repository ID.
project: added all source files and assets
r1 :type repoid: str or int
:param status: Only return pull requests with the specified status.
Valid options are.
* ``new`` (default)
* ``open``
* ``closed``
:type status: str
api: pull-requests get_all now sortes the results and have a flag to show/hide merge result state
r3445 :param merge_state: Optional calculate merge state for each repository.
This could result in longer time to fetch the data
:type merge_state: bool
project: added all source files and assets
r1
Example output:
.. code-block:: bash
"id": <id_given_in_input>,
"result":
[
...
{
"pull_request_id": "<pull_request_id>",
"url": "<url>",
"title" : "<title>",
"description": "<description>",
"status": "<status>",
"created_on": "<date_time_created>",
"updated_on": "<date_time_updated>",
"commit_ids": [
...
"<commit_id>",
"<commit_id>",
...
],
"review_status": "<review_status>",
"mergeable": {
"status": "<bool>",
"message: "<message>",
},
"source": {
"clone_url": "<clone_url>",
"reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
},
"target": {
"clone_url": "<clone_url>",
"reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
},
Martin Bornhold
api: Include merge reference into API data of a PR.
r1054 "merge": {
Martin Bornhold
api: Add an entry for pr shadow repositories to api functions.
r893 "clone_url": "<clone_url>",
Martin Bornhold
api: Include merge reference into API data of a PR.
r1054 "reference":
{
"name": "<name>",
"type": "<type>",
"commit_id": "<commit_id>",
}
Martin Bornhold
api: Add an entry for pr shadow repositories to api functions.
r893 },
project: added all source files and assets
r1 "author": <user_obj>,
"reviewers": [
...
{
"user": "<user_obj>",
"review_status": "<review_status>",
}
...
]
}
...
],
"error": null
"""
repo = get_repo_or_error(repoid)
if not has_superadmin_permission(apiuser):
_perms = (
'repository.admin', 'repository.write', 'repository.read',)
api: refactor auth helpers to reflect the action they do....
r1150 validate_repo_permissions(apiuser, repoid, repo, _perms)
project: added all source files and assets
r1
status = Optional.extract(status)
api: pull-requests get_all now sortes the results and have a flag to show/hide merge result state
r3445 merge_state = Optional.extract(merge_state, binary=True)
pull_requests = PullRequestModel().get_all(repo, statuses=[status],
order_by='id', order_dir='desc')
data = [pr.get_api_data(with_merge_state=merge_state) for pr in pull_requests]
project: added all source files and assets
r1 return data
@jsonrpc_method()
pull-request-api: updated logic of closing a PR via API call....
r1792 def merge_pull_request(
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 request, apiuser, pullrequestid, repoid=Optional(None),
pull-request-api: updated logic of closing a PR via API call....
r1792 userid=Optional(OAttr('apiuser'))):
project: added all source files and assets
r1 """
Merge the pull request specified by `pullrequestid` into its target
repository.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 :param repoid: Optional, repository name or repository ID of the
project: added all source files and assets
r1 target repository to which the |pr| is to be merged.
:type repoid: str or int
:param pullrequestid: ID of the pull request which shall be merged.
:type pullrequestid: int
:param userid: Merge the pull request as this user.
:type userid: Optional(str or int)
Example output:
.. code-block:: bash
docs: update API documentation.
r1603 "id": <id_given_in_input>,
"result": {
api: expose merge message in the merge operation
r3458 "executed": "<bool>",
"failure_reason": "<int>",
"merge_status_message": "<str>",
"merge_commit_id": "<merge_commit_id>",
"possible": "<bool>",
Martin Bornhold
api: Add merge reference to merge_pull_request api call.
r1055 "merge_ref": {
"commit_id": "<commit_id>",
"type": "<type>",
"name": "<name>"
}
project: added all source files and assets
r1 },
docs: update API documentation.
r1603 "error": null
project: added all source files and assets
r1 """
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 pull_request = get_pull_request_or_error(pullrequestid)
if Optional.extract(repoid):
repo = get_repo_or_error(repoid)
else:
repo = pull_request.target_repo
project: added all source files and assets
r1 if not isinstance(userid, Optional):
if (has_superadmin_permission(apiuser) or
HasRepoPermissionAnyApi('repository.admin')(
user=apiuser, repo_name=repo.repo_name)):
apiuser = get_user_or_error(userid)
else:
raise JSONRPCError('userid is not the same as your user')
pull-requests: introduce operation state for pull requests to prevent from...
r3371 if pull_request.pull_request_state != PullRequest.STATE_CREATED:
raise JSONRPCError(
'Operation forbidden because pull request is in state {}, '
'only state {} is allowed.'.format(
pull_request.pull_request_state, PullRequest.STATE_CREATED))
with pull_request.set_state(PullRequest.STATE_UPDATING):
check = MergeCheck.validate(
pull_request, auth_user=apiuser,
translator=request.translate)
pull-requests: unified merge checks....
r1335 merge_possible = not check.failed
if not merge_possible:
pull-requests: fixed translation of error messages via merge-api....
r1759 error_messages = []
for err_type, error_msg in check.errors:
error_msg = request.translate(error_msg)
error_messages.append(error_msg)
reasons = ','.join(error_messages)
project: added all source files and assets
r1 raise JSONRPCError(
pull-requests: unified merge checks....
r1335 'merge not possible for following reasons: {}'.format(reasons))
project: added all source files and assets
r1
target_repo = pull_request.target_repo
extras = vcs_operation_context(
request.environ, repo_name=target_repo.repo_name,
username=apiuser.username, action='push',
scm=target_repo.repo_type)
pull-requests: introduce operation state for pull requests to prevent from...
r3371 with pull_request.set_state(PullRequest.STATE_UPDATING):
merge_response = PullRequestModel().merge_repo(
pull_request, apiuser, extras=extras)
Martin Bornhold
api: Add merge reference to merge_pull_request api call.
r1055 if merge_response.executed:
project: added all source files and assets
r1 PullRequestModel().close_pull_request(
pull_request.pull_request_id, apiuser)
db: always use Session() for compatibility, Using Session is actually the...
r506 Session().commit()
Martin Bornhold
api: Add merge reference to merge_pull_request api call.
r1055
# In previous versions the merge response directly contained the merge
# commit id. It is now contained in the merge reference object. To be
# backwards compatible we have to extract it again.
dan
pull-requests: ensure merge response provide more details...
r3339 merge_response = merge_response.asdict()
Martin Bornhold
api: Add merge reference to merge_pull_request api call.
r1055 merge_response['merge_commit_id'] = merge_response['merge_ref'].commit_id
return merge_response
project: added all source files and assets
r1
@jsonrpc_method()
api: pull-requests added option to fetch comments from a pull requests....
r2394 def get_pull_request_comments(
request, apiuser, pullrequestid, repoid=Optional(None)):
"""
Get all comments of pull request specified with the `pullrequestid`
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param repoid: Optional repository name or repository ID.
:type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int
Example output:
.. code-block:: bash
id : <id_given_in_input>
result : [
{
"comment_author": {
"active": true,
"full_name_or_username": "Tom Gore",
"username": "admin"
},
"comment_created_on": "2017-01-02T18:43:45.533",
"comment_f_path": null,
"comment_id": 25,
"comment_lineno": null,
"comment_status": {
"status": "under_review",
"status_lbl": "Under Review"
},
"comment_text": "Example text",
"comment_type": null,
"pull_request_version": null
}
],
error : null
"""
pull_request = get_pull_request_or_error(pullrequestid)
if Optional.extract(repoid):
repo = get_repo_or_error(repoid)
else:
repo = pull_request.target_repo
if not PullRequestModel().check_user_read(
pull_request, apiuser, api=True):
raise JSONRPCError('repository `%s` or pull request `%s` '
'does not exist' % (repoid, pullrequestid))
(pull_request_latest,
pull_request_at_ver,
pull_request_display_obj,
at_version) = PullRequestModel().get_pr_version(
pull_request.pull_request_id, version=None)
versions = pull_request_display_obj.versions()
ver_map = {
ver.pull_request_version_id: cnt
for cnt, ver in enumerate(versions, 1)
}
# GENERAL COMMENTS with versions #
q = CommentsModel()._all_general_comments_of_pull_request(pull_request)
q = q.order_by(ChangesetComment.comment_id.asc())
general_comments = q.all()
# INLINE COMMENTS with versions #
q = CommentsModel()._all_inline_comments_of_pull_request(pull_request)
q = q.order_by(ChangesetComment.comment_id.asc())
inline_comments = q.all()
data = []
for comment in inline_comments + general_comments:
full_data = comment.get_api_data()
pr_version_id = None
if comment.pull_request_version_id:
pr_version_id = 'v{}'.format(
ver_map[comment.pull_request_version_id])
# sanitize some entries
full_data['pull_request_version'] = pr_version_id
full_data['comment_author'] = {
'username': full_data['comment_author'].username,
'full_name_or_username': full_data['comment_author'].full_name_or_username,
'active': full_data['comment_author'].active,
}
if full_data['comment_status']:
full_data['comment_status'] = {
'status': full_data['comment_status'][0].status,
'status_lbl': full_data['comment_status'][0].status_lbl,
}
else:
full_data['comment_status'] = {}
data.append(full_data)
return data
@jsonrpc_method()
api: added possibility to specify comment_type for comment API.
r1337 def comment_pull_request(
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 request, apiuser, pullrequestid, repoid=Optional(None),
message=Optional(None), commit_id=Optional(None), status=Optional(None),
api: added possibility to specify comment_type for comment API.
r1337 comment_type=Optional(ChangesetComment.COMMENT_TYPE_NOTE),
api: added comment_resolved_id into aprameters to resolve TODO notes via API.
r1338 resolves_comment_id=Optional(None),
api: added possibility to specify comment_type for comment API.
r1337 userid=Optional(OAttr('apiuser'))):
project: added all source files and assets
r1 """
Comment on the pull request specified with the `pullrequestid`,
in the |repo| specified by the `repoid`, and optionally change the
review status.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 :param repoid: Optional repository name or repository ID.
project: added all source files and assets
r1 :type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 :param commit_id: Specify the commit_id for which to set a comment. If
given commit_id is different than latest in the PR status
change won't be performed.
:type commit_id: str
api: added possibility to specify comment_type for comment API.
r1337 :param message: The text content of the comment.
:type message: str
:param status: (**Optional**) Set the approval status of the pull
request. One of: 'not_reviewed', 'approved', 'rejected',
'under_review'
:type status: str
:param comment_type: Comment type, one of: 'note', 'todo'
:type comment_type: Optional(str), default: 'note'
project: added all source files and assets
r1 :param userid: Comment on the pull request as this user
:type userid: Optional(str or int)
Example output:
.. code-block:: bash
docs: update API documentation.
r1603 id : <id_given_in_input>
result : {
project: added all source files and assets
r1 "pull_request_id": "<Integer>",
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 "comment_id": "<Integer>",
"status": {"given": <given_status>,
"was_changed": <bool status_was_actually_changed> },
docs: update API documentation.
r1603 },
error : null
project: added all source files and assets
r1 """
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 pull_request = get_pull_request_or_error(pullrequestid)
if Optional.extract(repoid):
repo = get_repo_or_error(repoid)
else:
repo = pull_request.target_repo
project: added all source files and assets
r1 if not isinstance(userid, Optional):
if (has_superadmin_permission(apiuser) or
HasRepoPermissionAnyApi('repository.admin')(
user=apiuser, repo_name=repo.repo_name)):
apiuser = get_user_or_error(userid)
else:
raise JSONRPCError('userid is not the same as your user')
api: forbid commenting on closed PR
r3463 if pull_request.is_closed():
raise JSONRPCError(
'pull request `%s` comment failed, pull request is closed' % (
pullrequestid,))
project: added all source files and assets
r1 if not PullRequestModel().check_user_read(
pull_request, apiuser, api=True):
raise JSONRPCError('repository `%s` does not exist' % (repoid,))
message = Optional.extract(message)
status = Optional.extract(status)
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 commit_id = Optional.extract(commit_id)
api: added possibility to specify comment_type for comment API.
r1337 comment_type = Optional.extract(comment_type)
api: added comment_resolved_id into aprameters to resolve TODO notes via API.
r1338 resolves_comment_id = Optional.extract(resolves_comment_id)
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269
project: added all source files and assets
r1 if not message and not status:
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 raise JSONRPCError(
'Both message and status parameters are missing. '
'At least one is required.')
project: added all source files and assets
r1
if (status not in (st[0] for st in ChangesetStatus.STATUSES) and
status is not None):
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 raise JSONRPCError('Unknown comment status: `%s`' % status)
if commit_id and commit_id not in pull_request.revisions:
raise JSONRPCError(
'Invalid commit_id `%s` for this pull request.' % commit_id)
project: added all source files and assets
r1
allowed_to_change_status = PullRequestModel().check_user_change_status(
pull_request, apiuser)
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269
# if commit_id is passed re-validated if user is allowed to change status
# based on latest commit_id from the PR
if commit_id:
commit_idx = pull_request.revisions.index(commit_id)
if commit_idx != 0:
allowed_to_change_status = False
api: added comment_resolved_id into aprameters to resolve TODO notes via API.
r1338 if resolves_comment_id:
comment = ChangesetComment.get(resolves_comment_id)
if not comment:
raise JSONRPCError(
'Invalid resolves_comment_id `%s` for this pull request.'
% resolves_comment_id)
if comment.comment_type != ChangesetComment.COMMENT_TYPE_TODO:
raise JSONRPCError(
'Comment `%s` is wrong type for setting status to resolved.'
% resolves_comment_id)
project: added all source files and assets
r1 text = message
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 status_label = ChangesetStatus.get_status_lbl(status)
project: added all source files and assets
r1 if status and allowed_to_change_status:
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 st_message = ('Status change %(transition_icon)s %(status)s'
% {'transition_icon': '>', 'status': status_label})
project: added all source files and assets
r1 text = message or st_message
rc_config = SettingsModel().get_all_settings()
renderer = rc_config.get('rhodecode_markup_renderer', 'rst')
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269
status_change = status and allowed_to_change_status
comments: renamed ChangesetCommentsModel to CommentsModel to reflect what it actually does....
r1323 comment = CommentsModel().create(
project: added all source files and assets
r1 text=text,
repo=pull_request.target_repo.repo_id,
user=apiuser.user_id,
pull_request=pull_request.pull_request_id,
f_path=None,
line_no=None,
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 status_change=(status_label if status_change else None),
status_change_type=(status if status_change else None),
project: added all source files and assets
r1 closing_pr=False,
api: added possibility to specify comment_type for comment API.
r1337 renderer=renderer,
api: added comment_resolved_id into aprameters to resolve TODO notes via API.
r1338 comment_type=comment_type,
audit-logs: store properly IP and user for certain comments types....
r2728 resolves_comment_id=resolves_comment_id,
auth_user=apiuser
project: added all source files and assets
r1 )
if allowed_to_change_status and status:
api/pull-requests: trigger events for comments/review status changes.
r3416 old_calculated_status = pull_request.calculated_review_status()
project: added all source files and assets
r1 ChangesetStatusModel().set_status(
pull_request.target_repo.repo_id,
status,
apiuser.user_id,
comment,
pull_request=pull_request.pull_request_id
)
Session().flush()
Session().commit()
api/pull-requests: trigger events for comments/review status changes.
r3416
PullRequestModel().trigger_pull_request_hook(
pull_request, apiuser, 'comment',
data={'comment': comment})
if allowed_to_change_status and status:
# we now calculate the status of pull request, and based on that
# calculation we set the commits status
calculated_status = pull_request.calculated_review_status()
if old_calculated_status != calculated_status:
PullRequestModel().trigger_pull_request_hook(
pull_request, apiuser, 'review_status_change',
data={'status': calculated_status})
project: added all source files and assets
r1 data = {
'pull_request_id': pull_request.pull_request_id,
api: comment_pull_request, added commit_id parameter to validate status changed on particular commit....
r1269 'comment_id': comment.comment_id if comment else None,
'status': {'given': status, 'was_changed': status_change},
project: added all source files and assets
r1 }
return data
@jsonrpc_method()
def create_pull_request(
request, apiuser, source_repo, target_repo, source_ref, target_ref,
api: expose owner to create_pull_request API. Fixes #5537
r3474 owner=Optional(OAttr('apiuser')), title=Optional(''), description=Optional(''),
description_renderer=Optional(''), reviewers=Optional(None)):
project: added all source files and assets
r1 """
Creates a new pull request.
Accepts refs in the following formats:
* branch:<branch_name>:<sha>
* branch:<branch_name>
* bookmark:<bookmark_name>:<sha> (Mercurial only)
* bookmark:<bookmark_name> (Mercurial only)
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
:param source_repo: Set the source repository name.
:type source_repo: str
:param target_repo: Set the target repository name.
:type target_repo: str
:param source_ref: Set the source ref name.
:type source_ref: str
:param target_ref: Set the target ref name.
:type target_ref: str
api: expose owner to create_pull_request API. Fixes #5537
r3474 :param owner: user_id or username
:type owner: Optional(str)
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 :param title: Optionally Set the pull request title, it's generated otherwise
project: added all source files and assets
r1 :type title: str
:param description: Set the pull request description.
:type description: Optional(str)
api: allow updates and setting description renderer for pull requests via the API.
r2904 :type description_renderer: Optional(str)
:param description_renderer: Set pull request renderer for the description.
It should be 'rst', 'markdown' or 'plain'. If not give default
system renderer will be used
project: added all source files and assets
r1 :param reviewers: Set the new pull request reviewers list.
dan
reviewers: added validation and default review rules via API calls....
r1795 Reviewer defined by review rules will be added automatically to the
defined list.
project: added all source files and assets
r1 :type reviewers: Optional(list)
dan
reviewers: store reviewer reasons to database, fixes #4238
r873 Accepts username strings or objects of the format:
docs: update API documentation.
r1603
dan
reviewers: added validation and default review rules via API calls....
r1795 [{'username': 'nick', 'reasons': ['original author'], 'mandatory': <bool>}]
project: added all source files and assets
r1 """
dan
reviewers: store reviewer reasons to database, fixes #4238
r873
api: pull-requests fixed logic of ancestor calculation and target ref calculation based on the web view.
r2873 source_db_repo = get_repo_or_error(source_repo)
dan
reviewers: added validation and default review rules via API calls....
r1795 target_db_repo = get_repo_or_error(target_repo)
project: added all source files and assets
r1 if not has_superadmin_permission(apiuser):
_perms = ('repository.admin', 'repository.write', 'repository.read',)
dan
reviewers: added validation and default review rules via API calls....
r1795 validate_repo_permissions(apiuser, source_repo, source_db_repo, _perms)
project: added all source files and assets
r1
api: expose owner to create_pull_request API. Fixes #5537
r3474 owner = validate_set_owner_permissions(apiuser, owner)
dan
reviewers: added validation and default review rules via API calls....
r1795 full_source_ref = resolve_ref_or_error(source_ref, source_db_repo)
full_target_ref = resolve_ref_or_error(target_ref, target_db_repo)
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859
source_scm = source_db_repo.scm_instance()
target_scm = target_db_repo.scm_instance()
dan
reviewers: added validation and default review rules via API calls....
r1795 source_commit = get_commit_or_error(full_source_ref, source_db_repo)
target_commit = get_commit_or_error(full_target_ref, target_db_repo)
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859
ancestor = source_scm.get_common_ancestor(
source_commit.raw_id, target_commit.raw_id, target_scm)
if not ancestor:
raise JSONRPCError('no common ancestor found')
# recalculate target ref based on ancestor
target_ref_type, target_ref_name, __ = full_target_ref.split(':')
full_target_ref = ':'.join((target_ref_type, target_ref_name, ancestor))
project: added all source files and assets
r1
commit_ranges = target_scm.compare(
target_commit.raw_id, source_commit.raw_id, source_scm,
merge=True, pre_load=[])
if not commit_ranges:
raise JSONRPCError('no commits found')
dan
reviewers: store reviewer reasons to database, fixes #4238
r873 reviewer_objects = Optional.extract(reviewers) or []
dan
reviewers: added validation and default review rules via API calls....
r1795
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 # serialize and validate passed in given reviewers
pull-request: extended default reviewers functionality....
r1769 if reviewer_objects:
schema = ReviewerListSchema()
try:
reviewer_objects = schema.deserialize(reviewer_objects)
except Invalid as err:
raise JSONRPCValidationError(colander_exc=err)
project: added all source files and assets
r1
dan
reviewers: added validation and default review rules via API calls....
r1795 # validate users
for reviewer_object in reviewer_objects:
user = get_user_or_error(reviewer_object['username'])
reviewer_object['user_id'] = user.user_id
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 get_default_reviewers_data, validate_default_reviewers = \
dan
reviewers: added validation and default review rules via API calls....
r1795 PullRequestModel().get_reviewer_functions()
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 # recalculate reviewers logic, to make sure we can validate this
dan
reviewers: added validation and default review rules via API calls....
r1795 reviewer_rules = get_default_reviewers_data(
api: expose owner to create_pull_request API. Fixes #5537
r3474 owner, source_db_repo,
dan
reviewers: added validation and default review rules via API calls....
r1795 source_commit, target_db_repo, target_commit)
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 # now MERGE our given with the calculated
reviewer_objects = reviewer_rules['reviewers'] + reviewer_objects
dan
reviewers: added validation and default review rules via API calls....
r1795
try:
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 reviewers = validate_default_reviewers(
dan
reviewers: added validation and default review rules via API calls....
r1795 reviewer_objects, reviewer_rules)
except ValueError as e:
raise JSONRPCError('Reviewers Validation: {}'.format(e))
project: added all source files and assets
r1
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 title = Optional.extract(title)
if not title:
title_source_ref = source_ref.split(':', 2)[1]
title = PullRequestModel().generate_pullrequest_title(
source=source_repo,
source_ref=title_source_ref,
target=target_repo
)
api: allow updates and setting description renderer for pull requests via the API.
r2904 # fetch renderer, if set fallback to plain in case of PR
rc_config = SettingsModel().get_all_settings()
default_system_renderer = rc_config.get('rhodecode_markup_renderer', 'plain')
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 description = Optional.extract(description)
api: allow updates and setting description renderer for pull requests via the API.
r2904 description_renderer = Optional.extract(description_renderer) or default_system_renderer
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859
pull_request = PullRequestModel().create(
api: expose owner to create_pull_request API. Fixes #5537
r3474 created_by=owner.user_id,
project: added all source files and assets
r1 source_repo=source_repo,
source_ref=full_source_ref,
target_repo=target_repo,
target_ref=full_target_ref,
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 revisions=[commit.raw_id for commit in reversed(commit_ranges)],
pull-request: extended default reviewers functionality....
r1769 reviewers=reviewers,
project: added all source files and assets
r1 title=title,
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 description=description,
api: allow updates and setting description renderer for pull requests via the API.
r2904 description_renderer=description_renderer,
api: fixed creation of pull request with custom rules of reviewers + proper diff creation.
r2859 reviewer_data=reviewer_rules,
audit-logs: use auth_user in few places to track action IP.
r2788 auth_user=apiuser
project: added all source files and assets
r1 )
Session().commit()
data = {
'msg': 'Created new pull request `{}`'.format(title),
'pull_request_id': pull_request.pull_request_id,
}
return data
@jsonrpc_method()
def update_pull_request(
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 request, apiuser, pullrequestid, repoid=Optional(None),
api: allow updates and setting description renderer for pull requests via the API.
r2904 title=Optional(''), description=Optional(''), description_renderer=Optional(''),
reviewers=Optional(None), update_commits=Optional(None)):
project: added all source files and assets
r1 """
Updates a pull request.
:param apiuser: This is filled automatically from the |authtoken|.
:type apiuser: AuthUser
api: pull-requests, make the repoid parameter optional. Because pullrequestid is global...
r2395 :param repoid: Optional repository name or repository ID.
project: added all source files and assets
r1 :type repoid: str or int
:param pullrequestid: The pull request ID.
:type pullrequestid: int
:param title: Set the pull request title.
:type title: str
:param description: Update pull request description.
:type description: Optional(str)
api: allow updates and setting description renderer for pull requests via the API.
r2904 :type description_renderer: Optional(str)
:param description_renderer: Update pull request renderer for the description.
It should be 'rst', 'markdown' or 'plain'
project: added all source files and assets
r1 :param reviewers: Update pull request reviewers list with new value.
:type reviewers: Optional(list)
pull-request: extended default reviewers functionality....
r1769 Accepts username strings or objects of the format:
dan
reviewers: added validation and default review rules via API calls....
r1795 [{'username': 'nick', 'reasons': ['original author'], 'mandatory': <bool>}]
pull-request: extended default reviewers functionality....
r1769
project: added all source files and assets
r1 :param update_commits: Trigger update of commits for this pull request
:type: update_commits: Optional(bool)
Example output:
.. code-block:: bash
docs: update API documentation.
r1603 id : <id_given_in_input>
result : {