Resolve "Make gitlab-shell go through Workhorse"

changelogs/unreleased/4583-make-gitlab-shell-go-through-workhorse.yml

+---
+title: Make gitlab-shell go through Workhorse
+merge_request: 4498
+author:
+type: changed

files/gitlab-cookbooks/gitlab/recipes/gitlab-shell.rb

@@ -49,10 +49,15 @@ end
   end
 end
-# If no internal_api_url is specified, default to the IP/port Unicorn listens on
-webserver_service = WebServerHelper.service_name
-api_url = node['gitlab']['gitlab-rails']['internal_api_url']
-api_url ||= "http://#{node['gitlab'][webserver_service]['listen']}:#{node['gitlab'][webserver_service]['port']}#{node['gitlab'][webserver_service]['relative_url']}"
+gitlab_url = node['gitlab']['gitlab-rails']['internal_api_url']
+
+# If no internal_api_url is specified, default to workhorse settings
+use_socket = node['gitlab']['gitlab-workhorse']['listen_network'] == "unix"
+workhorse_url = node['gitlab']['gitlab-workhorse']['listen_addr']
+relative_path = Gitlab['gitlab_workhorse']['relative_url']
+
+gitlab_url ||= use_socket ? "http+unix://#{ERB::Util.url_encode(workhorse_url)}" : "http://#{workhorse_url}#{relative_path}"
+gitlab_relative_path = relative_path || '' if use_socket
 templatesymlink "Create a config.yml and create a symlink to Rails root" do
   link_from File.join(gitlab_shell_dir, "config.yml")
@@ -63,7 +68,8 @@ templatesymlink "Create a config.yml and create a symlink to Rails root" do
   group git_group
   variables({
               user: git_user,
-              api_url: api_url,
+              gitlab_url: gitlab_url,
+              gitlab_relative_path: gitlab_relative_path,
               authorized_keys: authorized_keys,
               log_file: File.join(log_directory, "gitlab-shell.log"),
               log_level: node['gitlab']['gitlab-shell']['log_level'],

files/gitlab-cookbooks/gitlab/templates/default/gitlab-shell-config.yml.erb

@@ -6,7 +6,11 @@
 user: <%= @user %>
 # Url to gitlab instance. Used for api calls. May but need not end with a slash.
-gitlab_url: "<%= @api_url %>"
+gitlab_url: "<%= @gitlab_url %>"
+
+<% if @gitlab_relative_path %>
+gitlab_relative_url_root: <%= @gitlab_relative_path %>
+<% end %>
 http_settings:
   <%= @http_settings.to_json if @http_settings %>

spec/chef/recipes/gitlab-shell_spec.rb

@@ -48,7 +48,9 @@ RSpec.describe 'gitlab::gitlab-shell' do
           log_file: '/var/log/gitlab/gitlab-shell/gitlab-shell.log',
           log_format: "json",
           custom_hooks_dir: nil,
-          migration: { enabled: true, features: [] }
+          migration: { enabled: true, features: [] },
+          gitlab_url: 'http+unix://%2Fvar%2Fopt%2Fgitlab%2Fgitlab-workhorse%2Fsocket',
+          gitlab_relative_path: ''
         )
       )
     end
@@ -170,5 +172,71 @@ RSpec.describe 'gitlab::gitlab-shell' do
         )
       end
     end
+
+    context 'with a non-default workhorse unix socket' do
+      before do
+        stub_gitlab_rb(gitlab_workhorse: { listen_addr: '/fake/workhorse/socket' })
+      end
+
+      it 'create config file with provided values' do
+        expect(chef_run).to create_templatesymlink('Create a config.yml and create a symlink to Rails root').with_variables(
+          hash_including(
+            gitlab_url: 'http+unix://%2Ffake%2Fworkhorse%2Fsocket',
+            gitlab_relative_path: ''
+          )
+        )
+      end
+    end
+
+    context 'with a tcp workhorse listener' do
+      before do
+        stub_gitlab_rb(
+          external_url: 'http://example.com/gitlab',
+          gitlab_workhorse: {
+            listen_network: 'tcp',
+            listen_addr: 'localhost:1234'
+          }
+        )
+      end
+
+      it 'create config file with provided values' do
+        expect(chef_run).to create_templatesymlink('Create a config.yml and create a symlink to Rails root').with_variables(
+          hash_including(
+            gitlab_url: 'http://localhost:1234/gitlab',
+            gitlab_relative_path: nil
+          )
+        )
+      end
+    end
+
+    context 'with relative path in external_url' do
+      before do
+        stub_gitlab_rb(external_url: 'http://example.com/gitlab')
+      end
+
+      it 'create config file with provided values' do
+        expect(chef_run).to create_templatesymlink('Create a config.yml and create a symlink to Rails root').with_variables(
+          hash_including(
+            gitlab_url: 'http+unix://%2Fvar%2Fopt%2Fgitlab%2Fgitlab-workhorse%2Fsocket',
+            gitlab_relative_path: '/gitlab'
+          )
+        )
+      end
+    end
+
+    context 'with internal_api_url specified' do
+      before do
+        stub_gitlab_rb(gitlab_rails: { internal_api_url: 'http://localhost:8080' })
+      end
+
+      it 'create config file with provided values' do
+        expect(chef_run).to create_templatesymlink('Create a config.yml and create a symlink to Rails root').with_variables(
+          hash_including(
+            gitlab_url: 'http://localhost:8080',
+            gitlab_relative_path: ''
+          )
+        )
+      end
+    end
   end
 end