class Deltacloud::BaseDriver

Constants

MEMBER_SHOW_METHODS
STATE_MACHINE_OPTS

Public Class Methods

constraints(opts={}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 54
def self.constraints(opts={})
  if opts[:collection] and opts[:feature]
    return [] unless @constraints.has_key? opts[:collection]
    return @constraints[opts[:collection]][opts[:feature]]
  end
  @constraints ||= {}
end
define_hardware_profile(profile_id, &block) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 74
def self.define_hardware_profile(profile_id, &block)
  @hardware_profiles ||= []
  hw_profile = @hardware_profiles.find{|e| e.id == profile_id }
  return if hw_profile
  hw_profile = ::Deltacloud::HardwareProfile.new(profile_id, &block )
  @hardware_profiles << hw_profile
  hw_profile.params
end
define_instance_states(&block) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 125
def self.define_instance_states(&block)
  machine = ::Deltacloud::StateMachine.new(STATE_MACHINE_OPTS, &block)
  @instance_state_machine = machine
end
driver_name() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 35
def self.driver_name
  name.split('::').last.gsub('Driver', '').downcase
end
feature(collection, *feature_list) { || ... } click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 43
def self.feature(collection, *feature_list)
  feature_list.each do |feature_name|
    next if has_feature?(collection, feature_name)
    constraints[collection] ||= {}
    constraints[collection][feature_name] ||= {}
    constraints[collection][feature_name].merge!(yield) if block_given?
    features[collection] ||= []
    features[collection] << feature_name
  end
end
features() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 39
def self.features
  @features ||= {}
end
hardware_profiles() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 83
def self.hardware_profiles
  @hardware_profiles ||= []
  @hardware_profiles
end
has_feature?(collection, feature_name) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 62
def self.has_feature?(collection, feature_name)
  features.has_key?(collection) and features[collection].include?(feature_name)
end
instance_state_machine() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 130
def self.instance_state_machine
  @instance_state_machine
end

Public Instance Methods

address(credentials, opts={}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 258
def address(credentials, opts={})
  addresses(credentials, opts).first if has_capability?(:addresses)
end
api_provider() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 295
def api_provider
  Thread.current[:provider] || ENV['API_PROVIDER']
end
blob(credentials, opts = {}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 246
def blob(credentials, opts = {})
  blobs(credentials, opts).first if has_capability?(:blobs)
end
bucket(credentials, opts = {}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 241
def bucket(credentials, opts = {})
  #list of objects within bucket
  buckets(credentials, opts).first if has_capability?(:buckets)
end
catched_exceptions_list() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 291
def catched_exceptions_list
  { :error => [], :auth => [], :glob => [] }
end
configured_providers() click to toggle source

Return an array of the providers statically configured in the driver's YAML file

# File lib/deltacloud/drivers/base_driver.rb, line 301
def configured_providers
  []
end
filter_hardware_profiles(profiles, opts) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 98
def filter_hardware_profiles(profiles, opts)
  if opts
    if v = opts[:architecture]
      profiles = profiles.select { |hwp| hwp.include?(:architecture, v) }
    end
    if v = opts[:id]
      profiles = profiles.select { |hwp| hwp.id == v }
    end
  end
  profiles
end
filter_on(collection, opts, *attributes) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 266
def filter_on(collection, opts, *attributes)
  opts, attributes = attributes.pop, [opts] if !opts.nil? and !(opts.is_a?(Hash))
  # FIXME: ^^ This is just to keep backward compatibility until
  # drivers will be fixed to use the new syntax.
  #
  # filter_on instances, :opts, [ :id, :state, :realm_id]
  #
  # instead of old:
  #
  # filter_on instances, :id, opts
  # filter_on instances, :state, opts
  # filter_on instances, :realm_id, opts

  return collection if opts.nil?
  attributes.each do |attribute|
    next unless filter = opts[attribute]
    if ( filter.is_a?( Array ) )
      collection.select! { |e| filter.include?( e.send(attribute) ) }
    else
      collection.select! { |e| filter == e.send(attribute) }
    end
  end
  collection
end
find_hardware_profile(credentials, profile_id, image_id) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 110
def find_hardware_profile(credentials, profile_id, image_id)
  hwp = nil
  if profile_id
    unless hwp = hardware_profile(credentials, profile_id)
      raise Exceptions.exception_from_status(400, "Hardware profile '#{profile_id}' does not exists.")
    end
  else
    unless image = image(credentials, :id=>image_id)
      raise Exceptions.exception_from_status(400, "Image #{image_id} does not exists.")
    end
    hwp = hardware_profiles(credentials, :architecture => image.architecture).first
  end
  return hwp
end
firewall(credentials, opts={}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 254
def firewall(credentials, opts={})
  firewalls(credentials, opts).first if has_capability?(:firewalls)
end
hardware_profile(credentials, profile_id) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 93
def hardware_profile(credentials, profile_id)
  profile_id = profile_id[:id] if profile_id.kind_of? Hash
  hardware_profiles(credentials, :id => profile_id).first
end
hardware_profiles(credentials, opts = {}) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 88
def hardware_profiles(credentials, opts = {})
  results = self.class.hardware_profiles
  filter_hardware_profiles(results, opts)
end
has_capability?(method) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 149
def has_capability?(method)
  method = (RUBY_VERSION < '1.9') ? method.to_s : method
  # Prevent has_capability fail when driver is inherited from another
  # driver, like Eucalyptus
  superclass_methods = self.class.superclass.name == 'Deltacloud::BaseDriver' ?
    self.class.superclass.instance_methods : []
  (self.class.instance_methods - superclass_methods).include? method
end
has_feature?(collection, feature_name) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 66
def has_feature?(collection, feature_name)
  self.class.has_feature?(collection, feature_name)
end
image(credentials, opts) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 225
def image(credentials, opts)
  images(credentials, opts).first if has_capability?(:images)
end
instance(credentials, opts) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 229
def instance(credentials, opts)
  instances(credentials, opts).first if has_capability?(:instances)
end
instance_actions_for(state) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 138
def instance_actions_for(state)
  actions = []
  states = instance_state_machine.states()
  current_state = states.find{|e| e.name == state.underscore.to_sym }
  if ( current_state )
    actions = current_state.transitions.collect{|e|e.action}
    actions.reject!{|e| e.nil?}
  end
  actions
end
instance_state_machine() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 134
def instance_state_machine
  self.class.instance_state_machine
end
key(credentials, opts=nil) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 250
def key(credentials, opts=nil)
  keys(credentials, opts).first if has_capability?(:keys)
end
name() click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 70
def name
  self.class.name.split('::').last.gsub('Driver', '').downcase
end
realm(credentials, opts) click to toggle source
Capabilities

The rabbit dsl supports declaring a capability that is required in the backend driver for the call to succeed. A driver can provide a capability by implementing the method with the same name as the capability. Below is a list of the capabilities as the expected method signatures.

Following the capability list are the resource member show methods. They each require that the corresponding collection method be defined

TODO: standardize all of these to the same signature (credentials, opts)

def realms(credentials, opts=nil)

def images(credentials, ops)

def instances(credentials, ops) def create_instance(credentials, image_id, opts) def start_instance(credentials, id) def stop_instance(credentials, id) def reboot_instance(credentials, id)

def storage_volumes(credentials, ops)

def storage_snapshots(credentials, ops)

def buckets(credentials, opts = nil) def create_bucket(credentials, name, opts=nil) def delete_bucket(credentials, name, opts=nil)

def blobs(credentials, opts = nil) def blob_data(credentials, bucket_id, blob_id, opts) def create_blob(credentials, bucket_id, blob_id, blob_data, opts=nil) def delete_blob(credentials, bucket_id, blob_id, opts=nil)

def keys(credentials, opts) def create_key(credentials, opts) def destroy_key(credentials, opts)

def firewalls(credentials, opts) def create_firewall(credentials, opts) def delete_firewall(credentials, opts) def create_firewall_rule(credentials, opts) def delete_firewall_rule(credentials, opts) def providers(credentials)

# File lib/deltacloud/drivers/base_driver.rb, line 221
def realm(credentials, opts)
  realms = realms(credentials, opts).first if has_capability?(:realms)
end
storage_snapshot(credentials, opts) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 237
def storage_snapshot(credentials, opts)
  storage_snapshots(credentials, opts).first if has_capability?(:storage_snapshots)
end
storage_volume(credentials, opts) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 233
def storage_volume(credentials, opts)
  storage_volumes(credentials, opts).first if has_capability?(:storage_volumes)
end
supported_collections(credentials) { |c| ... } click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 158
def supported_collections(credentials)
  collection_arr = []
  Deltacloud::Collections.modules(:deltacloud).each do |m|
    m.collections.each do |c|
      # Get the required capability for the :index operation (like 'realms' or 'instance_state_machine')
      index_operation_capability = c.operation(:index).required_capability
      # Then use this capability to check if the 'capability' lambda defined
      # for the Sinatra::Base class evaluate to 'true'
      next if m.settings.respond_to?(:capability) and !m.settings.capability(index_operation_capability)
      yield c if block_given?
      collection_arr << c
    end
  end
  collection_arr
end
valid_credentials?(credentials) click to toggle source
# File lib/deltacloud/drivers/base_driver.rb, line 305
def valid_credentials?(credentials)
  begin
    new_client(credentials)
  rescue  Deltacloud::Exceptions::AuthenticationFailure
    return false
  rescue => e
    safely { raise e }
  end
  true
end