Git push options to create a merge request, set target_branch and set merge when pipeline succeeds

What does this MR do?

Adds the ability to perform the following with git push options:

• create a merge request
• set the target branch of a merge request
• set merge request to merge when its pipeline succeeds

Merge request creation

To create a new merge request:

git push -u origin -o merge_request.create

To create a new merge request, set its target branch, and set it to merge when its pipeline succeeds:

git push -u origin -o merge_request.create \
  -o merge_request.target=branch1 \
  -o merge_request.merge_when_pipeline_succeeds

Updating existing merge requests

When pushing branches with an existing open merge request, target and merge_when_pipeline_succeeds can be used to update the merge request.

Internals

A new Gitlab::PushOptions class handles parsing and validating the push options array. This can be the start of the standard of GitLab accepting push options that follow namespacing rules. Rules are discussed in https://gitlab.com/gitlab-org/gitlab-ce/issues/43263#note_147777088

E.g. these push options:

-o merge_request.create -o merge_request.target=123

Become parsed by the Gitlab::PushOptions class as:

{
  merge_request: {
    create: true,
    target: '123',
  }
}

And are fetched with the class via:

push_options.get(:merge_request)
push_options.get(:merge_request, :create)
push_options.get(:merge_request, :target)

A new MergeRequests::PushOptionsHandlerService takes the merge_request namespaced push options and handles creating and updating merge requests.

Any errors encountered are passed to the existing output Hash in Api::Internal's post_receive endpoint, and passed to gitlab-shell where they're output to the user.

What are the relevant issue numbers?

• https://gitlab.com/gitlab-org/gitlab-ce/issues/43263
• https://gitlab.com/gitlab-org/gitlab-ce/issues/53198

Does this MR meet the acceptance criteria?

• Changelog entry added, if necessary
• Documentation created/updated via this MR
• Documentation reviewed by technical writer or follow-up review issue created
• Tests added for this feature/bug
• Conforms to the code review guidelines
• Conforms to the merge request performance guidelines
• Conforms to the style guides
• Conforms to the database guides

Closes #43263 (closed)

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/53198

spec/requests/api/internal_spec.rb

@@ -907,7 +907,7 @@
       expect(PostReceive).to receive(:perform_async)
         .with(gl_repository, identifier, changes, push_options)
 
-      post api("/internal/post_receive"), params: valid_params
+      post api('/internal/post_receive'), params: valid_params
     end
 
     it 'decreases the reference counter and returns the result' do
@@ -915,13 +915,13 @@
         .and_return(reference_counter)
       expect(reference_counter).to receive(:decrease).and_return(true)
 
-      post api("/internal/post_receive"), params: valid_params
+      post api('/internal/post_receive'), params: valid_params
 
       expect(json_response['reference_counter_decreased']).to be(true)
     end
 
     it 'returns link to create new merge request' do
-      post api("/internal/post_receive"), params: valid_params
+      post api('/internal/post_receive'), params: valid_params
 
       expect(json_response['merge_request_urls']).to match [{
         "branch_name" => "new_branch",
@@ -933,7 +933,7 @@
     it 'returns empty array if printing_merge_request_link_enabled is false' do
       project.update!(printing_merge_request_link_enabled: false)
 
-      post api("/internal/post_receive"), params: valid_params
+      post api('/internal/post_receive'), params: valid_params
 
       expect(json_response['merge_request_urls']).to eq([])
     end
@@ -941,7 +941,7 @@
     it 'does not invoke MergeRequests::PushOptionsHandlerService' do
       expect(MergeRequests::PushOptionsHandlerService).not_to receive(:new)
 
-      post api("/internal/post_receive"), params: valid_params
+      post api('/internal/post_receive'), params: valid_params
     end
 
     context 'when there are merge_request push options' do
@@ -952,16 +952,16 @@
       it 'invokes MergeRequests::PushOptionsHandlerService' do
         expect(MergeRequests::PushOptionsHandlerService).to receive(:new)
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
       end
 
       it 'links to the newly created merge request' do
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(json_response['merge_request_urls']).to match [{
-          "branch_name" => "new_branch",
-          "url" => "http://#{Gitlab.config.gitlab.host}/#{project.namespace.name}/#{project.path}/merge_requests/1",
-          "new_merge_request" => false
+          'branch_name' => 'new_branch',
+          'url' => "http://#{Gitlab.config.gitlab.host}/#{project.namespace.name}/#{project.path}/merge_requests/1",
+          'new_merge_request' => false
         }]
       end
 
@@ -970,7 +970,7 @@
           MergeRequests::PushOptionsHandlerService::Error, 'my warning'
         )
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(json_response['warnings']).to eq('Error encountered with push options \'merge_request.create\': my warning')
       end
@@ -980,7 +980,7 @@
           MergeRequests::PushOptionsHandlerService
         ).to receive(:errors).at_least(:once).and_return(['my error'])
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(json_response['warnings']).to eq('Error encountered with push options \'merge_request.create\': my error')
       end
@@ -993,7 +993,7 @@
           MergeRequests::CreateService
         ).to receive(:execute).and_return(invalid_merge_request)
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(json_response['warnings']).to eq('Error encountered with push options \'merge_request.create\': my error')
       end
@@ -1003,7 +1003,7 @@
       let!(:broadcast_message) { create(:broadcast_message, starts_at: 1.day.ago, ends_at: 1.day.from_now ) }
 
       it 'returns one broadcast message' do
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
         expect(json_response['broadcast_message']).to eq(broadcast_message.message)
@@ -1012,7 +1012,7 @@
 
     context 'broadcast message does not exist' do
       it 'returns empty string' do
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
         expect(json_response['broadcast_message']).to eq(nil)
@@ -1023,7 +1023,7 @@
       it 'returns empty string' do
         allow(BroadcastMessage).to receive(:current).and_return(nil)
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
         expect(json_response['broadcast_message']).to eq(nil)
@@ -1035,7 +1035,7 @@
         project_moved = Gitlab::Checks::ProjectMoved.new(project, user, 'http', 'foo/baz')
         project_moved.add_message
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
         expect(json_response["redirected_message"]).to be_present
@@ -1048,7 +1048,7 @@
         project_created = Gitlab::Checks::ProjectCreated.new(project, user, 'http')
         project_created.add_message
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
         expect(json_response["project_created_message"]).to be_present
@@ -1060,7 +1060,7 @@
       it 'does not try to notify that project moved' do
         allow_any_instance_of(Gitlab::Identifier).to receive(:identify).and_return(nil)
 
-        post api("/internal/post_receive"), params: valid_params
+        post api('/internal/post_receive'), params: valid_params
 
         expect(response).to have_gitlab_http_status(200)
       end