debian-mirror-gitlab/lib/api/merge_requests.rb

470 lines
20 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
class MergeRequests < Grape::API
2017-08-17 22:00:37 +05:30
include PaginationParams
2018-03-17 18:26:18 +05:30
before { authenticate_non_get! }
2014-09-02 18:07:02 +05:30
2017-09-10 17:25:29 +05:30
helpers ::Gitlab::IssuableMetadata
2018-03-27 19:54:05 +05:30
# EE::API::MergeRequests would override the following helpers
helpers do
params :optional_params_ee do
end
2019-05-18 00:54:41 +05:30
params :optional_merge_requests_search_params do
end
2018-03-27 19:54:05 +05:30
end
def self.update_params_at_least_one_of
%i[
assignee_id
description
labels
milestone_id
remove_source_branch
state_event
target_branch
title
discussion_locked
2018-11-08 19:23:39 +05:30
squash
2018-03-27 19:54:05 +05:30
]
end
2017-09-10 17:25:29 +05:30
helpers do
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-09-10 17:25:29 +05:30
def find_merge_requests(args = {})
2018-03-17 18:26:18 +05:30
args = declared_params.merge(args)
2017-09-10 17:25:29 +05:30
args[:milestone_title] = args.delete(:milestone)
args[:label_name] = args.delete(:labels)
2018-11-08 19:23:39 +05:30
args[:scope] = args[:scope].underscore if args[:scope]
2017-09-10 17:25:29 +05:30
merge_requests = MergeRequestsFinder.new(current_user, args).execute
2019-05-18 00:54:41 +05:30
.reorder(order_options_with_tie_breaker)
2017-09-10 17:25:29 +05:30
merge_requests = paginate(merge_requests)
2018-11-08 19:23:39 +05:30
.preload(:source_project, :target_project)
2017-09-10 17:25:29 +05:30
return merge_requests if args[:view] == 'simple'
merge_requests
2019-05-18 00:54:41 +05:30
.with_api_entity_associations
2018-03-17 18:26:18 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2018-03-17 18:26:18 +05:30
def merge_request_pipelines_with_access
authorize! :read_pipeline, user_project
mr = find_merge_request_with_access(params[:merge_request_iid])
mr.all_pipelines
2017-09-10 17:25:29 +05:30
end
2018-03-27 19:54:05 +05:30
def check_sha_param!(params, merge_request)
if params[:sha] && merge_request.diff_head_sha != params[:sha]
render_api_error!("SHA does not match HEAD of source branch: #{merge_request.diff_head_sha}", 409)
end
end
2018-11-08 19:23:39 +05:30
def serializer_options_for(merge_requests)
options = { with: Entities::MergeRequestBasic, current_user: current_user }
if params[:view] == 'simple'
options[:with] = Entities::MergeRequestSimple
else
options[:issuable_metadata] = issuable_meta_data(merge_requests, 'MergeRequest')
end
options
end
2019-02-15 15:39:39 +05:30
def authorize_push_to_merge_request!(merge_request)
forbidden!('Source branch does not exist') unless
merge_request.source_branch_exists?
user_access = Gitlab::UserAccess.new(
current_user,
project: merge_request.source_project
)
forbidden!('Cannot push to source branch') unless
user_access.can_push_to_branch?(merge_request.source_branch)
end
2017-09-10 17:25:29 +05:30
params :merge_requests_params do
2018-11-08 19:23:39 +05:30
optional :state, type: String, values: %w[opened closed locked merged all], default: 'all',
desc: 'Return opened, closed, locked, merged, or all merge requests'
2017-09-10 17:25:29 +05:30
optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
desc: 'Return merge requests ordered by `created_at` or `updated_at` fields.'
optional :sort, type: String, values: %w[asc desc], default: 'desc',
desc: 'Return merge requests sorted in `asc` or `desc` order.'
optional :milestone, type: String, desc: 'Return merge requests for a specific milestone'
2019-05-18 00:54:41 +05:30
optional :labels, type: Array[String], coerce_with: Validations::Types::LabelsList.coerce, desc: 'Comma-separated list of label names'
2017-09-10 17:25:29 +05:30
optional :created_after, type: DateTime, desc: 'Return merge requests created after the specified time'
optional :created_before, type: DateTime, desc: 'Return merge requests created before the specified time'
2018-03-27 19:54:05 +05:30
optional :updated_after, type: DateTime, desc: 'Return merge requests updated after the specified time'
optional :updated_before, type: DateTime, desc: 'Return merge requests updated before the specified time'
2017-09-10 17:25:29 +05:30
optional :view, type: String, values: %w[simple], desc: 'If simple, returns the `iid`, URL, title, description, and basic state of merge request'
optional :author_id, type: Integer, desc: 'Return merge requests which are authored by the user with the given ID'
2018-12-13 13:39:08 +05:30
optional :assignee_id, types: [Integer, String], integer_none_any: true,
desc: 'Return merge requests which are assigned to the user with the given ID'
2018-11-08 19:23:39 +05:30
optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all],
desc: 'Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`'
2018-03-17 18:26:18 +05:30
optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
2018-03-27 19:54:05 +05:30
optional :source_branch, type: String, desc: 'Return merge requests with the given source branch'
2019-05-18 00:54:41 +05:30
optional :source_project_id, type: Integer, desc: 'Return merge requests with the given source project id'
2018-03-27 19:54:05 +05:30
optional :target_branch, type: String, desc: 'Return merge requests with the given target branch'
2019-03-02 22:35:43 +05:30
optional :search, type: String, desc: 'Search merge requests for text present in the title, description, or any combination of these'
optional :in, type: String, desc: '`title`, `description`, or a string joining them with comma'
2018-12-05 23:21:45 +05:30
optional :wip, type: String, values: %w[yes no], desc: 'Search merge requests for WIP in the title'
2019-05-18 00:54:41 +05:30
use :optional_merge_requests_search_params
2017-09-10 17:25:29 +05:30
use :pagination
end
end
resource :merge_requests do
desc 'List merge requests' do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
2018-11-08 19:23:39 +05:30
optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all], default: 'created_by_me',
desc: 'Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`'
2017-09-10 17:25:29 +05:30
end
get do
2018-03-17 18:26:18 +05:30
authenticate! unless params[:scope] == 'all'
2017-09-10 17:25:29 +05:30
merge_requests = find_merge_requests
2018-11-08 19:23:39 +05:30
present merge_requests, serializer_options_for(merge_requests)
end
end
2017-09-10 17:25:29 +05:30
2018-11-08 19:23:39 +05:30
params do
requires :id, type: String, desc: 'The ID of a group'
end
2019-02-15 15:39:39 +05:30
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2018-11-08 19:23:39 +05:30
desc 'Get a list of group merge requests' do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
end
get ":id/merge_requests" do
group = find_group!(params[:id])
2017-09-10 17:25:29 +05:30
2018-11-08 19:23:39 +05:30
merge_requests = find_merge_requests(group_id: group.id, include_subgroups: true)
present merge_requests, serializer_options_for(merge_requests)
2017-09-10 17:25:29 +05:30
end
end
2017-08-17 22:00:37 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
include TimeTrackingEndpoints
2014-09-02 18:07:02 +05:30
helpers do
def handle_merge_request_errors!(errors)
if errors[:project_access].any?
error!(errors[:project_access], 422)
elsif errors[:branch_conflict].any?
error!(errors[:branch_conflict], 422)
2015-04-26 12:48:37 +05:30
elsif errors[:validate_fork].any?
error!(errors[:validate_fork], 422)
elsif errors[:validate_branches].any?
conflict!(errors[:validate_branches])
2017-08-17 22:00:37 +05:30
elsif errors[:base].any?
error!(errors[:base], 422)
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
render_api_error!(errors, 400)
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
params :optional_params do
2017-08-17 22:00:37 +05:30
optional :description, type: String, desc: 'The description of the merge request'
optional :assignee_id, type: Integer, desc: 'The ID of a user to assign the merge request'
optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign the merge request'
2019-05-18 00:54:41 +05:30
optional :labels, type: Array[String], coerce_with: Validations::Types::LabelsList.coerce, desc: 'Comma-separated list of label names'
optional :remove_source_branch, type: Boolean, desc: 'Remove source branch when merging'
2018-11-08 19:23:39 +05:30
optional :allow_collaboration, type: Boolean, desc: 'Allow commits from members who can merge to the target branch'
optional :allow_maintainer_to_push, type: Boolean, as: :allow_collaboration, desc: '[deprecated] See allow_collaboration'
optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
use :optional_params_ee
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'List merge requests' do
success Entities::MergeRequestBasic
end
params do
2017-09-10 17:25:29 +05:30
use :merge_requests_params
2017-08-17 22:00:37 +05:30
optional :iids, type: Array[Integer], desc: 'The IID array of merge requests'
end
2014-09-02 18:07:02 +05:30
get ":id/merge_requests" do
authorize! :read_merge_request, user_project
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
merge_requests = find_merge_requests(project_id: user_project.id)
2015-09-11 14:41:01 +05:30
2018-11-08 19:23:39 +05:30
options = serializer_options_for(merge_requests)
options[:project] = user_project
2017-09-10 17:25:29 +05:30
present merge_requests, options
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create a merge request' do
success Entities::MergeRequest
end
params do
requires :title, type: String, desc: 'The title of the merge request'
requires :source_branch, type: String, desc: 'The source branch'
requires :target_branch, type: String, desc: 'The target branch'
optional :target_project_id, type: Integer,
desc: 'The target project of the merge request defaults to the :id of the project'
use :optional_params
end
2014-09-02 18:07:02 +05:30
post ":id/merge_requests" do
2018-03-17 18:26:18 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42316')
2018-05-09 12:01:36 +05:30
authorize! :create_merge_request_from, user_project
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
mr_params = declared_params(include_missing: false)
2017-09-10 17:25:29 +05:30
mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch)
2016-11-03 12:29:30 +05:30
2017-08-17 22:00:37 +05:30
merge_request = ::MergeRequests::CreateService.new(user_project, current_user, mr_params).execute
2014-09-02 18:07:02 +05:30
if merge_request.valid?
2017-08-17 22:00:37 +05:30
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
2014-09-02 18:07:02 +05:30
else
handle_merge_request_errors! merge_request.errors
end
end
2017-08-17 22:00:37 +05:30
desc 'Delete a merge request'
params do
requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
end
delete ":id/merge_requests/:merge_request_iid" do
merge_request = find_project_merge_request(params[:merge_request_iid])
2016-06-02 11:05:42 +05:30
authorize!(:destroy_merge_request, merge_request)
2018-03-17 18:26:18 +05:30
destroy_conditionally!(merge_request) do |merge_request|
Issuable::DestroyService.new(user_project, current_user).execute(merge_request)
end
2016-06-02 11:05:42 +05:30
end
2017-01-15 13:20:01 +05:30
params do
2017-08-17 22:00:37 +05:30
requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
2018-11-08 19:23:39 +05:30
optional :render_html, type: Boolean, desc: 'Returns the description and title rendered HTML'
2018-11-20 20:47:30 +05:30
optional :include_diverged_commits_count, type: Boolean, desc: 'Returns the commits count behind the target branch'
2019-02-15 15:39:39 +05:30
optional :include_rebase_in_progress, type: Boolean, desc: 'Returns whether a rebase operation is ongoing '
2017-01-15 13:20:01 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a single merge request' do
success Entities::MergeRequest
end
get ':id/merge_requests/:merge_request_iid' do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
present merge_request,
with: Entities::MergeRequest,
current_user: current_user,
project: user_project,
render_html: params[:render_html],
include_diverged_commits_count: params[:include_diverged_commits_count],
include_rebase_in_progress: params[:include_rebase_in_progress]
2017-08-17 22:00:37 +05:30
end
2015-12-23 02:04:40 +05:30
2018-03-17 18:26:18 +05:30
desc 'Get the participants of a merge request' do
success Entities::UserBasic
end
get ':id/merge_requests/:merge_request_iid/participants' do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
participants = ::Kaminari.paginate_array(merge_request.participants)
present paginate(participants), with: Entities::UserBasic
end
2017-08-17 22:00:37 +05:30
desc 'Get the commits of a merge request' do
2018-03-17 18:26:18 +05:30
success Entities::Commit
2017-08-17 22:00:37 +05:30
end
get ':id/merge_requests/:merge_request_iid/commits' do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
commits = ::Kaminari.paginate_array(merge_request.commits)
2015-12-23 02:04:40 +05:30
2018-03-17 18:26:18 +05:30
present paginate(commits), with: Entities::Commit
2017-08-17 22:00:37 +05:30
end
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
desc 'Show the merge request changes' do
success Entities::MergeRequestChanges
end
get ':id/merge_requests/:merge_request_iid/changes' do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2014-09-02 18:07:02 +05:30
2018-03-27 19:54:05 +05:30
present merge_request, with: Entities::MergeRequestChanges, current_user: current_user, project: user_project
2017-08-17 22:00:37 +05:30
end
2016-11-03 12:29:30 +05:30
2018-03-17 18:26:18 +05:30
desc 'Get the merge request pipelines' do
success Entities::PipelineBasic
end
get ':id/merge_requests/:merge_request_iid/pipelines' do
pipelines = merge_request_pipelines_with_access
present paginate(pipelines), with: Entities::PipelineBasic
end
2017-08-17 22:00:37 +05:30
desc 'Update a merge request' do
success Entities::MergeRequest
end
params do
optional :title, type: String, allow_blank: false, desc: 'The title of the merge request'
optional :target_branch, type: String, allow_blank: false, desc: 'The target branch'
optional :state_event, type: String, values: %w[close reopen],
desc: 'Status of the merge request'
2018-03-17 18:26:18 +05:30
optional :discussion_locked, type: Boolean, desc: 'Whether the MR discussion is locked'
2017-08-17 22:00:37 +05:30
use :optional_params
2018-03-27 19:54:05 +05:30
at_least_one_of(*::API::MergeRequests.update_params_at_least_one_of)
2017-08-17 22:00:37 +05:30
end
put ':id/merge_requests/:merge_request_iid' do
2018-03-17 18:26:18 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42318')
2017-08-17 22:00:37 +05:30
merge_request = find_merge_request_with_access(params.delete(:merge_request_iid), :update_merge_request)
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
mr_params = declared_params(include_missing: false)
2019-05-18 00:54:41 +05:30
mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch) if mr_params.has_key?(:remove_source_branch)
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, mr_params).execute(merge_request)
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
if merge_request.valid?
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
else
handle_merge_request_errors! merge_request.errors
end
end
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
desc 'Merge a merge request' do
success Entities::MergeRequest
end
params do
optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
2019-03-02 22:35:43 +05:30
optional :squash_commit_message, type: String, desc: 'Custom squash commit message'
2017-08-17 22:00:37 +05:30
optional :should_remove_source_branch, type: Boolean,
desc: 'When true, the source branch will be deleted if possible'
optional :merge_when_pipeline_succeeds, type: Boolean,
desc: 'When true, this merge request will be merged when the pipeline succeeds'
optional :sha, type: String, desc: 'When present, must have the HEAD SHA of the source branch'
2018-11-08 19:23:39 +05:30
optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
2017-08-17 22:00:37 +05:30
end
put ':id/merge_requests/:merge_request_iid/merge' do
2018-03-17 18:26:18 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42317')
2017-08-17 22:00:37 +05:30
merge_request = find_project_merge_request(params[:merge_request_iid])
merge_when_pipeline_succeeds = to_boolean(params[:merge_when_pipeline_succeeds])
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
# Merge request can not be merged
# because user dont have permissions to push into target branch
unauthorized! unless merge_request.can_be_merged_by?(current_user)
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
not_allowed! unless merge_request.mergeable_state?(skip_ci_check: merge_when_pipeline_succeeds)
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
render_api_error!('Branch cannot be merged', 406) unless merge_request.mergeable?(skip_ci_check: merge_when_pipeline_succeeds)
2015-10-24 18:46:33 +05:30
2018-03-27 19:54:05 +05:30
check_sha_param!(params, merge_request)
2018-11-08 19:23:39 +05:30
merge_request.update(squash: params[:squash]) if params[:squash]
2015-10-24 18:46:33 +05:30
2019-05-18 00:54:41 +05:30
merge_params = HashWithIndifferentAccess.new(
2017-08-17 22:00:37 +05:30
commit_message: params[:merge_commit_message],
2019-03-02 22:35:43 +05:30
squash_commit_message: params[:squash_commit_message],
2017-08-17 22:00:37 +05:30
should_remove_source_branch: params[:should_remove_source_branch]
2019-05-18 00:54:41 +05:30
)
2015-10-24 18:46:33 +05:30
2017-08-17 22:00:37 +05:30
if merge_when_pipeline_succeeds && merge_request.head_pipeline && merge_request.head_pipeline.active?
::MergeRequests::MergeWhenPipelineSucceedsService
.new(merge_request.target_project, current_user, merge_params)
.execute(merge_request)
else
::MergeRequests::MergeService
.new(merge_request.target_project, current_user, merge_params)
.execute(merge_request)
2016-04-02 18:10:28 +05:30
end
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
end
2019-05-18 00:54:41 +05:30
desc 'Merge a merge request to its default temporary merge ref path'
params do
optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
end
put ':id/merge_requests/:merge_request_iid/merge_to_ref' do
merge_request = find_project_merge_request(params[:merge_request_iid])
authorize! :admin_merge_request, user_project
merge_params = {
commit_message: params[:merge_commit_message]
}
result = ::MergeRequests::MergeToRefService
.new(merge_request.target_project, current_user, merge_params)
.execute(merge_request)
if result[:status] == :success
present result.slice(:commit_id), 200
else
http_status = result[:http_status] || 400
render_api_error!(result[:message], http_status)
end
end
2017-08-17 22:00:37 +05:30
desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
success Entities::MergeRequest
end
post ':id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds' do
merge_request = find_project_merge_request(params[:merge_request_iid])
unauthorized! unless merge_request.can_cancel_merge_when_pipeline_succeeds?(current_user)
2018-03-17 18:26:18 +05:30
::MergeRequests::MergeWhenPipelineSucceedsService
2017-08-17 22:00:37 +05:30
.new(merge_request.target_project, current_user)
.cancel(merge_request)
end
2019-02-15 15:39:39 +05:30
desc 'Rebase the merge request against its target branch' do
detail 'This feature was added in GitLab 11.6'
end
put ':id/merge_requests/:merge_request_iid/rebase' do
merge_request = find_project_merge_request(params[:merge_request_iid])
authorize_push_to_merge_request!(merge_request)
RebaseWorker.perform_async(merge_request.id, current_user.id)
status :accepted
end
2017-08-17 22:00:37 +05:30
desc 'List issues that will be closed on merge' do
success Entities::MRNote
end
params do
use :pagination
end
get ':id/merge_requests/:merge_request_iid/closes_issues' do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
2018-11-18 11:00:15 +05:30
issues = ::Kaminari.paginate_array(merge_request.visible_closing_issues_for(current_user))
2017-09-10 17:25:29 +05:30
issues = paginate(issues)
external_issues, internal_issues = issues.partition { |issue| issue.is_a?(ExternalIssue) }
data = Entities::IssueBasic.represent(internal_issues, current_user: current_user)
data += Entities::ExternalIssue.represent(external_issues, current_user: current_user)
data.as_json
2014-09-02 18:07:02 +05:30
end
end
end
end