Add latest changes from gitlab-org/gitlab@master

1 files changed, 51 insertions, 0 deletions

diff --git a/spec/support/rspec_order.rb b/spec/support/rspec_order.rb
new file mode 100644
index 00000000000..58f1fe29357
--- /dev/null
+++ b/spec/support/rspec_order.rb
@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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.include?(path)
+    end
+  end
+end
+
+RSpec.configure do |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)
+
+    if order
+      example_group.metadata[:order] = order.to_sym
+      example_group.metadata[:description] += " (order #{order})"
+    end
+  end
+end