v3(route-bindings): create and get metadata

Derik Evangelista · web-flow · commit 2871d5cb42a6 · 2020-10-30T17:07:11.000Z
* v3(route-bindings): create with metadata * v3(route-bindings): get metadata [#175092365](https://www.pivotaltracker.com/story/show/175092365) [#175092364](https://www.pivotaltracker.com/story/show/175092364)
diff --git a/app/actions/service_route_binding_create.rb b/app/actions/service_route_binding_create.rb
@@ -1,4 +1,5 @@
 require 'services/service_brokers/service_client_provider'
+require 'actions/metadata_update'
 require 'actions/v3/service_binding_create'
 
 module VCAP::CloudController
@@ -9,19 +10,23 @@ def initialize(service_event_repository)
         @service_event_repository = service_event_repository
       end
 
-      def precursor(service_instance, route)
+      def precursor(service_instance, route, message:)
         validate!(service_instance, route)
 
-        RouteBinding.new.save_with_new_operation(
-          {
-            service_instance: service_instance,
-            route: route,
-          },
-          {
-            type: 'create',
-            state: 'in progress',
-          }
-        )
+        RouteBinding.db.transaction do
+          b = RouteBinding.new.save_with_new_operation(
+            {
+              service_instance: service_instance,
+              route: route,
+            },
+            {
+              type: 'create',
+              state: 'in progress',
+            }
+          )
+          MetadataUpdate.update(b, message)
+          b
+        end
       end
 
       class UnprocessableCreate < StandardError; end
diff --git a/app/controllers/v3/service_route_bindings_controller.rb b/app/controllers/v3/service_route_bindings_controller.rb
@@ -46,7 +46,7 @@ def create
 
     check_parameters_support(service_instance, message)
     action = V3::ServiceRouteBindingCreate.new(service_event_repository)
-    precursor = action.precursor(service_instance, route)
+    precursor = action.precursor(service_instance, route, message: message)
 
     case service_instance
     when ManagedServiceInstance
diff --git a/app/messages/service_route_binding_create_message.rb b/app/messages/service_route_binding_create_message.rb
@@ -1,8 +1,8 @@
-require 'messages/base_message'
+require 'messages/metadata_base_message'
 require 'utils/hash_utils'
 
 module VCAP::CloudController
-  class ServiceRouteBindingCreateMessage < BaseMessage
+  class ServiceRouteBindingCreateMessage < MetadataBaseMessage
     register_allowed_keys [:relationships, :parameters]
 
     validates_with NoAdditionalKeysValidator, RelationshipValidator
diff --git a/app/models.rb b/app/models.rb
@@ -110,6 +110,8 @@
 require 'models/services/service_offering_annotation_model'
 require 'models/services/service_binding'
 require 'models/services/route_binding'
+require 'models/services/route_binding_label_model'
+require 'models/services/route_binding_annotation_model'
 require 'models/services/route_binding_operation'
 require 'models/services/service_dashboard_client'
 require 'models/services/service_instance'
diff --git a/app/models/services/route_binding.rb b/app/models/services/route_binding.rb
@@ -6,6 +6,11 @@ class RouteBinding < Sequel::Model
 
     one_to_one :route_binding_operation
 
+    one_to_many :labels, class: 'VCAP::CloudController::RouteBindingLabelModel', key: :resource_guid, primary_key: :guid
+    one_to_many :annotations, class: 'VCAP::CloudController::RouteBindingAnnotationModel', key: :resource_guid, primary_key: :guid
+    add_association_dependencies labels: :destroy
+    add_association_dependencies annotations: :destroy
+
     many_to_one :route
     many_to_one :service_instance
 
diff --git a/app/models/services/route_binding_annotation_model.rb b/app/models/services/route_binding_annotation_model.rb
@@ -0,0 +1,10 @@
+module VCAP::CloudController
+  class RouteBindingAnnotationModel < Sequel::Model(:route_binding_annotations)
+    many_to_one :route_binding,
+      primary_key: :guid,
+      key: :resource_guid,
+      without_guid_generation: true
+
+    def_column_alias(:key_name, :key)
+  end
+end
diff --git a/app/models/services/route_binding_label_model.rb b/app/models/services/route_binding_label_model.rb
@@ -0,0 +1,8 @@
+module VCAP::CloudController
+  class RouteBindingLabelModel < Sequel::Model(:route_binding_labels)
+    many_to_one :route_binding,
+      primary_key: :guid,
+      key: :resource_guid,
+      without_guid_generation: true
+  end
+end
diff --git a/app/presenters/v3/service_route_binding_presenter.rb b/app/presenters/v3/service_route_binding_presenter.rb
@@ -1,12 +1,14 @@
 require_relative 'base_presenter'
 require 'presenters/mixins/last_operation_helper'
+require 'presenters/mixins/metadata_presentation_helpers'
 
 module VCAP
   module CloudController
     module Presenters
       module V3
         class ServiceRouteBindingPresenter < BasePresenter
           include VCAP::CloudController::Presenters::Mixins::LastOperationHelper
+          include VCAP::CloudController::Presenters::Mixins::MetadataPresentationHelpers
 
           def to_hash
             base.merge(decorations)
@@ -21,6 +23,10 @@ def base
               created_at: binding.created_at,
               updated_at: binding.updated_at,
               last_operation: last_operation(binding),
+              metadata: {
+                labels: hashified_labels(binding.labels),
+                annotations: hashified_annotations(binding.annotations),
+              },
               relationships: relationships,
               links: links
             }
diff --git a/db/migrations/20201030105232_create_service_route_bindings_metadata_table.rb b/db/migrations/20201030105232_create_service_route_bindings_metadata_table.rb
@@ -0,0 +1,13 @@
+Sequel.migration do
+  change do
+    create_table(:route_binding_labels) do
+      VCAP::Migration.common(self)
+      VCAP::Migration.labels_common(self, :route_binding_labels, :route_bindings)
+    end
+
+    create_table(:route_binding_annotations) do
+      VCAP::Migration.common(self)
+      VCAP::Migration.annotations_common(self, :route_binding_annotations, :route_bindings)
+    end
+  end
+end
diff --git a/docs/v3/source/includes/api_resources/_service_route_bindings.erb b/docs/v3/source/includes/api_resources/_service_route_bindings.erb
@@ -11,6 +11,14 @@
     "updated_at": "2020-03-10T15:49:32Z",
     "created_at": "2020-03-10T15:49:29Z"
   },
+  "metadata": {
+    "annotations": {
+      "foo": "bar"
+    },
+    "labels": {
+      "baz": "qux"
+    }
+  },
   "relationships": {
     "service_instance": {
       "data": {
@@ -60,6 +68,14 @@
         "created_at": "2020-09-08T08:55:59Z",
         "updated_at": "2020-09-08T08:55:59Z",
         "last_operation": null,
+        "metadata": {
+          "annotations": {
+            "foo": "bar"
+          },
+          "labels": {
+            "baz": "qux"
+          }
+        },
         "relationships": {
           "service_instance": {
             "data": {
@@ -90,6 +106,14 @@
         "created_at": "2020-09-08T09:13:51Z",
         "updated_at": "2020-09-08T09:13:51Z",
         "last_operation": null,
+        "metadata": {
+          "annotations": {
+            "foo": "bar"
+          },
+          "labels": {
+            "baz": "qux"
+          }
+        },
         "relationships": {
           "service_instance": {
             "data": {
diff --git a/docs/v3/source/includes/experimental_resources/service_route_bindings/_create.md.erb b/docs/v3/source/includes/experimental_resources/service_route_bindings/_create.md.erb
@@ -10,6 +10,14 @@ curl "https://api.example.org/v3/service_route_bindings" \
   -H "Authorization: bearer [token]" \
   -H "Content-type: application/json" \
   -d '{
+    "metadata": {
+      "annotations": {
+        "foo": "bar"
+      },
+      "labels": {
+        "baz": "qux"
+      }
+    },
     "relationships": {
       "route": {
         "data": {
@@ -74,6 +82,8 @@ Name | Type | Description
 Name | Type | Description |
 ---- | ---- | ----------- |
 **parameters** | _object_ | A JSON object that is passed to the service broker
+**metadata.labels** | [_label object_](#labels) | Labels applied to the service route binding
+**metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the service route binding
 
 
 #### Permitted roles
diff --git a/docs/v3/source/includes/experimental_resources/service_route_bindings/_object.md.erb b/docs/v3/source/includes/experimental_resources/service_route_bindings/_object.md.erb
@@ -13,6 +13,8 @@ Name | Type | Description
 **created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
 **updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
 **route_service_url** | _string_ | The URL for the route service
+**metadata.labels** (*experimental*)| [_label object_](#labels) | Labels applied to the service route binding
+**metadata.annotations** (*experimental*) | [_annotation object_](#annotations) | Annotations applied to the service route binding
 **relationships.service_instance** | [_to-one relationship_](#to-one-relationships) | The service instance that the route is bound to
 **relationships.route** | [_to-one relationship_](#to-one-relationships) | The route that the service instance is bound to
 **links** | [_links object_](#links) | Links to related resources
diff --git a/spec/request/service_route_bindings_spec.rb b/spec/request/service_route_bindings_spec.rb
diff --git a/spec/unit/actions/service_route_binding_create_spec.rb b/spec/unit/actions/service_route_binding_create_spec.rb
diff --git a/spec/unit/messages/service_route_binding_create_message_spec.rb b/spec/unit/messages/service_route_binding_create_message_spec.rb
diff --git a/spec/unit/presenters/v3/service_route_binding_presenter_spec.rb b/spec/unit/presenters/v3/service_route_binding_presenter_spec.rb
