deltacloud-core 0.4.1 → 0.5.0

data/lib/deltacloud/models.rb

@@ -20,6 +20,7 @@ require 'deltacloud/models/image'
 require 'deltacloud/models/instance'
 require 'deltacloud/models/key'
 require 'deltacloud/models/address'
+require 'deltacloud/models/instance_address'
 require 'deltacloud/models/instance_profile'
 require 'deltacloud/models/storage_snapshot'
 require 'deltacloud/models/storage_volume'
@@ -28,3 +29,4 @@ require 'deltacloud/models/blob'
 require 'deltacloud/models/load_balancer'
 require 'deltacloud/models/firewall'
 require 'deltacloud/models/firewall_rule'
+require 'deltacloud/models/provider'

data/lib/deltacloud/models/bucket.rb

@@ -26,7 +26,7 @@ class Bucket < BaseModel
     h = self.to_hash_original
     unless blob_list.nil?
       h[:blob_list] = self.blob_list.collect { |blob| { :id => blob,
-        :href => "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/buckets/#{self.id}/#{blob}"}}
+        :href => "#{settings.root_url}/buckets/#{self.id}/#{blob}"}}
     end
     return h
   end

data/lib/deltacloud/models/image.rb

@@ -30,7 +30,7 @@ class Image < BaseModel
     h.merge({
       :actions => [ :create_instance => {
         :method => 'post',
-        :href => "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/instances;image_id=#{self.id}"
+        :href => "#{settings.root_url}/instances;image_id=#{self.id}"
       }]
     })
   end

data/lib/deltacloud/models/instance.rb

@@ -34,6 +34,7 @@ class Instance < BaseModel
   attr_accessor :password
   attr_accessor :create_image
   attr_accessor :firewalls
+  attr_accessor :storage_volumes
 
   def can_create_image?
     self.create_image
@@ -75,7 +76,7 @@ class Instance < BaseModel
   def to_hash
     h = self.to_hash_original
     h[:public_addresses] = h[:public_addresses].collect do |address|
-      { :address => { :type => address_type(address), :value => address } }
+      { :address => { :type => address.address_type, :value => address } }
     end
     h[:actions] = self.actions.collect do |action|
       { :"#{action}" => {

data/lib/deltacloud/models/instance_address.rb

@@ -0,0 +1,56 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# Model to store the hardware profile applied to an instance together with
+# any instance-specific overrides
+
+class InstanceAddress
+  attr_accessor :address
+  attr_accessor :port
+  attr_accessor :address_type
+
+  def initialize(address, opts={})
+    self.address = address
+    self.port = opts[:port] if opts[:port]
+    self.address_type = opts[:type] || :ipv4
+    self
+  end
+
+  def address_type
+    (address and !address.strip.empty?) ? @address_type : :unavailable
+  end
+
+  def to_s
+    return ['VNC', address, port].join(':') if is_vnc?
+    address
+  end
+
+  def is_mac?
+    address_type == :mac
+  end
+
+  def is_ipv4?
+    address_type == :ipv4
+  end
+
+  def is_hostname?
+    address_type == :hostname
+  end
+
+  def is_vnc?
+    address_type == :vnc
+  end
+
+end

data/lib/deltacloud/models/provider.rb

@@ -0,0 +1,27 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# Model to store the hardware profile applied to an instance together with
+# any instance-specific overrides
+
+class Provider < BaseModel
+  attr_accessor :url
+  attr_accessor :name
+
+  def initialize(opts={})
+    super(opts)
+  end
+
+end

data/{server.rb → lib/deltacloud/server.rb}

@@ -31,7 +31,7 @@ require 'sinatra/rack_date'
 require 'sinatra/rack_matrix_params'
 require 'sinatra/rack_syslog'
 
-set :version, '0.4.1'
+set :version, '0.5.0'
 
 include Deltacloud::Drivers
 set :drivers, Proc.new { driver_config }
@@ -46,8 +46,15 @@ use Rack::MediaType
 use Rack::Date
 
 configure do
-  set :views, File.dirname(__FILE__) + '/views'
-  set :public_folder, File.dirname(__FILE__) + '/public'
+  set :root_url, "/api"
+  set :views, File::join($top_srcdir, 'views')
+  # NOTE: Change :public to :public_folder once we update sinatra to 1.3
+  # set :public_folder, File::join($top_srcdir, 'public')
+  if settings.respond_to? :public_folder
+    set :public_folder, File::join($top_srcdir, 'public')
+  else
+    set :public, File::join($top_srcdir, 'public')
+  end
   # Try to load the driver on startup to fail early if there are issues
   driver
 end
@@ -87,13 +94,24 @@ after do
 end
 
 # Redirect to /api
-get '/' do redirect root_url, 301; end
+get '/' do redirect settings.root_url, 301; end
+
+
+# Generate a root route for API docs
+get "#{settings.root_url}/docs\/?" do
+  respond_to do |format|
+    format.html { haml :'docs/index' }
+    format.xml { haml :'docs/index' }
+  end
+end
 
-get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}\/?" do
+get "#{settings.root_url}\/?" do
   if params[:force_auth]
     return [401, 'Authentication failed'] unless driver.valid_credentials?(credentials)
   end
   @collections = [:drivers] + driver.supported_collections
+  @driver_name = driver.name unless driver.name.to_sym == DRIVER
+  @providers = driver.configured_providers
   respond_to do |format|
     format.xml { haml :"api/show" }
     format.json do
@@ -110,6 +128,15 @@ get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}\/?" do
   end
 end
 
+post "#{settings.root_url}\/?"  do
+  p = {}
+  ["provider", "driver"].each { |k| p[k] = params[k] if params[k] }
+  p.delete("provider") if p["provider"] == "default"
+  q = p.map { |k,v| "#{k}=#{v}" }.join(";")
+  q = ";" + q unless q.empty?
+  redirect "#{settings.root_url}#{q}", 301
+end
+
 # Rabbit DSL
 
 collection :drivers do
@@ -136,6 +163,9 @@ EOS
     param :id,      :string
     control do
       @name = params[:id].to_sym
+      if driver_symbol == @name
+        @providers = driver.providers(credentials)  if driver.respond_to? :providers
+      end
       @driver = settings.drivers[@name]
       return [404, "Driver #{@name} not found"] unless @driver
       respond_to do |format|
@@ -228,7 +258,7 @@ END
 	:description => params[:description]
       })
       status 201  # Created
-      response['Location'] = image_url(@instance.id)
+      response['Location'] = image_url(@image.id)
       respond_to do |format|
         format.xml  { haml :"images/show" }
         format.json { convert_to_json(:image, @image) }
@@ -293,7 +323,7 @@ collection :instance_states do
   end
 end
 
-get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/instances/:id/run" do
+get "#{settings.root_url}/instances/:id/run" do
   @instance = driver.instance(credentials, :id => params[:id])
   respond_to do |format|
     format.html { haml :"instances/run_command" }
@@ -448,14 +478,32 @@ END
     param :hwp_id,       :string, :optional
     control do
       @instance = driver.create_instance(credentials, params[:image_id], params)
+      if @instance.kind_of? Array
+        @elements = @instance
+        action_handler = "index"
+      else
+        response['Location'] = instance_url(@instance.id)
+        action_handler = "show"
+      end
       status 201  # Created
-      response['Location'] = instance_url(@instance.id)
       respond_to do |format|
-        format.xml  { haml :"instances/show" }
-        format.json { convert_to_json(:instance, @instance) }
+        format.xml  { haml :"instances/#{action_handler}" }
+        format.json do
+          if @elements
+            convert_to_json(:instances, @elements)
+          else
+            convert_to_json(:instance, @elements)
+          end
+        end
         format.html do
-          redirect instance_url(@instance.id) if @instance and @instance.id
-          redirect instances_url
+          if @elements
+            haml :"instances/index"
+          elsif @instance and @instance.id
+            response['Location'] = instance_url(@instance.id)
+            redirect instance_url(@instance.id)
+          else
+            redirect instances_url
+          end
         end
       end
     end
@@ -651,6 +699,16 @@ collection :storage_volumes do
     end
   end
 
+  operation :attach_instance, :method=>:get, :member=>true  do
+    description "A form to attach a storage volume to an instance"
+    control do
+      @instances = driver.instances(credentials)
+      respond_to do |format|
+        format.html{ haml :"storage_volumes/attach"}
+      end
+    end
+  end
+
   operation :attach, :method => :post, :member => true do
     description "Attach storage volume to instance"
     with_capability :attach_storage_volume
@@ -769,7 +827,7 @@ end
 # existing blob
 NEW_BLOB_FORM_ID = "new_blob_form_d15cfd90"
 
-get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/buckets/:bucket/#{NEW_BLOB_FORM_ID}" do
+get "#{settings.root_url}/buckets/:bucket/#{NEW_BLOB_FORM_ID}" do
   @bucket_id = params[:bucket]
   respond_to do |format|
     format.html {haml :"blobs/new"}
@@ -992,7 +1050,7 @@ collection :buckets do
 
 end
 
-get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/addresses/:id/associate" do
+get "#{settings.root_url}/addresses/:id/associate" do
   @instances = driver.instances(credentials)
   @address = Address::new(:id => params[:id])
   respond_to do |format|

data/lib/deltacloud/validation.rb

@@ -16,13 +16,12 @@
 
 module Deltacloud::Validation
 
-  class Failure < StandardError
+  class Failure < Deltacloud::ExceptionHandler::DeltacloudException
     attr_reader :param
-    def initialize(param, msg='')
-      super(msg)
-      @param = param
+    def initialize(e, message=nil)
+      message ||= e.message
+      super(400, e.class.name, message, [])
     end
-
     def name
       param.name if @param
     end
@@ -46,6 +45,19 @@ module Deltacloud::Validation
     def optional?
       type.eql?(:optional)
     end
+
+    def valid_value?(value)
+      true if (options.kind_of?(Range) or options.kind_of?(Array)) and options.include?(value)
+      true if options.kind_of?(String) and not options.empty?
+    end
+
+    def valid_hwp_value?(profile, value)
+      profile.property(@name.to_s.gsub(/^hwp_/, '')).valid?(value)
+    end
+
+    def hwp_property?
+      true if name.to_s =~ /^hwp_(cpu|memory|storage|architecture)/
+    end
   end
 
   def param(*args)
@@ -72,15 +84,24 @@ module Deltacloud::Validation
     params.each_value { |p| yield p }
   end
 
-  def validate(all_params, values)
-    all_params.each_value do |p|
+  def validate(current_driver, all_params, values, credentials)
+    all_params.each do |key, p|
       if p.required? and not values[p.name]
         raise Failure.new(p, "Required parameter #{p.name} not found")
       end
-      if values[p.name] and not p.options.empty? and
-          not p.options.include?(values[p.name])
-        raise Failure.new(p, "Parameter #{p.name} has value #{values[p.name]} which is not in #{p.options.join(", ")}")
+      next unless values[p.name]
+      if p.hwp_property?
+        profile = current_driver.hardware_profile(credentials, values['hwp_id'])
+        raise Failure.new(p, "Unknown hardware profile selected #{values['hwp_id']}") unless profile
+        unless p.valid_hwp_value?(profile, values[p.name])
+          raise Failure.new(p, "Hardware profile property #{p.name} has invalid value #{values[p.name]}")
+        end
+      else
+        if not p.options.empty? and p.valid_value?(values[p.name])
+          raise Failure.new(p, "Parameter #{p.name} has value #{values[p.name]} which is not in #{p.options.join(", ")}")
+        end
       end
     end
   end
+
 end

data/lib/sinatra/rabbit.rb

@@ -89,8 +89,8 @@ module Sinatra
 
       def generate_documentation
         coll, oper = @collection, self
-        Rabbit::routes << [:get, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@collection.name}/#{@name}"]
-        ::Sinatra::Application.get("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@collection.name}/#{@name}") do
+        Rabbit::routes << [:get, "#{settings.root_url}/docs/#{@collection.name}/#{@name}"]
+        ::Sinatra::Application.get("#{settings.root_url}/docs/#{@collection.name}/#{@name}") do
           @collection, @operation = coll, oper
           @features = driver.features_for_operation(coll.name, oper.name)
           respond_to do |format|
@@ -102,8 +102,8 @@ module Sinatra
 
       def generate_options
         current_operation = self
-        Rabbit::routes << [:options, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{current_operation.collection.name}/#{current_operation.name}"]
-        ::Sinatra::Application.options("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{current_operation.collection.name}/#{current_operation.name}") do
+        Rabbit::routes << [:options, "#{settings.root_url}/#{current_operation.collection.name}/#{current_operation.name}"]
+        ::Sinatra::Application.options("#{settings.root_url}/#{current_operation.collection.name}/#{current_operation.name}") do
           required_params = current_operation.effective_params(driver).collect do |name, validation|
             name.to_s if validation.type.eql?(:required)
           end.compact.join(',')
@@ -121,7 +121,7 @@ module Sinatra
         @control = Proc.new do
           op.collection.check_supported(driver)
           op.check_capability(driver)
-          op.validate(op.effective_params(driver), params)
+          op.validate(driver, op.effective_params(driver), params, credentials)
           instance_eval(&block)
         end
       end
@@ -152,8 +152,8 @@ module Sinatra
       end
 
       def generate
-        Rabbit::routes << [@method, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{path}"]
-        ::Sinatra::Application.send(@method, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{path}", {}, &@control)
+        Rabbit::routes << [@method, "#{settings.root_url}/#{path}"]
+        ::Sinatra::Application.send(@method, "#{settings.root_url}/#{path}", {}, &@control)
         # Set up some Rails-like URL helpers
         if name == :index
           gen_route "#{@collection.name}_url"
@@ -202,11 +202,11 @@ module Sinatra
     class Collection
       attr_reader :name, :operations, :subcollections
 
-      def initialize(name, &block)
+      def initialize(name, options={}, &block)
         @name = name
         @description = ""
         @operations, @subcollections = {}, {}
-        @global = false
+        @global = options[:global] || false
         instance_eval(&block) if block_given?
         generate_documentation
         generate_head
@@ -239,8 +239,8 @@ module Sinatra
 
       def generate_head
         current_collection = self
-        Rabbit::routes << [:head, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}"]
-        ::Sinatra::Application.head("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}") do
+        Rabbit::routes << [:head, "#{settings.root_url}/#{name}"]
+        ::Sinatra::Application.head("#{settings.root_url}/#{name}") do
           methods_allowed = current_collection.operations.collect { |o| o[1].method.to_s.upcase }.uniq.join(',')
           headers 'Allow' => "HEAD,OPTIONS,#{methods_allowed}"
           [200, '']
@@ -249,8 +249,8 @@ module Sinatra
 
       def generate_options
         current_collection = self
-        Rabbit::routes << [:options, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}"]
-        ::Sinatra::Application.options("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}") do
+        Rabbit::routes << [:options, "#{settings.root_url}/#{name}"]
+        ::Sinatra::Application.options("#{settings.root_url}/#{name}") do
           operations_allowed = current_collection.operations.collect { |o| o[0] }.join(',')
           headers 'X-Operations-Allowed' => operations_allowed
           [200, '']
@@ -259,8 +259,8 @@ module Sinatra
 
       def generate_documentation
         coll = self
-        Rabbit::routes << [:get, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@name}"]
-        ::Sinatra::Application.get("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@name}") do
+        Rabbit::routes << [:get, "#{settings.root_url}/docs/#{@name}"]
+        ::Sinatra::Application.get("#{settings.root_url}/docs/#{@name}") do
           coll.check_supported(driver)
           @collection = coll
           @operations = coll.operations
@@ -393,14 +393,19 @@ module Sinatra
       collections[name].generate
     end
 
-    # Generate a root route for API docs
-    get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs\/?" do
-      respond_to do |format|
-        format.html { haml :'docs/index' }
-        format.xml { haml :'docs/index' }
-      end
+    def global_collection(name, &block)
+      raise DuplicateCollectionException if collections[name]
+      collections[name] = Collection.new(name, { :global => true }, &block)
+      collections[name].generate
     end
 
+    # Make sure this collection can be accessed, regardless of whether the
+    # driver supports it or not
+    def global_collection(name, &block)
+      raise DuplicateCollectionException if collections[name]
+      collections[name] = Collection.new(name, :global => true, &block)
+      collections[name].generate
+    end
   end
 
   module RabbitHelper
@@ -423,11 +428,14 @@ module Sinatra
   helpers RabbitHelper
 end
 
-configure do
-  class << Sinatra::Base
-    def options(path, opts={}, &block)
-      route 'OPTIONS', path, opts, &block
+# In Sinatra < 1.2 there was no helper to create OPTIONS route
+unless Sinatra::Base.respond_to? :options
+  configure do
+    class << Sinatra::Base
+      def options(path, opts={}, &block)
+        route 'OPTIONS', path, opts, &block
+      end
     end
+    Sinatra::Delegator.delegate :options
   end
-  Sinatra::Delegator.delegate :options
 end