deltacloud-client-vm 1.1.4.2 → 1.1.4.3

data/lib/deltacloud_vm/client/base_error.rb

@@ -0,0 +1,80 @@
+# 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.
+
+module DeltacloudVM::Client
+
+  # Reporting internal client errors
+  #
+  class Error < StandardError; end
+
+  class BaseError < Error
+    attr_reader :server_backtrace
+    attr_reader :driver
+    attr_reader :provider
+    attr_reader :status
+    attr_reader :original_error
+
+    def initialize(opts={})
+      if opts.is_a? Hash
+        @server_backtrace = opts[:server_backtrace]
+        @driver = opts[:driver]
+        @provider = opts[:provider]
+        @status = opts[:status]
+        @original_error = opts[:original_error]
+        super(opts[:message])
+      else
+        super(opts)
+      end
+    end
+
+    # If the DeltacloudVM API server error response contain backtrace from
+    # server,then make this backtrace available as part of this exception
+    # backtrace
+    #
+    def set_backtrace(backtrace)
+      return super(backtrace) if @server_backtrace.nil?
+      super([
+        backtrace[0..3],
+        "-------DeltacloudVM API backtrace-------",
+        @server_backtrace.split[0..10],
+      ].flatten)
+    end
+
+  end
+
+  # Report 401 errors
+  class AuthenticationError < BaseError; end
+
+  # Report 502 errors (back-end cloud provider encounter error)
+  class BackendError < BaseError; end
+
+  # Report 5xx errors (error on DeltacloudVM API server)
+  class ServerError < BaseError; end
+
+  # Report 501 errors (collection or operation is not supported)
+  class NotSupported < ServerError; end
+
+  # Report 4xx failures (client failures)
+  class ClientFailure < BaseError; end
+
+  # Report 404 error (object not found)
+  class NotFound < BaseError; end
+
+  # Report 405 failures (resource state does not permit the requested operation)
+  class InvalidState < ClientFailure; end
+
+  # Report this when client do Image#launch using incompatible HWP
+  class IncompatibleHardwareProfile < ClientFailure; end
+end

data/lib/deltacloud_vm/client/connection.rb

@@ -0,0 +1,139 @@
+# 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.
+
+module DeltacloudVM::Client
+  class Connection
+
+    attr_accessor :connection
+    attr_reader :request_driver
+    attr_reader :request_provider
+    attr_reader :entrypoint
+
+    include DeltacloudVM::Client::Helpers::Model
+
+    include DeltacloudVM::Client::Methods::Address
+    include DeltacloudVM::Client::Methods::Api
+    include DeltacloudVM::Client::Methods::BackwardCompatibility
+    include DeltacloudVM::Client::Methods::Blob
+    include DeltacloudVM::Client::Methods::Bucket
+    include DeltacloudVM::Client::Methods::Common
+    include DeltacloudVM::Client::Methods::Driver
+    include DeltacloudVM::Client::Methods::Firewall
+    include DeltacloudVM::Client::Methods::HardwareProfile
+    include DeltacloudVM::Client::Methods::Image
+    include DeltacloudVM::Client::Methods::Instance
+    include DeltacloudVM::Client::Methods::InstanceState
+    include DeltacloudVM::Client::Methods::Key
+    include DeltacloudVM::Client::Methods::Realm
+    include DeltacloudVM::Client::Methods::StorageSnapshot
+    include DeltacloudVM::Client::Methods::StorageVolume
+    include DeltacloudVM::Client::Methods::LoadBalancer
+    include DeltacloudVM::Client::Methods::Metric
+
+    def initialize(opts={})
+      @request_driver = opts[:driver]
+      @request_provider = opts[:provider]
+      @connection = Faraday.new(:url => opts[:url]) do |f|
+        # NOTE: The order of this is somehow important for VCR
+        #       recording.
+        f.request :url_encoded
+        f.headers = deltacloud_request_headers
+        f.basic_auth opts[:api_user], opts[:api_password]
+        f.use DeltacloudVM::ErrorResponse
+        f.adapter :net_http
+      end
+      cache_entrypoint!
+      @request_driver ||= current_driver
+      @request_provider ||= current_provider
+    end
+
+    # Change the current driver and return copy of the client
+    # This allows chained calls like: client.driver(:ec2).instances
+    #
+    # - driver_id -> The new driver id (:mock, :ec2, :rhevm, ...)
+    # - api_user -> API user name
+    # - api_password -> API password
+    # - api_provider -> API provider (aka API_PROVIDER string)
+    #
+    def use(driver_id, api_user, api_password, api_provider=nil, &block)
+      new_client = self.class.new(
+        :url => @connection.url_prefix.to_s,
+        :api_user => api_user,
+        :api_password => api_password,
+        :provider => api_provider,
+        :driver => driver_id
+      )
+      new_client.cache_entrypoint!
+      yield new_client if block_given?
+      new_client
+    end
+
+    # Change the API provider but keep the current client credentials.
+    # This allows to change the EC2 region and list instances in that
+    # region without need to supply credentials.
+    #
+    # client.use_provider('eu-west-1') { |p| p.instances }
+    #
+    # - provider_id -> API provider (aka API_PROVIDER)
+    #
+    def use_provider(provider_id, &block)
+      new_client = self.clone
+      new_connection = @connection.clone
+      new_connection.headers['X-DeltacloudVM-Provider'] = provider_id
+      new_client.connection = new_connection
+      new_client.cache_entrypoint!(true)
+      yield new_client if block_given?
+      new_client
+    end
+
+    # Cache the API entrypoint (/api) for the current connection,
+    # so we don't need to query /api everytime we ask if certain
+    # collection/operation is supported
+    #
+    # - force -> If 'true' force to refresh stored cached entrypoint
+    #
+    def cache_entrypoint!(force=false)
+      @entrypoint = nil if force
+      @entrypoint ||= connection.get(path).body
+    end
+
+    # Check if the credentials used are valid for the current @connection
+    #
+    def valid_credentials?
+      begin
+        r = connection.get(path, { :force_auth => 'true' })
+        r.status == 200
+      rescue error(:authentication_error)
+        false
+      end
+    end
+
+    private
+
+    # Default DeltacloudVM HTTP headers. Common for *all* requests
+    # to DeltacloudVM API
+    #
+    def deltacloud_request_headers
+      headers = {}
+      headers['Accept'] = 'application/xml'
+      headers['X-DeltacloudVM-Driver'] = @request_driver.to_s \
+        if @request_driver
+      headers['X-DeltacloudVM-Provider'] = @request_provider.to_s \
+        if @request_provider
+      headers
+    end
+
+  end
+end

data/lib/deltacloud_vm/client/helpers/model_helper.rb

@@ -0,0 +1,69 @@
+# 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.
+
+module DeltacloudVM::Client
+  module Helpers
+    module Model
+
+      # Retrieve the class straight from
+      # DeltacloudVM::Client model.
+      #
+      # -name -> A class name in underscore form (:storage_volume)
+      #
+      def model(name)
+        if name.nil? or (!name.nil? and name.empty?)
+          raise error.new("The model name can't be blank")
+        end
+        DeltacloudVM::Client.const_get(name.to_s.camelize)
+      end
+
+      # Syntax sugar method for retrieving various Client
+      # exception classes.
+      #
+      # - name -> Exception class name in underscore
+      #
+      # NOTE: If name is 'nil' the default Error exception
+      #       will be returned
+      #
+      def error(name=nil)
+        model(name || :error)
+      end
+
+      # Checks if current @connection support +model_name+
+      # and then convert HTTP response to a Ruby model
+      #
+      # - model_name -> A class name in underscore form
+      # - collection_body -> HTTP body of collection
+      #
+      def from_collection(model_name, collection_body)
+        must_support!(model_name)
+        model(model_name.to_s.singularize).from_collection(
+          self,
+          collection_body
+        )
+      end
+
+      # Check if the collection for given model is supported
+      # in current @connection and then parse/convert
+      # resource XML to a Ruby class
+      #
+      def from_resource(model_name, resource_body)
+        must_support!(model_name.to_s.pluralize)
+        model(model_name).convert(self, resource_body)
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/helpers/property_helper.rb

@@ -0,0 +1,103 @@
+# 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.
+
+module DeltacloudVM::Client
+  module Helpers
+    module Property
+
+      class Property
+        attr_reader :name, :unit, :default
+
+        def initialize(name, unit, default=nil)
+          @name = name
+          @unit = unit
+          @default = default
+        end
+
+        def value
+          @default || 'opaque'
+        end
+
+        def self.parse(body)
+          Property.new(body['name'], body['unit'], body['value'])
+        end
+
+        def kind
+          self.class.name.split('::').last.downcase.to_sym
+        end
+
+      end
+
+      class Range < Property
+
+        attr_reader :first, :last
+
+        def initialize(name, unit, first, last, default=nil)
+          @first, @last = first, last
+          super(name, unit, default)
+        end
+
+        def value
+          ::Range.new(@first.to_i, @last.to_i)
+        end
+
+        def self.parse(body)
+          base = super
+          new(base.name, base.unit, body.at('range')['first'], body.at('range')['last'], base.default)
+        end
+
+      end
+
+      class Enum < Property
+        include Enumerable
+        attr_reader :values
+
+        def initialize(name, unit, values, default=nil)
+          @values = values
+          super(name, unit, default)
+        end
+
+        def value
+          @values
+        end
+
+        def each
+          value.each
+        end
+
+        def self.parse(body)
+          base = super
+          new(base.name, base.unit, body.xpath('enum/entry').map { |e| e['value'] }, base.default)
+        end
+      end
+
+      class Fixed < Property
+        attr_reader :value
+
+        def initialize(name, unit, value)
+          @value = value
+          super(name, unit, @value)
+        end
+
+        def self.parse(body)
+          base = super
+          new(base.name, base.unit, body['value'])
+        end
+
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/helpers/xml_helper.rb

@@ -0,0 +1,33 @@
+# 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.
+
+module DeltacloudVM::Client
+  module Helpers
+    module XmlHelper
+
+      # Extract XML string from the various objects
+      #
+      def extract_xml_body(obj)
+        case obj
+        when Faraday::Response then obj.body
+        when Nokogiri::XML::Element then obj.to_s
+        when Nokogiri::XML::Document then obj.to_s
+        else obj
+        end
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods.rb

@@ -0,0 +1,33 @@
+# 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.
+
+require_relative './methods/address'
+require_relative './methods/api'
+require_relative './methods/backward_compatiblity'
+require_relative './methods/blob'
+require_relative './methods/bucket'
+require_relative './methods/common'
+require_relative './methods/driver'
+require_relative './methods/firewall'
+require_relative './methods/hardware_profile'
+require_relative './methods/image'
+require_relative './methods/instance'
+require_relative './methods/instance_state'
+require_relative './methods/key'
+require_relative './methods/realm'
+require_relative './methods/storage_volume'
+require_relative './methods/storage_snapshot'
+require_relative './methods/load_balancer'
+require_relative './methods/metric'