From f3e102837150022daf1864c01b4bb84b24f591b7 Mon Sep 17 00:00:00 2001
From: Brett Walker <bwalker@gitlab.com>
Date: Sat, 7 Jul 2018 04:22:44 +0000
Subject: [PATCH] Refactor rspec matchers in read_only_spec.rb

---
 lib/gitlab/middleware/read_only/controller.rb |  1 +
 spec/lib/gitlab/middleware/read_only_spec.rb  | 44 +++++--------------
 .../matchers/disallow_request_matchers.rb     | 15 +++++++
 3 files changed, 27 insertions(+), 33 deletions(-)
 create mode 100644 spec/support/matchers/disallow_request_matchers.rb

diff --git a/lib/gitlab/middleware/read_only/controller.rb b/lib/gitlab/middleware/read_only/controller.rb
index 4a99b7cca5c..8dca431c005 100644
--- a/lib/gitlab/middleware/read_only/controller.rb
+++ b/lib/gitlab/middleware/read_only/controller.rb
@@ -69,6 +69,7 @@ module Gitlab
           @route_hash ||= Rails.application.routes.recognize_path(request.url, { method: request.request_method }) rescue {}
         end
 
+        # Overridden in EE module
         def whitelisted_routes
           grack_route || ReadOnly.internal_routes.any? { |path| request.path.include?(path) } || lfs_route || sidekiq_route
         end
diff --git a/spec/lib/gitlab/middleware/read_only_spec.rb b/spec/lib/gitlab/middleware/read_only_spec.rb
index 5c398bc2063..8fbeaa065fa 100644
--- a/spec/lib/gitlab/middleware/read_only_spec.rb
+++ b/spec/lib/gitlab/middleware/read_only_spec.rb
@@ -4,28 +4,6 @@ describe Gitlab::Middleware::ReadOnly do
   include Rack::Test::Methods
   using RSpec::Parameterized::TableSyntax
 
-  RSpec::Matchers.define :be_a_redirect do
-    match do |response|
-      response.status == 301
-    end
-  end
-
-  RSpec::Matchers.define :disallow_request do
-    match do |middleware|
-      alert = middleware.env['rack.session'].to_hash
-        .dig('flash', 'flashes', 'alert')
-
-      alert&.include?('You cannot perform write operations')
-    end
-  end
-
-  RSpec::Matchers.define :disallow_request_in_json do
-    match do |response|
-      json_response = JSON.parse(response.body)
-      response.body.include?('You cannot perform write operations') && json_response.key?('message')
-    end
-  end
-
   let(:rack_stack) do
     rack = Rack::Builder.new do
       use ActionDispatch::Session::CacheStore
@@ -66,38 +44,38 @@ describe Gitlab::Middleware::ReadOnly do
     it 'expects PATCH requests to be disallowed' do
       response = request.patch('/test_request')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
       expect(subject).to disallow_request
     end
 
     it 'expects PUT requests to be disallowed' do
       response = request.put('/test_request')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
       expect(subject).to disallow_request
     end
 
     it 'expects POST requests to be disallowed' do
       response = request.post('/test_request')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
       expect(subject).to disallow_request
     end
 
     it 'expects a internal POST request to be allowed after a disallowed request' do
       response = request.post('/test_request')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
 
       response = request.post("/api/#{API::API.version}/internal")
 
-      expect(response).not_to be_a_redirect
+      expect(response).not_to be_redirect
     end
 
     it 'expects DELETE requests to be disallowed' do
       response = request.delete('/test_request')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
       expect(subject).to disallow_request
     end
 
@@ -105,7 +83,7 @@ describe Gitlab::Middleware::ReadOnly do
       expect(Rails.application.routes).to receive(:recognize_path).and_call_original
       response = request.post('/root/gitlab-ce/new/master/app/info/lfs/objects/batch')
 
-      expect(response).to be_a_redirect
+      expect(response).to be_redirect
       expect(subject).to disallow_request
     end
 
@@ -120,19 +98,19 @@ describe Gitlab::Middleware::ReadOnly do
         expect(Rails.application.routes).not_to receive(:recognize_path)
         response = request.post("/api/#{API::API.version}/internal")
 
-        expect(response).not_to be_a_redirect
+        expect(response).not_to be_redirect
         expect(subject).not_to disallow_request
       end
 
       it 'expects requests to sidekiq admin to be allowed' do
         response = request.post('/admin/sidekiq')
 
-        expect(response).not_to be_a_redirect
+        expect(response).not_to be_redirect
         expect(subject).not_to disallow_request
 
         response = request.get('/admin/sidekiq')
 
-        expect(response).not_to be_a_redirect
+        expect(response).not_to be_redirect
         expect(subject).not_to disallow_request
       end
 
@@ -150,7 +128,7 @@ describe Gitlab::Middleware::ReadOnly do
           expect(Rails.application.routes).to receive(:recognize_path).and_call_original
           response = request.post(path)
 
-          expect(response).not_to be_a_redirect
+          expect(response).not_to be_redirect
           expect(subject).not_to disallow_request
         end
       end
diff --git a/spec/support/matchers/disallow_request_matchers.rb b/spec/support/matchers/disallow_request_matchers.rb
new file mode 100644
index 00000000000..db4d90e4fd0
--- /dev/null
+++ b/spec/support/matchers/disallow_request_matchers.rb
@@ -0,0 +1,15 @@
+RSpec::Matchers.define :disallow_request do
+  match do |middleware|
+    alert = middleware.env['rack.session'].to_hash
+      .dig('flash', 'flashes', 'alert')
+
+    alert&.include?('You cannot perform write operations')
+  end
+end
+
+RSpec::Matchers.define :disallow_request_in_json do
+  match do |response|
+    json_response = JSON.parse(response.body)
+    response.body.include?('You cannot perform write operations') && json_response.key?('message')
+  end
+end