Improve Redis instance test coverage

- add coverage for config file selection
- add coverage for Rails.env-keyed config selection
- consolidate duplicate config file fixtures

lib/gitlab/redis/wrapper.rb

@@ -55,12 +55,14 @@ def default_url
           DEFAULT_REDIS_URL
         end
 
-        # Return the absolute path to a Rails configuration file
-        #
-        # We use this instead of `Rails.root` because for certain tasks
-        # utilizing these classes, `Rails` might not be available.
         def config_file_path(filename)
-          File.expand_path("../../../config/#{filename}", __dir__)
+          File.join(rails_root, 'config', filename)
+        end
+
+        # We need this local implementation of Rails.root because MailRoom
+        # doesn't load Rails.
+        def rails_root
+          File.expand_path('../../..', __dir__)
         end
 
         def config_file_name

spec/config/mail_room_spec.rb

@@ -43,7 +43,7 @@
 
   context 'when both incoming email and service desk email are enabled' do
     let(:gitlab_config_path) { 'spec/fixtures/config/mail_room_enabled.yml' }
-    let(:queues_config_path) { 'spec/fixtures/config/redis_queues_new_format_host.yml' }
+    let(:queues_config_path) { 'spec/fixtures/config/redis_new_format_host.yml' }
     let(:gitlab_redis_queues) { Gitlab::Redis::Queues.new(Rails.env) }
 
     it 'contains the intended configuration' do
@@ -72,7 +72,7 @@
 
   context 'when both incoming email and service desk email are enabled for Microsoft Graph' do
     let(:gitlab_config_path) { 'spec/fixtures/config/mail_room_enabled_ms_graph.yml' }
-    let(:queues_config_path) { 'spec/fixtures/config/redis_queues_new_format_host.yml' }
+    let(:queues_config_path) { 'spec/fixtures/config/redis_new_format_host.yml' }
     let(:gitlab_redis_queues) { Gitlab::Redis::Queues.new(Rails.env) }
 
     it 'contains the intended configuration' do

spec/fixtures/config/redis_cache_config_with_env.yml

-test:
-  url: <%= ENV['TEST_GITLAB_REDIS_CACHE_URL'] %>

spec/fixtures/config/redis_cache_new_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development:
-  url: redis://:mynewpassword@localhost:6380/10
-  sentinels:
-    -
-      host: localhost
-      port: 26380 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26380 # point to sentinel, not to redis port
-test:
-  url: redis://:mynewpassword@localhost:6380/10
-  sentinels:
-    -
-      host: localhost
-      port: 26380 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26380 # point to sentinel, not to redis port
-production:
-  url: redis://:mynewpassword@localhost:6380/10
-  sentinels:
-    -
-      host: replica1
-      port: 26380 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26380 # point to sentinel, not to redis port

spec/fixtures/config/redis_cache_new_format_socket.yml

-development:
-  url: unix:/path/to/redis.cache.sock
-test:
-  url: unix:/path/to/redis.cache.sock
-production:
-  url: unix:/path/to/redis.cache.sock

spec/fixtures/config/redis_cache_old_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development: redis://:mypassword@localhost:6380/10
-test: redis://:mypassword@localhost:6380/10
-production: redis://:mypassword@localhost:6380/10

spec/fixtures/config/redis_cache_old_format_socket.yml

-development: unix:/path/to/old/redis.cache.sock
-test: unix:/path/to/old/redis.cache.sock
-production: unix:/path/to/old/redis.cache.sock

spec/fixtures/config/redis_new_format_host.yml

 # redis://[:password@]host[:port][/db-number][?option=value]
 # more details: http://www.iana.org/assignments/uri-schemes/prov/redis
 development:
-  url: redis://:mynewpassword@localhost:6379/99
+  url: redis://:mynewpassword@development-host:6379/99
   sentinels:
     -
-      host: localhost
+      host: development-replica1
       port: 26379 # point to sentinel, not to redis port
     -
-      host: replica2
+      host: development-replica2
       port: 26379 # point to sentinel, not to redis port
 test:
-  url: redis://:mynewpassword@localhost:6379/99
+  url: redis://:mynewpassword@test-host:6379/99
   sentinels:
     -
-      host: localhost
+      host: test-replica1
       port: 26379 # point to sentinel, not to redis port
     -
-      host: replica2
+      host: test-replica2
       port: 26379 # point to sentinel, not to redis port
 production:
-  url: redis://:mynewpassword@localhost:6379/99
+  url: redis://:mynewpassword@production-host:6379/99
   sentinels:
     -
-      host: replica1
+      host: production-replica1
       port: 26379 # point to sentinel, not to redis port
     -
-      host: replica2
+      host: production-replica2
       port: 26379 # point to sentinel, not to redis port

spec/fixtures/config/redis_queues_config_with_env.yml

-test:
-  url: <%= ENV['TEST_GITLAB_REDIS_QUEUES_URL'] %>

spec/fixtures/config/redis_queues_new_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development:
-  url: redis://:mynewpassword@localhost:6381/11
-  sentinels:
-    -
-      host: localhost
-      port: 26381 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26381 # point to sentinel, not to redis port
-test:
-  url: redis://:mynewpassword@localhost:6381/11
-  sentinels:
-    -
-      host: localhost
-      port: 26381 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26381 # point to sentinel, not to redis port
-production:
-  url: redis://:mynewpassword@localhost:6381/11
-  sentinels:
-    -
-      host: replica1
-      port: 26381 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26381 # point to sentinel, not to redis port

spec/fixtures/config/redis_queues_new_format_socket.yml

-development:
-  url: unix:/path/to/redis.queues.sock
-test:
-  url: unix:/path/to/redis.queues.sock
-production:
-  url: unix:/path/to/redis.queues.sock

spec/fixtures/config/redis_queues_old_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development: redis://:mypassword@localhost:6381/11
-test: redis://:mypassword@localhost:6381/11
-production: redis://:mypassword@localhost:6381/11

spec/fixtures/config/redis_queues_old_format_socket.yml

-development: unix:/path/to/old/redis.queues.sock
-test: unix:/path/to/old/redis.queues.sock
-production: unix:/path/to/old/redis.queues.sock

spec/fixtures/config/redis_shared_state_config_with_env.yml

-test:
-  url: <%= ENV['TEST_GITLAB_REDIS_SHARED_STATE_URL'] %>

spec/fixtures/config/redis_shared_state_new_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development:
-  url: redis://:mynewpassword@localhost:6382/12
-  sentinels:
-    -
-      host: localhost
-      port: 26382 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26382 # point to sentinel, not to redis port
-test:
-  url: redis://:mynewpassword@localhost:6382/12
-  sentinels:
-    -
-      host: localhost
-      port: 26382 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26382 # point to sentinel, not to redis port
-production:
-  url: redis://:mynewpassword@localhost:6382/12
-  sentinels:
-    -
-      host: replica1
-      port: 26382 # point to sentinel, not to redis port
-    -
-      host: replica2
-      port: 26382 # point to sentinel, not to redis port

spec/fixtures/config/redis_shared_state_new_format_socket.yml

-development:
-  url: unix:/path/to/redis.shared_state.sock
-test:
-  url: unix:/path/to/redis.shared_state.sock
-production:
-  url: unix:/path/to/redis.shared_state.sock

spec/fixtures/config/redis_shared_state_old_format_host.yml

-# redis://[:password@]host[:port][/db-number][?option=value]
-# more details: http://www.iana.org/assignments/uri-schemes/prov/redis
-development: redis://:mypassword@localhost:6382/12
-test: redis://:mypassword@localhost:6382/12
-production: redis://:mypassword@localhost:6382/12

spec/fixtures/config/redis_shared_state_old_format_socket.yml

-development: unix:/path/to/old/redis.shared_state.sock
-test: unix:/path/to/old/redis.shared_state.sock
-production: unix:/path/to/old/redis.shared_state.sock

spec/lib/gitlab/redis/cache_spec.rb

@@ -3,19 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Gitlab::Redis::Cache do
-  let(:config_file_name) { "config/redis.cache.yml" }
+  let(:instance_specific_config_file) { "config/redis.cache.yml" }
   let(:environment_config_file_name) { "GITLAB_REDIS_CACHE_CONFIG_FILE" }
-  let(:config_old_format_socket) { "spec/fixtures/config/redis_cache_old_format_socket.yml" }
-  let(:config_new_format_socket) { "spec/fixtures/config/redis_cache_new_format_socket.yml" }
-  let(:old_socket_path) {"/path/to/old/redis.cache.sock" }
-  let(:new_socket_path) {"/path/to/redis.cache.sock" }
-  let(:config_old_format_host) { "spec/fixtures/config/redis_cache_old_format_host.yml" }
-  let(:config_new_format_host) { "spec/fixtures/config/redis_cache_new_format_host.yml" }
-  let(:redis_port) { 6380 }
-  let(:redis_database) { 10 }
-  let(:sentinel_port) { redis_port + 20000 }
-  let(:config_with_environment_variable_inside) { "spec/fixtures/config/redis_cache_config_with_env.yml"}
-  let(:config_env_variable_url) {"TEST_GITLAB_REDIS_CACHE_URL"}
   let(:class_redis_url) { Gitlab::Redis::Cache::DEFAULT_REDIS_CACHE_URL }
 
   include_examples "redis_shared_examples"

spec/lib/gitlab/redis/queues_spec.rb

@@ -3,19 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Gitlab::Redis::Queues do
-  let(:config_file_name) { "config/redis.queues.yml" }
+  let(:instance_specific_config_file) { "config/redis.queues.yml" }
   let(:environment_config_file_name) { "GITLAB_REDIS_QUEUES_CONFIG_FILE" }
-  let(:config_old_format_socket) { "spec/fixtures/config/redis_queues_old_format_socket.yml" }
-  let(:config_new_format_socket) { "spec/fixtures/config/redis_queues_new_format_socket.yml" }
-  let(:old_socket_path) {"/path/to/old/redis.queues.sock" }
-  let(:new_socket_path) {"/path/to/redis.queues.sock" }
-  let(:config_old_format_host) { "spec/fixtures/config/redis_queues_old_format_host.yml" }
-  let(:config_new_format_host) { "spec/fixtures/config/redis_queues_new_format_host.yml" }
-  let(:redis_port) { 6381 }
-  let(:redis_database) { 11 }
-  let(:sentinel_port) { redis_port + 20000 }
-  let(:config_with_environment_variable_inside) { "spec/fixtures/config/redis_queues_config_with_env.yml"}
-  let(:config_env_variable_url) {"TEST_GITLAB_REDIS_QUEUES_URL"}
   let(:class_redis_url) { Gitlab::Redis::Queues::DEFAULT_REDIS_QUEUES_URL }
 
   include_examples "redis_shared_examples"