GitLab steht wegen Wartungsarbeiten am Montag, den 10. Mai, zwischen 17:00 und 19:00 Uhr nicht zur Verfügung.

merge_requests.rb 11.5 KB
Newer Older
1
module API
Valeriy Sizov's avatar
Valeriy Sizov committed
2
  class MergeRequests < Grape::API
3 4
    DEPRECATION_MESSAGE = 'This endpoint is deprecated and will be removed in GitLab 9.0.'.freeze

Valeriy Sizov's avatar
Valeriy Sizov committed
5 6
    before { authenticate! }

7 8 9
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
Hiroyuki Sato's avatar
Hiroyuki Sato committed
10
    resource :projects do
11
      helpers do
12 13 14
        def handle_merge_request_errors!(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
15 16
          elsif errors[:branch_conflict].any?
            error!(errors[:branch_conflict], 422)
17 18 19 20
          elsif errors[:validate_fork].any?
            error!(errors[:validate_fork], 422)
          elsif errors[:validate_branches].any?
            conflict!(errors[:validate_branches])
21
          end
22 23

          render_api_error!(errors, 400)
24
        end
25 26 27 28 29 30 31

        params :optional_params do
          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'
        end
32 33
      end

34 35 36 37 38 39 40 41 42 43 44 45
      desc 'List merge requests' do
        success Entities::MergeRequest
      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.'
        optional :iid, type: Integer, desc: 'The IID of the merge requests'
      end
Valeriy Sizov's avatar
Valeriy Sizov committed
46
      get ":id/merge_requests" do
47
        authorize! :read_merge_request, user_project
48
        merge_requests = user_project.merge_requests.inc_notes_with_associations
49

50 51 52 53
        unless params[:iid].nil?
          merge_requests = filter_by_iid(merge_requests, params[:iid])
        end

54
        merge_requests =
55 56 57 58
          case params[:state]
          when 'opened' then merge_requests.opened
          when 'closed' then merge_requests.closed
          when 'merged' then merge_requests.merged
59 60
          else merge_requests
          end
61

Stan Hu's avatar
Stan Hu committed
62
        merge_requests = merge_requests.reorder(issuable_order_by => issuable_sort)
63
        present paginate(merge_requests), with: Entities::MergeRequest, current_user: current_user, project: user_project
Valeriy Sizov's avatar
Valeriy Sizov committed
64
      end
65

66 67 68 69 70 71 72 73 74 75 76
      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
Valeriy Sizov's avatar
Valeriy Sizov committed
77
      post ":id/merge_requests" do
78
        authorize! :create_merge_request, user_project
79 80

        mr_params = declared_params
81 82

        # Validate label names in advance
83
        if (errors = validate_label_params(mr_params)).any?
Robert Schilling's avatar
Robert Schilling committed
84
          render_api_error!({ labels: errors }, 400)
85 86
        end

87
        merge_request = ::MergeRequests::CreateService.new(user_project, current_user, mr_params).execute
Izaak Alpert's avatar
Izaak Alpert committed
88

89
        if merge_request.valid?
90
          present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
91 92
        else
          handle_merge_request_errors! merge_request.errors
Valeriy Sizov's avatar
Valeriy Sizov committed
93
        end
Valeriy Sizov's avatar
Valeriy Sizov committed
94 95
      end

96 97 98 99
      desc 'Delete a merge request'
      params do
        requires :merge_request_id, type: Integer, desc: 'The ID of a merge request'
      end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
100
      delete ":id/merge_requests/:merge_request_id" do
101
        merge_request = user_project.merge_requests.find_by(id: params[:merge_request_id])
102

103
        authorize!(:destroy_merge_request, merge_request)
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
104 105 106
        merge_request.destroy
      end

107 108
      # Routing "merge_request/:merge_request_id/..." is DEPRECATED and WILL BE REMOVED in version 9.0
      # Use "merge_requests/:merge_request_id/..." instead.
Valeriy Sizov's avatar
Valeriy Sizov committed
109
      #
110 111 112 113 114 115 116 117 118 119
      params do
        requires :merge_request_id, type: Integer, desc: 'The ID of a merge request'
      end
      { ":id/merge_request/:merge_request_id" => :deprecated, ":id/merge_requests/:merge_request_id" => :ok }.each do |path, status|
        desc 'Get a single merge request' do
          if status == :deprecated
            detail DEPRECATION_MESSAGE
          end
          success Entities::MergeRequest
        end
120 121 122
        get path do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
          authorize! :read_merge_request, merge_request
123
          present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
Valeriy Sizov's avatar
Valeriy Sizov committed
124
        end
125

126 127 128
        desc 'Get the commits of a merge request' do
          success Entities::RepoCommit
        end
129
        get "#{path}/commits" do
130
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
131 132
          authorize! :read_merge_request, merge_request
          present merge_request.commits, with: Entities::RepoCommit
133
        end
134

135 136 137
        desc 'Show the merge request changes' do
          success Entities::MergeRequestChanges
        end
138
        get "#{path}/changes" do
139
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
140
          authorize! :read_merge_request, merge_request
141
          present merge_request, with: Entities::MergeRequestChanges, current_user: current_user
142
        end
143

144 145 146 147 148 149 150 151 152 153 154 155
        desc 'Update a merge request' do
          success Entities::MergeRequest
        end
        params do
          optional :title, type: String, desc: 'The title of the merge request'
          optional :target_branch, type: String, desc: 'The target branch'
          optional :state_event, type: String, values: %w[close reopen merge],
                                 desc: 'Status of the merge request'
          use :optional_params
          at_least_one_of :title, :target_branch, :description, :assignee_id,
                          :milestone_id, :labels, :state_event
        end
156
        put path do
157
          merge_request = user_project.merge_requests.find(params.delete(:merge_request_id))
158 159
          authorize! :update_merge_request, merge_request

160
          mr_params = declared_params(include_missing: false)
161

162
          # Validate label names in advance
163
          if (errors = validate_label_params(mr_params)).any?
164 165
            render_api_error!({ labels: errors }, 400)
          end
166

167
          merge_request = ::MergeRequests::UpdateService.new(user_project, current_user, mr_params).execute(merge_request)
168

169
          if merge_request.valid?
170
            present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
171 172 173 174
          else
            handle_merge_request_errors! merge_request.errors
          end
        end
175

176 177 178 179 180 181 182 183
        desc 'Merge a merge request' do
          success Entities::MergeRequest
        end
        params do
          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'
          optional :merge_when_build_succeeds, type: Boolean,
184
                                               desc: 'When true, this merge request will be merged when the pipeline succeeds'
185 186
          optional :sha, type: String, desc: 'When present, must have the HEAD SHA of the source branch'
        end
187 188 189 190 191 192 193
        put "#{path}/merge" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])

          # 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)

194
          not_allowed! unless merge_request.mergeable_state?
195

196
          render_api_error!('Branch cannot be merged', 406) unless merge_request.mergeable?
197

198 199
          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)
200 201
          end

202 203 204 205 206
          merge_params = {
            commit_message: params[:merge_commit_message],
            should_remove_source_branch: params[:should_remove_source_branch]
          }

207
          if params[:merge_when_build_succeeds] && merge_request.pipeline && merge_request.pipeline.active?
208 209 210
            ::MergeRequests::MergeWhenPipelineSucceedsService
              .new(merge_request.target_project, current_user, merge_params)
              .execute(merge_request)
211
          else
212 213 214
            ::MergeRequests::MergeService
              .new(merge_request.target_project, current_user, merge_params)
              .execute(merge_request)
215
          end
216

217
          present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
218
        end
219

220
        desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
221 222
          success Entities::MergeRequest
        end
223 224
        post "#{path}/cancel_merge_when_build_succeeds" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
225

226
          unauthorized! unless merge_request.can_cancel_merge_when_build_succeeds?(current_user)
227

228 229 230
          ::MergeRequest::MergeWhenPipelineSucceedsService
            .new(merge_request.target_project, current_user)
            .cancel(merge_request)
231
        end
232

233 234 235 236
        desc 'Get the comments of a merge request' do
          detail 'Duplicate. DEPRECATED and WILL BE REMOVED in 9.0'
          success Entities::MRNote
        end
237 238 239 240 241 242 243
        get "#{path}/comments" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])

          authorize! :read_merge_request, merge_request

          present paginate(merge_request.notes.fresh), with: Entities::MRNote
        end
Valeriy Sizov's avatar
Valeriy Sizov committed
244

245 246 247 248 249 250 251
        desc 'Post a comment to a merge request' do
          detail 'Duplicate. DEPRECATED and WILL BE REMOVED in 9.0'
          success Entities::MRNote
        end
        params do
          requires :note, type: String, desc: 'The text of the comment'
        end
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
        post "#{path}/comments" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
          authorize! :create_note, merge_request

          opts = {
            note: params[:note],
            noteable_type: 'MergeRequest',
            noteable_id: merge_request.id
          }

          note = ::Notes::CreateService.new(user_project, current_user, opts).execute

          if note.save
            present note, with: Entities::MRNote
          else
            render_api_error!("Failed to save note #{note.errors.messages}", 400)
          end
269
        end
270

271 272 273
        desc 'List issues that will be closed on merge' do
          success Entities::MRNote
        end
274 275
        get "#{path}/closes_issues" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
276
          issues = ::Kaminari.paginate_array(merge_request.closes_issues(current_user))
277
          present paginate(issues), with: issue_entity(user_project), current_user: current_user
278
        end
279
      end
Valeriy Sizov's avatar
Valeriy Sizov committed
280 281 282
    end
  end
end