v3(route bindings): fetch parameters (cloudfoundry#1908)

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

Author: Derik Evangelista

app/controllers/v3/service_route_bindings_controller.rb

@@ -13,6 +13,8 @@
 require 'cloud_controller/paging/sequel_paginator'
 
 class ServiceRouteBindingsController < ApplicationController
+  before_action :set_route_binding, only: [:show, :parameters, :destroy]
+
   def create
     route_services_disabled! unless route_services_enabled?
     message = parse_create_request
@@ -40,10 +42,9 @@ def create
 
   def show
     message = show_message
-    route_binding = RouteBinding.first(guid: hashed_params[:guid])
-    route_binding_not_found! unless route_binding && can_read_space?(route_binding.route.space)
+    route_binding_not_found! unless @route_binding && can_read_space?(@route_binding.route.space)
     presenter = Presenters::V3::ServiceRouteBindingPresenter.new(
-      route_binding,
+      @route_binding,
       decorators: decorators(message)
     )
     render status: :ok, json: presenter
@@ -62,20 +63,34 @@ def index
   end
 
   def destroy
-    route_binding = RouteBinding.first(guid: hashed_params[:guid])
-    route_binding_not_found! unless route_binding && can_read_space?(route_binding.route.space)
+    route_binding_not_found! unless @route_binding && can_read_space?(@route_binding.route.space)
 
     action = V3::ServiceRouteBindingDelete.new(service_event_repository)
-    result = action.delete(route_binding, async_allowed: false)
+    result = action.delete(@route_binding, async_allowed: false)
 
     if result.is_a? V3::ServiceRouteBindingDelete::RequiresAsync
-      pollable_job_guid = enqueue_unbind_job(route_binding.guid)
+      pollable_job_guid = enqueue_unbind_job(@route_binding.guid)
       head :accepted, 'Location' => url_builder.build_url(path: "/v3/jobs/#{pollable_job_guid}")
     else
       head :no_content
     end
   end
 
+  def parameters
+    route_binding_not_found! unless @route_binding && can_read_space?(@route_binding.route.space)
+    unauthorized! unless can_write_space?(@route_binding.route.space)
+
+    fetcher = ServiceBindingRead.new
+    parameters = fetcher.fetch_parameters(@route_binding)
+
+    render status: :ok, json: parameters
+  rescue ServiceBindingRead::NotSupportedError
+    bad_request!('user provided service instances do not support fetching route bindings parameters.') if @route_binding.service_instance.user_provided_instance?
+    bad_request!('this service does not support fetching route bindings parameters.')
+  rescue LockCheck::ServiceBindingLockedError
+    unprocessable!('There is an operation in progress for the service route binding.')
+  end
+
   private
 
   AVAILABLE_DECORATORS = [
@@ -206,4 +221,8 @@ def parameters_not_supported!
   def already_exists!
     raise CloudController::Errors::ApiError.new_from_details('ServiceInstanceAlreadyBoundToSameRoute').with_response_code(422)
   end
+
+  def set_route_binding
+    @route_binding = RouteBinding.first(guid: hashed_params[:guid])
+  end
 end

app/presenters/v3/service_route_binding_presenter.rb

@@ -45,7 +45,11 @@ def links
               route: {
                 href: url_builder.build_url(path: "/v3/routes/#{binding.route.guid}")
               }
-            }
+            }.tap do |l|
+              if binding.service_instance.managed_instance?
+                l[:parameters] = { href: url_builder.build_url(path: "/v3/service_route_bindings/#{binding.guid}/parameters") }
+              end
+            end
           end
 
           def relationships

config/routes.rb

@@ -197,7 +197,11 @@
   # service_route_bindings
   resources :service_route_bindings,
     param: :guid,
-    only: [:show, :create, :index, :destroy]
+    only: [:show, :create, :index, :destroy] do
+    member do
+      get :parameters
+    end
+  end
 
   # service_brokers
   get '/service_brokers', to: 'service_brokers#index'

docs/v3/source/includes/experimental_resources/service_credential_bindings/_parameters.md.erb

@@ -0,0 +1,40 @@
+### Get parameters for a service credential binding
+
+```
+Example Request
+```
+
+```shell
+curl "https://api.example.org/v3/service_credential_bindings/[guid]/parameters" \
+  -X GET \
+  -H "Authorization: bearer [token]"
+```
+
+```
+Example Response
+```
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "foo": "bar",
+  "foz": "baz"
+}
+```
+
+Queries the Service Broker for the parameters associated with this service credential binding.
+The broker catalog must have enabled the `bindings_retrievable` feature for the Service Offering.
+Check the [Service Offering object](#the-service-offering-object) for the value of this feature flag.
+This endpoint is not available for User-Provided Service Instances.
+
+#### Definition
+`GET /v3/service_credential_bindings/:guid/parameters`
+
+#### Permitted roles
+ |
+--- | ---
+Admin |
+Admin Read-Only |
+Space Developer |

docs/v3/source/includes/experimental_resources/service_route_bindings/_parameters.md.erb

@@ -0,0 +1,40 @@
+### Get parameters for a route binding
+
+```
+Example Request
+```
+
+```shell
+curl "https://api.example.org/v3/service_route_bindings/[guid]/parameters" \
+  -X GET \
+  -H "Authorization: bearer [token]"
+```
+
+```
+Example Response
+```
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "foo": "bar",
+  "foz": "baz"
+}
+```
+
+Queries the Service Broker for the parameters associated with this service route binding.
+The broker catalog must have enabled the `bindings_retrievable` feature for the Service Offering.
+Check the [Service Offering object](#the-service-offering-object) for the value of this feature flag.
+This endpoint is not available for User-Provided Service Instances.
+
+#### Definition
+`GET /v3/service_route_bindings/:guid/parameters`
+
+#### Permitted roles
+ |
+--- | ---
+Admin |
+Admin Read-Only |
+Space Developer |

docs/v3/source/index.md

@@ -367,12 +367,14 @@ includes:
   - experimental_resources/service_credential_bindings/list
   - experimental_resources/service_credential_bindings/delete
   - experimental_resources/service_credential_bindings/details
+  - experimental_resources/service_credential_bindings/parameters
   - experimental_resources/service_route_bindings/header
   - experimental_resources/service_route_bindings/object
   - experimental_resources/service_route_bindings/create
   - experimental_resources/service_route_bindings/list
   - experimental_resources/service_route_bindings/get
   - experimental_resources/service_route_bindings/delete
+  - experimental_resources/service_route_bindings/parameters
   - experimental_resources/service_instances/header
   - experimental_resources/service_instances/create
   - experimental_resources/service_instances/get

spec/request/service_route_bindings_spec.rb

@@ -558,6 +558,7 @@
             route_guid: route.guid,
             last_operation_type: 'create',
             last_operation_state: 'succeeded',
+            include_params_link: service_instance.managed_instance?
           )
         )
       end
@@ -670,6 +671,7 @@
             route_guid: route.guid,
             last_operation_type: 'create',
             last_operation_state: 'successful',
+            include_params_link: service_instance_1.managed_instance?
           ),
           expected_json(
             binding_guid: route_binding_2.guid,
@@ -678,6 +680,7 @@
             route_guid: route.guid,
             last_operation_type: 'create',
             last_operation_state: 'successful',
+            include_params_link: service_instance_2.managed_instance?
           )
         ]
       end
@@ -816,6 +819,7 @@
         route_guid: route.guid,
         last_operation_type: 'create',
         last_operation_state: 'successful',
+        include_params_link: service_instance.managed_instance?
       )
     end
 
@@ -1115,6 +1119,113 @@
     end
   end
 
+  describe 'GET /v3/service_route_bindings/:guid/parameters' do
+    let(:offering) { VCAP::CloudController::Service.make(requires: ['route_forwarding'], bindings_retrievable: true) }
+    let(:plan) { VCAP::CloudController::ServicePlan.make(service: offering) }
+    let(:service_instance) { VCAP::CloudController::ManagedServiceInstance.make(space: space, service_plan: plan) }
+    let(:route) { VCAP::CloudController::Route.make(space: space) }
+    let(:app_model) { VCAP::CloudController::AppModel.make(space: space) }
+    let(:binding) { bind_service_to_route(service_instance, route) }
+
+    let(:api_call) { ->(user_headers) { get "/v3/service_route_bindings/#{binding.guid}/parameters", nil, user_headers } }
+
+    context 'managed service instances' do
+      let(:broker_base_url) { service_instance.service_broker.broker_url }
+      let(:broker_fetch_binding_url) { "#{broker_base_url}/v2/service_instances/#{service_instance.guid}/service_bindings/#{binding.guid}" }
+      let(:broker_status_code) { 200 }
+      let(:broker_response) { { parameters: { abra: 'kadabra', kadabra: 'alakazan' } } }
+      let(:parameters_response) { { code: 200, response_object: broker_response[:parameters] } }
+
+      let(:expected_codes_and_responses) do
+        Hash.new(code: 403).tap do |h|
+          h['admin'] = parameters_response
+          h['admin_readonly'] = parameters_response
+          h['space_developer'] = parameters_response
+          h['org_auditor'] = { code: 404 }
+          h['org_billing_manager'] = { code: 404 }
+          h['no_role'] = { code: 404 }
+        end
+      end
+
+      before do
+        stub_request(:get, broker_fetch_binding_url).
+          to_return(status: broker_status_code, body: broker_response.to_json, headers: {})
+      end
+
+      it_behaves_like 'permissions for single object endpoint', ALL_PERMISSIONS
+
+      context 'when bindings are not retrievable' do
+        let(:offering) { VCAP::CloudController::Service.make(requires: ['route_forwarding']) }
+
+        it 'returns the appropriate error' do
+          api_call.call(admin_headers)
+          expect(last_response).to have_status_code(400)
+          expect(parsed_response['errors']).to include(
+            include({
+              'detail' => 'Bad request: this service does not support fetching route bindings parameters.',
+              'title' => 'CF-BadRequest',
+              'code' => 1004,
+            })
+          )
+        end
+      end
+
+      context 'when there is an operation in progress' do
+        before do
+          binding.save_with_new_operation({}, {
+            type: 'create',
+            state: 'in progress'
+          })
+        end
+
+        it 'returns the appropriate error' do
+          api_call.call(admin_headers)
+          expect(last_response).to have_status_code(422)
+          expect(parsed_response['errors']).to include(
+            include({
+              'detail' => 'There is an operation in progress for the service route binding.',
+              'title' => 'CF-UnprocessableEntity',
+              'code' => 10008,
+            })
+          )
+        end
+      end
+    end
+
+    context 'user provided service instances' do
+      let(:service_instance) { VCAP::CloudController::UserProvidedServiceInstance.make(space: space, route_service_url: 'https://route.example.com') }
+      let(:error_response) { {
+        code: 'CF-BadRequest',
+        error: 'User provided service instances do not support fetching service binding parameters.'
+      }
+      }
+      let(:expected_codes_and_responses) do
+        Hash.new(code: 403).tap do |h|
+          h['admin'] = { code: 400, response_object: error_response }
+          h['admin_readonly'] = { code: 400, response_object: error_response }
+          h['space_developer'] = { code: 400, response_object: error_response }
+          h['org_auditor'] = { code: 404 }
+          h['org_billing_manager'] = { code: 404 }
+          h['no_role'] = { code: 404 }
+        end
+      end
+
+      it_behaves_like 'permissions for single object endpoint', ALL_PERMISSIONS
+
+      it 'returns the appropriate error' do
+        api_call.call(admin_headers)
+        expect(last_response).to have_status_code(400)
+        expect(parsed_response['errors']).to include(
+          include({
+            'detail' => 'Bad request: user provided service instances do not support fetching route bindings parameters.',
+            'title' => 'CF-BadRequest',
+            'code' => 1004,
+          })
+        )
+      end
+    end
+  end
+
   let(:user) { VCAP::CloudController::User.make }
   let(:org) { VCAP::CloudController::Organization.make }
   let(:space) { VCAP::CloudController::Space.make(organization: org) }
@@ -1126,7 +1237,7 @@
     headers_for(user)
   end
 
-  def expected_json(binding_guid:, route_service_url:, route_guid:, service_instance_guid:, last_operation_state:, last_operation_type:)
+  def expected_json(binding_guid:, route_service_url:, route_guid:, service_instance_guid:, last_operation_state:, last_operation_type:, include_params_link:)
     {
       guid: binding_guid,
       created_at: iso8601,
@@ -1160,8 +1271,14 @@ def expected_json(binding_guid:, route_service_url:, route_guid:, service_instan
         },
         route: {
           href: "#{link_prefix}/v3/routes/#{route_guid}"
-        }
-      }
+        },
+      }.tap do |ls|
+        if include_params_link
+          ls[:parameters] = {
+            href: "#{link_prefix}/v3/service_route_bindings/#{binding_guid}/parameters"
+          }
+        end
+      end
     }
   end
 

spec/unit/presenters/v3/service_route_binding_presenter_spec.rb

@@ -61,7 +61,8 @@ module CloudController
               },
               service_instance: {
                 href: %r{.*/v3/service_instances/#{service_instance.guid}}
-              }
+              },
+
             }
           }
         )
@@ -108,6 +109,19 @@ module CloudController
           expect(decorator2).to have_received(:decorate).with({ foo: 'bar' }, [binding])
         end
       end
+
+      describe 'links' do
+        let(:offering) { VCAP::CloudController::Service.make(requires: ['route_forwarding']) }
+        let(:plan) { VCAP::CloudController::ServicePlan.make(service: offering) }
+        let(:service_instance) { VCAP::CloudController::ManagedServiceInstance.make(space: space, service_plan: plan) }
+
+        it 'include parameters for managed service instance bindings' do
+          presenter = described_class.new(binding)
+          expect(presenter.to_hash.dig(:links, :parameters)).to match({
+            href: %r{.*/v3/service_route_bindings/#{guid}/parameters}
+          })
+        end
+      end
     end
   end
 end