Class: Deltacloud::BaseDriver

Inherits:
Object
  • Object
show all
Includes:
Exceptions
Defined in:
lib/deltacloud/drivers/base_driver.rb

Constant Summary collapse

STATE_MACHINE_OPTS = 
{
  :all_states => [:start, :pending, :running, :stopping, :stopped, :finish, :error],
  :all_actions => [:create, :reboot, :stop, :start, :destroy]
}
MEMBER_SHOW_METHODS = 
[ :realm, :image, :instance, :storage_volume, :bucket, :blob,
:key, :firewall ]

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Exceptions

exception_from_status, exceptions, included, logger, #safely

Class Method Details

.constraints(opts = {}) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 51

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) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 71

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) ⇒ Object 



122
123
124
125
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 122

def self.define_instance_states(&block)
  machine = ::Deltacloud::StateMachine.new(STATE_MACHINE_OPTS, &block)
  @instance_state_machine = machine
end

.driver_name ⇒ Object 



34
35
36
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 34

def self.driver_name
  name.split('::').last.gsub('Driver', '').downcase
end

.feature(collection, feature_name) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 42

def self.feature(collection, feature_name)
  return 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

.features ⇒ Object 



38
39
40
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 38

def self.features
  @features ||= {}
end

.hardware_profiles ⇒ Object 



80
81
82
83
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 80

def self.hardware_profiles
  @hardware_profiles ||= []
  @hardware_profiles
end

.has_feature?(collection, feature_name) ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 59

def self.has_feature?(collection, feature_name)
  features.has_key?(collection) and features[collection].include?(feature_name)
end

.instance_state_machine ⇒ Object 



127
128
129
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 127

def self.instance_state_machine
  @instance_state_machine
end

Instance Method Details

#address(credentials, opts = {}) ⇒ Object 



255
256
257
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 255

def address(credentials, opts={})
  addresses(credentials, opts).first if has_capability?(:addresses)
end

#api_provider ⇒ Object 



278
279
280
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 278

def api_provider
  Thread.current[:provider] || ENV['API_PROVIDER']
end

#blob(credentials, opts = {}) ⇒ Object 



243
244
245
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 243

def blob(credentials, opts = {})
  blobs(credentials, opts).first if has_capability?(:blobs)
end

#bucket(credentials, opts = {}) ⇒ Object 



238
239
240
241
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 238

def bucket(credentials, opts = {})
  #list of objects within bucket
  buckets(credentials, opts).first if has_capability?(:buckets)
end

#catched_exceptions_list ⇒ Object 



274
275
276
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 274

def catched_exceptions_list
  { :error => [], :auth => [], :glob => [] }
end

#configured_providers ⇒ Object

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



284
285
286
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 284

def configured_providers
  []
end

#filter_hardware_profiles(profiles, opts) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 95

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, attribute, opts) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 263

def filter_on(collection, attribute, opts)
  return collection if opts.nil?
  return collection if opts[attribute].nil?
  filter = opts[attribute]
  if ( filter.is_a?( Array ) )
    return collection.select{|e| filter.include?( e.send(attribute) ) }
  else
    return collection.select{|e| filter == e.send(attribute) }
  end
end

#find_hardware_profile(credentials, profile_id, image_id) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 107

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 = {}) ⇒ Object 



251
252
253
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 251

def firewall(credentials, opts={})
  firewalls(credentials, opts).first if has_capability?(:firewalls)
end

#hardware_profile(credentials, profile_id) ⇒ Object 



90
91
92
93
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 90

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 = {}) ⇒ Object 



85
86
87
88
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 85

def hardware_profiles(credentials, opts = {})
  results = self.class.hardware_profiles
  filter_hardware_profiles(results, opts)
end

#has_capability?(method) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
149
150
151
152
153
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 146

def has_capability?(method)
  method = (RUBY_VERSION =~ /^1\.9/) ? method : method.to_s
  # 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) ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 63

def has_feature?(collection, feature_name)
  self.class.has_feature?(collection, feature_name)
end

#image(credentials, opts) ⇒ Object 



222
223
224
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 222

def image(credentials, opts)
  images(credentials, opts).first if has_capability?(:images)
end

#instance(credentials, opts) ⇒ Object 



226
227
228
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 226

def instance(credentials, opts)
  instances(credentials, opts).first if has_capability?(:instances)
end

#instance_actions_for(state) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 135

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 ⇒ Object 



131
132
133
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 131

def instance_state_machine
  self.class.instance_state_machine
end

#key(credentials, opts = nil) ⇒ Object 



247
248
249
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 247

def key(credentials, opts=nil)
  keys(credentials, opts).first if has_capability?(:keys)
end

#name ⇒ Object 



67
68
69
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 67

def name
  self.class.name.split('::').last.gsub('Driver', '').downcase
end

#realm(credentials, opts) ⇒ Object

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)



218
219
220
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 218

def realm(credentials, opts)
  realms = realms(credentials, opts).first if has_capability?(:realms)
end

#storage_snapshot(credentials, opts) ⇒ Object 



234
235
236
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 234

def storage_snapshot(credentials, opts)
  storage_snapshots(credentials, opts).first if has_capability?(:storage_snapshots)
end

#storage_volume(credentials, opts) ⇒ Object 



230
231
232
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 230

def storage_volume(credentials, opts)
  storage_volumes(credentials, opts).first if has_capability?(:storage_volumes)
end

#supported_collections(credentials) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/deltacloud/drivers/base_driver.rb', line 155

def supported_collections(credentials)
  collection_arr = []
  Deltacloud::Collections.deltacloud_modules.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