Automatic merge of gitlab-org/gitlab-ce master

changelogs/unreleased/osw-merge-refs-refreshing-api.yml

+---
+title: API support for MR merge to temporary merge ref path
+merge_request: 24918
+author:
+type: added

config/gitlab.yml.example

@@ -816,7 +816,6 @@ production: &base
   ## GitLab Shell settings
   gitlab_shell:
     path: /home/git/gitlab-shell/
-    hooks_path: /home/git/gitlab-shell/hooks/
 
     # File that contains the secret key for verifying access for gitlab-shell.
     # Default is '.gitlab_shell_secret' relative to Rails.root (i.e. root of the GitLab app).
@@ -985,7 +984,6 @@ test:
         region: us-east-1
   gitlab_shell:
     path: tmp/tests/gitlab-shell/
-    hooks_path: tmp/tests/gitlab-shell/hooks/
   issues_tracker:
     redmine:
       title: "Redmine"

config/initializers/1_settings.rb

@@ -414,7 +414,7 @@ Settings['sidekiq']['log_format'] ||= 'default'
 #
 Settings['gitlab_shell'] ||= Settingslogic.new({})
 Settings.gitlab_shell['path']           = Settings.absolute(Settings.gitlab_shell['path'] || Settings.gitlab['user_home'] + '/gitlab-shell/')
-Settings.gitlab_shell['hooks_path']     = Settings.absolute(Settings.gitlab_shell['hooks_path'] || Settings.gitlab['user_home'] + '/gitlab-shell/hooks/')
+Settings.gitlab_shell['hooks_path']     = :deprecated_use_gitlab_shell_path_instead
 Settings.gitlab_shell['secret_file'] ||= Rails.root.join('.gitlab_shell_secret')
 Settings.gitlab_shell['receive_pack']   = true if Settings.gitlab_shell['receive_pack'].nil?
 Settings.gitlab_shell['upload_pack']    = true if Settings.gitlab_shell['upload_pack'].nil?

doc/api/merge_requests.md

@@ -1117,6 +1117,40 @@ Parameters:
 }
 ```
 
+## Merge to default merge ref path
+
+Merge the changes between the merge request source and target branches into `refs/merge-requests/:iid/merge` 
+ref, of the target project repository. This ref will have the state the target branch would have if
+a regular merge action was taken.
+
+This is not a regular merge action given it doesn't change the merge request state in any manner.
+
+This ref (`refs/merge-requests/:iid/merge`) is **always** overwritten when submitting
+requests to this API, so none of its state is kept or used in the process.
+
+If the merge request has conflicts, is empty or already merged,
+you'll get a `400` and a descriptive error message. If you don't have permissions to do so, 
+you'll get a `403`.
+
+It returns the HEAD commit of `refs/merge-requests/:iid/merge` in the response body in
+case of `200`.
+
+```
+PUT /projects/:id/merge_requests/:merge_request_iid/merge_to_ref
+```
+
+Parameters:
+
+- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
+- `merge_request_iid` (required)            - Internal ID of MR
+- `merge_commit_message` (optional)         - Custom merge commit message
+
+```json
+{
+  "commit_id": "854a3a7a17acbcc0bbbea170986df1eb60435f34"
+}
+```
+
 ## Cancel Merge When Pipeline Succeeds
 
 If you don't have permissions to accept this merge request - you'll get a `401`

lib/api/merge_requests.rb

@@ -390,6 +390,31 @@ module API
         present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
       end
 
+      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
+
       desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
         success Entities::MergeRequest
       end

lib/gitlab/shell.rb

@@ -340,16 +340,16 @@ module Gitlab
     end
     # rubocop: enable CodeReuse/ActiveRecord
 
+    def hooks_path
+      File.join(gitlab_shell_path, 'hooks')
+    end
+
     protected
 
     def gitlab_shell_path
       File.expand_path(Gitlab.config.gitlab_shell.path)
     end
 
-    def gitlab_shell_hooks_path
-      File.expand_path(Gitlab.config.gitlab_shell.hooks_path)
-    end
-
     def gitlab_shell_user_home
       File.expand_path("~#{Gitlab.config.gitlab_shell.ssh_user}")
     end

lib/tasks/gitlab/info.rake

@@ -73,7 +73,7 @@ namespace :gitlab do
       puts "Omniauth Providers: #{omniauth_providers.join(', ')}" if Gitlab::Auth.omniauth_enabled?
 
       # check Gitolite version
-      gitlab_shell_version_file = "#{Gitlab.config.gitlab_shell.hooks_path}/../VERSION"
+      gitlab_shell_version_file = "#{Gitlab.config.gitlab_shell.path}/VERSION"
       if File.readable?(gitlab_shell_version_file)
         gitlab_shell_version = File.read(gitlab_shell_version_file)
       end
@@ -87,7 +87,7 @@ namespace :gitlab do
           puts "- #{name}: \t#{repository_storage.legacy_disk_path}"
         end
       end
-      puts "Hooks:\t\t#{Gitlab.config.gitlab_shell.hooks_path}"
+      puts "GitLab Shell path:\t\t#{Gitlab.config.gitlab_shell.path}"
       puts "Git:\t\t#{Gitlab.config.git.bin_path}"
     end
   end

spec/lib/gitlab/git/repository_spec.rb

@@ -31,7 +31,7 @@ describe Gitlab::Git::Repository, :seed_helper do
   describe '.create_hooks' do
     let(:repo_path) { File.join(storage_path, 'hook-test.git') }
     let(:hooks_dir) { File.join(repo_path, 'hooks') }
-    let(:target_hooks_dir) { Gitlab.config.gitlab_shell.hooks_path }
+    let(:target_hooks_dir) { Gitlab::Shell.new.hooks_path }
     let(:existing_target) { File.join(repo_path, 'foobar') }
 
     before do
@@ -1945,7 +1945,7 @@ describe Gitlab::Git::Repository, :seed_helper do
       imported_repo.create_from_bundle(valid_bundle_path)
       hooks_path = Gitlab::GitalyClient::StorageSettings.allow_disk_access { File.join(imported_repo.path, 'hooks') }
 
-      expect(File.readlink(hooks_path)).to eq(Gitlab.config.gitlab_shell.hooks_path)
+      expect(File.readlink(hooks_path)).to eq(Gitlab::Shell.new.hooks_path)
     end
 
     it 'raises an error if the bundle is an attempted malicious payload' do

spec/lib/gitlab/shell_spec.rb

@@ -393,7 +393,6 @@ describe Gitlab::Shell do
 
     before do
       allow(Gitlab.config.gitlab_shell).to receive(:path).and_return(gitlab_shell_path)
-      allow(Gitlab.config.gitlab_shell).to receive(:hooks_path).and_return(gitlab_shell_hooks_path)
       allow(Gitlab.config.gitlab_shell).to receive(:git_timeout).and_return(800)
     end
 

spec/requests/api/merge_requests_spec.rb

@@ -1034,6 +1034,67 @@ describe API::MergeRequests do
     end
   end
 
+  describe "PUT /projects/:id/merge_requests/:merge_request_iid/merge_to_ref" do
+    let(:pipeline) { create(:ci_pipeline_without_jobs) }
+    let(:url) do
+      "/projects/#{project.id}/merge_requests/#{merge_request.iid}/merge_to_ref"
+    end
+
+    it 'returns the generated ID from the merge service in case of success' do
+      put api(url, user), params: { merge_commit_message: 'Custom message' }
+
+      commit = project.commit(json_response['commit_id'])
+
+      expect(response).to have_gitlab_http_status(200)
+      expect(json_response['commit_id']).to be_present
+      expect(commit.message).to eq('Custom message')
+    end
+
+    it "returns 400 if branch can't be merged" do
+      merge_request.update!(state: 'merged')
+
+      put api(url, user)
+
+      expect(response).to have_gitlab_http_status(400)
+      expect(json_response['message'])
+        .to eq("Merge request is not mergeable to #{merge_request.merge_ref_path}")
+    end
+
+    it 'returns 403 if user has no permissions to merge to the ref' do
+      user2 = create(:user)
+      project.add_reporter(user2)
+
+      put api(url, user2)
+
+      expect(response).to have_gitlab_http_status(403)
+      expect(json_response['message']).to eq('403 Forbidden')
+    end
+
+    it 'returns 404 for an invalid merge request IID' do
+      put api("/projects/#{project.id}/merge_requests/12345/merge_to_ref", user)
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+
+    it "returns 404 if the merge request id is used instead of iid" do
+      put api("/projects/#{project.id}/merge_requests/#{merge_request.id}/merge", user)
+
+      expect(response).to have_gitlab_http_status(404)
+    end
+
+    it "returns 400 when merge method is not supported" do
+      merge_request.project.update!(merge_method: 'ff')
+
+      put api(url, user)
+
+      expected_error =
+        'Fast-forward to refs/merge-requests/1/merge is currently not supported.'
+
+      expect(response).to have_gitlab_http_status(400)
+      expect(json_response['message']).to eq(expected_error)
+    end
+  end
+
   describe "PUT /projects/:id/merge_requests/:merge_request_iid" do
     context "to close a MR" do
       it "returns merge_request" do

spec/support/helpers/test_env.rb

@@ -147,12 +147,15 @@ module TestEnv
       version: Gitlab::Shell.version_required,
       task: 'gitlab:shell:install')
 
-    create_fake_git_hooks
+    # gitlab-shell hooks don't work in our test environment because they try to make internal API calls
+    sabotage_gitlab_shell_hooks
   end
 
-  def create_fake_git_hooks
-    # gitlab-shell hooks don't work in our test environment because they try to make internal API calls
-    hooks_dir = File.join(Gitlab.config.gitlab_shell.path, 'hooks')
+  def sabotage_gitlab_shell_hooks
+    create_fake_git_hooks(Gitlab::Shell.new.hooks_path)
+  end
+
+  def create_fake_git_hooks(hooks_dir)
     %w[pre-receive post-receive update].each do |hook|
       File.open(File.join(hooks_dir, hook), 'w', 0755) { |f| f.puts '#!/bin/sh' }
     end
@@ -169,6 +172,7 @@ module TestEnv
       task: "gitlab:gitaly:install[#{install_gitaly_args}]") do
 
         Gitlab::SetupHelper.create_gitaly_configuration(gitaly_dir, { 'default' => repos_path }, force: true)
+        create_fake_git_hooks(File.join(gitaly_dir, 'ruby/git-hooks'))
         start_gitaly(gitaly_dir)
       end
   end

spec/tasks/gitlab/shell_rake_spec.rb

@@ -8,7 +8,7 @@ describe 'gitlab:shell rake tasks' do
   end
 
   after do
-    TestEnv.create_fake_git_hooks
+    TestEnv.sabotage_gitlab_shell_hooks
   end
 
   describe 'install task' do