diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-23 15:09:36 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-23 15:09:36 +0000 |
commit | 074d013e1eb3f6e0c27f96a3be8b9361254c8a98 (patch) | |
tree | f185c474ddc8624a4793c84b0b1f4cc07349694b /rubocop | |
parent | 8f9beefac3774b30e911fb00a68f4c7a5244cf27 (diff) | |
download | gitlab-ce-074d013e1eb3f6e0c27f96a3be8b9361254c8a98.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'rubocop')
-rw-r--r-- | rubocop/cop/gitlab/duplicate_spec_location.rb | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/rubocop/cop/gitlab/duplicate_spec_location.rb b/rubocop/cop/gitlab/duplicate_spec_location.rb new file mode 100644 index 00000000000..025f75d644f --- /dev/null +++ b/rubocop/cop/gitlab/duplicate_spec_location.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +require 'rubocop/rspec/top_level_describe' + +module RuboCop + module Cop + module Gitlab + # Cop that detects duplicate EE spec files + # + # There should not be files in both ee/spec/*/ee/my_spec.rb and ee/spec/*/my_spec.rb + # + # # bad + # ee/spec/controllers/my_spec.rb # describe MyClass + # ee/spec/controllers/ee/my_spec.rb # describe MyClass + # + # # good, spec for EE extension code + # ee/spec/controllers/ee/my_spec.rb # describe MyClass + # + # # good, spec for EE only code + # ee/spec/controllers/my_spec.rb # describe MyClass + # + class DuplicateSpecLocation < RuboCop::Cop::Cop + include RuboCop::RSpec::TopLevelDescribe + + MSG = 'Duplicate spec location in `%<path>s`.' + + def on_top_level_describe(node, _args) + path = file_path_for_node(node).sub(/\A#{rails_root}\//, '') + duplicate_path = find_duplicate_path(path) + + if duplicate_path && File.exist?(File.join(rails_root, duplicate_path)) + add_offense(node, message: format(MSG, path: duplicate_path)) + end + end + + private + + def ee_spec?(path) + File.fnmatch?('ee/spec/**/*.rb', path, File::FNM_PATHNAME) + end + + def find_duplicate_path(path) + return unless ee_spec?(path) + + if File.fnmatch?('ee/spec/**/ee/**', path) + path.match('\A(ee/spec/[^/]+)/ee/(.+)') do |match| + File.join(match[1], match[2]) + end + else + path.match('\A(ee/spec/[^/]+)/(.+)') do |match| + File.join(match[1], 'ee', match[2]) + end + end + end + + def file_path_for_node(node) + node.location.expression.source_buffer.name + end + + def rails_root + File.expand_path('../../..', __dir__) + end + end + end + end +end |