fog-ovirt 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db39545b28114f4585da4d3a292c3657df5091df
-  data.tar.gz: 89cb59e5f67129a8e78401b018086aac8c986b04
+  metadata.gz: bd8e9f9e8c862d91460d0f89a404e63f1a9aa22d
+  data.tar.gz: 30b9ad6857bd86479b48ee066fa8a3c1939f9722
 SHA512:
-  metadata.gz: 43655aca8237ef76dd2d861bcc8ae400382e283012be06509bb0e13f6449aec980c57a8111da46319d7e67e455b08064b01b5fd64153556834bc4061dc5ae38e
-  data.tar.gz: 1aa88959254782218a7c1f9dafe5383d2d60f8772f653fdbaa6f7fc73111ce33117942108b0d81c8e54841362a30e8199bbf1668c6e88841bdece60bf183e494
+  metadata.gz: '09bed3bc7ff912ab77167c48e69e2339b1d91c071ef5e410f87573ef9908e81cf53e6159bcd3b89484d22fdb969fc14b97ec83b713560ab7af14b8d268f8666f'
+  data.tar.gz: 3da84bbfa399997f07670f183dcb6ed8c6451078735eca74bddfe9a14a5d2bfe99095fbad6a0d4dfbc7f275c63b489ad7546f2a2e003d15c7afa44babc5294c9

data/.rubocop_todo.yml

@@ -14,7 +14,7 @@ Metrics/ClassLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 19
+  Max: 20
 
 # Offense count: 1
 Style/ClassVars:

data/fog-ovirt.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("fog-core", "~> 1.45")
   spec.add_dependency("fog-json")
   spec.add_dependency("fog-xml", "~> 0.1.1")
+  spec.add_dependency("ovirt-engine-sdk", ">= 4.1.3")
   spec.add_dependency("rbovirt", "~> 0.1.5")
 
   spec.add_development_dependency "bundler", "~> 1.10"

data/lib/fog/ovirt/compute/v3.rb

@@ -4,7 +4,7 @@ module Fog
       class V3 < Fog::Service
         requires   :ovirt_username, :ovirt_password
         recognizes :ovirt_url,      :ovirt_server, :ovirt_port, :ovirt_api_path, :ovirt_datacenter,
-                   :ovirt_filtered_api,
+                   :ovirt_filtered_api, :public_key, :api_version,
                    :ovirt_ca_cert_store, :ovirt_ca_cert_file, :ovirt_ca_no_verify
         request_path "fog/ovirt/requests/compute/v3"
 

data/lib/fog/ovirt/compute/v4.rb

@@ -0,0 +1,163 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4 < Fog::Service
+        requires   :ovirt_username, :ovirt_password
+        recognizes :ovirt_url,      :ovirt_server, :ovirt_port, :ovirt_api_path, :ovirt_datacenter,
+                   :ca_file, :public_key, :api_version, :ovirt_ca_cert_store
+        request_path "fog/ovirt/requests/compute/v4"
+
+        request :vm_action
+        request :destroy_vm
+        request :create_vm
+        request :datacenters
+        request :storage_domains
+        request :list_virtual_machines
+        request :get_virtual_machine
+        request :list_templates
+        request :get_template
+        request :list_instance_types
+        request :get_instance_type
+        request :list_clusters
+        request :get_cluster
+        request :add_interface
+        request :destroy_interface
+        request :update_interface
+        request :list_vm_interfaces
+        request :list_template_interfaces
+        request :list_networks
+        request :vm_ticket
+        request :list_vm_volumes
+        request :list_template_volumes
+        request :list_volumes
+        request :add_volume
+        request :destroy_volume
+        request :update_volume
+        request :get_api_version
+        request :list_quotas
+        request :get_quota
+        request :list_operating_systems
+
+        module Shared
+          # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          # converts an OVIRT object into an hash for fog to consume.
+          def ovirt_attrs(obj)
+            opts = {}
+            # TODO: stop using instance_variables, they will change
+            obj.instance_variables.each do |v|
+              key = v.to_s.delete("@").to_sym
+              value = obj.instance_variable_get(v)
+
+              if key == :network
+                opts[key] = client.follow_link(obj.vnic_profile).network.id
+                next
+              end
+
+              if key == :provisioned_size
+                opts[:size] = value
+                next
+              end
+
+              # ignore nil values
+              next if value.nil?
+
+              if key != :data_center && value.respond_to?(:href) && value.href && value.respond_to?(:id)
+                opts[key] = value.id
+              end
+
+              opts[key] ||= get_attr_value(value, opts)
+            end
+            opts
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+          def get_attr_value(value, opts)
+            case value
+            when OvirtSDK4::TemplateVersion, Array, Hash, OvirtSDK4::List, OvirtSDK4::DataCenter
+              value
+            when OvirtSDK4::Mac
+              value.address
+            when OvirtSDK4::Cpu
+              opts[:cores] = value.topology.nil? ? nil : value.topology.cores
+            when OvirtSDK4::Display
+              subject = value.certificate.subject if value.certificate
+              {
+                :type => value.type,
+                :address => value.address,
+                :port => value.port,
+                :secure_port => value.secure_port,
+                :subject => subject,
+                :monitors => value.monitors
+              }
+            else
+              value.to_s.strip
+            end
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        end
+
+        class Mock
+          include Shared
+
+          def initialize(_options = {})
+            require "ovirtsdk4"
+          end
+
+          private
+
+          def client
+            return @client if defined?(@client)
+          end
+
+          # read mocks xml
+          def read_xml(file_name)
+            file_path = File.join(__dir__, "../requests", "compute/v4", "mock_files", file_name)
+            File.read(file_path)
+          end
+        end
+
+        class Real
+          include Shared
+
+          # rubocop:disable Metrics/AbcSize
+          def initialize(options = {})
+            require "ovirtsdk4"
+            username   = options[:ovirt_username]
+            password   = options[:ovirt_password]
+            server     = options[:ovirt_server]
+            port       = options[:ovirt_port]       || 8080
+            api_path   = options[:ovirt_api_path]   || "/api"
+            url        = options[:ovirt_url]        || "https://#{server}:#{port}#{api_path}"
+
+            connection_opts = {
+              :url      => url,
+              :username => username,
+              :password => password
+            }
+
+            @datacenter = options[:ovirt_datacenter]
+            connection_opts[:ca_file]  = options[:ca_file]
+            connection_opts[:ca_certs] = [OpenSSL::X509::Certificate.new(options[:public_key])] if options[:public_key].present?
+
+            @client = ExceptionWrapper.new(OvirtSDK4::Connection.new(connection_opts))
+          end
+          # rubocop:enable Metrics/AbcSize
+
+          def api_version
+            api = client.system_service.get
+            api.product_info.version.full_version
+          end
+
+          def datacenter
+            @datacenter ||= datacenters.first.id
+          end
+
+          private
+
+          attr_reader :client
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/compute.rb

@@ -3,6 +3,9 @@ require "fog/ovirt/core"
 module Fog
   module Compute
     class Ovirt < Fog::Service
+      recognizes :api_version, :ovirt_username, :ovirt_password, :ovirt_url,
+                 :ovirt_datacenter, :ovirt_ca_cert_store, :public_key
+
       model_path "fog/ovirt/models/compute"
       model      :server
       collection :servers
@@ -31,13 +34,13 @@ module Fog
         # rubocop:disable Style/MethodMissing
         def method_missing(symbol, *args)
           if block_given?
-            @client.send(symbol, *args) do |*block_args|
+            @client.__send__(symbol, *args) do |*block_args|
               yield(*block_args)
             end
           else
-            @client.send(symbol, *args)
+            @client.__send__(symbol, *args)
           end
-        rescue ::OVIRT::OvirtException => e
+        rescue StandardError => e
           raise ::Fog::Ovirt::Errors::OvirtEngineError, e
         end
 
@@ -48,15 +51,23 @@ module Fog
       end
 
       require "fog/ovirt/compute/v3"
+      require "fog/ovirt/compute/v4"
 
       def self.new(options = {})
-        super()
-        @client = Fog::Compute::Ovirt::V3.new(options)
+        super(options)
+
+        # rubocop:disable Style/ConditionalAssignment
+        if options[:api_version] == "v4"
+          @client = Fog::Compute::Ovirt::V4.new(options)
+        else
+          @client = Fog::Compute::Ovirt::V3.new(options)
+        end
+        # rubocop:enable Style/ConditionalAssignment
       end
 
       # rubocop:disable Style/MethodMissing
       def method_missing(symbol, *args)
-        @client.send(symbol, *args)
+        @client.__send__(symbol, *args)
       end
 
       def respond_to?(symbol, include_all = false)
@@ -66,13 +77,18 @@ module Fog
 
       class Mock
         def initialize(options = {})
-          Fog::Compute::Ovirt::V3::Mock.send(:include, Fog::Compute::Ovirt::Collections)
-          @client = Fog::Compute::Ovirt::V3::Mock.new(options)
+          if options[:api_version] == "v4"
+            Fog::Compute::Ovirt::V4::Mock.send(:include, Fog::Compute::Ovirt::Collections)
+            @client = Fog::Compute::Ovirt::V4::Mock.new(options)
+          else
+            Fog::Compute::Ovirt::V3::Mock.send(:include, Fog::Compute::Ovirt::Collections)
+            @client = Fog::Compute::Ovirt::V3::Mock.new(options)
+          end
         end
 
         # rubocop:disable Style/MethodMissing
         def method_missing(symbol, *args)
-          @client.send(symbol, *args)
+          @client.__send__(symbol, *args)
         end
 
         def respond_to?(symbol, include_all = false)
@@ -83,8 +99,13 @@ module Fog
 
       class Real
         def initialize(options = {})
-          Fog::Compute::Ovirt::V3::Real.send(:include, Fog::Compute::Ovirt::Collections)
-          @client = Fog::Compute::Ovirt::V3::Real.new(options)
+          if options[:api_version] == "v4"
+            Fog::Compute::Ovirt::V4::Real.send(:include, Fog::Compute::Ovirt::Collections)
+            @client = Fog::Compute::Ovirt::V4::Real.new(options)
+          else
+            Fog::Compute::Ovirt::V3::Real.send(:include, Fog::Compute::Ovirt::Collections)
+            @client = Fog::Compute::Ovirt::V3::Real.new(options)
+          end
         end
 
         # rubocop:disable Style/MethodMissing

data/lib/fog/ovirt/requests/compute/v4/add_interface.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          # rubocop:disable Metrics/AbcSize
+          def add_interface(id, options = {})
+            raise ArgumentError, "instance id is a required parameter" unless id
+            vm = client.system_service.vms_service.vm_service(id)
+            nics_service = vm.nics_service
+            options = options.dup
+
+            if options[:network].present?
+              network = client.system_service.networks_service.network_service(options[:network]).get
+
+              profiles = client.follow_link(network.vnic_profiles)
+
+              profile = profiles.detect { |x| x.name == network.name }
+
+              profile ||= profiles.sort_by(&:name).first
+
+              options.delete(:network)
+              options[:vnic_profile] = { :id => profile.id }
+            end
+
+            interface = OvirtSDK4::Nic.new(options)
+            nics_service.add(interface)
+          end
+          # rubocop:enable Metrics/AbcSize
+        end
+
+        class Mock
+          def add_interface(id, _options = {})
+            raise ArgumentError, "instance id is a required parameter" unless id
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/add_volume.rb

@@ -0,0 +1,54 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          DISK_SIZE_TO_GB = 1024 * 1024 * 1024
+
+          def add_volume(id, options = {})
+            raise ArgumentError, "instance id is a required parameter" unless id
+
+            options = add_options_defaults(options)
+
+            disk_attachments_service = client.system_service.vms_service.vm_service(id).disk_attachments_service
+            disk = OvirtSDK4::DiskAttachment.new(options)
+            disk_attachments_service.add(disk)
+          end
+
+          # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+          def add_options_defaults(options)
+            options = options.dup
+            search = options[:search] || format("datacenter=%<datacenter>s", :datacenter => datacenter)
+            options[:bootable] ||= "true"
+            options[:interface] ||= OvirtSDK4::DiskInterface::VIRTIO
+            options[:provisioned_size] = options[:size_gb].to_i * DISK_SIZE_TO_GB if options[:size_gb]
+
+            options[:storage_domain_id] = options[:storage_domain] || storagedomains(:role => "data", :search => search).first.id
+            # If no size is given, default to a volume size of 8GB
+            options[:provisioned_size] ||= 8 * DISK_SIZE_TO_GB
+            options[:type] ||= OvirtSDK4::DiskType::DATA
+            options[:format] ||= OvirtSDK4::DiskFormat::COW
+            options[:sparse] = true unless options[:sparse].present?
+            options[:quota] = options[:quota].present? ? client.system_service.data_centers_service.data_center_service(datacenter).quotas_service.quota_service(options[:quota]).get : nil
+
+            options[:disk] ||= {}
+            options[:disk][:storage_domains] ||= [client.system_service.storage_domains_service.storage_domain_service(options[:storage_domain_id]).get]
+            options[:disk][:provisioned_size] ||= options.delete(:provisioned_size)
+            options[:disk][:type] ||= options.delete(:type)
+            options[:disk][:format] ||= options.delete(:format)
+            options[:disk][:sparse] = options.delete(:sparse) unless options[:disk][:sparse].present?
+            options
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        end
+
+        class Mock
+          def add_volume(id, _options = {})
+            raise ArgumentError, "instance id is a required parameter" unless id
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/create_vm.rb

@@ -0,0 +1,62 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def check_for_option(opts, name)
+            opts[name.to_sym] || opts[(name + "_name").to_sym]
+          end
+
+          # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          def process_vm_opts(opts)
+            return unless check_for_option(opts, "template") && check_for_option(opts, "storagedomain")
+
+            template_id = opts[:template] || client.system_service.templates_service.search(:name => opts[:template_name]).first.id
+            template_disks = client.system_service.templates_service.template_service(template_id).get.disk_attachments
+            storagedomain_id = opts[:storagedomain] || storagedomains.select { |s| s.name == opts[:storagedomain_name] }.first.id
+
+            # Make sure the 'clone' option is set if any of the disks defined by
+            # the template is stored on a different storage domain than requested
+            opts[:clone] = true unless opts[:clone] == true || template_disks.empty? || template_disks.all? { |d| d.storage_domain == storagedomain_id }
+
+            # Create disks map
+            opts[:disks] = template_disks.collect { |d| { :id => d.id, :storagedomain => storagedomain_id } }
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # rubocop:disable Metrics/AbcSize
+          def create_vm(attrs)
+            attrs = attrs.dup
+            attrs[:cluster_name] ||= datacenter.clusters.first.name unless attrs[:cluster]
+            vms_service = client.system_service.vms_service
+            attrs[:cluster] = client.system_service.clusters_service.cluster_service(attrs[:cluster]).get
+            attrs[:instance_type] = attrs[:instance_type].present? ? client.system_service.instance_types_service.instance_type_service(attrs[:instance_type]).get : nil
+
+            attrs[:template] = if attrs[:template].present?
+                                 client.system_service.templates_service.template_service(attrs[:template]).get
+                               else
+                                 client.system_service.get.special_objects.blank_template
+                               end
+
+            attrs[:comment] ||= ""
+            attrs[:quota] = attrs[:quota].present? ? client.system_service.data_centers_service.data_center_service(datacenter).quotas_service.quota_service(attrs[:quota]).get : nil
+
+            # TODO: handle cloning from template
+            process_vm_opts(attrs)
+
+            new_vm = OvirtSDK4::Vm.new(attrs)
+            vms_service.add(new_vm)
+          end
+          # rubocop:enable Metrics/AbcSize
+        end
+
+        class Mock
+          def create_vm(_attrs)
+            xml = read_xml("vm.xml")
+            OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/datacenters.rb

@@ -0,0 +1,22 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def datacenters(filter = {})
+            client.system_service.data_centers_service.list(filter).map { |ovirt_obj| ovirt_attrs ovirt_obj }
+          end
+        end
+
+        class Mock
+          def datacenters(_filters = {})
+            xml = read_xml "data_centers.xml"
+            Nokogiri::XML(xml).xpath("/data_centers/data_center").map do |dc|
+              ovirt_attrs OvirtSDK4::Reader.read(dc.to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/destroy_interface.rb

@@ -0,0 +1,24 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def destroy_interface(id, options)
+            raise ArgumentError, "instance id is a required parameter" unless id
+            raise ArgumentError, "interface id is a required parameter for destroy-interface" unless options.key? :id
+            vm = client.system_service.vms_service.vm_service(id)
+            vm.nics_service.nic_service(options[:id]).remove
+          end
+        end
+
+        class Mock
+          def destroy_interface(id, options)
+            raise ArgumentError, "instance id is a required parameter" unless id
+            raise ArgumentError, "interface id is a required parameter for destroy-interface" unless options.key? :id
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/destroy_vm.rb

@@ -0,0 +1,23 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def destroy_vm(options = {})
+            raise ArgumentError, "instance id is a required parameter" unless options.key? :id
+
+            client.system_service.vms_service.vm_service(options[:id]).remove
+            true
+          end
+        end
+
+        class Mock
+          def destroy_vm(options = {})
+            raise ArgumentError, "instance id is a required parameter" unless options.key? :id
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/destroy_volume.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def destroy_volume(id, options)
+            raise ArgumentError, "instance id is a required parameter" unless id
+            raise ArgumentError, "volume id is a required parameter for destroy-volume" unless options.key? :id
+
+            disks_service = client.system_service.disks_service
+            disks_service.disk_service(options[:id]).remove
+          end
+        end
+
+        class Mock
+          def destroy_volume(id, options)
+            raise ArgumentError, "instance id is a required parameter" unless id
+            raise ArgumentError, "volume id is a required parameter for destroy-volume" unless options.key? :id
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_api_version.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def api_version
+            "4.0"
+          end
+        end
+        class Mock
+          def api_version
+            "4.0"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_cluster.rb

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def get_cluster(id)
+            ovirt_attrs client.system_service.clusters_service.cluster_service(id).get
+          end
+        end
+        class Mock
+          def get_cluster(_id)
+            xml = read_xml("cluster.xml")
+            ovirt_attrs OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_instance_type.rb

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def get_instance_type(id)
+            ovirt_attrs client.system_service.instance_types_service.instance_type_service(id).get
+          end
+        end
+        class Mock
+          def get_instance_type(_id)
+            xml = read_xml "instance_type.xml"
+            ovirt_attrs OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_quota.rb

@@ -0,0 +1,20 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def get_quota(id)
+            quota = client.system_service.data_centers_service.data_center_service(datacenter).quotas_service.quota_service(id).get
+            ovirt_attrs quota
+          end
+        end
+        class Mock
+          def get_quota(_id)
+            xml = read_xml("quota.xml")
+            ovirt_attrs OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_template.rb

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def get_template(id)
+            ovirt_attrs client.system_service.templates_service.template_service(id).get
+          end
+        end
+        class Mock
+          def get_template(_id)
+            xml = read_xml "template.xml"
+            ovirt_attrs OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/ovirt/requests/compute/v4/get_virtual_machine.rb

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class Ovirt
+      class V4
+        class Real
+          def get_virtual_machine(id)
+            ovirt_attrs client.system_service.vms_service.vm_service(id).get
+          end
+        end
+        class Mock
+          def get_virtual_machine(_id)
+            xml = read_xml "vm.xml"
+            ovirt_attrs OvirtSDK4::Reader.read(Nokogiri::XML(xml).root.to_s)
+          end
+        end
+      end
+    end
+  end
+end