BigW Consortium Gitlab

merge_requests.rb 10.8 KB
Newer Older
1
module API
2
  class MergeRequests < Grape::API
3 4
    include PaginationParams

5 6
    before { authenticate! }

7 8 9
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
10
    resource :projects, requirements: { id: %r{[^/]+} } do
11 12
      include TimeTrackingEndpoints

13
      helpers do
14 15 16
        def handle_merge_request_errors!(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
17 18
          elsif errors[:branch_conflict].any?
            error!(errors[:branch_conflict], 422)
19 20 21 22
          elsif errors[:validate_fork].any?
            error!(errors[:validate_fork], 422)
          elsif errors[:validate_branches].any?
            conflict!(errors[:validate_branches])
23 24
          elsif errors[:base].any?
            error!(errors[:base], 422)
25
          end
26 27

          render_api_error!(errors, 400)
28
        end
29

30 31 32 33 34 35 36 37
        def issue_entity(project)
          if project.has_external_issue_tracker?
            Entities::ExternalIssue
          else
            Entities::IssueBasic
          end
        end

38 39 40 41 42 43 44 45 46 47 48
        def find_merge_requests(args = {})
          args = params.merge(args)

          args[:milestone_title] = args.delete(:milestone)
          args[:label_name] = args.delete(:labels)

          merge_requests = MergeRequestsFinder.new(current_user, args).execute.inc_notes_with_associations

          merge_requests.reorder(args[:order_by] => args[:sort])
        end

49
        params :optional_params_ce do
50 51 52 53
          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'
          optional :labels, type: String, desc: 'Comma-separated list of label names'
54
          optional :remove_source_branch, type: Boolean, desc: 'Remove source branch when merging'
55
        end
56 57 58 59

        params :optional_params do
          use :optional_params_ce
        end
60 61
      end

62
      desc 'List merge requests' do
63
        success Entities::MergeRequestBasic
64 65 66 67 68 69 70 71
      end
      params do
        optional :state, type: String, values: %w[opened closed merged all], default: 'all',
                         desc: 'Return opened, closed, merged, or all merge requests'
        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.'
72
        optional :iids, type: Array[Integer], desc: 'The IID array of merge requests'
73 74
        optional :milestone, type: String, desc: 'Return merge requests for a specific milestone'
        optional :labels, type: String, desc: 'Comma-separated list of label names'
75 76
        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'
77
        use :pagination
78
      end
79
      get ":id/merge_requests" do
80
        authorize! :read_merge_request, user_project
81

82
        merge_requests = find_merge_requests(project_id: user_project.id)
83

84
        present paginate(merge_requests), with: Entities::MergeRequestBasic, current_user: current_user, project: user_project
85
      end
86

87 88 89 90 91 92 93 94 95 96 97
      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
98
      post ":id/merge_requests" do
99
        authorize! :create_merge_request, user_project
100

101
        mr_params = declared_params(include_missing: false)
102
        mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch)
103

104
        merge_request = ::MergeRequests::CreateService.new(user_project, current_user, mr_params).execute
Izaak Alpert committed
105

106
        if merge_request.valid?
107
          present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
108 109
        else
          handle_merge_request_errors! merge_request.errors
110
        end
111 112
      end

113 114
      desc 'Delete a merge request'
      params do
115
        requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
116
      end
117 118
      delete ":id/merge_requests/:merge_request_iid" do
        merge_request = find_project_merge_request(params[:merge_request_iid])
119

120
        authorize!(:destroy_merge_request, merge_request)
121 122 123
        merge_request.destroy
      end

124
      params do
125
        requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
126
      end
127 128 129
      desc 'Get a single merge request' do
        success Entities::MergeRequest
      end
130 131
      get ':id/merge_requests/:merge_request_iid' do
        merge_request = find_merge_request_with_access(params[:merge_request_iid])
132

133 134
        present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
      end
135

136 137 138
      desc 'Get the commits of a merge request' do
        success Entities::RepoCommit
      end
139 140
      get ':id/merge_requests/:merge_request_iid/commits' do
        merge_request = find_merge_request_with_access(params[:merge_request_iid])
141
        commits = ::Kaminari.paginate_array(merge_request.commits)
142

143
        present paginate(commits), with: Entities::RepoCommit
144
      end
145

146 147 148
      desc 'Show the merge request changes' do
        success Entities::MergeRequestChanges
      end
149 150
      get ':id/merge_requests/:merge_request_iid/changes' do
        merge_request = find_merge_request_with_access(params[:merge_request_iid])
151

152 153
        present merge_request, with: Entities::MergeRequestChanges, current_user: current_user
      end
154

155 156 157 158
      desc 'Update a merge request' do
        success Entities::MergeRequest
      end
      params do
159 160 161 162 163 164 165 166 167 168 169
        # CE
        at_least_one_of_ce = [
          :assignee_id,
          :description,
          :labels,
          :milestone_id,
          :remove_source_branch,
          :state_event,
          :target_branch,
          :title
        ]
170 171
        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'
172
        optional :state_event, type: String, values: %w[close reopen],
173
                               desc: 'Status of the merge request'
174

175
        use :optional_params
176
        at_least_one_of(*at_least_one_of_ce)
177
      end
178 179
      put ':id/merge_requests/:merge_request_iid' do
        merge_request = find_merge_request_with_access(params.delete(:merge_request_iid), :update_merge_request)
180

181 182
        mr_params = declared_params(include_missing: false)
        mr_params[:force_remove_source_branch] = mr_params.delete(:remove_source_branch) if mr_params[:remove_source_branch].present?
183

184
        merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, mr_params).execute(merge_request)
185

186 187 188 189
        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
190
        end
191
      end
192

193 194 195 196
      desc 'Merge a merge request' do
        success Entities::MergeRequest
      end
      params do
197
        # CE
198 199 200
        optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
        optional :should_remove_source_branch, type: Boolean,
                                               desc: 'When true, the source branch will be deleted if possible'
201 202
        optional :merge_when_pipeline_succeeds, type: Boolean,
                                                desc: 'When true, this merge request will be merged when the pipeline succeeds'
203 204
        optional :sha, type: String, desc: 'When present, must have the HEAD SHA of the source branch'
      end
205 206
      put ':id/merge_requests/:merge_request_iid/merge' do
        merge_request = find_project_merge_request(params[:merge_request_iid])
207
        merge_when_pipeline_succeeds = to_boolean(params[:merge_when_pipeline_succeeds])
208

209 210 211
        # 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)
212

213
        not_allowed! unless merge_request.mergeable_state?(skip_ci_check: merge_when_pipeline_succeeds)
214

215
        render_api_error!('Branch cannot be merged', 406) unless merge_request.mergeable?(skip_ci_check: merge_when_pipeline_succeeds)
216

217 218 219
        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
220

221 222 223 224
        merge_params = {
          commit_message: params[:merge_commit_message],
          should_remove_source_branch: params[:should_remove_source_branch]
        }
225

226
        if merge_when_pipeline_succeeds && merge_request.head_pipeline && merge_request.head_pipeline.active?
227 228 229 230 231 232 233
          ::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)
234
        end
235

236 237
        present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
      end
238

239 240 241
      desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
        success Entities::MergeRequest
      end
242 243
      post ':id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds' do
        merge_request = find_project_merge_request(params[:merge_request_iid])
244

245
        unauthorized! unless merge_request.can_cancel_merge_when_pipeline_succeeds?(current_user)
246

247 248 249 250
        ::MergeRequest::MergeWhenPipelineSucceedsService
          .new(merge_request.target_project, current_user)
          .cancel(merge_request)
      end
Valeriy Sizov committed
251

252 253 254 255 256 257
      desc 'List issues that will be closed on merge' do
        success Entities::MRNote
      end
      params do
        use :pagination
      end
258 259
      get ':id/merge_requests/:merge_request_iid/closes_issues' do
        merge_request = find_merge_request_with_access(params[:merge_request_iid])
260 261 262
        issues = ::Kaminari.paginate_array(merge_request.closes_issues(current_user))
        present paginate(issues), with: issue_entity(user_project), current_user: current_user
      end
263 264 265
    end
  end
end