summaryrefslogtreecommitdiff
path: root/spec/validators
diff options
context:
space:
mode:
authorBob Van Landuyt <bob@gitlab.com>2017-05-02 11:48:54 +0200
committerBob Van Landuyt <bob@gitlab.com>2017-05-02 11:48:54 +0200
commite2b9420c11cc5f328fc4014f5bfe66bacd3c8028 (patch)
tree2c3a27dfc3cb57e070694a793f315eb23c21f22f /spec/validators
parenta035ebbe069fa6b203c279c8944b447f8fe896c5 (diff)
downloadgitlab-ce-e2b9420c11cc5f328fc4014f5bfe66bacd3c8028.tar.gz
Add a better error message when a certain path is missing
Diffstat (limited to 'spec/validators')
-rw-r--r--spec/validators/dynamic_path_validator_spec.rb37
1 files changed, 34 insertions, 3 deletions
diff --git a/spec/validators/dynamic_path_validator_spec.rb b/spec/validators/dynamic_path_validator_spec.rb
index deeff477193..b114bfc1bca 100644
--- a/spec/validators/dynamic_path_validator_spec.rb
+++ b/spec/validators/dynamic_path_validator_spec.rb
@@ -37,6 +37,24 @@ describe DynamicPathValidator do
described_class::WILDCARD_ROUTES.include?(path.split('/').first)
end
+ def failure_message(missing_words, constant_name, migration_helper)
+ missing_words = Array(missing_words)
+ <<-MSG
+ Found new routes that could cause conflicts with existing namespaced routes
+ for groups or projects.
+
+ Add <#{missing_words.join(', ')}> to `DynamicPathValidator::#{constant_name}
+ to make sure no projects or namespaces can be created with those paths.
+
+ To rename any existing records with those paths you can use the
+ `Gitlab::Database::RenameReservedpathsMigration::<VERSION>.#{migration_helper}`
+ migration helper.
+
+ Make sure to make a note of the renamed records in the release blog post.
+
+ MSG
+ end
+
let(:all_routes) do
Rails.application.routes.routes.routes.
map { |r| r.path.spec.to_s }
@@ -101,13 +119,25 @@ describe DynamicPathValidator do
describe 'TOP_LEVEL_ROUTES' do
it 'includes all the top level namespaces' do
- expect(described_class::TOP_LEVEL_ROUTES).to include(*top_level_words)
+ failure_block = lambda do
+ missing_words = top_level_words - described_class::TOP_LEVEL_ROUTES
+ failure_message(missing_words, 'TOP_LEVEL_ROUTES', 'rename_root_paths')
+ end
+
+ expect(described_class::TOP_LEVEL_ROUTES)
+ .to include(*top_level_words), failure_block
end
end
describe 'GROUP_ROUTES' do
it "don't contain a second wildcard" do
- expect(described_class::GROUP_ROUTES).to include(*paths_after_group_id)
+ failure_block = lambda do
+ missing_words = paths_after_group_id - described_class::GROUP_ROUTES
+ failure_message(missing_words, 'GROUP_ROUTES', 'rename_child_paths')
+ end
+
+ expect(described_class::GROUP_ROUTES)
+ .to include(*paths_after_group_id), failure_block
end
end
@@ -115,7 +145,8 @@ describe DynamicPathValidator do
it 'includes all paths that can be used after a namespace/project path' do
aggregate_failures do
all_wildcard_paths.each do |path|
- expect(wildcards_include?(path)).to be(true), "Expected #{path} to be rejected"
+ expect(wildcards_include?(path))
+ .to be(true), failure_message(path, 'WILDCARD_ROUTES', 'rename_wildcard_paths')
end
end
end