v3(test): route bindings orphan mitigation scenarios

[#174398275](https://www.pivotaltracker.com/story/show/174398275)

Author: pivotal-marcela-campo

spec/request/service_route_bindings_spec.rb

@@ -286,7 +286,7 @@
         end
 
         context 'when the bind completes synchronously' do
-          it 'updates the the binding' do
+          it 'updates the binding' do
             execute_all_jobs(expected_successes: 1, expected_failures: 0)
 
             binding.reload
@@ -300,6 +300,30 @@
 
             expect(job.state).to eq(VCAP::CloudController::PollableJobModel::COMPLETE_STATE)
           end
+
+          context 'orphan mitigation' do
+            it_behaves_like 'create binding orphan mitigation' do
+              let(:bind_url) { broker_bind_url }
+              let(:plan_id) { plan.unique_id }
+              let(:offering_id) { offering.unique_id }
+              let(:client_body) do
+                {
+                  context: {
+                    platform: 'cloudfoundry',
+                    organization_guid: org.guid,
+                    organization_name: org.name,
+                    space_guid: space.guid,
+                    space_name: space.name,
+                  },
+                  service_id: service_instance.service_plan.service.unique_id,
+                  plan_id: service_instance.service_plan.unique_id,
+                  bind_resource: {
+                    route: route.uri,
+                  },
+                }
+              end
+            end
+          end
         end
 
         context 'when the binding completes asynchronously' do
@@ -365,7 +389,7 @@
                 to_return(status: fetch_binding_status_code, body: fetch_binding_body.to_json, headers: {})
             end
 
-            it 'fetches the service instance' do
+            it 'fetches the binding' do
               execute_all_jobs(expected_successes: 1, expected_failures: 0)
 
               expect(

spec/support/shared_examples/request/bindings_orphan_mitigation.rb

@@ -0,0 +1,160 @@
+RSpec.shared_examples 'create binding orphan mitigation' do
+  let(:job) { VCAP::CloudController::PollableJobModel.last }
+
+  before do
+    stub_request(:delete, bind_url).
+      with(query: {
+        accepts_incomplete: true,
+        plan_id: plan_id,
+        service_id: offering_id,
+      }).to_return(status: 200, body: {}.to_json)
+  end
+
+  context 'broker returns a success code' do
+    codes = [200, 201]
+    codes.each do |code|
+      context "response is #{code}" do
+        before do
+          stub_request(:put, bind_url).
+            with(query: {
+              accepts_incomplete: true,
+            },
+              body: client_body).to_return(status: code, body: {}.to_json)
+        end
+
+        it 'updates the binding and job' do
+          execute_all_jobs(expected_successes: 1, expected_failures: 0)
+
+          expect(binding.last_operation.type).to eq('create')
+          expect(binding.last_operation.state).to eq('succeeded')
+
+          expect(job.state).to eq(VCAP::CloudController::PollableJobModel::COMPLETE_STATE)
+
+          expect(
+            a_request(:delete, bind_url).
+              with(
+                query: {
+                  accepts_incomplete: true,
+                  plan_id: plan_id,
+                  service_id: offering_id,
+                },
+              )
+          ).not_to have_been_made
+        end
+      end
+    end
+
+    context 'response is 201 with malformed response' do
+      before do
+        stub_request(:put, bind_url).
+          with(query: {
+            accepts_incomplete: true,
+          },
+            body: client_body).to_return(status: 201, body: nil)
+      end
+
+      it 'updates the binding and performs orphan mitigation' do
+        execute_all_jobs(expected_successes: 1, expected_failures: 1)
+
+        assert_failed_job(binding, job)
+        assert_orphan_mitigation_performed(plan_id, offering_id)
+      end
+    end
+  end
+
+  context 'broker does not process the request' do
+    [400, 401, 408, 409, *411..431].each do |code|
+      context "response is #{code}" do
+        before do
+          stub_request(:put, bind_url).
+            with(query: {
+              accepts_incomplete: true,
+            },
+              body: client_body).to_return(status: code, body: { error: 'ConcurrencyError', description: 'some description' }.to_json)
+        end
+
+        it 'updates the binding and job' do
+          execute_all_jobs(expected_successes: 0, expected_failures: 1)
+
+          assert_failed_job(binding, job)
+
+          expect(
+            a_request(:delete, bind_url).
+              with(
+                query: {
+                  accepts_incomplete: true,
+                  plan_id: plan_id,
+                  service_id: offering_id,
+                },
+              )
+          ).not_to have_been_made
+        end
+      end
+    end
+  end
+
+  context 'broker fails to bind with an error not specified in osbapi' do
+    [*500..511, *203..208].sample(4).each do |code|
+      context "response is #{code}" do
+        before do
+          stub_request(:put, bind_url).
+            with(query: {
+              accepts_incomplete: true,
+            },
+              body: client_body).to_return(status: code, body: {}.to_json)
+        end
+
+        it 'does orphan mitigation and fails the job' do
+          execute_all_jobs(expected_successes: 1, expected_failures: 1)
+
+          assert_failed_job(binding, job)
+          assert_orphan_mitigation_performed(plan_id, offering_id)
+        end
+      end
+    end
+  end
+
+  context 'timeout' do
+    before do
+      stub_request(:put, bind_url).
+        with(query: {
+          accepts_incomplete: true,
+        },
+          body: client_body).to_timeout
+
+      stub_request(:delete, bind_url).
+        with(query: {
+          accepts_incomplete: true,
+          plan_id: plan_id,
+          service_id: offering_id,
+        }).to_return(status: 200, body: {}.to_json)
+    end
+
+    it 'does orphan mitigation and fails the job' do
+      execute_all_jobs(expected_successes: 1, expected_failures: 1)
+
+      assert_failed_job(binding, job)
+      assert_orphan_mitigation_performed(plan_id, offering_id)
+    end
+  end
+end
+
+def assert_failed_job(binding, job)
+  binding.reload
+  expect(binding.last_operation.type).to eq('create')
+  expect(binding.last_operation.state).to eq('failed')
+  expect(job.state).to eq(VCAP::CloudController::PollableJobModel::FAILED_STATE)
+end
+
+def assert_orphan_mitigation_performed(plan_id, offering_id)
+  expect(
+    a_request(:delete, bind_url).
+      with(
+        query: {
+          accepts_incomplete: true,
+          plan_id: plan_id,
+          service_id: offering_id,
+        },
+      )
+  ).to have_been_made.once
+end