merge_requests.rb 11.6 KB
Newer Older
1
module API
Valeriy Sizov's avatar
Valeriy Sizov committed
2
  # MergeRequest API
3 4 5
  class MergeRequests < Grape::API
    before { authenticate! }

Hiroyuki Sato's avatar
Hiroyuki Sato committed
6
    resource :projects do
7
      helpers do
8 9 10
        def handle_merge_request_errors!(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
11 12
          elsif errors[:branch_conflict].any?
            error!(errors[:branch_conflict], 422)
13 14 15 16
          elsif errors[:validate_fork].any?
            error!(errors[:validate_fork], 422)
          elsif errors[:validate_branches].any?
            conflict!(errors[:validate_branches])
17
          end
18 19

          render_api_error!(errors, 400)
20 21 22
        end
      end

Valeriy Sizov's avatar
Valeriy Sizov committed
23
      # List merge requests
24
      #
Valeriy Sizov's avatar
Valeriy Sizov committed
25
      # Parameters:
26
      #   id (required) - The ID of a project
27
      #   iid (optional) - Return the project MR having the given `iid`
28
      #   state (optional) - Return requests "merged", "opened" or "closed"
29 30
      #   order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
      #   sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
Valeriy Sizov's avatar
Valeriy Sizov committed
31 32
      #
      # Example:
33
      #   GET /projects/:id/merge_requests
34 35
      #   GET /projects/:id/merge_requests?state=opened
      #   GET /projects/:id/merge_requests?state=closed
36
      #   GET /projects/:id/merge_requests?order_by=created_at
Marin Jankovski's avatar
Marin Jankovski committed
37
      #   GET /projects/:id/merge_requests?order_by=updated_at
38 39
      #   GET /projects/:id/merge_requests?sort=desc
      #   GET /projects/:id/merge_requests?sort=asc
40
      #   GET /projects/:id/merge_requests?iid=42
Valeriy Sizov's avatar
Valeriy Sizov committed
41
      #
42
      get ":id/merge_requests" do
43
        authorize! :read_merge_request, user_project
44
        merge_requests = user_project.merge_requests
45

46 47 48 49
        unless params[:iid].nil?
          merge_requests = filter_by_iid(merge_requests, params[:iid])
        end

50 51 52 53 54 55 56
        merge_requests =
          case params["state"]
          when "opened" then merge_requests.opened
          when "closed" then merge_requests.closed
          when "merged" then merge_requests.merged
          else merge_requests
          end
57

58
        merge_requests = merge_requests.reorder(issuable_order_by => issuable_sort)
59
        present paginate(merge_requests), with: Entities::MergeRequest
60
      end
61

Valeriy Sizov's avatar
Valeriy Sizov committed
62 63 64 65
      # Create MR
      #
      # Parameters:
      #
66
      #   id (required)            - The ID of a project - this will be the source of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
67 68
      #   source_branch (required) - The source branch
      #   target_branch (required) - The target branch
sue445's avatar
sue445 committed
69
      #   target_project_id        - The target project of the merge request defaults to the :id of the project
Valeriy Sizov's avatar
Valeriy Sizov committed
70 71
      #   assignee_id              - Assignee user ID
      #   title (required)         - Title of MR
72
      #   description              - Description of MR
73
      #   labels (optional)        - Labels for MR as a comma-separated list
74
      #
Valeriy Sizov's avatar
Valeriy Sizov committed
75
      # Example:
76
      #   POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
77
      #
78
      post ":id/merge_requests" do
79
        authorize! :create_merge_request, user_project
80 81
        required_attributes! [:source_branch, :target_branch, :title]
        attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :target_project_id, :description]
82 83

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

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

90
        if merge_request.valid?
91 92 93 94 95
          # Find or create labels and attach to issue
          if params[:labels].present?
            merge_request.add_labels_by_names(params[:labels].split(","))
          end

96 97 98
          present merge_request, with: Entities::MergeRequest
        else
          handle_merge_request_errors! merge_request.errors
Valeriy Sizov's avatar
Valeriy Sizov committed
99
        end
100 101
      end

102 103
      # 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
104
      #
105 106 107 108 109 110 111 112 113 114 115 116 117 118
      [":id/merge_request/:merge_request_id", ":id/merge_requests/:merge_request_id"].each do |path|
        # Show MR
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - The ID of MR
        #
        # Example:
        #   GET /projects/:id/merge_requests/:merge_request_id
        #
        get path do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])

          authorize! :read_merge_request, merge_request
119

120
          present merge_request, with: Entities::MergeRequest
121
        end
122

123 124 125 126 127 128 129 130 131 132 133 134 135 136
        # Show MR commits
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - The ID of MR
        #
        # Example:
        #   GET /projects/:id/merge_requests/:merge_request_id/commits
        #
        get "#{path}/commits" do
          merge_request = user_project.merge_requests.
            find(params[:merge_request_id])
          authorize! :read_merge_request, merge_request
          present merge_request.commits, with: Entities::RepoCommit
137
        end
138

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
        # Show MR changes
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - The ID of MR
        #
        # Example:
        #   GET /projects/:id/merge_requests/:merge_request_id/changes
        #
        get "#{path}/changes" do
          merge_request = user_project.merge_requests.
            find(params[:merge_request_id])
          authorize! :read_merge_request, merge_request
          present merge_request, with: Entities::MergeRequestChanges
        end
154

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        # Update MR
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - ID of MR
        #   target_branch               - The target branch
        #   assignee_id                 - Assignee user ID
        #   title                       - Title of MR
        #   state_event                 - Status of MR. (close|reopen|merge)
        #   description                 - Description of MR
        #   labels (optional)           - Labels for a MR as a comma-separated list
        # Example:
        #   PUT /projects/:id/merge_requests/:merge_request_id
        #
        put path do
          attrs = attributes_for_keys [:target_branch, :assignee_id, :title, :state_event, :description]
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
          authorize! :update_merge_request, merge_request

          # Ensure source_branch is not specified
          if params[:source_branch].present?
            render_api_error!('Source branch cannot be changed', 400)
          end
178

179 180 181 182
          # Validate label names in advance
          if (errors = validate_label_params(params)).any?
            render_api_error!({ labels: errors }, 400)
          end
183

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

186 187 188 189 190 191
          if merge_request.valid?
            # Find or create labels and attach to issue
            unless params[:labels].nil?
              merge_request.remove_labels
              merge_request.add_labels_by_names(params[:labels].split(","))
            end
192

193 194 195 196 197
            present merge_request, with: Entities::MergeRequest
          else
            handle_merge_request_errors! merge_request.errors
          end
        end
198

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
        # Merge MR
        #
        # Parameters:
        #   id (required)                           - The ID of a project
        #   merge_request_id (required)             - ID of MR
        #   merge_commit_message (optional)         - Custom merge commit message
        #   should_remove_source_branch (optional)  - When true, the source branch will be deleted if possible
        #   merge_when_build_succeeds (optional)    - When true, this MR will be merged when the build succeeds
        # Example:
        #   PUT /projects/:id/merge_requests/:merge_request_id/merge
        #
        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)
          not_allowed! if !merge_request.open? || merge_request.work_in_progress?

          merge_request.check_if_can_be_merged

          render_api_error!('Branch cannot be merged', 406) unless merge_request.can_be_merged?

          merge_params = {
            commit_message: params[:merge_commit_message],
            should_remove_source_branch: params[:should_remove_source_branch]
          }

          if parse_boolean(params[:merge_when_build_succeeds]) && merge_request.ci_commit && merge_request.ci_commit.active?
            ::MergeRequests::MergeWhenBuildSucceedsService.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)
          end
234

235 236
          present merge_request, with: Entities::MergeRequest
        end
237

238 239 240 241 242 243 244
        # Cancel Merge if Merge When build succeeds is enabled
        # Parameters:
        #   id (required)                         - The ID of a project
        #   merge_request_id (required)           - ID of MR
        #
        post "#{path}/cancel_merge_when_build_succeeds" do
          merge_request = user_project.merge_requests.find(params[:merge_request_id])
245

246
          unauthorized! unless merge_request.can_cancel_merge_when_build_succeeds?(current_user)
247

248 249
          ::MergeRequest::MergeWhenBuildSucceedsService.new(merge_request.target_project, current_user).cancel(merge_request)
        end
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
        # Duplicate. DEPRECATED and WILL BE REMOVED in 9.0.
        # Use GET "/projects/:id/merge_requests/:merge_request_id/notes" instead
        #
        # Get a merge request's comments
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - ID of MR
        # Examples:
        #   GET /projects/:id/merge_requests/:merge_request_id/comments
        #
        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
269

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
        # Duplicate. DEPRECATED and WILL BE REMOVED in 9.0.
        # Use POST "/projects/:id/merge_requests/:merge_request_id/notes" instead
        #
        # Post comment to merge request
        #
        # Parameters:
        #   id (required)               - The ID of a project
        #   merge_request_id (required) - ID of MR
        #   note (required)             - Text of comment
        # Examples:
        #   POST /projects/:id/merge_requests/:merge_request_id/comments
        #
        post "#{path}/comments" do
          required_attributes! [:note]

          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
302 303
        end
      end
304 305 306
    end
  end
end