cloudfoundry/cloud_controller_ng

View on GitHub
app/models/runtime/droplet_model.rb

Summary

Maintainability
A
3 hrs
Test Coverage
module VCAP::CloudController
  class DropletModel < Sequel::Model(:droplets)
    include Serializer

    DROPLET_STATES = [
      STAGING_STATE = 'STAGING'.freeze,
      COPYING_STATE = 'COPYING'.freeze,
      FAILED_STATE = 'FAILED'.freeze,
      STAGED_STATE = 'STAGED'.freeze,
      EXPIRED_STATE = 'EXPIRED'.freeze,
      AWAITING_UPLOAD_STATE = 'AWAITING_UPLOAD'.freeze,
      PROCESSING_UPLOAD_STATE = 'PROCESSING_UPLOAD'.freeze
    ].freeze
    FINAL_STATES = [
      FAILED_STATE,
      STAGED_STATE,
      EXPIRED_STATE
    ].freeze
    STAGING_FAILED_REASONS = %w[StagerError StagingError StagingTimeExpired NoAppDetectedError BuildpackCompileFailed
                                BuildpackReleaseFailed InsufficientResources NoCompatibleCell
                                CNBGenericBuildFailed CNBDownloadBuildpackFailed CNBDetectFailed
                                CNBBuildFailed CNBExportFailed CNBLaunchFailed CNBRestoreFailed].map(&:freeze).freeze

    many_to_one :package, class: 'VCAP::CloudController::PackageModel', key: :package_guid, primary_key: :guid, without_guid_generation: true
    many_to_one :app, class: 'VCAP::CloudController::AppModel', key: :app_guid, primary_key: :guid, without_guid_generation: true
    many_to_one :build,
                class: 'VCAP::CloudController::BuildModel',
                key: :build_guid,
                primary_key: :guid,
                without_guid_generation: true
    one_through_one :space, join_table: AppModel.table_name, left_key: :guid, left_primary_key: :app_guid, right_primary_key: :guid, right_key: :space_guid
    one_to_one :buildpack_lifecycle_data,
               class: 'VCAP::CloudController::BuildpackLifecycleDataModel',
               key: :droplet_guid,
               primary_key: :guid
    one_to_one :kpack_lifecycle_data,
               class: 'VCAP::CloudController::KpackLifecycleDataModel',
               key: :droplet_guid,
               primary_key: :guid
    one_to_one :cnb_lifecycle_data,
               class: 'VCAP::CloudController::CNBLifecycleDataModel',
               key: :droplet_guid,
               primary_key: :guid
    one_to_many :labels, class: 'VCAP::CloudController::DropletLabelModel', key: :resource_guid, primary_key: :guid
    one_to_many :annotations, class: 'VCAP::CloudController::DropletAnnotationModel', key: :resource_guid, primary_key: :guid

    add_association_dependencies buildpack_lifecycle_data: :destroy
    add_association_dependencies kpack_lifecycle_data: :destroy
    add_association_dependencies cnb_lifecycle_data: :destroy
    add_association_dependencies labels: :destroy
    add_association_dependencies annotations: :destroy

    set_field_as_encrypted :docker_receipt_password, salt: :docker_receipt_password_salt, column: :encrypted_docker_receipt_password
    serializes_via_json :process_types
    serializes_via_json :sidecars

    def around_destroy
      yield
    rescue Sequel::ForeignKeyConstraintViolation => e
      raise e unless e.message.include?('fk_apps_droplet_guid')

      raise in_use_error
    end

    def error
      e = [error_id, error_description].compact.join(' - ')
      e.presence
    end

    def validate
      super
      validates_includes DROPLET_STATES, :state, allow_missing: true
    end

    def set_buildpack_receipt(buildpack_key:, detect_output:, requested_buildpack:, buildpack_url: nil)
      self.buildpack_receipt_detect_output = detect_output

      if buildpack_key.present? && (admin_buildpack = Buildpack.find(key: buildpack_key))
        self.buildpack_receipt_buildpack_guid = admin_buildpack.guid
        self.buildpack_receipt_buildpack = admin_buildpack.name
      elsif buildpack_url.present?
        self.buildpack_receipt_buildpack = buildpack_url
      else
        self.buildpack_receipt_buildpack = requested_buildpack
      end

      self.buildpack_receipt_buildpack = CloudController::UrlSecretObfuscator.obfuscate(buildpack_receipt_buildpack)
    end

    def blobstore_key(hash=nil)
      hash ||= droplet_hash
      File.join(guid, hash) if hash
    end

    def checksum
      sha256_checksum || droplet_hash
    end

    def buildpack?
      lifecycle_type == BuildpackLifecycleDataModel::LIFECYCLE_TYPE
    end

    def docker?
      lifecycle_type == DockerLifecycleDataModel::LIFECYCLE_TYPE
    end

    def cnb?
      lifecycle_type == CNBLifecycleDataModel::LIFECYCLE_TYPE
    end

    def docker_ports
      exposed_ports = []
      if execution_metadata.present?
        begin
          metadata = Oj.load(execution_metadata)
          unless metadata['ports'].nil?
            metadata['ports'].each do |port|
              exposed_ports << port['Port'] if port['Protocol'] == 'tcp'
            end
          end
        rescue StandardError
          # ignore
        end
      end
      exposed_ports
    end

    def staging?
      state == STAGING_STATE
    end

    def failed?
      state == FAILED_STATE
    end

    def staged?
      state == STAGED_STATE
    end

    def copying?
      state == COPYING_STATE
    end

    def processing_upload?
      state == PROCESSING_UPLOAD_STATE
    end

    def mark_as_staged
      self.state = STAGED_STATE
    end

    def fail_to_stage!(reason='StagingError', details='staging failed')
      reason = 'StagingError' unless STAGING_FAILED_REASONS.include?(reason)

      self.state = FAILED_STATE
      self.error_id = reason
      self.error_description = CloudController::Errors::ApiError.new_from_details(reason, details).message
      save_changes(raise_on_save_failure: true)
    end

    def lifecycle_type
      return BuildpackLifecycleDataModel::LIFECYCLE_TYPE if buildpack_lifecycle_data
      return CNBLifecycleDataModel::LIFECYCLE_TYPE if cnb_lifecycle_data

      DockerLifecycleDataModel::LIFECYCLE_TYPE
    end

    def lifecycle_data
      return buildpack_lifecycle_data if buildpack_lifecycle_data
      return cnb_lifecycle_data if cnb_lifecycle_data

      DockerLifecycleDataModel.new
    end

    def in_final_state?
      FINAL_STATES.include?(state)
    end

    def process_start_command(process_type)
      process_types.try(:[], process_type) || ''
    end

    def current?
      app.droplet_guid == guid
    end

    def in_use_error
      CloudController::Errors::ApiError.new_from_details('UnprocessableEntity', "The droplet is currently used by app with guid \"#{app_guid}\".")
    end

    private

    def app_usage_event_repository
      @app_usage_event_repository ||= Repositories::AppUsageEventRepository.new
    end
  end
end