Move spec helpers/matchers/shared examples/contexts to their relevant folder

Signed-off-by: Rémy Coutable <remy@rymai.me>

1 files changed, 102 insertions, 0 deletions

diff --git a/spec/support/helpers/stub_configuration.rb b/spec/support/helpers/stub_configuration.rb
new file mode 100644
index 00000000000..1823099dd9c
--- /dev/null
+++ b/spec/support/helpers/stub_configuration.rb
@@ -0,0 +1,102 @@
+require 'active_support/core_ext/hash/transform_values'
+require 'active_support/hash_with_indifferent_access'
+
+module StubConfiguration
+  def stub_application_setting(messages)
+    add_predicates(messages)
+
+    # Stubbing both of these because we're not yet consistent with how we access
+    # current application settings
+    allow_any_instance_of(ApplicationSetting).to receive_messages(to_settings(messages))
+    allow(Gitlab::CurrentSettings.current_application_settings)
+      .to receive_messages(to_settings(messages))
+
+    # Ensure that we don't use the Markdown cache when stubbing these values
+    allow_any_instance_of(ApplicationSetting).to receive(:cached_html_up_to_date?).and_return(false)
+  end
+
+  def stub_not_protect_default_branch
+    stub_application_setting(
+      default_branch_protection: Gitlab::Access::PROTECTION_NONE)
+  end
+
+  def stub_config_setting(messages)
+    allow(Gitlab.config.gitlab).to receive_messages(to_settings(messages))
+  end
+
+  def stub_gravatar_setting(messages)
+    allow(Gitlab.config.gravatar).to receive_messages(to_settings(messages))
+  end
+
+  def stub_incoming_email_setting(messages)
+    allow(Gitlab.config.incoming_email).to receive_messages(to_settings(messages))
+  end
+
+  def stub_mattermost_setting(messages)
+    allow(Gitlab.config.mattermost).to receive_messages(to_settings(messages))
+  end
+
+  def stub_omniauth_setting(messages)
+    allow(Gitlab.config.omniauth).to receive_messages(to_settings(messages))
+  end
+
+  def stub_backup_setting(messages)
+    allow(Gitlab.config.backup).to receive_messages(to_settings(messages))
+  end
+
+  def stub_lfs_setting(messages)
+    allow(Gitlab.config.lfs).to receive_messages(to_settings(messages))
+  end
+
+  def stub_artifacts_setting(messages)
+    allow(Gitlab.config.artifacts).to receive_messages(to_settings(messages))
+  end
+
+  def stub_storage_settings(messages)
+    messages.deep_stringify_keys!
+
+    # Default storage is always required
+    messages['default'] ||= Gitlab.config.repositories.storages.default
+    messages.each do |storage_name, storage_hash|
+      if !storage_hash.key?('path') || storage_hash['path'] == Gitlab::GitalyClient::StorageSettings::Deprecated
+        storage_hash['path'] = TestEnv.repos_path
+      end
+
+      messages[storage_name] = Gitlab::GitalyClient::StorageSettings.new(storage_hash.to_h)
+    end
+
+    allow(Gitlab.config.repositories).to receive(:storages).and_return(Settingslogic.new(messages))
+  end
+
+  private
+
+  # Modifies stubbed messages to also stub possible predicate versions
+  #
+  # Examples:
+  #
+  #   add_predicates(foo: true)
+  #   # => {foo: true, foo?: true}
+  #
+  #   add_predicates(signup_enabled?: false)
+  #   # => {signup_enabled? false}
+  def add_predicates(messages)
+    # Only modify keys that aren't already predicates
+    keys = messages.keys.map(&:to_s).reject { |k| k.end_with?('?') }
+
+    keys.each do |key|
+      predicate = key + '?'
+      messages[predicate.to_sym] = messages[key.to_sym]
+    end
+  end
+
+  # Support nested hashes by converting all values into Settingslogic objects
+  def to_settings(hash)
+    hash.transform_values do |value|
+      if value.is_a? Hash
+        Settingslogic.new(value.deep_stringify_keys)
+      else
+        value
+      end
+    end
+  end
+end