diff options
Diffstat (limited to 'rubocop/cop/rspec/avoid_conditional_statements.rb')
| -rw-r--r-- | rubocop/cop/rspec/avoid_conditional_statements.rb | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/rubocop/cop/rspec/avoid_conditional_statements.rb b/rubocop/cop/rspec/avoid_conditional_statements.rb new file mode 100644 index 00000000000..48c230a6a7a --- /dev/null +++ b/rubocop/cop/rspec/avoid_conditional_statements.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +require 'rubocop-rspec' + +module RuboCop + module Cop + module RSpec + # This cop checks for the usage of conditional statements in specs. + # + # @example + # + # # bad + # + # page.has_css?('[data-testid="begin-commit-button"]') ? find('[data-testid="begin-commit-button"]').click : nil + # + # if page.has_css?('[data-testid="begin-commit-button"]') + # find('[data-testid="begin-commit-button"]').click + # end + # + # unless page.has_css?('[data-testid="begin-commit-button"]') + # find('[data-testid="begin-commit-button"]').click + # end + class AvoidConditionalStatements < RuboCop::Cop::Base + MESSAGE = "Don't use `%{conditional}` conditional statments in specs, it might create flakiness. " \ + "See https://gitlab.com/gitlab-org/gitlab/-/issues/385304#note_1345437109" + + def on_if(node) + conditional = node.ternary? ? "#{node.condition.to_s.delete!("\n")} ? (ternary)" : node.keyword + + add_offense(node, message: format(MESSAGE, conditional: conditional)) + end + end + end + end +end |