blob: a247bd807b0d1350ac1c76116a5586222eca4d72 (
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
|
# frozen_string_literal: true
require 'rubocop/cop/rspec/base'
require 'rubocop/cop/rspec/mixin/top_level_group'
require_relative '../../feature_categories'
module RuboCop
module Cop
module RSpec
# Ensures that feature categories in specs are present and valid.
#
# @example
#
# # bad
# RSpec.describe 'foo' do
# end
#
# RSpec.describe 'foo', feature_category: :invalid do
# context 'a context', feature_category: :aip do
# end
# end
#
# RSpec.describe 'foo', feature_category: :not_owned do
# end
#
# # good
#
# RSpec.describe 'foo', feature_category: :wiki do
# context 'a context', feature_category: :api do
# end
# end
#
# RSpec.describe 'foo', feature_category: :tooling do
# end
#
class FeatureCategory < RuboCop::Cop::RSpec::Base
include RuboCop::Cop::RSpec::TopLevelGroup
DOCUMENT_LINK = 'https://docs.gitlab.com/ee/development/feature_categorization/#rspec-examples'
# @!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_top_level_example_group(node)
check_feature_category(node, optional: false)
end
def on_block(node)
check_feature_category(node, optional: true)
end
def external_dependency_checksum
FeatureCategories.config_checksum
end
private
def check_feature_category(node, optional:)
value_node = feature_category_value(node)
return if optional && !value_node
feature_categories.check(
value_node: value_node,
document_link: DOCUMENT_LINK
) do |message|
add_offense(value_node || node, message: message)
end
end
def feature_categories
@feature_categories ||=
FeatureCategories.new(FeatureCategories.available_with_custom)
end
end
end
end
end
|
