fog-libvirt 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12e7867890312a401d0733ed3bd058c7bfba0488d32748569d6de134e516a752
-  data.tar.gz: 1e37605f3bd9fee08a79d18d4383bcb68f38d88675f12ead62b6366afc1c0a60
+  metadata.gz: 4f599806341a157d51f1d560bd4ae124da48172f9e6f3273892e4b219dd9ff22
+  data.tar.gz: 95035f1e61df4bd437502cf1489eddde02718d0f38f0061087a9068a1e334ce0
 SHA512:
-  metadata.gz: 6c5a173e6974eaa247bad12a3d3cacd10a43a1679dba49a361eb179e6a2a5d58ed12dacdab08b25c24ea49d05024f26b6c9564a2fb8fbf95be3e0500af6447c5
-  data.tar.gz: cb7536c410f12da3549d328e19dd6f997f0a3ae4795a90d6eea576bcca8e79a0c7a086ec8dc6b85c84e860d93ba70109d13cd3a0684769eec4991ff0c5311592
+  metadata.gz: 5fd5999bb19e032e6fd20fd89e6a8f690a1e9f1ead269b8517a6d7f4a8c6835d4ce17c930791dcecae17a376351c8357e707824ee2cb53a81a868add8071dd9c
+  data.tar.gz: b19806eb8d0f066c9456d77f09b394f36587c94ea5ab8507be1e6248a5c6e6008d101b7827907f72b4c016b73465ee2089d7df6a724335bf9f50dda668a08d66

data/Gemfile

@@ -6,7 +6,4 @@ group :development, :test do
   gem "octokit", :require => false
 end
 
-# 0.8.3 breaks our tests
-gem "ruby-libvirt", ">= 0.7.0", "< 0.8.3"
-
 gemspec

data/fog-libvirt.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "fog/libvirt/version"
@@ -23,23 +22,23 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md]
 
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = '>= 2.7'
 
   s.add_dependency("fog-core", ">= 1.27.4")
   s.add_dependency("fog-json")
   s.add_dependency("fog-xml", "~> 0.1.1")
-  s.add_dependency('ruby-libvirt','>= 0.7.0')
   s.add_dependency("json")
+  s.add_dependency('ruby-libvirt','>= 0.7.0')
 
-  s.add_development_dependency("net-ssh")
   s.add_development_dependency("minitest", "~> 5.0")
+  s.add_development_dependency("mocha", ">= 1.15", "< 3")
+  s.add_development_dependency("net-ssh")
   s.add_development_dependency("pry")
   s.add_development_dependency("rake")
   s.add_development_dependency("rubocop")
   s.add_development_dependency("shindo", "~> 0.3.4")
   s.add_development_dependency("simplecov")
   s.add_development_dependency("yard")
-  s.add_development_dependency("mocha", ">= 1.15", "< 3")
 
   # Let's not ship dot files and gemfiles
   git_files = `git ls-files`.split("\n")

data/lib/fog/libvirt/compute.rb

@@ -6,7 +6,6 @@ module Fog
     class Compute < Fog::Service
       requires   :libvirt_uri
       recognizes :libvirt_username, :libvirt_password
-      recognizes :libvirt_ip_command
 
       model_path 'fog/libvirt/models/compute'
       model       :server
@@ -50,37 +49,13 @@ module Fog
 
       module Shared
         include Fog::Libvirt::Util
-      end
-
-      class Mock
-        include Shared
-        def initialize(options={})
-          # libvirt is part of the gem => ruby-libvirt
-          require 'libvirt'
-        end
-
-        private
-
-        def client
-          return @client if defined?(@client)
-        end
 
-        #read mocks xml
-        def read_xml(file_name)
-          file_path = File.join(File.dirname(__FILE__),"requests","compute","mock_files",file_name)
-          File.read(file_path)
-        end
-      end
-
-      class Real
-        include Shared
         attr_reader :client
         attr_reader :uri
-        attr_reader :ip_command
 
         def initialize(options={})
+          super()
           @uri = ::Fog::Libvirt::Util::URI.new(enhance_uri(options[:libvirt_uri]))
-          @ip_command = options[:libvirt_ip_command]
 
           # libvirt is part of the gem => ruby-libvirt
           begin
@@ -135,6 +110,14 @@ module Fog
           uri+append
         end
       end
+
+      class Real
+        include Shared
+      end
+
+      class Mock
+        include Shared
+      end
     end
   end
 end

data/lib/fog/libvirt/models/compute/network.rb

@@ -27,6 +27,17 @@ module Fog
         def shutdown
           service.destroy_network(uuid)
         end
+
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.network do
+              xml.name(name)
+              xml.bridge(:name => bridge_name, :stp => 'on', :delay => '0')
+            end
+          end
+
+          builder.to_xml
+        end
       end
     end
   end

data/lib/fog/libvirt/models/compute/pool.rb

@@ -78,6 +78,20 @@ module Fog
         def volumes
           service.list_pool_volumes uuid
         end
+
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.pool(:type => 'dir') do
+              xml.name(name)
+
+              xml.target do
+                xml.path(path)
+              end
+            end
+          end
+
+          builder.to_xml
+        end
       end
     end
   end

data/lib/fog/libvirt/models/compute/server.rb

@@ -13,6 +13,10 @@ module Fog
 
         attribute :cpus
         attribute :cputime
+        attribute :firmware
+        attribute :firmware_features
+        attribute :secure_boot
+        attribute :loader_attributes
         attribute :os_type
         attribute :memory_size
         attribute :max_memory_size
@@ -30,6 +34,7 @@ module Fog
         attribute :cpu
         attribute :hugepages
         attribute :guest_agent
+        attribute :video
         attribute :virtio_rng
 
         attribute :state
@@ -83,7 +88,7 @@ module Fog
         end
 
         def mac
-          nics.first.mac if nics && nics.first
+          nics&.first&.mac
         end
 
         def disk_path
@@ -96,6 +101,10 @@ module Fog
           if flags.zero?
             service.vm_action(uuid, :undefine)
           else
+            # the test driver doesn't support UNDEFINE_NVRAM
+            if service.uri.driver == 'test'
+              flags ^= ::Libvirt::Domain::UNDEFINE_NVRAM
+            end
             service.vm_action(uuid, :undefine, flags)
           end
           volumes.each { |vol| vol.destroy } if options[:destroy_volumes]
@@ -282,14 +291,31 @@ module Fog
               end
 
               xml.vcpu(cpus)
-              xml.os do
+              os_tags = {}
+
+              os_tags[:firmware] = firmware if firmware == 'efi'
+
+              xml.os(**os_tags) do
                 type = xml.type(os_type, :arch => arch)
                 type[:machine] = "q35" if ["i686", "x86_64"].include?(arch)
 
                 boot_order.each do |dev|
                   xml.boot(:dev => dev)
                 end
+
+                loader_attributes&.each do |key, value|
+                  xml.loader(key => value)
+                end
+
+                if firmware == "efi" && firmware_features&.any?
+                  xml.firmware do
+                    firmware_features.each_pair do |key, value|
+                      xml.feature(:name => key, :enabled => value)
+                    end
+                  end
+                end
               end
+
               xml.features do
                 xml.acpi
                 xml.apic
@@ -302,7 +328,7 @@ module Fog
                   end
                 else
                   xml.cpu(
-                    :mode => cpu.dig(:model, :name) || "host-passthrough",
+                    :mode => cpu.fetch(:mode, "host-passthrough"),
                     :check => cpu.fetch(:check, "none"),
                     :migratable => cpu.fetch(:migratable, "on")
                   )
@@ -357,14 +383,15 @@ module Fog
                   xml.disk(:type => "file", :device => "cdrom") do
                     xml.driver(:name => "qemu", :type => "raw")
                     xml.source(:file => "#{iso_dir}/#{iso_file}")
-                    xml.target(:dev => "hdc", :bus => "ide")
+                    xml.target(:dev => "sda", :bus => "scsi")
                     xml.readonly
-                    xml.address(:type => "drive", :controller => 0, :bus => 1, :unit => 0)
+                    xml.address(:type => "drive", :controller => 0, :bus => 0, :unit => 0)
                   end
                 end
 
                 nics.each do |nic|
                   xml.interface(:type => nic.type) do
+                    xml.mac(:address => nic.mac) if nic.mac
                     if nic.type == "bridge"
                       xml.source(:bridge => nic.bridge)
                     else
@@ -409,10 +436,10 @@ module Fog
                     graphics.autoport = "yes"
                   end
                   graphics.listen = display[:listen] unless display[:listen].empty?
-                  graphics.passwd = display[:password] unless display[:password].empty?
+                  graphics.passwd = display[:password] if display[:password] && !display[:password].empty?
 
                   xml.video do
-                    xml.model(:type => "cirrus", :vram => 9216, :heads => 1)
+                    xml.model(video)
                   end
                 end
               end
@@ -441,160 +468,26 @@ module Fog
           args
         end
 
-        # This tests the library version before redefining the address
-        # method for this instance to use a method compatible with
-        # earlier libvirt libraries, or uses the dhcp method from more
-        # recent releases.
-        def addresses(service_arg=service, options={})
-          addresses_method = self.method(:addresses_dhcp)
-          # check if ruby-libvirt was compiled against a new enough version
-          # that can use dhcp_leases, as otherwise it will not provide the
-          # method dhcp_leases on any of the network objects.
-          has_dhcp_leases = true
-          begin
-            service.networks.first.dhcp_leases(self.mac)
-          rescue NoMethodError
-            has_dhcp_leases = false
-          rescue
-            # assume some other odd exception.
-          end
-
-          # if ruby-libvirt not compiled with support, or remote library is
-          # too old (must be newer than 1.2.8), then use old fallback
-          if not has_dhcp_leases or service.libversion() < 1002008
-            addresses_method = self.method(:addresses_ip_command)
-          end
-
-          # replace current definition for this instance with correct one for
-          # detected libvirt to perform check once for connection
-          (class << self; self; end).class_eval do
-            define_method(:addresses, addresses_method)
-          end
-          addresses(service_arg, options)
-        end
-
-        def ssh_ip_command(ip_command, uri)
-          # Retrieve the parts we need from the service to setup our ssh options
-          user=uri.user #could be nil
-          host=uri.host
-          keyfile=uri.keyfile
-          port=uri.port
-
-          # Setup the options
-          ssh_options={}
-          ssh_options[:keys]=[ keyfile ] unless keyfile.nil?
-          ssh_options[:port]=port unless keyfile.nil?
-          ssh_options[:paranoid]=true if uri.no_verify?
-
-          begin
-            result=Fog::SSH.new(host, user, ssh_options).run(ip_command)
-          rescue Errno::ECONNREFUSED
-            raise Fog::Errors::Error.new("Connection was refused to host #{host} to retrieve the ip_address for #{mac}")
-          rescue Net::SSH::AuthenticationFailed
-            raise Fog::Errors::Error.new("Error authenticating over ssh to host #{host} and user #{user}")
-          end
-
-          # Check for a clean exit code
-          if result.first.status == 0
-            return result.first.stdout.strip
-          else
-            # We got a failure executing the command
-            raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code")
-          end
-        end
-
-        def local_ip_command(ip_command)
-          # Execute the ip_command locally
-          # Initialize empty ip_address string
-          ip_address=""
-
-          IO.popen("#{ip_command}") do |p|
-            p.each_line do |l|
-              ip_address+=l
-            end
-            status=Process.waitpid2(p.pid)[1].exitstatus
-            if status!=0
-              raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code")
-            end
-          end
-
-          #Strip any new lines from the string
-          ip_address.chomp
-        end
-
-        # Locale-friendly removal of non-alpha nums
-        DOMAIN_CLEANUP_REGEXP = Regexp.compile('[\W_-]')
-
-        # This retrieves the ip address of the mac address using ip_command
-        # It returns an array of public and private ip addresses
-        # Currently only one ip address is returned, but in the future this could be multiple
-        # if the server has multiple network interface
-        def addresses_ip_command(service_arg=service, options={})
-          mac=self.mac
-
-          # Aug 24 17:34:41 juno arpwatch: new station 10.247.4.137 52:54:00:88:5a:0a eth0.4
-          # Aug 24 17:37:19 juno arpwatch: changed ethernet address 10.247.4.137 52:54:00:27:33:00 (52:54:00:88:5a:0a) eth0.4
-          # Check if another ip_command string was provided
-          ip_command_global=service_arg.ip_command.nil? ? 'grep $mac /var/log/arpwatch.log|sed -e "s/new station//"|sed -e "s/changed ethernet address//g" |sed -e "s/reused old ethernet //" |tail -1 |cut -d ":" -f 4-| cut -d " " -f 3' : service_arg.ip_command
-          ip_command_local=options[:ip_command].nil? ? ip_command_global : options[:ip_command]
-
-          ip_command="mac=#{mac}; server_name=#{name.gsub(DOMAIN_CLEANUP_REGEXP, '_')}; "+ip_command_local
-
-          ip_address=nil
-
-          if service_arg.uri.ssh_enabled?
-            ip_address=ssh_ip_command(ip_command, service_arg.uri)
-          else
-            # It's not ssh enabled, so we assume it is
-            if service_arg.uri.transport=="tls"
-              raise Fog::Errors::Error.new("TlS remote transport is not currently supported, only ssh")
-            end
-            ip_address=local_ip_command(ip_command)
-          end
-
-          # The Ip-address command has been run either local or remote now
-
-          if ip_address==""
-            #The grep didn't find an ip address result"
-            ip_address=nil
-          else
-            # To be sure that the command didn't return another random string
-            # We check if the result is an actual ip-address
-            # otherwise we return nil
-            unless ip_address=~/^(\d{1,3}\.){3}\d{1,3}$/
-              raise Fog::Errors::Error.new(
-                        "The result of #{ip_command} does not have valid ip-address format\n"+
-                            "Result was: #{ip_address}\n"
-                    )
-            end
-          end
-
-          return { :public => [ip_address], :private => [ip_address]}
-        end
-
         # This retrieves the ip address of the mac address using dhcp_leases
         # It returns an array of public and private ip addresses
         # Currently only one ip address is returned, but in the future this could be multiple
         # if the server has multiple network interface
-        def addresses_dhcp(service_arg=service, options={})
-          mac=self.mac
-
+        def addresses(service_arg=service, options={})
           ip_address = nil
-          nic = self.nics.find {|nic| nic.mac==mac}
-          if !nic.nil?
+          if (nic = self.nics&.first)
             net = service.networks.all(:name => nic.network).first
-            if !net.nil?
-              leases = net.dhcp_leases(mac, 0)
-              # Assume the lease expiring last is the current IP address
-              ip_address = leases.sort_by { |lse| lse["expirytime"] }.last["ipaddr"] if !leases.empty?
-            end
+            # Assume the lease expiring last is the current IP address
+            ip_address = net&.dhcp_leases(nic.mac)&.max_by { |lse| lse["expirytime"] }&.dig("ipaddr")
           end
 
           return { :public => [ip_address], :private => [ip_address] }
         end
 
+        # Locale-friendly removal of non-alpha nums
+        DOMAIN_CLEANUP_REGEXP = Regexp.compile('[\W_-]')
+
         def ip_address(key)
-          addresses[key].nil? ? nil : addresses[key].first
+          addresses[key]&.first
         end
 
         def initialize_nics
@@ -665,7 +558,9 @@ module Fog
             :cpu                    => {},
             :hugepages              => false,
             :guest_agent            => true,
+            :video                  => {:type => "cirrus", :vram => 9216, :heads => 1},
             :virtio_rng             => {},
+            :firmware_features      => { "secure-boot" => "no" },
           }
         end
 
@@ -679,7 +574,7 @@ module Fog
         end
 
         def default_display
-          {:port => '-1', :listen => '127.0.0.1', :type => 'vnc', :password => '' }
+          {:port => '-1', :listen => '127.0.0.1', :type => 'vnc' }
         end
       end
     end

data/lib/fog/libvirt/models/compute/util/util.rb

@@ -12,16 +12,8 @@ module Fog
       end
 
       def xml_elements(xml, path, attribute=nil)
-         xml = Nokogiri::XML(xml)
-         attribute.nil? ? (xml/path).map : (xml/path).map{|element| element[attribute.to_sym]}
-      end
-
-      def to_xml template_name = nil
-        # figure out our ERB template filename
-        erb = template_name || self.class.to_s.split("::").last.downcase
-        path     = File.join(File.dirname(__FILE__), "..", "templates", "#{erb}.xml.erb")
-        template = File.read(path)
-        ERB.new(template, nil, '-').result(binding)
+        xml = Nokogiri::XML(xml)
+        attribute.nil? ? (xml/path).map : (xml/path).map{|element| element[attribute.to_sym]}
       end
 
       def randomized_name

data/lib/fog/libvirt/models/compute/volume.rb

@@ -39,7 +39,8 @@ module Fog
 
           raise Fog::Errors::Error.new('Reserving an existing volume may create a duplicate') if key
           @xml ||= to_xml
-          self.path = service.create_volume(pool_name, xml).path
+          self.id = service.create_volume(pool_name, xml).key
+          reload
         end
 
         # Destroy a volume
@@ -68,8 +69,8 @@ module Fog
           new_volume      = self.dup
           new_volume.key  = nil
           new_volume.name = new_name
-          new_volume.path = service.clone_volume(pool_name, new_volume.to_xml, self.name).path
 
+          new_volume.id = service.clone_volume(pool_name, new_volume.to_xml, self.name).key
           new_volume.reload
         end
 
@@ -78,8 +79,46 @@ module Fog
           service.upload_volume(pool_name, name, file_path)
         end
 
+        def to_xml
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.volume do
+              xml.name(name)
+
+              allocation_size, allocation_unit = split_size_unit(allocation)
+              xml.allocation(allocation_size, :unit => allocation_unit)
+
+              capacity_size, capacity_unit = split_size_unit(capacity)
+              xml.capacity(capacity_size, :unit => capacity_unit)
+
+              xml.target do
+                xml.format(:type => format_type)
+                xml_permissions(xml)
+              end
+
+              if backing_volume
+                xml.backingStore do
+                  xml.path(backing_volume.path)
+                  xml.format(:type => backing_volume.format_type)
+                  xml_permissions(xml)
+                end
+              end
+            end
+          end
+
+          builder.to_xml
+        end
+
         private
 
+        def xml_permissions(xml)
+          xml.permissions do
+            xml.owner(owner) if owner
+            xml.group(group) if group
+            xml.mode('0744')
+            xml.label('virt_image_t')
+          end
+        end
+
         def image_suffix
           return "img" if format_type == "raw"
           format_type

data/lib/fog/libvirt/requests/compute/clone_volume.rb

@@ -1,17 +1,19 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
-        def clone_volume (pool_name, xml, name)
+      module Shared
+        def clone_volume(pool_name, xml, name)
           vol = client.lookup_storage_pool_by_name(pool_name).lookup_volume_by_name(name)
           client.lookup_storage_pool_by_name(pool_name).create_vol_xml_from(xml, vol)
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def clone_volume(pool_name, xml, name)
-          Fog::Libvirt::Compute::Volume.new({:pool_name => pool_name, :xml => xml})
-        end
+        include Shared
       end
     end
   end

data/lib/fog/libvirt/requests/compute/create_domain.rb

@@ -1,16 +1,18 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
+      module Shared
         def create_domain(xml)
           client.create_domain_xml(xml)
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def create_domain(xml)
-          ::Libvirt::Domain.new()
-        end
+        include Shared
       end
     end
   end

data/lib/fog/libvirt/requests/compute/create_volume.rb

@@ -1,15 +1,18 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
+      module Shared
         def create_volume(pool_name, xml)
           client.lookup_storage_pool_by_name(pool_name).create_vol_xml(xml)
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def create_volume(pool_name, xml)
-        end
+        include Shared
       end
     end
   end

data/lib/fog/libvirt/requests/compute/define_domain.rb

@@ -1,16 +1,18 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
+      module Shared
         def define_domain(xml)
           client.define_domain_xml(xml)
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def define_domain(xml)
-          ::Libvirt::Domain.new()
-        end
+        include Shared
       end
     end
   end

data/lib/fog/libvirt/requests/compute/define_pool.rb

@@ -1,15 +1,18 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
+      module Shared
         def define_pool(xml)
           client.define_storage_pool_xml(xml)
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def define_pool(xml)
-        end
+        include Shared
       end
     end
   end

data/lib/fog/libvirt/requests/compute/destroy_interface.rb

@@ -1,17 +1,19 @@
 module Fog
   module Libvirt
     class Compute
-      class Real
+      module Shared
         #shutdown the interface
         def destroy_interface(uuid)
           client.lookup_interface_by_uuid(uuid).destroy
         end
       end
 
+      class Real
+        include Shared
+      end
+
       class Mock
-        def destroy_interface(uuid)
-          true
-        end
+        include Shared
       end
     end
   end