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
|
# frozen_string_literal: true
require 'rubocop/cop/rspec/base'
module RuboCop
module Cop
module RSpec
# Ensures that shared examples and shared context don't have any metadata.
#
# @example
#
# # bad
# RSpec.shared_examples 'an external link with rel attribute', feature_category: :team_planning do
# end
#
# RSpec.shared_examples 'an external link with rel attribute', :aggregate_failures do
# end
#
# RSpec.shared_context 'an external link with rel attribute', :aggregate_failures do
# end
#
# # good
# RSpec.shared_examples 'an external link with rel attribute' do
# end
#
# shared_examples 'an external link with rel attribute' do
# end
#
# it 'adds rel="nofollow" to external links', feature_category: :team_planning do
# end
class SharedGroupsMetadata < RuboCop::Cop::RSpec::Base
MSG = 'Avoid using metadata on shared examples and shared context. They might cause flaky tests. See https://gitlab.com/gitlab-org/gitlab/-/issues/404388'
# @!method metadata_value(node)
def_node_matcher :metadata_value, <<~PATTERN
(block
(send #rspec? {#SharedGroups.all} _description $_ ...)
...
)
PATTERN
def on_block(node)
value_node = metadata_value(node)
return unless value_node
add_offense(value_node, message: MSG)
end
end
end
end
end
|
