v3(services): filter route bindings by labels

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

Author: pivotal-marcela-campo

app/fetchers/route_binding_list_fetcher.rb

@@ -39,6 +39,14 @@ def filter(message, bindings)
         end,
         route_guids: ->(dataset, message) do
           dataset.where { Sequel[:routes][:guid] =~ message.route_guids }
+        end,
+        label_selector: ->(dataset, message) do
+          LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: RouteBindingLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: RouteBinding
+          )
         end
       }.freeze
     end

app/messages/service_route_bindings_list_message.rb

@@ -1,8 +1,8 @@
-require 'messages/list_message'
+require 'messages/metadata_list_message'
 
 module VCAP
   module CloudController
-    class ServiceRouteBindingsListMessage < ListMessage
+    class ServiceRouteBindingsListMessage < MetadataListMessage
       QUERY_PARAMS = %w[
         service_instance_guids
         service_instance_names

spec/request/service_route_bindings_spec.rb

@@ -86,9 +86,7 @@
 
         expect(last_response).to have_status_code(200)
 
-        expected_route_binding_guids = filtered_route_bindings.map(&:guid)
-        route_binding_guids = parsed_response['resources'].map { |x| x['guid'] }
-        expect(route_binding_guids).to match_array(expected_route_binding_guids)
+        expect_route_bindings(filtered_route_bindings)
       end
 
       it 'can be filtered by service instance names' do
@@ -103,9 +101,7 @@
 
         expect(last_response).to have_status_code(200)
 
-        expected_route_binding_guids = filtered_route_bindings.map(&:guid)
-        route_binding_guids = parsed_response['resources'].map { |x| x['guid'] }
-        expect(route_binding_guids).to match_array(expected_route_binding_guids)
+        expect_route_bindings(filtered_route_bindings)
       end
 
       it 'can be filtered by route guids' do
@@ -120,9 +116,29 @@
 
         expect(last_response).to have_status_code(200)
 
-        expected_route_binding_guids = filtered_route_bindings.map(&:guid)
-        route_binding_guids = parsed_response['resources'].map { |x| x['guid'] }
-        expect(route_binding_guids).to match_array(expected_route_binding_guids)
+        expect_route_bindings(filtered_route_bindings)
+      end
+
+      it 'filters by label' do
+        rb1 = VCAP::CloudController::RouteBinding.make
+        rb2 = VCAP::CloudController::RouteBinding.make
+        rb3 = VCAP::CloudController::RouteBinding.make
+        rb4 = VCAP::CloudController::RouteBinding.make
+        rb5 = VCAP::CloudController::RouteBinding.make
+        filtered_route_bindings = [rb2, rb3]
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'fruit', value: 'strawberry', route_binding: rb1)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'animal', value: 'horse', route_binding: rb1)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'env', value: 'prod', route_binding: rb2)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'animal', value: 'dog', route_binding: rb2)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'env', value: 'prod', route_binding: rb3)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'animal', value: 'horse', route_binding: rb3)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'env', value: 'prod', route_binding: rb4)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'env', value: 'staging', route_binding: rb5)
+        VCAP::CloudController::RouteBindingLabelModel.make(key_name: 'animal', value: 'dog', route_binding: rb5)
+
+        get '/v3/service_route_bindings?label_selector=!fruit,env=prod,animal in (dog,horse)', nil, admin_headers
+
+        expect_route_bindings(filtered_route_bindings)
       end
     end
 
@@ -1607,4 +1623,9 @@ def bind_service_to_route(service_instance, route)
       { type: 'create', state: 'successful' }
     )
   end
+
+  def expect_route_bindings(route_bindings)
+    response_guids = parsed_response['resources'].map { |x| x['guid'] }
+    expect(response_guids).to match_array(route_bindings.map(&:guid))
+  end
 end

spec/support/fakes/blueprints.rb

@@ -32,7 +32,7 @@
 
 module VCAP::CloudController
   %w/App Build Buildpack Deployment Domain Droplet IsolationSegment Organization Package
-     Process Revision Route ServiceInstance ServiceOffering ServiceBroker Space Stack
+     Process Revision Route RouteBinding ServiceInstance ServiceOffering ServiceBroker Space Stack
      ServicePlan Task User/.each do |root|
     "VCAP::CloudController::#{root}LabelModel".constantize.blueprint do end
     "VCAP::CloudController::#{root}AnnotationModel".constantize.blueprint do end

spec/unit/fetchers/route_binding_list_fetcher_spec.rb

@@ -13,9 +13,7 @@ module CloudController
             ServiceRouteBindingsListMessage.from_params({})
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_route_binding_guids = route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_route_binding_guids)
+          expect_binding_guids(fetched_route_bindings, route_bindings)
         end
 
         it 'can be filtered by service_instance_guids' do
@@ -26,9 +24,7 @@ module CloudController
             ServiceRouteBindingsListMessage.from_params({ 'service_instance_guids' => service_instance_guids })
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
         end
 
         it 'can be filtered by service_instance_names' do
@@ -39,9 +35,7 @@ module CloudController
             ServiceRouteBindingsListMessage.from_params({ 'service_instance_names' => service_instance_names })
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
         end
 
         it 'can be filtered by route_guids' do
@@ -52,9 +46,25 @@ module CloudController
             ServiceRouteBindingsListMessage.from_params({ 'route_guids' => route_guids })
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
+        end
+
+        context 'can be filtered by label selector' do
+          before do
+            RouteBindingLabelModel.make(key_name: 'fruit', value: 'strawberry', route_binding: route_bindings[0])
+            RouteBindingLabelModel.make(key_name: 'fruit', value: 'strawberry', route_binding: route_bindings[1])
+            RouteBindingLabelModel.make(key_name: 'fruit', value: 'lemon', route_binding: route_bindings[2])
+          end
+
+          it 'returns instances with matching labels' do
+            filtered_route_bindings = route_bindings[0..1]
+
+            fetched_route_bindings = fetcher.fetch_all(
+              ServiceRouteBindingsListMessage.from_params({ 'label_selector' => 'fruit=strawberry' })
+            )
+
+            expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
+          end
         end
       end
 
@@ -74,9 +84,7 @@ module CloudController
             space_guids: [target_space.guid]
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          target_space_route_binding_guids = route_bindings_in_target_space.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(target_space_route_binding_guids)
+          expect_binding_guids(fetched_route_bindings, route_bindings_in_target_space)
         end
 
         it 'can be filtered by service_instance_guids' do
@@ -93,9 +101,7 @@ module CloudController
             space_guids: [target_space.guid]
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
         end
 
         it 'can be filtered by service_instance_names' do
@@ -112,9 +118,7 @@ module CloudController
             space_guids: [target_space.guid]
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
         end
 
         it 'can be filtered by route_guids' do
@@ -131,15 +135,17 @@ module CloudController
             space_guids: [target_space.guid]
           )
 
-          fetched_route_binding_guids = fetched_route_bindings.map(&:guid)
-          expected_binding_guids = filtered_route_bindings.map(&:guid)
-          expect(fetched_route_binding_guids).to match_array(expected_binding_guids)
+          expect_binding_guids(fetched_route_bindings, filtered_route_bindings)
         end
 
         def make_other_route_bindings
           Array.new(3) { RouteBinding.make }
         end
       end
+
+      def expect_binding_guids(fetched_route_bindings, expected_route_bindings)
+        expect(fetched_route_bindings.map(&:guid)).to match_array(expected_route_bindings.map(&:guid))
+      end
     end
   end
 end

spec/unit/messages/service_route_bindings_list_message_spec.rb

@@ -12,6 +12,7 @@ module CloudController
             'service_instance_guids' => 'guid-1,guid-2,guid-3',
             'service_instance_names' => 'name-1,name-2,name-3',
             'route_guids' => 'guid-4,guid-5,guid-6',
+            'label_selector' => 'key=value',
             'include' => 'service_instance'
           }
         end
@@ -27,6 +28,7 @@ module CloudController
           expect(message.service_instance_names).to eq(%w[name-1 name-2 name-3])
           expect(message.route_guids).to eq(%w[guid-4 guid-5 guid-6])
           expect(message.include).to eq(%w[service_instance])
+          expect(message.label_selector).to eq('key=value')
         end
 
         it 'converts requested keys to symbols' do
@@ -35,6 +37,7 @@ module CloudController
           expect(message.requested?(:service_instance_guids)).to be_truthy
           expect(message.requested?(:service_instance_names)).to be_truthy
           expect(message.requested?(:route_guids)).to be_truthy
+          expect(message.requested?(:label_selector)).to be_truthy
         end
       end
 
@@ -51,6 +54,16 @@ module CloudController
             expect(message).to be_valid
           end
         end
+
+        it 'validates metadata requirements' do
+          message = described_class.from_params({ 'label_selector' => '' }.with_indifferent_access)
+
+          expect_any_instance_of(Validators::LabelSelectorRequirementValidator).
+            to receive(:validate).
+            with(message).
+            and_call_original
+          message.valid?
+        end
       end
     end
   end