Merge branch '19572-storage-path-validations-fail-incorrectly-for-some-patterns' into 'master'

Fix a false positive where similar un-nested storage paths were reported as nested

Closes #19572

See merge request !5145

2 files changed, 40 insertions, 18 deletions

diff --git a/config/initializers/6_validations.rb b/config/initializers/6_validations.rb
index 3ba9e36c567..37746968675 100644
--- a/config/initializers/6_validations.rb
+++ b/config/initializers/6_validations.rb
@@ -3,22 +3,27 @@ def storage_name_valid?(name)
 end
 
 def find_parent_path(name, path)
+  parent = Pathname.new(path).realpath.parent
   Gitlab.config.repositories.storages.detect do |n, p|
-    name != n && path.chomp('/').start_with?(p.chomp('/'))
+    name != n && Pathname.new(p).realpath == parent
   end
 end
 
-def error(message)
+def storage_validation_error(message)
   raise "#{message}. Please fix this in your gitlab.yml before starting GitLab."
 end
 
-error('No repository storage path defined') if Gitlab.config.repositories.storages.empty?
+def validate_storages
+  storage_validation_error('No repository storage path defined') if Gitlab.config.repositories.storages.empty?
 
-Gitlab.config.repositories.storages.each do |name, path|
-  error("\"#{name}\" is not a valid storage name") unless storage_name_valid?(name)
+  Gitlab.config.repositories.storages.each do |name, path|
+    storage_validation_error("\"#{name}\" is not a valid storage name") unless storage_name_valid?(name)
 
-  parent_name, _parent_path = find_parent_path(name, path)
-  if parent_name
-    error("#{name} is a nested path of #{parent_name}. Nested paths are not supported for repository storages")
+    parent_name, _parent_path = find_parent_path(name, path)
+    if parent_name
+      storage_validation_error("#{name} is a nested path of #{parent_name}. Nested paths are not supported for repository storages")
+    end
   end
 end
+
+validate_storages unless Rails.env.test?
diff --git a/spec/initializers/6_validations_spec.rb b/spec/initializers/6_validations_spec.rb
index 5178bd130f4..baab30f482f 100644
--- a/spec/initializers/6_validations_spec.rb
+++ b/spec/initializers/6_validations_spec.rb
@@ -1,41 +1,58 @@
 require 'spec_helper'
+require_relative '../../config/initializers/6_validations.rb'
 
 describe '6_validations', lib: true do
+  before :all do
+    FileUtils.mkdir_p('tmp/tests/paths/a/b/c/d')
+    FileUtils.mkdir_p('tmp/tests/paths/a/b/c2')
+    FileUtils.mkdir_p('tmp/tests/paths/a/b/d')
+  end
+
+  after :all do
+    FileUtils.rm_rf('tmp/tests/paths')
+  end
+
   context 'with correct settings' do
     before do
-      mock_storages('foo' => '/a/b/c', 'bar' => 'a/b/d')
+      mock_storages('foo' => 'tmp/tests/paths/a/b/c', 'bar' => 'tmp/tests/paths/a/b/d')
     end
 
     it 'passes through' do
-      expect { load_validations }.not_to raise_error
+      expect { validate_storages }.not_to raise_error
     end
   end
 
   context 'with invalid storage names' do
     before do
-      mock_storages('name with spaces' => '/a/b/c')
+      mock_storages('name with spaces' => 'tmp/tests/paths/a/b/c')
     end
 
     it 'throws an error' do
-      expect { load_validations }.to raise_error('"name with spaces" is not a valid storage name. Please fix this in your gitlab.yml before starting GitLab.')
+      expect { validate_storages }.to raise_error('"name with spaces" is not a valid storage name. Please fix this in your gitlab.yml before starting GitLab.')
     end
   end
 
   context 'with nested storage paths' do
     before do
-      mock_storages('foo' => '/a/b/c', 'bar' => '/a/b/c/d')
+      mock_storages('foo' => 'tmp/tests/paths/a/b/c', 'bar' => 'tmp/tests/paths/a/b/c/d')
     end
 
     it 'throws an error' do
-      expect { load_validations }.to raise_error('bar is a nested path of foo. Nested paths are not supported for repository storages. Please fix this in your gitlab.yml before starting GitLab.')
+      expect { validate_storages }.to raise_error('bar is a nested path of foo. Nested paths are not supported for repository storages. Please fix this in your gitlab.yml before starting GitLab.')
     end
   end
 
-  def mock_storages(storages)
-    allow(Gitlab.config.repositories).to receive(:storages).and_return(storages)
+  context 'with similar but un-nested storage paths' do
+    before do
+      mock_storages('foo' => 'tmp/tests/paths/a/b/c', 'bar' => 'tmp/tests/paths/a/b/c2')
+    end
+
+    it 'passes through' do
+      expect { validate_storages }.not_to raise_error
+    end
   end
 
-  def load_validations
-    load File.join(__dir__, '../../config/initializers/6_validations.rb')
+  def mock_storages(storages)
+    allow(Gitlab.config.repositories).to receive(:storages).and_return(storages)
   end
 end