Packages, packages for app, org quotas, and roles can be filtered by created_ats and updated_ats

[#173719526]

Co-authored-by: Chris Selzo <cselzo@pivotal.io>
Co-authored-by: Sarah Weinstein <sweinstein@pivotal.io>

Author: selzoc

app/controllers/v3/packages_controller.rb

@@ -21,13 +21,13 @@ def index
     invalid_param!(message.errors.full_messages) unless message.valid?
 
     if app_nested?
-      app, dataset = PackageListFetcher.new.fetch_for_app(message: message)
+      app, dataset = PackageListFetcher.fetch_for_app(message: message)
       app_not_found! unless app && permission_queryer.can_read_from_space?(app.space.guid, app.organization.guid)
     else
       dataset = if permission_queryer.can_read_globally?
-                  PackageListFetcher.new.fetch_all(message: message)
+                  PackageListFetcher.fetch_all(message: message)
                 else
-                  PackageListFetcher.new.fetch_for_spaces(message: message, space_guids: permission_queryer.readable_space_guids)
+                  PackageListFetcher.fetch_for_spaces(message: message, space_guids: permission_queryer.readable_space_guids)
                 end
     end
 

app/fetchers/organization_quota_list_fetcher.rb

@@ -1,8 +1,9 @@
 require 'cloud_controller/paging/sequel_paginator'
 require 'cloud_controller/paging/paginated_result'
+require 'fetchers/base_list_fetcher'
 
 module VCAP::CloudController
-  class OrganizationQuotaListFetcher
+  class OrganizationQuotaListFetcher < BaseListFetcher
     class << self
       def fetch(message:, readable_org_guids:)
         dataset = QuotaDefinition.dataset
@@ -27,7 +28,7 @@ def filter(message, dataset, readable_org_guids)
                     qualify(:quota_definitions)
         end
 
-        dataset
+        super(message, dataset, QuotaDefinition)
       end
     end
   end

app/fetchers/package_list_fetcher.rb

@@ -1,76 +1,80 @@
-module VCAP::CloudController
-  class PackageListFetcher
-    def fetch_all(message:)
-      filter(message, joined_dataset)
-    end
+require 'fetchers/base_list_fetcher'
 
-    def fetch_for_spaces(message:, space_guids:)
-      dataset = joined_dataset.where(table_column_name(AppModel, :space_guid) => space_guids)
-      filter(message, dataset)
-    end
+module VCAP::CloudController
+  class PackageListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message:)
+        filter(message, joined_dataset)
+      end
 
-    def fetch_for_app(message:)
-      app_dataset = AppModel.where(guid: message.app_guid).eager(:space, :organization)
-      app = app_dataset.first
-      return [nil, nil] unless app
+      def fetch_for_spaces(message:, space_guids:)
+        dataset = joined_dataset.where(table_column_name(AppModel, :space_guid) => space_guids)
+        filter(message, dataset)
+      end
 
-      dataset = PackageModel.dataset.select_all(PackageModel.table_name).
-                join(AppModel.table_name, guid: :app_guid).
-                where(table_column_name(AppModel, :guid) => message.app_guid)
+      def fetch_for_app(message:)
+        app_dataset = AppModel.where(guid: message.app_guid).eager(:space, :organization)
+        app = app_dataset.first
+        return [nil, nil] unless app
 
-      [app, filter(message, dataset)]
-    end
+        dataset = PackageModel.dataset.select_all(PackageModel.table_name).
+                  join(AppModel.table_name, guid: :app_guid).
+                  where(table_column_name(AppModel, :guid) => message.app_guid)
 
-    private
+        [app, filter(message, dataset)]
+      end
 
-    def table_column_name(table_class, name)
-      "#{table_class.table_name}__#{name}".to_sym
-    end
+      private
 
-    def joined_dataset
-      PackageModel.dataset.select_all(PackageModel.table_name).
-        join(AppModel.table_name, guid: :app_guid)
-    end
-
-    def filter(message, dataset)
-      if message.requested? :states
-        dataset = dataset.where(table_column_name(PackageModel, :state) => message.states)
+      def table_column_name(table_class, name)
+        "#{table_class.table_name}__#{name}".to_sym
       end
 
-      if message.requested? :types
-        dataset = dataset.where(table_column_name(PackageModel, :type) => message.types)
+      def joined_dataset
+        PackageModel.dataset.select_all(PackageModel.table_name).
+          join(AppModel.table_name, guid: :app_guid)
       end
 
-      if message.requested? :guids
-        dataset = dataset.where(table_column_name(PackageModel, :guid) => message.guids)
-      end
+      def filter(message, dataset)
+        if message.requested? :states
+          dataset = dataset.where(table_column_name(PackageModel, :state) => message.states)
+        end
 
-      if message.requested? :app_guids
-        dataset = dataset.where(table_column_name(AppModel, :guid) => message.app_guids)
-      end
+        if message.requested? :types
+          dataset = dataset.where(table_column_name(PackageModel, :type) => message.types)
+        end
 
-      if message.requested? :space_guids
-        dataset = dataset.where(table_column_name(AppModel, :space_guid) => message.space_guids)
-      end
+        if message.requested? :guids
+          dataset = dataset.where(table_column_name(PackageModel, :guid) => message.guids)
+        end
 
-      if message.requested? :organization_guids
-        dataset = dataset.
-                  join(:spaces, guid: :space_guid).
-                  join(:organizations, id: :organization_id).
-                  where(Sequel[:organizations][:guid] => message.organization_guids).
-                  qualify(:packages)
-      end
+        if message.requested? :app_guids
+          dataset = dataset.where(table_column_name(AppModel, :guid) => message.app_guids)
+        end
 
-      if message.requested?(:label_selector)
-        dataset = LabelSelectorQueryGenerator.add_selector_queries(
-          label_klass: PackageLabelModel,
-          resource_dataset: dataset,
-          requirements: message.requirements,
-          resource_klass: PackageModel,
-        )
-      end
+        if message.requested? :space_guids
+          dataset = dataset.where(table_column_name(AppModel, :space_guid) => message.space_guids)
+        end
+
+        if message.requested? :organization_guids
+          dataset = dataset.
+                    join(:spaces, guid: :space_guid).
+                    join(:organizations, id: :organization_id).
+                    where(Sequel[:organizations][:guid] => message.organization_guids).
+                    qualify(:packages)
+        end
 
-      dataset
+        if message.requested?(:label_selector)
+          dataset = LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: PackageLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: PackageModel,
+          )
+        end
+
+        super(message, dataset, PackageModel)
+      end
     end
   end
 end

app/fetchers/role_list_fetcher.rb

@@ -1,8 +1,9 @@
 require 'cloud_controller/paging/sequel_paginator'
 require 'cloud_controller/paging/paginated_result'
+require 'fetchers/base_list_fetcher'
 
 module VCAP::CloudController
-  class RoleListFetcher
+  class RoleListFetcher < BaseListFetcher
     class << self
       def fetch(message, readable_users_dataset, eager_loaded_associations: [])
         filter(message, readable_users_dataset).eager(eager_loaded_associations)
@@ -29,7 +30,8 @@ def filter(message, dataset)
           space_ids = Space.dataset.where(guid: message.space_guids).select(:id)
           dataset = dataset.where(space_id: space_ids)
         end
-        dataset
+
+        super(message, dataset, Role)
       end
     end
   end

spec/request/organization_quotas_spec.rb

@@ -212,6 +212,14 @@ module VCAP::CloudController
 
         it_behaves_like 'permissions for list endpoint', ALL_PERMISSIONS
 
+        it_behaves_like 'list_endpoint_with_common_filters' do
+          let(:resource_klass) { VCAP::CloudController::QuotaDefinition }
+          let(:api_call) do
+            lambda { |headers, filters| get "/v3/organization_quotas?#{filters}", nil, headers }
+          end
+          let(:headers) { admin_headers }
+        end
+
         context 'with filters' do
           let!(:organization_quota_2) { VCAP::CloudController::QuotaDefinition.make(guid: 'second-guid', name: 'second-name') }
           let!(:organization_quota_3) { VCAP::CloudController::QuotaDefinition.make(guid: 'third-guid', name: 'third-name') }

spec/request/packages_spec.rb

@@ -161,7 +161,7 @@
 
   describe 'GET /v3/apps/:guid/packages' do
     let(:space) { VCAP::CloudController::Space.make }
-    let!(:package) { VCAP::CloudController::PackageModel.make(app_guid: app_model.guid, created_at: Time.at(1)) }
+    let!(:package) { VCAP::CloudController::PackageModel.make(app_guid: app_model.guid) }
     let(:app_model) { VCAP::CloudController::AppModel.make(space_guid: space.guid) }
     let(:guid) { app_model.guid }
     let(:page) { 1 }
@@ -174,7 +174,7 @@
     end
 
     it 'lists paginated result of all packages for an app' do
-      package2 = VCAP::CloudController::PackageModel.make(app_guid: app_model.guid, created_at: Time.at(2))
+      package2 = VCAP::CloudController::PackageModel.make(app_guid: app_model.guid, created_at: package.created_at + 1.hour)
 
       expected_response = {
         'pagination' => {
@@ -235,6 +235,15 @@
       expect(parsed_response).to be_a_response_like(expected_response)
     end
 
+    it_behaves_like 'list_endpoint_with_common_filters' do
+      let(:resource_klass) { VCAP::CloudController::PackageModel }
+      let(:api_call) do
+        lambda { |headers, filters| get "/v3/apps/#{guid}/packages?#{filters}", nil, headers }
+      end
+      let(:additional_resource_params) { { app: app_model } }
+      let(:headers) { admin_headers }
+    end
+
     context 'faceted search' do
       it 'filters by types' do
         VCAP::CloudController::PackageModel.make(app_guid: app_model.guid, type: VCAP::CloudController::PackageModel::BITS_TYPE)
@@ -349,6 +358,14 @@
       end
     end
 
+    it_behaves_like 'list_endpoint_with_common_filters' do
+      let(:resource_klass) { VCAP::CloudController::PackageModel }
+      let(:api_call) do
+        lambda { |headers, filters| get "/v3/packages?#{filters}", nil, headers }
+      end
+      let(:headers) { admin_headers }
+    end
+
     it 'gets all the packages' do
       bits_package = VCAP::CloudController::PackageModel.make(type: bits_type, app_guid: app_model.guid)
       docker_package = VCAP::CloudController::PackageModel.make(

spec/request/processes_spec.rb

@@ -910,6 +910,15 @@
     let!(:revision2) { VCAP::CloudController::RevisionModel.make }
     let!(:deployment_revision) { VCAP::CloudController::RevisionModel.make }
 
+    it_behaves_like 'list_endpoint_with_common_filters' do
+      let(:resource_klass) { VCAP::CloudController::ProcessModel }
+      let(:additional_resource_params) { { app: app_model } }
+      let(:api_call) do
+        lambda { |headers, filters| get "/v3/apps/#{app_model.guid}/processes?#{filters}", nil, headers }
+      end
+      let(:headers) { admin_headers }
+    end
+
     it 'returns a paginated list of processes for an app' do
       get "/v3/apps/#{app_model.guid}/processes?per_page=2", nil, developer_headers
 

spec/request/roles_spec.rb

@@ -924,6 +924,15 @@ def make_space_role_for_current_user(type)
       }
     end
 
+    it_behaves_like 'list_endpoint_with_common_filters' do
+      let(:resource_klass) { VCAP::CloudController::SpaceAuditor }
+      let(:additional_resource_params) { { user: user } }
+      let(:api_call) do
+        lambda { |headers, filters| get "/v3/roles?#{filters}", nil, headers }
+      end
+      let(:headers) { admin_headers }
+    end
+
     describe 'list query parameters' do
       before do
         allow(uaa_client).to receive(:users_for_ids).and_return([])