cloudfoundry/cloud_controller_ng

View on GitHub
app/models/services/service.rb

Summary

Maintainability
A
3 hrs
Test Coverage
module VCAP::CloudController
  class Service < Sequel::Model
    plugin :serialization

    many_to_one :service_broker
    one_to_many :service_plans
    add_association_dependencies service_plans: :destroy

    one_to_many :labels, class: 'VCAP::CloudController::ServiceOfferingLabelModel', key: :resource_guid, primary_key: :guid
    one_to_many :annotations, class: 'VCAP::CloudController::ServiceOfferingAnnotationModel', key: :resource_guid, primary_key: :guid
    add_association_dependencies labels: :destroy
    add_association_dependencies annotations: :destroy

    export_attributes :label, :provider, :url, :description, :long_description,
                      :version, :info_url, :active, :bindable,
                      :unique_id, :extra, :tags, :requires, :documentation_url,
                      :service_broker_guid, :plan_updateable, :bindings_retrievable,
                      :instances_retrievable, :allow_context_updates

    import_attributes :label, :description, :long_description, :info_url,
                      :active, :bindable, :unique_id, :extra,
                      :tags, :requires, :documentation_url, :plan_updateable,
                      :bindings_retrievable, :instances_retrievable,
                      :allow_context_updates

    strip_attributes :label

    alias_method :name, :label

    class << self
      def public_visible
        public_active_plans = ServicePlan.where(active: true, public: true).all
        service_ids = public_active_plans.map(&:service_id).uniq
        dataset.filter(id: service_ids)
      end

      def user_visibility_filter(current_user, operation=nil)
        visible_plans = ServicePlan.user_visible(current_user, operation)

        { id: visible_plans.select(:service_id).distinct }
      end

      def user_visibility_for_read(current_user, _admin_override)
        user_visibility_filter(current_user, :read)
      end

      def unauthenticated_visibility_filter
        { id: public_visible.map(&:id) }
      end

      def space_or_org_visible_for_user(space, user)
        org_visible = organization_visible(space.organization)
        space_visible = space_visible(space, user)
        org_visible.union(space_visible, alias: :services, all: true)
      end

      def organization_visible(organization)
        service_ids = ServicePlan.
                      organization_visible(organization).
                      inject([]) { |ids_so_far, service_plan| ids_so_far << service_plan.service_id }
        dataset.filter(id: service_ids)
      end

      private

      def space_visible(space, user)
        if space.has_member?(user) || can_read_globally?(user)
          private_brokers_for_space = ServiceBroker.filter(space_id: space.id)
          dataset.filter(service_broker: private_brokers_for_space)
        else
          dataset.filter(id: nil)
        end
      end

      def can_read_globally?(user)
        VCAP::CloudController::Permissions.new(user).can_read_globally?
      end
    end

    def validate
      validates_presence :label, message: Sequel.lit('Service name is required')
      validates_presence :description, message: 'is required'
      validates_presence :bindable, message: 'is required'
      validates_url :info_url, message: 'must be a valid url'
      validates_max_length 2048, :tag_contents, message: Sequel.lit("Service tags for service #{label} must be 2048 characters or less.")
    end

    serialize_attributes :json, :tags, :requires

    # When selecting a UNION of multiple sub-queries, MySQL does not maintain the original type - i.e. tinyint(1) - and
    # thus Sequel does not convert the value to a boolean.
    # See https://bugs.mysql.com/bug.php?id=30886
    def active?
      ActiveModel::Type::Boolean.new.cast(active)
    end

    def bindable?
      ActiveModel::Type::Boolean.new.cast(bindable)
    end

    def plan_updateable?
      ActiveModel::Type::Boolean.new.cast(plan_updateable)
    end

    def bindings_retrievable?
      ActiveModel::Type::Boolean.new.cast(bindings_retrievable)
    end

    def instances_retrievable?
      ActiveModel::Type::Boolean.new.cast(instances_retrievable)
    end

    def allow_context_updates?
      ActiveModel::Type::Boolean.new.cast(allow_context_updates)
    end

    def tags
      super || []
    end

    def tag_contents
      tags.join
    end

    def requires
      super || []
    end

    def client
      if purging
        VCAP::Services::ServiceBrokers::NullClient.new
      else
        service_broker.client
      end
    end

    # The "unique_id" should really be called broker_provided_id because it's the id assigned by the broker
    def broker_provided_id
      unique_id
    end

    def purge(event_repository)
      db.transaction do
        update(purging: true)
        service_plans.each do |plan|
          plan.service_instances_dataset.each do |instance|
            ServiceInstancePurger.new(event_repository).purge(instance)
          end
        end
        destroy
      end
    end

    def service_broker_guid
      service_broker ? service_broker.guid : nil
    end

    def route_service?
      requires.include?('route_forwarding')
    end

    def shareable?
      return false if extra.nil?

      metadata = Oj.load(extra)
      metadata && metadata['shareable']
    rescue StandardError
      false
    end

    def volume_service?
      requires.include?('volume_mount')
    end

    def deleted_field
      nil
    end

    def public?
      service_plans.any?(&:public)
    end

    alias_method :provider, :deleted_field
    alias_method :url, :deleted_field
    alias_method :version, :deleted_field
  end
end