rbovirt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37364775867c2c85d2ce024df84520d268709c11
-  data.tar.gz: cfc11b0e00842a67a37aaf00402313af04f13564
+  metadata.gz: 58cb5fab7fdfa1f4dce04d45532618c7415c8be5
+  data.tar.gz: ad23cc3fa62db7186b4bf14ae198f5d7e95c74bb
 SHA512:
-  metadata.gz: fd9cd881cc6a1da9e596830af2d73af02bd21ef48abd6f29fd0da7428e9297bfdb1d10fe33424f671198ce6a9badd5dbb9c885e504897f70b19050700f067224
-  data.tar.gz: 2d347cf659fe0f17ede50ed5f99efe143dff113f03f4e0d1484a08b3f65cee14b8da7bc643eabd60444d1a83592366ef138ece1c7245b5d9b54aa4796c1f0e74
+  metadata.gz: 22b5ba8ada4d36d8ece11c9be5520188385c6978c80bdee0640b5fe898b559af46a6dd450d4e0b4195e36e3603d027722dc0197fff191c47e01cf789b3d6dde8
+  data.tar.gz: 47ba3a1763257b788c3bba4eb5596be1dbed85e36345f4f6a4c7ffaaca9cf97cd96024412020fbcb620f95412c1dd3e85f77e210a0e531f9115645d9c87e0c95

data/CHANGES.rdoc

@@ -6,6 +6,28 @@ _rbovirt_ project.
 Note that this list of changes was added with the 0.0.30 release,
 previous releases aren't described here.
 
+== 0.1.1
+
+New features:
+
+* Support operating systems
+* Added missing brackets for template display
+* Support for using the persistent-auth
+* Add instance types support.
+* Fixes Blank template display
+* Added support for VMS search options max/pages
+* Handle template's disk
+* Fix cloud init for OVirt >= 3.5
+* Set storage domain for template when provided.
+* Include disks in VM XML.
+* Make comment of vm or template editable
+* Adding override_iptables parameter to reinstall_host
+* Implement stricter checks of nicsdef content
+* Implement cloud-init for multiple nics
+* Fix broken OVIRT::Template#volumes
+* Fix for cloudinit so nokogiri correctly processes the files section
+* Add option to set description on VM create.
+
 == 0.1.0 / 2015-05-07
 
 New features:

data/lib/client/host_api.rb

@@ -17,11 +17,17 @@ module OVIRT
         http_post("/hosts/%s/approve" % host_id, "<action></action>")
     end
 
-    def reinstall_host(host_id, opts={})
+    def reinstall_host(host_id, override_iptables=False, opts={})
         http_post("/hosts/%s/install" % host_id,
-                  "<action><ssh>
-                   <authentication_method>PublicKey</authentication_method>
-                   </ssh></action>")
+                  "<action>
+                    <ssh>
+                     <authentication_method>PublicKey</authentication_method>
+                    </ssh>
+                    <host>
+                     <override_iptables>" + override_iptables + "</override_iptables>
+                    </host>
+                   </action>"
+                 )
     end
   end
 end

data/lib/client/instance_type_api.rb

@@ -0,0 +1,20 @@
+module OVIRT
+  class Client
+    def instance_type(instance_type_id)
+        begin
+          instance_type = http_get("/instancetypes/%s" % instance_type_id)
+          OVIRT::InstanceType::new(self, instance_type.root)
+        rescue
+          handle_fault $!
+        end
+      end
+
+      def instance_types(opts={})
+        search = opts[:search] ||""
+        instance_types = http_get("/instancetypes?search=%s" % CGI.escape(search))
+        instance_types.xpath('/instance_types/instance_type').collect do |it|
+          OVIRT::InstanceType::new(self, it)
+        end
+      end
+  end
+end

data/lib/client/operating_system_api.rb

@@ -0,0 +1,10 @@
+module OVIRT
+  class Client
+    def operating_systems
+      operating_systems = http_get('/operatingsystems')
+      operating_systems.xpath('/operating_systems/operating_system').collect do |os|
+        OVIRT::OperatingSystem::new(self, os)
+      end
+    end
+  end
+end

data/lib/client/vm_api.rb

@@ -6,7 +6,11 @@ module OVIRT
     end
 
     def vms(opts={})
-      headers = {:accept => "application/xml; detail=disks; detail=nics; detail=hosts"}
+      if opts[:without_details]
+        headers = {:accept => "application/xml"}
+      else
+        headers = {:accept => "application/xml; detail=disks; detail=nics; detail=hosts"}
+      end
       path = "/vms"
       path += search_url(opts) unless filtered_api
       http_get(path, headers).xpath('/vms/vm').collect do |vm|
@@ -14,6 +18,21 @@ module OVIRT
       end
     end
 
+    def process_vm_opts(opts)
+      if (opts[:template] or opts[:template_name]) and (opts[:storagedomain] or opts[:storagedomain_name])
+        template_id = opts[:template] || templates.select{|t| t.name == opts[:template_name]}.first.id
+        template_disks = template_volumes(template_id)
+        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
+    end
+
     def create_vm(opts)
       cluster_major_ver, cluster_minor_ver = cluster_version(self.cluster_id)
 
@@ -32,6 +51,9 @@ module OVIRT
           raise BackendVersionUnsupportedException.new
         end
       end
+
+      process_vm_opts(opts)
+
       opts[:cluster_name] ||= clusters.first.name unless opts[:cluster]
       OVIRT::VM::new(self, http_post("/vms",OVIRT::VM.to_xml(opts)).root)
     end
@@ -122,6 +144,12 @@ module OVIRT
     end
 
     def vm_start_with_cloudinit(id, opts={})
+      # Get the api and cluster version on which the VM is provisioned.
+      # This is required for VM::cloudinit.
+      opts.merge!(
+        :cluster_version => cluster_version(vm(id).cluster.id),
+        :api_version => api_version.split('.').map(&:to_i)
+      )
       xml = OVIRT::VM.cloudinit(opts)
       xml_response = http_post("/vms/%s/%s" % [id, 'start'], xml, {} )
       return (xml_response/'action/status').first.text.strip.upcase=="COMPLETE"

data/lib/ovirt/instance_type.rb

@@ -0,0 +1,73 @@
+module OVIRT
+  # Instance types are added to oVirt 3.5 and have been updated in oVirt 3.6
+  class InstanceType < BaseObject
+    # Common attributes to all oVirt version supported at this time
+    attr_reader :name, :description, :memory, :cores, :os, :creation_time
+    attr_reader :ha, :ha_priority, :display, :usb, :migration_downtime
+
+    # oVirt 3.5 attributes
+    attr_reader :type, :status, :cpu_shares, :boot_menu, :origin, :stateless
+    attr_reader :delete_protected, :sso, :timezone
+
+    # oVirt 3.6 attributes
+    attr_reader :migration, :io_threads, :memory_guaranteed
+
+    def initialize(client, xml)
+      super(client, xml[:id], xml[:href], (xml/'name').first.text)
+      parse_xml_attributes!(xml)
+      self
+    end
+
+    private
+    def parse_xml_attributes!(xml)
+      # Common attributes
+      @description = ((xml/'description').first.text rescue '')
+      @memory = (xml/'memory').first.text
+      @cores = ((xml/'cpu/topology').first[:cores].to_i * (xml/'cpu/topology').first[:sockets].to_i rescue nil)
+      @os = {
+          :type => (xml/'os').first[:type],
+          :boot => (xml/'os/boot').collect {|boot| boot[:dev] }
+      }
+      @creation_time = (xml/'creation_time').text
+      @ha = parse_bool((xml/'high_availability/enabled').first.text)
+      @ha_priority = ((xml/'high_availability/priority').first.text rescue nil)
+      @display = {
+        :type => (xml/'display/type').first.text,
+        :monitors => (xml/'display/monitors').first.text,
+        :single_qxl_pci => parse_bool((xml/'display/single_qxl_pci').first.text),
+        :smartcard_enabled => parse_bool((xml/'display/smartcard_enabled').first.text),
+
+      }
+      @usb = parse_bool((xml/'usb/enabled').first.text)
+      @migration_downtime = ((xml/'migration_downtime').first.text)
+
+      # oVirt 3.5 attributes
+      @type = ((xml/'type').first.text rescue nil)
+      @status = ((xml/'status').first.text rescue nil)
+      @cpu_shares = (((xml/'cpu_shares').first.text) rescue nil)
+      potential_bool = ((xml/'bios/boot_menu/enabled').first.text rescue nil)
+      @boot_menu = potential_bool.nil? ? nil : parse_bool(potential_bool)
+      @origin = ((xml/'origin').text rescue nil)
+      potential_bool = ((xml/'stateless').first.text rescue nil)
+      @stateless = potential_bool.nil? ? nil : parse_bool(potential_bool)
+      potential_bool = ((xml/'delete_protected').first.text rescue nil)
+      @delete_protected = potential_bool.nil? ? nil : parse_bool(potential_bool)
+      #@sso = ((xml/'sso/methods').first.text rescue nil)
+      @timezone = ((xml/'timezone').first.text rescue nil)
+      potential_bool = ((xml/'display/allow_override').first.text rescue nil)
+      @display[:allow_override] = potential_bool.nil? ? nil : parse_bool(potential_bool)
+      potential_bool = ((xml/'display/file_transfer_enabled').first.text rescue nil)
+      @display[:file_transfer_enabled] = potential_bool.nil? ? nil : parse_bool(potential_bool)
+      potential_bool = ((xml/'display/copy_paste_enabled').first.text rescue nil)
+      @display[:copy_paste_enabled] = potential_bool.nil? ? nil : parse_bool(potential_bool)
+
+      # oVirt 3.6 attributes
+      @migration = {
+        :auto_converge => ((xml/'migration/auto_converge').first.text rescue nil),
+        :compressed => ((xml/'migration/compressed').first.text rescue nil)
+      }
+      @io_threads = ((xml/'io/threads').first.text rescue nil)
+      @memory_guaranteed = ((xml/'memory_policy/guaranteed').first.text rescue nil)
+    end
+  end
+end

data/lib/ovirt/operating_system.rb

@@ -0,0 +1,11 @@
+module OVIRT
+  class OperatingSystem < BaseObject
+    attr_reader :description
+
+    def initialize(client, xml)
+      super(client, xml[:id], xml[:href], (xml/'name').text)
+      @description = (xml/'description').text
+      self
+    end
+  end
+end

data/lib/ovirt/template.rb

@@ -1,6 +1,7 @@
 module OVIRT
   class Template < BaseObject
-    attr_reader :description, :comment, :status, :cluster, :creation_time, :os, :storage, :display, :profile, :memory, :version
+    attr_reader :description, :status, :cluster, :creation_time, :os, :storage, :display, :profile, :memory, :version
+    attr_accessor :comment
 
     def initialize(client, xml)
       super(client, xml[:id], xml[:href], (xml/'name').first.text)
@@ -25,7 +26,7 @@ module OVIRT
     end
 
     def volumes
-      @volumes ||= @client.send(:volumes, "/templates/%s/disks" % id)
+      @volumes ||= @client.template_volumes(id)
     end
 
     private
@@ -38,8 +39,8 @@ module OVIRT
       @profile = (xml/'type').first.text
       @cluster = Link::new(@client, (xml/'cluster').first[:id], (xml/'cluster').first[:href])
       @display = {
-        :type => (xml/'display/type').first.text,
-        :monitors => (xml/'display/monitors').first.text
+        :type => ((xml/'display/type').first.text rescue ''),
+        :monitors => ((xml/'display/monitors').first.text rescue 0)
       }
       @cores = ((xml/'cpu/topology').first[:cores].to_i * (xml/'cpu/topology').first[:sockets].to_i rescue nil)
       @storage = ((xml/'disks/disk/size').first.text rescue nil)

data/lib/ovirt/template_version.rb

@@ -8,7 +8,7 @@ module OVIRT
     def parse_xml_attributes(xml)
       @base_template = (xml/"base_template").first[:id]
       @version_number = (xml/"version_number").first.text
-      @version_name = (xml/"version_name").first.text
+      @version_name = ((xml/"version_name").first.text rescue nil)
     end
   end
-end
+end

data/lib/ovirt/version.rb

@@ -1,3 +1,3 @@
 module OVIRT
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/ovirt/vm.rb

@@ -4,9 +4,9 @@ module OVIRT
     FILEINJECT_PATH = "user-data.txt"
 
   class VM < BaseObject
-    attr_reader :description, :comment, :status, :memory, :profile, :display, :host, :cluster, :template
+    attr_reader :description, :status, :memory, :profile, :display, :host, :cluster, :template
     attr_reader :storage, :cores, :creation_time, :os, :ha, :ha_priority, :ips, :vnc, :quota, :clone
-    attr_accessor :interfaces, :volumes
+    attr_accessor :comment, :interfaces, :volumes
 
     def initialize(client, xml)
       super(client, xml[:id], xml[:href], (xml/'name').first.text)
@@ -50,6 +50,7 @@ module OVIRT
       builder = Nokogiri::XML::Builder.new do
         vm{
           name_ opts[:name] || "i-#{Time.now.to_i}"
+          description_ opts[:description] || ""
           if opts[:comment]
             comment_ opts[:comment]
           end
@@ -79,18 +80,23 @@ module OVIRT
           end
           # os element must not be sent when template is present (RHBZ 1104235)
           if opts[:template].nil? || opts[:template].empty?
-            os({:type => opts[:os_type] || 'unassigned' }){
-              if(opts[:first_boot_dev] && opts[:first_boot_dev] == 'network')
-                boot(:dev=> opts[:boot_dev1] || 'network')
-                boot(:dev=> opts[:boot_dev2] || 'hd')
-              else
-                boot(:dev=> opts[:boot_dev2] || 'hd')
-                boot(:dev=> opts[:boot_dev1] || 'network')
+            os_opts = opts[:os] ? opts[:os].dup : {}
+            os_opts[:type] ||= opts[:os_type] || 'unassigned'
+            os_opts[:boot] ||= [opts.fetch(:boot_dev1, 'network'), opts.fetch(:boot_dev2, 'hd')]
+            os_opts[:kernel] ||= opts[:os_kernel]
+            os_opts[:initrd] ||= opts[:os_initrd]
+            os_opts[:cmdline] ||= opts[:os_cmdline]
+            if opts[:first_boot_dev]
+              os_opts[:boot] = os_opts[:boot].sort_by.with_index do |device, index|
+                device == opts[:first_boot_dev] ? -1 : index
               end
-              kernel (opts[:os_kernel])
-              initrd (opts[:os_initrd])
-              cmdline (opts[:os_cmdline])
-            }
+            end
+            os(:type => os_opts[:type]) do
+              os_opts[:boot].each { |device| boot(:dev => device) }
+              kernel os_opts[:kernel]
+              initrd os_opts[:initrd]
+              cmdline os_opts[:cmdline]
+            end
           end
           if !opts[:ha].nil? || !opts[:ha_priority].nil?
             high_availability_{
@@ -98,7 +104,16 @@ module OVIRT
               priority_(opts[:ha_priority]) unless opts[:ha_priority].nil?
             }
           end
-          disks_ { clone_(opts[:clone]) } if opts[:clone]
+          disks_ {
+            clone_(opts[:clone]) if opts[:clone]
+            if opts[:disks]
+              opts[:disks].each do |d|
+                disk(:id => d[:id]) {
+                  storage_domains { storage_domain(:id => d[:storagedomain]) }
+                }
+              end
+            end
+          }
           display_{
             type_(opts[:display][:type])
           } if opts[:display]
@@ -136,11 +151,14 @@ module OVIRT
       gateway             = opts[:gateway]
       domain              = opts[:domain]
       nicname             = opts[:nicname]
+      nicsdef             = opts[:nicsdef]
       user                = opts[:user] || 'root'
       password            = opts[:password]
       ssh_authorized_keys = opts[:ssh_authorized_keys]
       fileslist           = opts[:files]
       runcmd              = opts[:runcmd]
+      cluster_major, cluster_minor = opts[:cluster_version]
+      api_major,api_minor, api_build, api_revision = opts[:api_version]
       extracmd            = nil 
       unless opts[:phone_home].nil?
         phone_home = \
@@ -164,6 +182,23 @@ module OVIRT
       end
       builder   = Nokogiri::XML::Builder.new do
         action {
+          # An API has changed in version 3.5.5. Make sure
+          # <use_cloud_init>true</use_cloud_init> is used only if the endpoint
+          # if of that version or higher and the cluster the VM is provisioned
+          # to is of version 3.5 or higher.
+          # NOTE: RHEV-m/OVirt versions prior to 3.6.0 contain a bug
+          # (https://bugzilla.redhat.com/show_bug.cgi?id=1206068) which causes
+          # that build and revision parameters ov API version are set to 0.
+          # This may have an impact on conditional inclusion of <use_cloud_init>
+          # and thus leaving the guest unconfigured.
+          # You can either upgrade to RHEV-m/OVirt 3.6+ or work this around by
+          # manually forcing the ovirt engine to report an appropriate version:
+          # % rhevm-config -s VdcVersion=<major>.<minor>.<build>.<revision>
+          # % service ovirt-engine restart
+          # Please replace the placeholders with appropriate values. 
+          if api_major > 3 || (api_major == 3 && api_minor > 5) || (api_major == 3 && api_minor == 5 && api_build >= 5)
+            use_cloud_init true if cluster_major > 3 || (cluster_major == 3 && cluster_minor >= 5)
+          end
           vm {
             initialization {
               unless runcmd.nil?
@@ -194,18 +229,35 @@ module OVIRT
                     }
                   }
                 end
-                network_configuration { 
-                  unless nicname.nil?
+                network_configuration {
+                  if !nicname.nil?
                     nics {
                       nic {
-	                name_ nicname
+                        name_ nicname
                         unless ip.nil? || netmask.nil? || gateway.nil?
                           network { ip(:'address'=> ip , :'netmask'=> netmask, :'gateway'=> gateway ) }
                           boot_protocol 'STATIC'
                           on_boot 'true'
                         end 
                       }
-                    } 
+                    }
+                  elsif nicsdef.is_a?(Array) && !nicsdef.empty? && nicsdef.all? { |n| n.is_a?(Hash) }
+                    nics {
+                      nicsdef.each do |n|
+                        nic {
+                          name_(n[:nicname])
+                          boot_protocol_(n[:boot_protocol] || 'NONE') # Defaults to NONE boot proto
+                          on_boot_(n[:on_boot] || 'true') # Defaults to 'true'
+                          unless n[:ip].nil? || n[:netmask].nil?
+                            network_ {
+                              n[:gateway].nil? ?
+                              ip_(:address => n[:ip], :netmask => n[:netmask]) :
+                              ip_(:address => n[:ip], :netmask => n[:netmask], :gateway => n[:gateway])
+                            }
+                          end
+                        }
+                      end
+                    }
                   end
                   dns { 
                     unless dns.nil? 
@@ -223,7 +275,7 @@ module OVIRT
               regenerate_ssh_keys 'true'
               files {
                 unless extracmd.nil?
-                  file {
+                  file_ {
                     name_   'ignored'
                     content extracmd
                     type    'PLAINTEXT'
@@ -259,12 +311,12 @@ module OVIRT
       @host = Link::new(@client, (xml/'host').first[:id], (xml/'host').first[:href]) rescue nil
       @cluster = Link::new(@client, (xml/'cluster').first[:id], (xml/'cluster').first[:href])
       @display = {
-        :type => (xml/'display/type').first.text,
+        :type => ((xml/'display/type').first.text rescue ''),
         :address => ((xml/'display/address').first.text rescue nil),
         :port => ((xml/'display/port').first.text rescue nil),
         :secure_port => ((xml/'display/secure_port').first.text rescue nil),
         :subject => ((xml/'display/certificate/subject').first.text rescue nil),
-        :monitors => (xml/'display/monitors').first.text
+        :monitors => ((xml/'display/monitors').first.text rescue 0)
       }
       @cores = ((xml/'cpu/topology').first[:cores].to_i * (xml/'cpu/topology').first[:sockets].to_i rescue nil)
       @storage = ((xml/'disks/disk/size').first.text rescue nil)

data/lib/rbovirt.rb

@@ -12,7 +12,9 @@ require "ovirt/interface"
 require "ovirt/network"
 require "ovirt/quota"
 require "ovirt/affinity_group"
+require "ovirt/instance_type"
 require "ovirt/version"
+require "ovirt/operating_system"
 
 require "client/vm_api"
 require "client/template_api"
@@ -24,6 +26,8 @@ require "client/quota_api"
 require "client/disk_api"
 require "client/affinity_group_api"
 require "client/disk_profile_api"
+require "client/instance_type_api"
+require "client/operating_system_api"
 
 require "nokogiri"
 require "rest_client"
@@ -45,7 +49,7 @@ module OVIRT
 
   class Client
 
-    attr_reader :credentials, :api_entrypoint, :datacenter_id, :cluster_id, :filtered_api, :ca_cert_file, :ca_cert_store, :ca_no_verify
+    attr_reader :credentials, :api_entrypoint, :datacenter_id, :cluster_id, :filtered_api, :ca_cert_file, :ca_cert_store, :ca_no_verify, :persistent_auth, :jsessionid
 
     # Construct a new ovirt client class.
     # mandatory parameters
@@ -67,20 +71,26 @@ module OVIRT
                    :cluster_id => backward_compatibility_cluster,
                    :filtered_api => backward_compatibility_filtered}
       end
-      @api_entrypoint = api_entrypoint
-      @credentials    = { :username => username, :password => password }
-      @datacenter_id  = options[:datacenter_id]
-      @cluster_id     = options[:cluster_id]
-      @filtered_api   = options[:filtered_api]
-      @ca_cert_file   = options[:ca_cert_file]
-      @ca_cert_store  = options[:ca_cert_store]
-      @ca_no_verify   = options[:ca_no_verify]
+      @api_entrypoint  = api_entrypoint
+      @credentials     = { :username => username, :password => password }
+      @datacenter_id   = options[:datacenter_id]
+      @cluster_id      = options[:cluster_id]
+      @filtered_api    = options[:filtered_api]
+      @ca_cert_file    = options[:ca_cert_file]
+      @ca_cert_store   = options[:ca_cert_store]
+      @ca_no_verify    = options[:ca_no_verify]
+      @persistent_auth = options[:persistent_auth]
+      @jsessionid      = options[:jsessionid]
     end
 
     def api_version
       return @api_version unless @api_version.nil?
       xml = http_get("/")/'/api/product_info/version'
-      @api_version = (xml/'version').first[:major] +"."+ (xml/'version').first[:minor]
+      major = (xml/'version').first[:major]
+      minor = (xml/'version').first[:minor]
+      build = (xml/'version').first[:build]
+      revision = (xml/'version').first[:revision]
+      @api_version = "#{major}.#{minor}.#{build}.#{revision}"
     end
 
     def api_version?(major, minor=nil)
@@ -93,9 +103,13 @@ module OVIRT
     end
 
     private
+
     def search_url opts
-      search = opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      "?search=%s" % CGI.escape(search)
+      search = opts[:search] || ''
+      search += " datacenter=\"%s\"" % current_datacenter.name
+      search += " page #{opts[:page]}" if opts[:page]
+      max = opts[:max] ? ";max=#{opts[:max]}" : ''
+      "#{max}?search=#{CGI.escape(search)}"
     end
 
     def current_datacenter
@@ -108,9 +122,7 @@ module OVIRT
 
     def http_get(suburl, headers={})
       begin
-        res = rest_client(suburl).get(http_headers(headers))
-        puts "#{res}\n" if ENV['RBOVIRT_LOG_RESPONSE']
-        Nokogiri::XML(res)
+        handle_success(rest_client(suburl).get(http_headers(headers)))
       rescue
         handle_fault $!
       end
@@ -118,9 +130,7 @@ module OVIRT
 
     def http_post(suburl, body, headers={})
       begin
-        res = rest_client(suburl).post(body, http_headers(headers))
-        puts "#{res}\n" if ENV['RBOVIRT_LOG_RESPONSE']
-        Nokogiri::XML(res)
+        handle_success(rest_client(suburl).post(body, http_headers(headers)))
       rescue
         handle_fault $!
       end
@@ -128,9 +138,7 @@ module OVIRT
 
     def http_put(suburl, body, headers={})
       begin
-        res = rest_client(suburl).put(body, http_headers(headers))
-        puts "#{res}\n" if ENV['RBOVIRT_LOG_RESPONSE']
-        Nokogiri::XML(res)
+        handle_success(rest_client(suburl).put(body, http_headers(headers)))
       rescue
         handle_fault $!
       end
@@ -140,9 +148,7 @@ module OVIRT
       begin
         headers = body ? http_headers(headers) :
           {:accept => 'application/xml'}.merge(auth_header).merge(filter_header)
-        res = rest_client(suburl).delete_with_payload(body, headers)
-        puts "#{res}\n" if ENV['RBOVIRT_LOG_RESPONSE']
-        Nokogiri::XML(res)
+        handle_success(rest_client(suburl).delete_with_payload(body, headers))
       rescue
         handle_fault $!
       end
@@ -151,7 +157,12 @@ module OVIRT
     def auth_header
       # This is the method for strict_encode64:
       encoded_credentials = ["#{@credentials[:username]}:#{@credentials[:password]}"].pack("m0").gsub(/\n/,'')
-      { :authorization => "Basic " + encoded_credentials }
+      headers = { :authorization => "Basic " + encoded_credentials }
+      if persistent_auth
+        headers[:prefer] = 'persistent-auth'
+        headers[:cookie] = "JSESSIONID=#{jsessionid}" if jsessionid
+      end
+      headers
     end
 
     def rest_client(suburl)
@@ -189,6 +200,12 @@ module OVIRT
       }).merge(headers)
     end
 
+    def handle_success(response)
+      puts "#{response}\n" if ENV['RBOVIRT_LOG_RESPONSE']
+      @jsessionid ||= response.cookies['JSESSIONID']
+      Nokogiri::XML(response)
+    end
+
     def handle_fault(f)
       if f.is_a?(RestClient::BadRequest) || f.is_a?(RestClient::Conflict)
         fault = (Nokogiri::XML(f.http_body)/'//fault/detail')

data/spec/integration/api_spec.rb

@@ -58,6 +58,28 @@ describe OVIRT, "Https authentication" do
   end
 end
 
+describe OVIRT, "Persistent authentication" do
+  context 'use persistent authentication' do
+
+    it "test_request_with_persistent_authentication" do
+      user, password, url, datacenter = endpoint
+      cert = ca_cert(url)
+      store = OpenSSL::X509::Store.new().add_cert(
+              OpenSSL::X509::Certificate.new(cert))
+
+      client = ::OVIRT::Client.new(user, password, url, {:ca_cert_store => store, :persistent_auth => true})
+      client.api_version.class.should eql(String)
+      client.persistent_auth.should eql(true)
+      client.jsessionid.should_not be_nil
+
+      # When performing a new request the jsessionid should remain the same
+      orig_jsession_id = client.jsessionid
+      client.datacenters.class.should eql(Array)
+      client.jsessionid.should eql(orig_jsession_id)
+    end
+  end
+end
+
 describe OVIRT, "Admin API" do
 
   before(:all) do
@@ -97,3 +119,22 @@ describe OVIRT, "User API" do
   end
 
 end
+
+describe OVIRT, "Operating systems API" do
+
+  before(:all) do
+    setup_client
+  end
+
+  context 'basic user api and listing' do
+    it "exposes supported operating systems" do
+      oses = @client.operating_systems
+      oses.should_not be_empty
+      os = oses.first
+      os.id.should_not be_empty
+      os.name.should_not be_empty
+      os.description.should_not be_empty
+    end
+  end
+
+end

data/spec/integration/instance_type_spec.rb

@@ -0,0 +1,16 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe "Basic Instance type life cycle" do
+  before(:all) do
+    setup_client
+  end
+
+  it "test_should_return_instance_types" do
+    @client.instance_types
+  end
+
+  it "test_should_return_an_instance_type" do
+    @instance_type = @client.instance_types.first
+    @client.instance_type(@instance_type.id).id.should eql(@instance_type.id)
+  end
+end

data/spec/integration/vm_crud_spec.rb

@@ -51,6 +51,8 @@ shared_examples_for "Basic VM Life cycle" do
   end
 
   it "test_should_set_vm_ticket" do
+    while @client.vm(@vm.id).status.strip != 'down' do
+    end
     @client.vm_action(@vm.id, :start)
     while !@client.vm(@vm.id).running? do
     end
@@ -117,6 +119,7 @@ shared_examples_for "VM Life cycle without template" do
   end
 end
 
+
 describe "Admin API VM Life cycle" do
 
   before(:all) do
@@ -149,3 +152,124 @@ describe "User API VM Life cycle" do
     it_behaves_like "Basic VM Life cycle"
   end
 end
+
+describe "VM API support functions" do
+
+  before(:all) do
+    setup_client
+    if @client.templates.empty?
+      name = 'vm-'+Time.now.to_i.to_s
+      @cluster = @client.clusters.select{|c| c.name == cluster_name}.first.id
+      vm = @client.create_vm(:name => name, :cluster => @cluster)
+      @client.add_volume(vm.id)
+      @client.add_interface(vm.id, :network_name => network_name)
+      while !@client.vm(vm.id).ready? do
+      end
+      @client.create_template(:vm => vm.id, :name => "template-#{name}", :description => "test_template", :comment => "test_template")
+    end
+
+    @template_name = @config['template'] || @client.templates.first.name
+    @template = @client.templates.find { |t| t.name == @template_name }.id
+    @template_disks = @client.template_volumes(@template)
+    @storagedomain = @client.storagedomains.first.id
+    @storagedomain_name = @client.storagedomains.first.name
+  end
+
+  context 'options processing' do
+    it "should process template option into disk decriptions" do
+      t_id = @template
+      opts = {:template => t_id}
+      t_name = opts[:template_name]
+      @client.process_vm_opts(opts)
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+    end
+
+    it "should process template_name option into disk decriptions" do
+      t_name = @template_name
+      opts = {:template_name => t_name}
+      t_id = opts[:template]
+      @client.process_vm_opts(opts)
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+    end
+
+    it "should process template and storagedomain options into disk decriptions" do
+      t_id = @template
+      s_id = @storagedomain
+      opts = {:template => t_id,
+              :storagedomain => s_id}
+      t_name = opts[:template_name]
+      s_name = opts[:storagedomain_name]
+      @client.process_vm_opts(opts)
+      opts[:disks].length.should eql(@template_disks.length)
+      unless @template_disks.empty?
+        opts[:disks].first[:id].should_not be_nil
+        opts[:disks].first[:storagedomain].should eql(s_id)
+      end
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+      opts[:storagedomain].should eql(s_id)
+      opts[:storagedomain_name].should eql(s_name)
+    end
+
+    it "should process template_name and storagedomain options into disk decriptions" do
+      t_name = @template_name
+      s_id = @storagedomain
+      opts = {:template_name => t_name,
+              :storagedomain => s_id}
+      t_id = opts[:template]
+      s_name = opts[:storagedomain_name]
+      @client.process_vm_opts(opts)
+      opts[:disks].length.should eql(@template_disks.length)
+      unless @template_disks.empty?
+        opts[:disks].first[:id].should_not be_nil
+        opts[:disks].first[:storagedomain].should eql(s_id)
+      end
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+      opts[:storagedomain].should eql(s_id)
+      opts[:storagedomain_name].should eql(s_name)
+    end
+
+    it "should process template and storagedomain_name options into disk decriptions" do
+      t_id = @template
+      s_name = @storagedomain_name
+      opts = {:template => t_id,
+              :storagedomain_name => s_name}
+      t_name = opts[:template_name]
+      s_id = opts[:storagedomain_id]
+      @client.process_vm_opts(opts)
+      opts[:disks].length.should eql(@template_disks.length)
+      unless @template_disks.empty?
+        opts[:disks].first[:id].should_not be_nil
+        opts[:disks].first[:storagedomain].should eql(@storagedomain)
+      end
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+      opts[:storagedomain].should eql(s_id)
+      opts[:storagedomain_name].should eql(s_name)
+    end
+
+    it "should process template_name and storagedomain_name options into disk decriptions" do
+      t_name = @template_name
+      s_name = @storagedomain_name
+      opts = {:template_name => t_name,
+              :storagedomain_name => s_name}
+      t_id = opts[:template]
+      s_id = opts[:storagedomain]
+      @client.process_vm_opts(opts)
+      opts[:disks].length.should eql(@template_disks.length)
+      unless @template_disks.empty?
+        opts[:disks].first[:id].should_not be_nil
+        opts[:disks].first[:storagedomain].should eql(@storagedomain)
+      end
+      opts[:template].should eql(t_id)
+      opts[:template_name].should eql(t_name)
+      opts[:storagedomain].should eql(s_id)
+      opts[:storagedomain_name].should eql(s_name)
+    end
+
+  end
+end
+

data/spec/unit/vm_spec.rb

@@ -232,6 +232,50 @@ END_HEREDOC
       xml.nil?.should eql(false)
     end
 
+    it "create vm xml without description" do
+      opts = {
+          :cluster_name =>'cluster',
+          :template_name =>'template',
+      }
+      xml = OVIRT::VM.to_xml(opts)
+      xml.nil?.should eql(false)
+      Nokogiri::XML(xml).xpath("//description").length.should eql(1)
+      Nokogiri::XML(xml).xpath("//description")[0].children.length.should eql(0)
+    end
+
+    it "create vm xml with description" do
+      opts = {
+          :cluster_name =>'cluster',
+          :template_name =>'template',
+          :description => 'a description',
+      }
+      xml = OVIRT::VM.to_xml(opts)
+      xml.nil?.should eql(false)
+      Nokogiri::XML(xml).xpath("//description").length.should eql(1)
+      Nokogiri::XML(xml).xpath("//description")[0].children.length.should eql(1)
+      Nokogiri::XML(xml).xpath("//description")[0].children[0].text?.should eql(true)
+      Nokogiri::XML(xml).xpath("//description")[0].content.should eql("a description")
+    end
+
+    it "create vm xml with disks" do
+      disk = "00000000-0000-0000-0000-000000000000"
+      storagedomain = "00000000-0000-0000-0000-000000000001"
+      disks = [{:id => disk, :storagedomain => storagedomain}]
+      opts = {
+          :cluster_name => 'cluster',
+          :disks => disks,
+      }
+      xml = OVIRT::VM.to_xml(opts)
+      puts xml
+      xml.nil?.should eql(false)
+      Nokogiri::XML(xml).xpath("//disks").length.should eql(1)
+      Nokogiri::XML(xml).xpath("//disks")[0].element_children.length.should eql(1)
+      Nokogiri::XML(xml).xpath("//disks/disk[contains(@id,'#{disk}')]").length.should eql(1)
+      Nokogiri::XML(xml).xpath("//disks/disk/storage_domains").length.should eql(1)
+      Nokogiri::XML(xml).xpath("//disks/disk/storage_domains")[0].element_children.length.should eql(1)
+      Nokogiri::XML(xml).xpath("//disks/disk/storage_domains/storage_domain[contains(@id,'#{storagedomain}')]").length.should eql(1)
+    end
+
     it "should be running" do
       vm = OVIRT::VM.new(nil, Nokogiri::XML(@xml).xpath('/').first)
       vm.running?.should eql(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbovirt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Amos Benari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,8 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      A Ruby client for oVirt REST API
+description: "    A Ruby client for oVirt REST API\n"
 email:
 - abenari@redhat.com
 executables: []
@@ -103,6 +102,8 @@ files:
 - lib/client/disk_api.rb
 - lib/client/disk_profile_api.rb
 - lib/client/host_api.rb
+- lib/client/instance_type_api.rb
+- lib/client/operating_system_api.rb
 - lib/client/quota_api.rb
 - lib/client/storage_domain_api.rb
 - lib/client/template_api.rb
@@ -113,8 +114,10 @@ files:
 - lib/ovirt/datacenter.rb
 - lib/ovirt/disk_profile.rb
 - lib/ovirt/host.rb
+- lib/ovirt/instance_type.rb
 - lib/ovirt/interface.rb
 - lib/ovirt/network.rb
+- lib/ovirt/operating_system.rb
 - lib/ovirt/quota.rb
 - lib/ovirt/storage_domain.rb
 - lib/ovirt/template.rb
@@ -127,6 +130,7 @@ files:
 - rbovirt.gemspec
 - spec/endpoint.yml.example
 - spec/integration/api_spec.rb
+- spec/integration/instance_type_spec.rb
 - spec/integration/vm_crud_spec.rb
 - spec/spec_helper.rb
 - spec/unit/client_spec.rb
@@ -157,14 +161,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A Ruby client for oVirt REST API
 test_files:
 - spec/endpoint.yml.example
 - spec/integration/api_spec.rb
+- spec/integration/instance_type_spec.rb
 - spec/integration/vm_crud_spec.rb
 - spec/spec_helper.rb
 - spec/unit/client_spec.rb
 - spec/unit/vm_spec.rb
+has_rdoc: