v3(route-bindings): update metadata

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

Author: Derik Evangelista

app/controllers/v3/service_route_bindings_controller.rb

@@ -13,7 +13,7 @@
 require 'cloud_controller/paging/sequel_paginator'
 
 class ServiceRouteBindingsController < ApplicationController
-  before_action :set_route_binding, only: [:show, :parameters, :destroy]
+  before_action :set_route_binding, except: [:create]
 
   def index
     message = list_message
@@ -93,6 +93,19 @@ def parameters
     unprocessable!('There is an operation in progress for the service route binding.')
   end
 
+  def update
+    route_binding_not_found! unless @route_binding.present? && can_read_space?(@route_binding.route.space)
+    unauthorized! unless can_write_space?(@route_binding.route.space)
+
+    unprocessable!('The service route binding is being deleted') if delete_in_progress?(@route_binding)
+
+    message = MetadataUpdateMessage.new(hashed_params[:body])
+    unprocessable!(message.errors.full_messages) unless message.valid?
+
+    updated_route_binding = TransactionalMetadataUpdate.update(@route_binding, message)
+    render status: :ok, json: Presenters::V3::ServiceRouteBindingPresenter.new(updated_route_binding)
+  end
+
   private
 
   AVAILABLE_DECORATORS = [
@@ -227,4 +240,8 @@ def already_exists!
   def set_route_binding
     @route_binding = RouteBinding.first(guid: hashed_params[:guid])
   end
+
+  def delete_in_progress?(binding)
+    binding.operation_in_progress? && binding.last_operation.type == 'delete'
+  end
 end

config/routes.rb

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

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

@@ -0,0 +1,48 @@
+### Update a service route binding
+
+```
+Example Request
+```
+
+```shell
+curl "https://api.example.org/v3/service_route_bindings/[guid]" \
+  -X PATCH \
+  -H "Authorization: bearer [token]" \
+  -H "Content-type: application/json" \
+  -d '{
+    "metadata": {
+      "labels": {"key": "value"},
+      "annotations": {"note": "detailed information"}
+    }
+  }'
+```
+
+```
+Example Response
+```
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+<%= yield_content :single_service_route_binding %>
+```
+
+This endpoint updates a service route bindings with labels and annotations.
+
+#### Definition
+`PATCH /v3/service_route_bindings/:guid`
+
+#### Optional parameters
+
+Name | Type | Description
+---- | ---- | -----------
+**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
+ |
+--- | ---
+Admin |
+Space Developer (only for service plans from space-scoped brokers) |
+

docs/v3/source/index.md

@@ -370,9 +370,10 @@ includes:
   - 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/list
+  - experimental_resources/service_route_bindings/create
+  - experimental_resources/service_route_bindings/update
   - experimental_resources/service_route_bindings/delete
   - experimental_resources/service_route_bindings/parameters
   - experimental_resources/service_instances/header

spec/request/service_route_bindings_spec.rb

@@ -1389,6 +1389,143 @@
     end
   end
 
+  describe 'PATCH /v3/service_plans/:guid' 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, route_service_url: route_service_url) }
+    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(:guid) { binding.guid }
+    let(:labels) { { potato: 'sweet' } }
+    let(:annotations) { { style: 'mashed', amount: 'all' } }
+    let(:update_request_body) {
+      {
+        metadata: {
+          labels: labels,
+          annotations: annotations
+        }
+      }
+    }
+
+    let(:api_call) { lambda { |user_headers| patch "/v3/service_route_bindings/#{guid}", update_request_body.to_json, user_headers } }
+
+    it 'can update labels and annotations' do
+      api_call.call(admin_headers)
+      expect(last_response).to have_status_code(200)
+      expect(parsed_response.deep_symbolize_keys).to include(update_request_body)
+    end
+
+    context 'when some labels are invalid' do
+      let(:labels) { { potato: 'sweet invalid potato' } }
+
+      it 'returns a proper failure' do
+        api_call.call(admin_headers)
+
+        expect(last_response).to have_status_code(422)
+        expect(parsed_response['errors'][0]['detail']).to match(/Metadata [\w\s]+ error/)
+      end
+    end
+
+    context 'when some annotations are invalid' do
+      let(:annotations) { { '/style' => 'sweet invalid style' } }
+
+      it 'returns a proper failure' do
+        api_call.call(admin_headers)
+
+        expect(last_response).to have_status_code(422)
+        expect(parsed_response['errors'][0]['detail']).to match(/Metadata [\w\s]+ error/)
+      end
+    end
+
+    context 'when the route binding does not exist' do
+      let(:guid) { 'moonlight-sonata' }
+
+      it 'returns a not found error' do
+        api_call.call(admin_headers)
+        expect(last_response).to have_status_code(404)
+      end
+    end
+
+    context 'when the route binding is being created' do
+      before do
+        binding.save_with_new_operation(
+          {},
+          { type: 'create', state: 'in progress', broker_provided_operation: 'some-info' }
+        )
+      end
+
+      before do
+        api_call.call(admin_headers)
+        expect(last_response).to have_status_code(200)
+        binding.reload
+      end
+
+      it 'can still update metadata' do
+        expect(binding).to have_labels({ prefix: nil, key: 'potato', value: 'sweet' })
+        expect(binding).to have_annotations({ prefix: nil, key: 'style', value: 'mashed' }, { prefix: nil, key: 'amount', value: 'all' })
+      end
+
+      it 'does not update last operation' do
+        expect(binding.last_operation.type).to eq('create')
+        expect(binding.last_operation.state).to eq('in progress')
+        expect(binding.last_operation.broker_provided_operation).to eq('some-info')
+      end
+    end
+
+    context 'when the route binding is being deleted' do
+      before do
+        binding.save_with_new_operation(
+          {},
+          { type: 'delete', state: 'in progress', broker_provided_operation: 'some-info' }
+        )
+      end
+
+      it 'responds with a 422' do
+        api_call.call(admin_headers)
+        expect(last_response).to have_status_code(422)
+      end
+
+      it 'does not update last operation' do
+        api_call.call(admin_headers)
+        binding.reload
+        expect(binding.last_operation.type).to eq('delete')
+        expect(binding.last_operation.state).to eq('in progress')
+        expect(binding.last_operation.broker_provided_operation).to eq('some-info')
+      end
+    end
+
+    context 'permissions' do
+      let(:response_object) {
+        expected_json(
+          binding_guid: binding.guid,
+          route_service_url: route_service_url,
+          service_instance_guid: service_instance.guid,
+          route_guid: route.guid,
+          last_operation_type: 'create',
+          last_operation_state: 'successful',
+          include_params_link: service_instance.managed_instance?,
+          metadata: {
+            labels: labels,
+            annotations: annotations
+          }
+        )
+      }
+
+      let(:expected_codes_and_responses) do
+        Hash.new(code: 403).tap do |h|
+          h['admin'] = { code: 200, response_object: response_object }
+          h['space_developer'] = { code: 200, response_object: response_object }
+          h['no_role'] = { code: 404 }
+          h['org_auditor'] = { code: 404 }
+          h['org_billing_manager'] = { code: 404 }
+        end
+      end
+
+      it_behaves_like 'permissions for single object endpoint', ALL_PERMISSIONS
+    end
+  end
+
   let(:user) { VCAP::CloudController::User.make }
   let(:org) { VCAP::CloudController::Organization.make }
   let(:space) { VCAP::CloudController::Space.make(organization: org) }