ServiceBindingFilesBuilder

Author: philippthun

lib/cloud_controller/diego/service_binding_files_builder.rb

@@ -0,0 +1,44 @@
+class ServiceBindingFilesBuilder
+  def self.build(app_or_process)
+    new(app_or_process).build
+  end
+
+  def initialize(app_or_process)
+    @service_bindings = app_or_process.service_bindings
+  end
+
+  def build
+    service_binding_files = {}
+
+    @service_bindings.select(&:create_succeeded?).each do |service_binding|
+      sb_hash = ServiceBindingPresenter.new(service_binding, include_instance: true).to_hash
+      dir = sb_hash[:name]
+      label = sb_hash[:label]
+
+      sb_hash.delete(:credentials)&.each { |k, v| add_file(service_binding_files, dir, k, v) }
+
+      sb_hash.each { |k, v| add_file(service_binding_files, dir, k, v) }
+
+      add_file(service_binding_files, dir, 'type', label)
+      add_file(service_binding_files, dir, 'provider', label)
+    end
+
+    service_binding_files.values
+  end
+
+  private
+
+  def add_file(service_binding_files, dir, key, value)
+    content = if value.nil?
+                return
+              elsif value.is_a?(String)
+                value
+              else
+                return if (value.is_a?(Array) || value.is_a?(Hash)) && value.empty?
+
+                Oj.dump(value, mode: :compat)
+              end
+
+    service_binding_files[key.to_sym] = ::Diego::Bbs::Models::Files.new(name: "#{dir}/#{key}", value: content)
+  end
+end

spec/unit/lib/cloud_controller/diego/service_binding_files_builder_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+require 'cloud_controller/diego/service_binding_files_builder'
+
+module VCAP::CloudController::Diego
+  RSpec.shared_examples 'mapping of type and provider' do |label|
+    it 'sets type and provider to the service label' do
+      expect(service_binding_files.find { |f| f.name == "#{directory}/type" }).to have_attributes(value: label || 'service-name')
+      expect(service_binding_files.find { |f| f.name == "#{directory}/provider" }).to have_attributes(value: label || 'service-name')
+      expect(service_binding_files.find { |f| f.name == "#{directory}/label" }).to have_attributes(value: label || 'service-name')
+    end
+  end
+
+  RSpec.shared_examples 'mapping of binding metadata' do |name|
+    it 'maps service binding metadata attributes to files' do
+      expect(service_binding_files.find { |f| f.name == "#{directory}/binding_guid" }).to have_attributes(value: binding.guid)
+      expect(service_binding_files.find { |f| f.name == "#{directory}/name" }).to have_attributes(value: name || 'binding-name')
+      expect(service_binding_files.find { |f| f.name == "#{directory}/binding_name" }).to have_attributes(value: 'binding-name') if name.nil?
+    end
+  end
+
+  RSpec.shared_examples 'mapping of instance metadata' do |instance_name|
+    it 'maps service instance metadata attributes to files' do
+      expect(service_binding_files.find { |f| f.name == "#{directory}/instance_guid" }).to have_attributes(value: instance.guid)
+      expect(service_binding_files.find { |f| f.name == "#{directory}/instance_name" }).to have_attributes(value: instance_name || 'instance-name')
+    end
+  end
+
+  RSpec.shared_examples 'mapping of plan metadata' do
+    it 'maps service plan metadata attributes to files' do
+      expect(service_binding_files.find { |f| f.name == "#{directory}/plan" }).to have_attributes(value: 'plan-name')
+    end
+  end
+
+  RSpec.shared_examples 'mapping of tags' do |tags|
+    it 'maps (service tags merged with) instance tags to a file' do
+      expect(service_binding_files.find do |f|
+        f.name == "#{directory}/tags"
+      end).to have_attributes(value: tags || '["a-service-tag","another-service-tag","an-instance-tag","another-instance-tag"]')
+    end
+  end
+
+  RSpec.shared_examples 'mapping of credentials' do |credential_files|
+    it 'maps service binding credentials to individual files' do
+      expected_credential_files = credential_files || {
+        string: 'a string',
+        number: '42',
+        boolean: 'true',
+        array: '["one","two","three"]',
+        hash: '{"key":"value"}'
+      }
+      expected_credential_files.each do |name, content|
+        expect(service_binding_files.find { |f| f.name == "#{directory}/#{name}" }).to have_attributes(value: content)
+      end
+    end
+  end
+
+  RSpec.shared_examples 'expected files' do |files|
+    it 'does not include other files' do
+      other_files = service_binding_files.reject do |file|
+        match = file.name.match(%r{^#{directory}/(.+)$})
+        !match.nil? && !files.delete(match[1]).nil?
+      end
+
+      expect(files).to be_empty
+      expect(other_files).to be_empty
+    end
+  end
+
+  RSpec.describe ServiceBindingFilesBuilder do
+    let(:service) { VCAP::CloudController::Service.make(label: 'service-name', tags: %w[a-service-tag another-service-tag]) }
+    let(:plan) { VCAP::CloudController::ServicePlan.make(name: 'plan-name', service: service) }
+    let(:instance) { VCAP::CloudController::ManagedServiceInstance.make(name: 'instance-name', tags: %w[an-instance-tag another-instance-tag], service_plan: plan) }
+    let(:binding_name) { 'binding-name' }
+    let(:credentials) do
+      {
+        string: 'a string',
+        number: 42,
+        boolean: true,
+        array: %w[one two three],
+        hash: {
+          key: 'value'
+        }
+      }
+    end
+    let(:syslog_drain_url) { nil }
+    let(:volume_mounts) { nil }
+    let(:binding) do
+      VCAP::CloudController::ServiceBinding.make(
+        name: binding_name,
+        credentials: credentials,
+        service_instance: instance,
+        syslog_drain_url: syslog_drain_url,
+        volume_mounts: volume_mounts
+      )
+    end
+    let(:app) { binding.app }
+    let(:directory) { 'binding-name' }
+
+    describe '#build' do
+      subject(:build) { ServiceBindingFilesBuilder.build(app) }
+
+      it 'returns an array of Diego::Bbs::Models::Files' do
+        expect(build).to be_an(Array)
+        expect(build).not_to be_empty
+        expect(build).to all(be_a(Diego::Bbs::Models::Files))
+      end
+
+      describe 'mapping rules for service binding files' do
+        subject(:service_binding_files) { build }
+
+        it 'puts all files into a directory named after the service binding' do
+          expect(service_binding_files).not_to be_empty
+          expect(service_binding_files).to all(have_attributes(name: match(%r{^binding-name/.+$})))
+        end
+
+        include_examples 'mapping of type and provider'
+        include_examples 'mapping of binding metadata'
+        include_examples 'mapping of instance metadata'
+        include_examples 'mapping of plan metadata'
+        include_examples 'mapping of tags'
+        include_examples 'mapping of credentials'
+
+        it 'omits null or empty array attributes' do
+          expect(service_binding_files).not_to include(have_attributes(name: 'binding-name/syslog_drain_url'))
+          expect(service_binding_files).not_to include(have_attributes(name: 'binding-name/volume_mounts'))
+        end
+
+        include_examples 'expected files', %w[type provider label binding_guid name binding_name instance_guid instance_name plan tags string number boolean array hash]
+
+        context 'when binding name is nil' do
+          let(:binding_name) { nil }
+          let(:directory) { 'instance-name' }
+
+          include_examples 'mapping of type and provider'
+          include_examples 'mapping of binding metadata', 'instance-name'
+          include_examples 'mapping of instance metadata'
+          include_examples 'mapping of plan metadata'
+          include_examples 'mapping of tags'
+          include_examples 'mapping of credentials'
+
+          include_examples 'expected files', %w[type provider label binding_guid name instance_guid instance_name plan tags string number boolean array hash]
+        end
+
+        context 'when syslog_drain_url is set' do
+          let(:syslog_drain_url) { 'https://syslog.drain' }
+
+          it 'maps the attribute to a file' do
+            expect(service_binding_files.find { |f| f.name == 'binding-name/syslog_drain_url' }).to have_attributes(value: 'https://syslog.drain')
+          end
+
+          include_examples 'mapping of type and provider'
+          include_examples 'mapping of binding metadata'
+          include_examples 'mapping of instance metadata'
+          include_examples 'mapping of plan metadata'
+          include_examples 'mapping of tags'
+          include_examples 'mapping of credentials'
+
+          include_examples 'expected files',
+                           %w[type provider label binding_guid name binding_name instance_guid instance_name plan tags string number boolean array hash syslog_drain_url]
+        end
+
+        context 'when volume_mounts is set' do
+          let(:volume_mounts) do
+            [{
+              container_dir: 'dir1',
+              device_type: 'type1',
+              mode: 'mode1',
+              foo: 'bar'
+            }, {
+              container_dir: 'dir2',
+              device_type: 'type2',
+              mode: 'mode2',
+              foo: 'baz'
+            }]
+          end
+
+          it 'maps the attribute to a file' do
+            expect(service_binding_files.find do |f|
+              f.name == 'binding-name/volume_mounts'
+            end).to have_attributes(value: '[{"container_dir":"dir1","device_type":"type1","mode":"mode1"},{"container_dir":"dir2","device_type":"type2","mode":"mode2"}]')
+          end
+
+          include_examples 'mapping of type and provider'
+          include_examples 'mapping of binding metadata'
+          include_examples 'mapping of instance metadata'
+          include_examples 'mapping of plan metadata'
+          include_examples 'mapping of tags'
+          include_examples 'mapping of credentials'
+
+          include_examples 'expected files',
+                           %w[type provider label binding_guid name binding_name instance_guid instance_name plan tags string number boolean array hash volume_mounts]
+        end
+
+        context 'when the instance is user-provided' do
+          let(:instance) { VCAP::CloudController::UserProvidedServiceInstance.make(name: 'upsi', tags: %w[an-upsi-tag another-upsi-tag]) }
+
+          include_examples 'mapping of type and provider', 'user-provided'
+          include_examples 'mapping of binding metadata'
+          include_examples 'mapping of instance metadata', 'upsi'
+          include_examples 'mapping of tags', '["an-upsi-tag","another-upsi-tag"]'
+          include_examples 'mapping of credentials'
+
+          include_examples 'expected files', %w[type provider label binding_guid name binding_name instance_guid instance_name tags string number boolean array hash]
+        end
+
+        context 'when there are duplicate keys at different levels' do
+          let(:credentials) { { type: 'duplicate-type', name: 'duplicate-name', credentials: { password: 'secret' } } }
+
+          include_examples 'mapping of type and provider' # no 'duplicate-type'
+          include_examples 'mapping of binding metadata' # no 'duplicate-name'
+          include_examples 'mapping of instance metadata'
+          include_examples 'mapping of plan metadata'
+          include_examples 'mapping of tags'
+          include_examples 'mapping of credentials', { credentials: '{"password":"secret"}' }
+
+          include_examples 'expected files', %w[type provider label binding_guid name binding_name instance_guid instance_name plan tags credentials]
+        end
+      end
+    end
+  end
+end