Merge branch 'wc/no-dup-gitaly-storages' into 'master'

Prevent Gitaly storages from using the same path

See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7564

Merged-by: Will Chandler <wchandler@gitlab.com>
Approved-by: Gabriel Mazetto <gabriel@gitlab.com>
Reviewed-by: Gabriel Mazetto <gabriel@gitlab.com>
Reviewed-by: Will Chandler <wchandler@gitlab.com>
Reviewed-by: Robert Marshall <rmarshall@gitlab.com>

config/software/registry.rb

@@ -19,7 +19,7 @@
 require "#{Omnibus::Config.project_root}/lib/gitlab/version"
 
 name 'registry'
-version = Gitlab::Version.new('registry', 'v3.93.0-gitlab')
+version = Gitlab::Version.new('registry', 'v4.0.0-gitlab')
 
 default_version version.print(false)
 display_version version.print(false).delete_suffix('-gitlab')

files/gitlab-cookbooks/gitaly/libraries/gitaly.rb

@@ -27,6 +27,7 @@ module Gitaly
       parse_git_data_dirs
       parse_gitaly_storages
       parse_gitconfig
+      check_duplicate_storage_paths
     end
 
     def gitaly_address
@@ -160,6 +161,32 @@ module Gitaly
       Chef::Mixin::DeepMerge.deep_merge!(tmp_source_hash, Gitlab['gitaly'])
     end
 
+    # Validate that no storages are sharing the same path.
+    def check_duplicate_storage_paths
+      # Deep copy storages to avoid mutating the original.
+      storages = Marshal.load(Marshal.dump(Gitlab['gitaly']['configuration']['storage']))
+
+      storages.each do |storage|
+        storage[:realpath] =
+          begin
+            File.realpath(storage[:path])
+          rescue Errno::ENOENT
+            storage[:path]
+          end
+      end
+
+      realpath_duplicates = storages.group_by { |storage| storage[:realpath] }.select { |_, entries| entries.size > 1 }
+
+      return if realpath_duplicates.empty?
+
+      output = realpath_duplicates.map do |realpath, entries|
+        names = entries.map { |s| s[:name] }.join(', ')
+        "#{realpath}: #{names}"
+      end
+
+      raise "More than one Gitaly storage assigned to the same realpath:\n  #{output.join('\n  ')}"
+    end
+
     private
 
     def user_config

spec/chef/cookbooks/gitaly/recipes/gitaly_spec.rb

@@ -803,6 +803,48 @@ RSpec.describe 'gitaly' do
               .with_content(%r{\[\[storage\]\]\s+name = "nfs1"\s+path = "/mnt/nfs1/repositories"})
           end
         end
+
+        context 'with multiple storages using the same path' do
+          let(:real_path) { Dir.mktmpdir }
+          let(:other_dir) { Dir.mktmpdir }
+          let(:symlink_path) { File.join(other_dir, 'symlink') }
+
+          before do
+            File.symlink(real_path, symlink_path)
+            stub_gitlab_rb(
+              gitaly: {
+                configuration: {
+                  storage: [
+                    {
+                      'name' => 'default',
+                      'path' => '/var/opt/gitlab/git-data/repositories'
+                    },
+                    {
+                      'name' => 'other',
+                      'path' => '/var/opt/gitlab/git-data/repositories'
+                    },
+                    {
+                      'name' => 'realpath',
+                      'path' => real_path
+                    },
+                    {
+                      'name' => 'symlinked',
+                      'path' => symlink_path,
+                    }
+                  ]
+                }
+              }
+            )
+          end
+
+          after do
+            FileUtils.rm_rf([real_path, other_dir])
+          end
+
+          it 'raises an error' do
+            expect { chef_run }.to raise_error(/More than one Gitaly storage assigned to the same realpath:.*: default.*: realpath/m)
+          end
+        end
       end
     end
   end