rubocop/cop/rspec/avoid_conditional_statements.rb


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

# 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 statement 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.source : node.keyword

          add_offense(node, message: format(MESSAGE, conditional: conditional))
        end
      end
    end
  end
end