v3(bindings): allow the binding SI to be included (cloudfoundry#1795)

Get and list endpoints

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

Author: Derik Evangelista

app/controllers/v3/service_credential_bindings_controller.rb

@@ -4,6 +4,7 @@
 require 'messages/service_credential_bindings_list_message'
 require 'messages/service_credential_bindings_show_message'
 require 'decorators/include_binding_app_decorator'
+require 'decorators/include_binding_service_instance_decorator'
 
 class ServiceCredentialBindingsController < ApplicationController
   def index
@@ -35,7 +36,8 @@ def show
   private
 
   AVAILABLE_DECORATORS = [
-    IncludeBindingAppDecorator
+    IncludeBindingAppDecorator,
+    IncludeBindingServiceInstanceDecorator
   ].freeze
 
   def decorators(message)

app/decorators/include_binding_service_instance_decorator.rb

@@ -0,0 +1,23 @@
+module VCAP::CloudController
+  class IncludeBindingServiceInstanceDecorator
+    class << self
+      def match?(include)
+        include&.any? { |i| %w(service_instance).include?(i) }
+      end
+
+      def decorate(hash, bindings)
+        hash.deep_merge({
+          included: {
+            service_instances: service_instances(bindings).map { |i| Presenters::V3::ServiceInstancePresenter.new(i).to_hash }
+          }
+        })
+      end
+
+      private
+
+      def service_instances(bindings)
+        ServiceInstance.where(guid: bindings.map { |b| b[:service_instance_guid] }).order(:created_at)
+      end
+    end
+  end
+end

app/messages/service_credential_bindings_list_message.rb

@@ -19,7 +19,7 @@ class ServiceCredentialBindingsListMessage < ListMessage
 
     validates_with NoAdditionalParamsValidator
     validates :type, allow_nil: true, inclusion: { in: %w(app key), message: "must be one of 'app', 'key'" }
-    validates_with IncludeParamValidator, valid_values: %w(app)
+    validates_with IncludeParamValidator, valid_values: %w(app service_instance)
 
     def self.from_params(params)
       super(params, ARRAY_KEYS.map(&:to_s))

app/messages/service_credential_bindings_show_message.rb

@@ -9,7 +9,7 @@ class ServiceCredentialBindingsShowMessage < BaseMessage
     register_allowed_keys ARRAY_KEYS
 
     validates_with NoAdditionalParamsValidator
-    validates_with IncludeParamValidator, valid_values: %w(app)
+    validates_with IncludeParamValidator, valid_values: %w(app service_instance)
 
     def self.from_params(params)
       super(params, ARRAY_KEYS.map(&:to_s))

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

@@ -42,7 +42,7 @@ This endpoint retrieves the service credential binding by GUID.
 
 Name | Type | Description
 ---- | ---- | ------------
-**include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`
+**include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`, `service_instance`
 
 #### Permitted roles
  |

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

@@ -37,7 +37,7 @@ Name | Type | Description
 **app_guids** | _list of strings_ | Comma-delimited list of app guids to filter by
 **app_names** | _strings_ | Type of credential binding to filter by. Valid values are: `app` or `key`
 **type** | _list of strings_ | Comma-delimited list of app names to filter by
-**include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`
+**include** | _list of strings_ | Optionally include a list of unique related resources in the response. Valid values are: `app`, `service_instance`
 **page** | _integer_ | Page to display; valid values are integers >= 1
 **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending<br>Valid values are `created_at`, `updated_at`, and `name`

spec/request/service_credential_bindings_spec.rb

@@ -241,6 +241,15 @@ def check_filtered_bindings(*bindings)
         expect(guids).to contain_exactly(app_binding.app.guid, other_app_binding.app.guid)
       end
 
+      it 'can include `service_instance`' do
+        get '/v3/service_credential_bindings?include=service_instance', nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['service_instances']).to have(2).items
+        guids = parsed_response['included']['service_instances'].map { |x| x['guid'] }
+        expect(guids).to contain_exactly(instance.guid, other_instance.guid)
+      end
+
       it 'returns a 400 for invalid includes' do
         get '/v3/service_credential_bindings?include=routes', nil, admin_headers
         expect(last_response).to have_status_code(400)
@@ -312,9 +321,17 @@ def check_filtered_bindings(*bindings)
         it 'can include `app`' do
           get "/v3/service_credential_bindings/#{key.guid}?include=app", nil, admin_headers
           expect(last_response).to have_status_code(200)
-
           expect(parsed_response['included']['apps']).to have(0).items
         end
+
+        it 'can include `service_instance`' do
+          get "/v3/service_credential_bindings/#{key.guid}?include=service_instance", nil, admin_headers
+          expect(last_response).to have_status_code(200)
+
+          expect(parsed_response['included']['service_instances']).to have(1).items
+          guids = parsed_response['included']['service_instances'].map { |x| x['guid'] }
+          expect(guids).to contain_exactly(instance.guid)
+        end
       end
     end
   end
@@ -383,6 +400,15 @@ def check_filtered_bindings(*bindings)
         guids = parsed_response['included']['apps'].map { |x| x['guid'] }
         expect(guids).to contain_exactly(app_to_bind_to.guid)
       end
+
+      it 'can include `service_instance`' do
+        get "/v3/service_credential_bindings/#{app_binding.guid}?include=service_instance", nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['service_instances']).to have(1).items
+        guids = parsed_response['included']['service_instances'].map { |x| x['guid'] }
+        expect(guids).to contain_exactly(instance.guid)
+      end
     end
   end
 

spec/unit/decorators/include_binding_app_decorator_spec.rb

@@ -9,7 +9,7 @@ module VCAP::CloudController
       bindings.map { |b| Presenters::V3::AppPresenter.new(b.app).to_hash }
     }
 
-    it 'decorates the given hash with organizations from apps' do
+    it 'decorates the given hash with apps from bindings' do
       dict = { foo: 'bar' }
       hash = subject.decorate(dict, bindings)
       expect(hash[:foo]).to eq('bar')

spec/unit/decorators/include_binding_service_instance_decorator_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'decorators/include_binding_service_instance_decorator'
+
+module VCAP::CloudController
+  RSpec.describe IncludeBindingServiceInstanceDecorator do
+    subject(:decorator) { described_class }
+    let(:bindings) { [ServiceBinding.make, ServiceBinding.make, ServiceBinding.make] }
+    let(:instances) {
+      bindings.map { |b| Presenters::V3::ServiceInstancePresenter.new(b.service_instance).to_hash }
+    }
+
+    it 'decorates the given hash with service instances from bindings' do
+      dict = { foo: 'bar' }
+      hash = subject.decorate(dict, bindings)
+      expect(hash[:foo]).to eq('bar')
+      expect(hash[:included][:service_instances]).to match_array(instances)
+    end
+
+    it 'does not overwrite other included fields' do
+      dict = { foo: 'bar', included: { fruits: ['tomato', 'banana'] } }
+      hash = subject.decorate(dict, bindings)
+      expect(hash[:foo]).to eq('bar')
+      expect(hash[:included][:service_instances]).to match_array(instances)
+      expect(hash[:included][:fruits]).to match_array(['tomato', 'banana'])
+    end
+
+    it 'does not include duplicates' do
+      hash = subject.decorate({}, bindings << ServiceBinding.make(service_instance: bindings[0].service_instance))
+      expect(hash[:included][:service_instances]).to have(3).items
+    end
+
+    describe '.match?' do
+      it 'matches include arrays containing "app"' do
+        expect(decorator.match?(['potato', 'service_instance', 'turnip'])).to be_truthy
+      end
+
+      it 'does not match other include arrays' do
+        expect(decorator.match?(['potato', 'turnip'])).to be_falsey
+      end
+    end
+  end
+end

spec/unit/messages/service_credential_bindings_list_message_spec.rb

@@ -16,7 +16,7 @@ module VCAP::CloudController
         'app_guids' => 'app-1-guid, app-2-guid, app-3-guid',
         'app_names' => 'app-1-name, app-2-name, app-3-name',
         'type' => 'app',
-        'include' => 'app'
+        'include' => 'app,service_instance'
       }
     end
 
@@ -32,7 +32,7 @@ module VCAP::CloudController
         expect(message.app_guids).to match_array(['app-1-guid', 'app-2-guid', 'app-3-guid'])
         expect(message.app_names).to match_array(['app-1-name', 'app-2-name', 'app-3-name'])
         expect(message.type).to eq('app')
-        expect(message.include).to match_array(['app'])
+        expect(message.include).to match_array(['app', 'service_instance'])
       end
 
       it 'converts requested keys to symbols' do
@@ -87,7 +87,7 @@ module VCAP::CloudController
         end
 
         it 'returns true for valid values' do
-          message = described_class.from_params({ 'include' => 'app' })
+          message = described_class.from_params({ 'include' => 'app, service_instance' })
           expect(message).to be_valid
         end
       end