spec/support/rspec_order.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
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

# frozen_string_literal: true

require 'yaml'
require 'rspec/core/formatters/base_formatter'

module Support
  module RspecOrder
    TODO_YAML = File.join(__dir__, 'rspec_order_todo.yml')

    module_function

    def order_for(example_group)
      order_from_env || random_order(example_group)
    end

    def order_from_env
      return @order_from_env if defined?(@order_from_env)

      # Passing custom defined order via `--order NAME` is not supported.
      # For example, `--order reverse` does not work so we are passing it via
      # environment variable RSPEC_ORDER.
      @order_from_env = ENV['RSPEC_ORDER']
    end

    def random_order(example_group)
      path = example_group.metadata.fetch(:file_path)

      :random unless potential_order_dependent?(path)
    end

    def potential_order_dependent?(path)
      @todo ||= YAML.load_file(TODO_YAML).to_set # rubocop:disable Gitlab/PredicateMemoization -- @todo is never `nil` or `false`.

      @todo.include?(path)
    end

    # Adds '# order <ORDER>` below the example group description if the order
    # has been set to help debugging in case of failure.
    #
    # Previously, we've modified metadata[:description] directly but that led
    # to bugs. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96137
    class RSpecFormatter < RSpec::Core::Formatters::BaseFormatter
      RSpec::Core::Formatters.register self, :example_group_started

      # See https://github.com/rspec/rspec-core/blob/v3.11.0/lib/rspec/core/formatters/documentation_formatter.rb#L24-L29
      def example_group_started(notification)
        order = notification.group.metadata[:order]

        output.puts "  # order #{order}" if order
      end

      # Print order information only with `--format documentation`.
      def self.add_formatter_to(config)
        documentation_formatter = config.formatters
          .find { |formatter| formatter.is_a?(RSpec::Core::Formatters::DocumentationFormatter) }
        return unless documentation_formatter

        config.add_formatter self, documentation_formatter.output
      end
    end
  end
end

RSpec.configure do |config|
  Support::RspecOrder::RSpecFormatter.add_formatter_to(config)

  # Useful to find order-dependent specs.
  config.register_ordering(:reverse, &:reverse)

  # Randomization can be reproduced across test runs.
  Kernel.srand config.seed

  config.on_example_group_definition do |example_group|
    order = Support::RspecOrder.order_for(example_group)

    example_group.metadata[:order] = order.to_sym if order
  end
end