Merge branch '66966-convert-rails-env-stub-usages-to-use-railshelpers-stub_rails_env-instead' into 'master'

Use stub_rails_env for Rails.env stubbing

Closes #66966

See merge request gitlab-org/gitlab-ce!32625

15 files changed, 25 insertions, 45 deletions

diff --git a/spec/features/help_pages_spec.rb b/spec/features/help_pages_spec.rb
index bcd2b90d3bb..88a7aa51326 100644
--- a/spec/features/help_pages_spec.rb
+++ b/spec/features/help_pages_spec.rb
@@ -58,7 +58,7 @@ describe 'Help Pages' do
     before do
       stub_application_setting(version_check_enabled: true)
 
-      allow(Rails.env).to receive(:production?).and_return(true)
+      stub_rails_env('production')
       allow(VersionCheck).to receive(:url).and_return('/version-check-url')
 
       sign_in(create(:user))
diff --git a/spec/features/user_can_display_performance_bar_spec.rb b/spec/features/user_can_display_performance_bar_spec.rb
index 154e948015f..8b3f193f418 100644
--- a/spec/features/user_can_display_performance_bar_spec.rb
+++ b/spec/features/user_can_display_performance_bar_spec.rb
@@ -37,7 +37,7 @@ describe 'User can display performance bar', :js do
 
   shared_examples 'performance bar is enabled by default in development' do
     before do
-      allow(Rails.env).to receive(:development?).and_return(true)
+      stub_rails_env('development')
     end
 
     it 'shows the performance bar by default' do
diff --git a/spec/helpers/icons_helper_spec.rb b/spec/helpers/icons_helper_spec.rb
index f92b94a9583..950f951e22e 100644
--- a/spec/helpers/icons_helper_spec.rb
+++ b/spec/helpers/icons_helper_spec.rb
@@ -60,20 +60,19 @@ describe IconsHelper do
       non_existing = 'non_existing_icon_sprite'
 
       it 'raises in development mode' do
-        allow(Rails.env).to receive(:development?).and_return(true)
+        stub_rails_env('development')
 
         expect { sprite_icon(non_existing) }.to raise_error(ArgumentError, /is not a known icon/)
       end
 
       it 'raises in test mode' do
-        allow(Rails.env).to receive(:test?).and_return(true)
+        stub_rails_env('test')
 
         expect { sprite_icon(non_existing) }.to raise_error(ArgumentError, /is not a known icon/)
       end
 
       it 'does not raise in production mode' do
-        allow(Rails.env).to receive(:test?).and_return(false)
-        allow(Rails.env).to receive(:development?).and_return(false)
+        stub_rails_env('production')
 
         expect { sprite_icon(non_existing) }.not_to raise_error
       end
diff --git a/spec/helpers/version_check_helper_spec.rb b/spec/helpers/version_check_helper_spec.rb
index e384e2bf9a0..edc0d64d031 100644
--- a/spec/helpers/version_check_helper_spec.rb
+++ b/spec/helpers/version_check_helper_spec.rb
@@ -3,7 +3,7 @@ require 'spec_helper'
 describe VersionCheckHelper do
   describe '#version_status_badge' do
     it 'returns nil if not dev environment and not enabled' do
-      allow(Rails.env).to receive(:production?) { false }
+      stub_rails_env('development')
       allow(Gitlab::CurrentSettings.current_application_settings).to receive(:version_check_enabled) { false }
 
       expect(helper.version_status_badge).to be(nil)
@@ -11,7 +11,7 @@ describe VersionCheckHelper do
 
     context 'when production and enabled' do
       before do
-        allow(Rails.env).to receive(:production?) { true }
+        stub_rails_env('production')
         allow(Gitlab::CurrentSettings.current_application_settings).to receive(:version_check_enabled) { true }
         allow(VersionCheck).to receive(:url) { 'https://version.host.com/check.svg?gitlab_info=xxx' }
       end
diff --git a/spec/lib/gitlab/database/migration_helpers_spec.rb b/spec/lib/gitlab/database/migration_helpers_spec.rb
index cff4eb398bf..49f92f14559 100644
--- a/spec/lib/gitlab/database/migration_helpers_spec.rb
+++ b/spec/lib/gitlab/database/migration_helpers_spec.rb
@@ -1283,33 +1283,19 @@ describe Gitlab::Database::MigrationHelpers do
 
   describe '#perform_background_migration_inline?' do
     it 'returns true in a test environment' do
-      allow(Rails.env)
-        .to receive(:test?)
-        .and_return(true)
+      stub_rails_env('test')
 
       expect(model.perform_background_migration_inline?).to eq(true)
     end
 
     it 'returns true in a development environment' do
-      allow(Rails.env)
-        .to receive(:test?)
-        .and_return(false)
-
-      allow(Rails.env)
-        .to receive(:development?)
-        .and_return(true)
+      stub_rails_env('development')
 
       expect(model.perform_background_migration_inline?).to eq(true)
     end
 
     it 'returns false in a production environment' do
-      allow(Rails.env)
-        .to receive(:test?)
-        .and_return(false)
-
-      allow(Rails.env)
-        .to receive(:development?)
-        .and_return(false)
+      stub_rails_env('production')
 
       expect(model.perform_background_migration_inline?).to eq(false)
     end
diff --git a/spec/lib/gitlab/favicon_spec.rb b/spec/lib/gitlab/favicon_spec.rb
index 63c26e29d73..d221f39c2ed 100644
--- a/spec/lib/gitlab/favicon_spec.rb
+++ b/spec/lib/gitlab/favicon_spec.rb
@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe Gitlab::Favicon, :request_store do
-  include RailsHelpers
-
   describe '.main' do
     it 'defaults to favicon.png' do
       stub_rails_env('production')
diff --git a/spec/lib/gitlab/gitaly_client_spec.rb b/spec/lib/gitlab/gitaly_client_spec.rb
index 99d563e03ec..1c5f72a4396 100644
--- a/spec/lib/gitlab/gitaly_client_spec.rb
+++ b/spec/lib/gitlab/gitaly_client_spec.rb
@@ -265,7 +265,7 @@ describe Gitlab::GitalyClient do
 
     context 'in production and when RequestStore is enabled', :request_store do
       before do
-        allow(Rails.env).to receive(:production?).and_return(true)
+        stub_rails_env('production')
       end
 
       context 'when the maximum number of calls is enforced by a feature flag' do
diff --git a/spec/lib/gitlab/query_limiting/transaction_spec.rb b/spec/lib/gitlab/query_limiting/transaction_spec.rb
index 39d5a575efc..4e906314b5a 100644
--- a/spec/lib/gitlab/query_limiting/transaction_spec.rb
+++ b/spec/lib/gitlab/query_limiting/transaction_spec.rb
@@ -86,9 +86,7 @@ describe Gitlab::QueryLimiting::Transaction do
     it 'returns false in a production environment' do
       transaction = described_class.new
 
-      expect(Rails.env)
-        .to receive(:test?)
-        .and_return(false)
+      stub_rails_env('production')
 
       expect(transaction.raise_error?).to eq(false)
     end
diff --git a/spec/lib/gitlab/query_limiting_spec.rb b/spec/lib/gitlab/query_limiting_spec.rb
index f0d0340cd6e..e9c6bbc35a3 100644
--- a/spec/lib/gitlab/query_limiting_spec.rb
+++ b/spec/lib/gitlab/query_limiting_spec.rb
@@ -9,14 +9,14 @@ describe Gitlab::QueryLimiting do
     end
 
     it 'returns true in a development environment' do
-      allow(Rails.env).to receive(:development?).and_return(true)
+      stub_rails_env('development')
+      stub_rails_env('development')
 
       expect(described_class.enable?).to eq(true)
     end
 
     it 'returns false on GitLab.com' do
-      expect(Rails.env).to receive(:development?).and_return(false)
-      expect(Rails.env).to receive(:test?).and_return(false)
+      stub_rails_env('production')
       allow(Gitlab).to receive(:com?).and_return(true)
 
       expect(described_class.enable?).to eq(false)
@@ -24,8 +24,7 @@ describe Gitlab::QueryLimiting do
 
     it 'returns false in a non GitLab.com' do
       allow(Gitlab).to receive(:com?).and_return(false)
-      expect(Rails.env).to receive(:development?).and_return(false)
-      expect(Rails.env).to receive(:test?).and_return(false)
+      stub_rails_env('production')
 
       expect(described_class.enable?).to eq(false)
     end
diff --git a/spec/lib/gitlab_spec.rb b/spec/lib/gitlab_spec.rb
index 74d4b12a070..589dac61528 100644
--- a/spec/lib/gitlab_spec.rb
+++ b/spec/lib/gitlab_spec.rb
@@ -3,8 +3,6 @@
 require 'spec_helper'
 
 describe Gitlab do
-  include RailsHelpers
-
   describe '.root' do
     it 'returns the root path of the app' do
       expect(described_class.root).to eq(Pathname.new(File.expand_path('../..', __dir__)))
diff --git a/spec/models/concerns/cacheable_attributes_spec.rb b/spec/models/concerns/cacheable_attributes_spec.rb
index da46effe411..d8f940a808e 100644
--- a/spec/models/concerns/cacheable_attributes_spec.rb
+++ b/spec/models/concerns/cacheable_attributes_spec.rb
@@ -131,7 +131,7 @@ describe CacheableAttributes do
 
       context 'in production environment' do
         before do
-          expect(Rails.env).to receive(:production?).and_return(true)
+          stub_rails_env('production')
         end
 
         it 'returns an uncached record and logs a warning' do
@@ -143,7 +143,7 @@ describe CacheableAttributes do
 
       context 'in other environments' do
         before do
-          expect(Rails.env).to receive(:production?).and_return(false)
+          stub_rails_env('development')
         end
 
         it 'returns an uncached record and logs a warning' do
diff --git a/spec/models/concerns/sha_attribute_spec.rb b/spec/models/concerns/sha_attribute_spec.rb
index a4a81ae126d..0d4dbfb215e 100644
--- a/spec/models/concerns/sha_attribute_spec.rb
+++ b/spec/models/concerns/sha_attribute_spec.rb
@@ -17,7 +17,7 @@ describe ShaAttribute do
   describe '#sha_attribute' do
     context 'when in non-production' do
       before do
-        allow(Rails.env).to receive(:production?).and_return(false)
+        stub_rails_env('development')
       end
 
       context 'when the table exists' do
@@ -76,7 +76,7 @@ describe ShaAttribute do
 
     context 'when in production' do
       before do
-        allow(Rails.env).to receive(:production?).and_return(true)
+        stub_rails_env('production')
       end
 
       it 'defines a SHA attribute' do
diff --git a/spec/models/internal_id_spec.rb b/spec/models/internal_id_spec.rb
index 28630f7d3fe..c73ade3f896 100644
--- a/spec/models/internal_id_spec.rb
+++ b/spec/models/internal_id_spec.rb
@@ -106,7 +106,8 @@ describe InternalId do
       end
 
       it 'always attempts to generate internal IDs in production mode' do
-        allow(Rails.env).to receive(:test?).and_return(false)
+        stub_rails_env('production')
+
         val = rand(1..100)
         generator = double(generate: val)
         expect(InternalId::InternalIdGenerator).to receive(:new).and_return(generator)
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 6ce76af556f..47f09bf14d0 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -109,6 +109,7 @@ RSpec.configure do |config|
   config.include PolicyHelpers, type: :policy
   config.include MemoryUsageHelper
   config.include ExpectRequestWithStatus, type: :request
+  config.include RailsHelpers
 
   if ENV['CI']
     # This includes the first try, i.e. tests will be run 4 times before failing.
diff --git a/spec/tasks/gitlab/gitaly_rake_spec.rb b/spec/tasks/gitlab/gitaly_rake_spec.rb
index e6e4d9504d9..2f3fc7839c1 100644
--- a/spec/tasks/gitlab/gitaly_rake_spec.rb
+++ b/spec/tasks/gitlab/gitaly_rake_spec.rb
@@ -57,7 +57,7 @@ describe 'gitlab:gitaly namespace rake task' do
         stub_env('CI', false)
         FileUtils.mkdir_p(clone_path)
         expect(Dir).to receive(:chdir).with(clone_path).and_call_original
-        allow(Rails.env).to receive(:test?).and_return(false)
+        stub_rails_env('development')
       end
 
       context 'gmake is available' do
@@ -93,7 +93,7 @@ describe 'gitlab:gitaly namespace rake task' do
           end
 
           before do
-            allow(Rails.env).to receive(:test?).and_return(true)
+            stub_rails_env('test')
           end
 
           it 'calls make in the gitaly directory with --no-deployment flag for bundle' do