blob: 9ef880d6aac20947f1cdb1e8d96ad6508db92d38 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# frozen_string_literal: true
require 'rubocop/cop/rspec/base'
require 'rubocop/cop/rspec/mixin/top_level_group'
require 'did_you_mean'
module RuboCop
module Cop
module RSpec
# Ensures that feature categories in specs are valid.
#
# @example
#
# # bad
# RSpec.describe 'foo', feature_category: :invalid do
# end
#
# RSpec.describe 'foo', feature_category: :not_owned do
# end
#
# # good
#
# RSpec.describe 'foo', feature_category: :wiki do
# end
#
# RSpec.describe 'foo', feature_category: :tooling do
# end
#
class InvalidFeatureCategory < RuboCop::Cop::RSpec::Base
MSG = 'Please use a valid feature category. %{msg_suggestion}' \
'See https://docs.gitlab.com/ee/development/feature_categorization/#rspec-examples.'
MSG_DID_YOU_MEAN = 'Did you mean `:%{suggestion}`? '
MSG_SYMBOL = 'Please use a symbol as value.'
FEATURE_CATEGORIES_PATH = File.expand_path('../../../config/feature_categories.yml', __dir__).freeze
# List of feature categories which are not defined in config/feature_categories.yml
CUSTOM_FEATURE_CATEGORIES = [
# https://docs.gitlab.com/ee/development/feature_categorization/#tooling-feature-category
:tooling,
# https://docs.gitlab.com/ee/development/feature_categorization/#shared-feature-category
:shared
].to_set.freeze
# @!method feature_category?(node)
def_node_matcher :feature_category_value, <<~PATTERN
(block
(send #rspec? {#ExampleGroups.all #Examples.all} ...
(hash <(pair (sym :feature_category) $_) ...>)
)
...
)
PATTERN
def on_block(node)
value_node = feature_category_value(node)
return unless value_node
unless value_node.sym_type?
add_offense(value_node, message: MSG_SYMBOL)
return
end
return if valid_feature_category?(value_node)
message = format(MSG, msg_suggestion: suggestion_message(value_node))
add_offense(value_node, message: message)
end
# Used by RuboCop to invalidate its cache if the contents of
# config/feature_categories.yml changes.
def external_dependency_checksum
@external_dependency_checksum ||=
Digest::SHA256.file(FEATURE_CATEGORIES_PATH).hexdigest
end
private
def suggestion_message(value_node)
spell = DidYouMean::SpellChecker.new(dictionary: self.class.feature_categories)
suggestions = spell.correct(value_node.value)
return if suggestions.none?
format(MSG_DID_YOU_MEAN, suggestion: suggestions.first)
end
def valid_feature_category?(node)
self.class.feature_categories.include?(node.value)
end
def self.feature_categories
@feature_categories ||= YAML
.load_file(FEATURE_CATEGORIES_PATH)
.map(&:to_sym)
.to_set
.union(CUSTOM_FEATURE_CATEGORIES)
end
end
end
end
end
|
