Merge branch 'geo/mk/add-custom-http-clone-url-root' into 'master'

Add "Custom Git clone URL for HTTP(S)" setting

Closes #31949

See merge request gitlab-org/gitlab!18422

app/helpers/application_settings_helper.rb

@@ -291,7 +291,8 @@ module ApplicationSettingsHelper
       :snowplow_enabled,
       :snowplow_site_id,
       :push_event_hooks_limit,
-      :push_event_activities_limit
+      :push_event_activities_limit,
+      :custom_http_clone_url_root
     ]
   end
 

app/models/application_setting_implementation.rb

@@ -128,7 +128,8 @@ module ApplicationSettingImplementation
         snowplow_collector_hostname: nil,
         snowplow_cookie_domain: nil,
         snowplow_enabled: false,
-        snowplow_site_id: nil
+        snowplow_site_id: nil,
+        custom_http_clone_url_root: nil
       }
     end
 

app/models/project.rb

@@ -1036,8 +1036,8 @@ class Project < ApplicationRecord
     end
   end
 
-  def web_url
-    Gitlab::Routing.url_helpers.project_url(self)
+  def web_url(only_path: nil)
+    Gitlab::Routing.url_helpers.project_url(self, only_path: only_path)
   end
 
   def readme_url
@@ -1316,7 +1316,18 @@ class Project < ApplicationRecord
   end
 
   def http_url_to_repo
-    "#{web_url}.git"
+    custom_root = Gitlab::CurrentSettings.custom_http_clone_url_root
+
+    project_url = if custom_root.present?
+                    Gitlab::Utils.append_path(
+                      custom_root,
+                      web_url(only_path: true)
+                    )
+                  else
+                    web_url
+                  end
+
+    "#{project_url}.git"
   end
 
   # Is overridden in EE

app/models/project_wiki.rb

@@ -54,7 +54,7 @@ class ProjectWiki
   end
 
   def http_url_to_repo
-    "#{Gitlab.config.gitlab.url}/#{full_path}.git"
+    @project.http_url_to_repo.sub(%r{git\z}, 'wiki.git')
   end
 
   def wiki_base_path

app/views/admin/application_settings/_visibility_and_access.html.haml

@@ -53,6 +53,11 @@
       = select(:application_setting, :enabled_git_access_protocol, [['Both SSH and HTTP(S)', nil], ['Only SSH', 'ssh'], ['Only HTTP(S)', 'http']], {}, class: 'form-control')
       %span.form-text.text-muted#clone-protocol-help
         = _('Allow only the selected protocols to be used for Git access.')
+    .form-group
+      = f.label :custom_http_clone_url_root, _('Custom Git clone URL for HTTP(S)'), class: 'label-bold'
+      = f.text_field :custom_http_clone_url_root, class: 'form-control', placeholder: 'https://git.example.com', :'aria-describedby' => 'custom_http_clone_url_root_help_block'
+      %span.form-text.text-muted#custom_http_clone_url_root_help_block
+        = _('Replaces the clone URL root.')
 
     - ApplicationSetting::SUPPORTED_KEY_TYPES.each do |type|
       - field_name = :"#{type}_key_restriction"

changelogs/unreleased/geo-mk-add-custom-http-clone-url-root.yml

+---
+title: Add "Custom HTTP Git clone URL root" setting
+merge_request: 18422
+author:
+type: added

db/migrate/20191009222222_add_custom_http_clone_url_root_to_application_settings.rb

+# frozen_string_literal: true
+
+# See http://doc.gitlab.com/ce/development/migration_style_guide.html
+# for more information on how to write migrations for GitLab.
+
+class AddCustomHttpCloneUrlRootToApplicationSettings < ActiveRecord::Migration[5.2]
+  # Set this constant to true if this migration requires downtime.
+  DOWNTIME = false
+
+  def change
+    add_column :application_settings, :custom_http_clone_url_root, :string, limit: 511
+  end
+end

db/schema.rb

@@ -340,6 +340,7 @@ ActiveRecord::Schema.define(version: 2019_10_16_220135) do
     t.integer "throttle_incident_management_notification_per_period", default: 3600
     t.integer "push_event_hooks_limit", default: 3, null: false
     t.integer "push_event_activities_limit", default: 3, null: false
+    t.string "custom_http_clone_url_root", limit: 511
     t.index ["custom_project_templates_group_id"], name: "index_application_settings_on_custom_project_templates_group_id"
     t.index ["file_template_project_id"], name: "index_application_settings_on_file_template_project_id"
     t.index ["instance_administration_project_id"], name: "index_applicationsettings_on_instance_administration_project_id"

doc/administration/geo/replication/location_aware_git_url.md

@@ -95,13 +95,12 @@ on the external URL of the current host. For example:
 
 ![Clone panel](img/single_git_clone_panel.png)
 
-However, you can customize the SSH remote URL to use the location-aware
+You can customize the SSH remote URL to use the location-aware
 `git.example.com`. To do so, change the SSH remote URL's host by setting
 `gitlab_rails['gitlab_ssh_host']` in `gitlab.rb` of web nodes.
 
-Unfortunately the means to specify a custom HTTP clone URL is not yet
-implemented. The feature request can be found at
-[Customizable Git HTTP clone root URL](https://gitlab.com/gitlab-org/gitlab/issues/31949).
+You can customize the HTTP remote URL as shown in
+[Custom Git clone URL for HTTP(S)](../../../user/admin_area/settings/visibility_and_access_controls.md#custom-git-clone-url-for-https).
 
 ## Example Git request handling behavior
 

doc/user/admin_area/settings/visibility_and_access_controls.md

@@ -135,6 +135,30 @@ Starting with [GitLab 10.7](https://gitlab.com/gitlab-org/gitlab-ce/merge_reques
 HTTP(S) protocol will be allowed for Git clone or fetch requests done by GitLab Runner
 from CI/CD jobs, even if _Only SSH_ was selected.
 
+## Custom Git clone URL for HTTP(S)
+
+You can customize project Git clone URLs for HTTP(S). This will affect the clone
+panel:
+
+![Clone panel](img/clone_panel.png)
+
+For example, if your
+GitLab instance is at `https://example.com`, then project clone URLs look like
+`https://example.com/foo/bar.git`. If you'd to provide clone URLs that look like
+`https://git.example.com/gitlab/foo/bar.git` instead, then you can set this
+setting to `https://git.example.com/gitlab/`.
+
+![Custom Git clone URL for HTTP](img/custom_git_clone_url_for_https.png)
+
+To specify a custom Git clone URL for HTTP(S):
+
+1. Enter a root URL for **Custom Git clone URL for HTTP(S)**.
+1. Click on **Save changes**.
+
+NOTE: **Note:**
+SSH clone URLs can be customized in `gitlab.rb` by setting
+`gitlab_rails["gitlab_ssh_host"]` and other related settings.
+
 ## RSA, DSA, ECDSA, ED25519 SSH keys
 
 These options specify the permitted types and lengths for SSH keys.

locale/gitlab.pot

@@ -4828,6 +4828,9 @@ msgstr ""
 msgid "Custom CI configuration path"
 msgstr ""
 
+msgid "Custom Git clone URL for HTTP(S)"
+msgstr ""
+
 msgid "Custom hostname (for private commit emails)"
 msgstr ""
 
@@ -13738,6 +13741,9 @@ msgstr ""
 msgid "Replaced all labels with %{label_references} %{label_text}."
 msgstr ""
 
+msgid "Replaces the clone URL root."
+msgstr ""
+
 msgid "Reply by email"
 msgstr ""
 

spec/models/project_spec.rb

@@ -631,10 +631,40 @@ describe Project do
   describe "#web_url" do
     let(:project) { create(:project, path: "somewhere") }
 
+    context 'when given the only_path option' do
+      subject { project.web_url(only_path: only_path) }
+
+      context 'when only_path is false' do
+        let(:only_path) { false }
+
+        it 'returns the full web URL for this repo' do
+          expect(subject).to eq("#{Gitlab.config.gitlab.url}/#{project.namespace.full_path}/somewhere")
+        end
+      end
+
+      context 'when only_path is true' do
+        let(:only_path) { true }
+
+        it 'returns the relative web URL for this repo' do
+          expect(subject).to eq("/#{project.namespace.full_path}/somewhere")
+        end
+      end
+
+      context 'when only_path is nil' do
+        let(:only_path) { nil }
+
+        it 'returns the full web URL for this repo' do
+          expect(subject).to eq("#{Gitlab.config.gitlab.url}/#{project.namespace.full_path}/somewhere")
+        end
+      end
+    end
+
+    context 'when not given the only_path option' do
       it 'returns the full web URL for this repo' do
         expect(project.web_url).to eq("#{Gitlab.config.gitlab.url}/#{project.namespace.full_path}/somewhere")
       end
     end
+  end
 
   describe "#readme_url" do
     context 'with a non-existing repository' do
@@ -3226,15 +3256,60 @@ describe Project do
   describe '#http_url_to_repo' do
     let(:project) { create(:project) }
 
+    context 'when a custom HTTP clone URL root is not set' do
       it 'returns the url to the repo without a username' do
         expect(project.http_url_to_repo).to eq("#{project.web_url}.git")
         expect(project.http_url_to_repo).not_to include('@')
       end
     end
 
+    context 'when a custom HTTP clone URL root is set' do
+      before do
+        stub_application_setting(custom_http_clone_url_root: custom_http_clone_url_root)
+      end
+
+      context 'when custom HTTP clone URL root has a relative URL root' do
+        context 'when custom HTTP clone URL root ends with a slash' do
+          let(:custom_http_clone_url_root) { 'https://git.example.com:51234/mygitlab/' }
+
+          it 'returns the url to the repo, with the root replaced with the custom one' do
+            expect(project.http_url_to_repo).to eq("https://git.example.com:51234/mygitlab/#{project.full_path}.git")
+          end
+        end
+
+        context 'when custom HTTP clone URL root does not end with a slash' do
+          let(:custom_http_clone_url_root) { 'https://git.example.com:51234/mygitlab' }
+
+          it 'returns the url to the repo, with the root replaced with the custom one' do
+            expect(project.http_url_to_repo).to eq("https://git.example.com:51234/mygitlab/#{project.full_path}.git")
+          end
+        end
+      end
+
+      context 'when custom HTTP clone URL root does not have a relative URL root' do
+        context 'when custom HTTP clone URL root ends with a slash' do
+          let(:custom_http_clone_url_root) { 'https://git.example.com:51234/' }
+
+          it 'returns the url to the repo, with the root replaced with the custom one' do
+            expect(project.http_url_to_repo).to eq("https://git.example.com:51234/#{project.full_path}.git")
+          end
+        end
+
+        context 'when custom HTTP clone URL root does not end with a slash' do
+          let(:custom_http_clone_url_root) { 'https://git.example.com:51234' }
+
+          it 'returns the url to the repo, with the root replaced with the custom one' do
+            expect(project.http_url_to_repo).to eq("https://git.example.com:51234/#{project.full_path}.git")
+          end
+        end
+      end
+    end
+  end
+
   describe '#lfs_http_url_to_repo' do
     let(:project) { create(:project) }
 
+    context 'when a custom HTTP clone URL root is not set' do
       it 'returns the url to the repo without a username' do
         lfs_http_url_to_repo = project.lfs_http_url_to_repo('operation_that_doesnt_matter')
 
@@ -3243,6 +3318,19 @@ describe Project do
       end
     end
 
+    context 'when a custom HTTP clone URL root is set' do
+      before do
+        stub_application_setting(custom_http_clone_url_root: 'https://git.example.com:51234')
+      end
+
+      it 'returns the url to the repo, with the root replaced with the custom one' do
+        lfs_http_url_to_repo = project.lfs_http_url_to_repo('operation_that_doesnt_matter')
+
+        expect(lfs_http_url_to_repo).to eq("https://git.example.com:51234/#{project.full_path}.git")
+      end
+    end
+  end
+
   describe '#pipeline_status' do
     let(:project) { create(:project, :repository) }
     it 'builds a pipeline status' do

spec/models/project_wiki_spec.rb

@@ -47,6 +47,7 @@ describe ProjectWiki do
   describe "#http_url_to_repo" do
     let(:project) { create :project }
 
+    context 'when a custom HTTP clone URL root is not set' do
       it 'returns the full http url to the repo' do
         expected_url = "#{Gitlab.config.gitlab.url}/#{subject.full_path}.git"
 
@@ -55,6 +56,19 @@ describe ProjectWiki do
       end
     end
 
+    context 'when a custom HTTP clone URL root is set' do
+      before do
+        stub_application_setting(custom_http_clone_url_root: 'https://git.example.com:51234')
+      end
+
+      it 'returns the full http url to the repo, with the root replaced with the custom one' do
+        expected_url = "https://git.example.com:51234/#{subject.full_path}.git"
+
+        expect(project_wiki.http_url_to_repo).to eq(expected_url)
+      end
+    end
+  end
+
   describe "#wiki_base_path" do
     it "returns the wiki base path" do
       wiki_base_path = "#{Gitlab.config.gitlab.relative_url_root}/#{project.full_path}/wikis"