vagrant-libvirt 0.8.2 → 0.10.1

data/lib/vagrant-libvirt/action/start_domain.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'diffy'
 require 'log4r'
 require 'rexml/document'
 
@@ -14,8 +15,6 @@ module VagrantPlugins
         end
 
         def call(env)
-          env[:ui].info(I18n.t('vagrant_libvirt.starting_domain'))
-
           domain = env[:machine].provider.driver.connection.servers.get(env[:machine].id.to_s)
           raise Errors::NoDomainError if domain.nil?
           config = env[:machine].provider_config
@@ -33,6 +32,7 @@ module VagrantPlugins
                 libvirt_domain.memory = libvirt_domain.max_memory
               end
             end
+
             begin
               # XML definition manipulation
               descr = libvirt_domain.xml_desc(1)
@@ -64,7 +64,7 @@ module VagrantPlugins
                 disk_target.parent.delete_element("#{disk_target.parent.xpath}/address")
               end
 
-              # Iterface type
+              # Interface type
               unless config.nic_model_type.nil?
                 REXML::XPath.each(xml_descr, '/domain/devices/interface/model') do |iface_model|
                   if iface_model.attributes['type'] != config.nic_model_type
@@ -248,7 +248,7 @@ module VagrantPlugins
               # TPM
               if [config.tpm_path, config.tpm_version].any?
                 if config.tpm_path
-                  raise Errors::FogCreateServerError, 'The TPM Path must be fully qualified' unless config.tpm_path[0].chr == '/'
+                  raise Errors::UpdateServerError, 'The TPM Path must be fully qualified' unless config.tpm_path[0].chr == '/'
                 end
 
                 # just build the tpm element every time
@@ -375,20 +375,88 @@ module VagrantPlugins
                 end
               end
 
+              loader = REXML::XPath.first(xml_descr, '/domain/os/loader')
+              if config.loader
+                if loader.nil?
+                  descr_changed = true
+                  loader = REXML::Element.new('loader')
+                  REXML::XPath.first(xml_descr, '/domain/os').insert_after('//type', loader)
+                  loader.text = config.loader
+                else
+                  if (loader.text or '').strip != config.loader
+                    descr_changed = true
+                    loader.text = config.loader
+                  end
+                end
+                loader.attributes['type'] = config.nvram ? 'pflash' : 'rom'
+              elsif !loader.nil?
+                descr_changed = true
+                loader.parent.delete_element(loader)
+              end
+
+              nvram = REXML::XPath.first(xml_descr, '/domain/os/nvram')
+              if config.nvram
+                if nvram.nil?
+                  descr_changed = true
+                  nvram = REXML::Element.new('nvram')
+                  REXML::XPath.first(xml_descr, '/domain/os').insert_after(loader, nvram)
+                  nvram.text = config.nvram
+                else
+                  if (nvram.text or '').strip != config.nvram
+                    descr_changed = true
+                    nvram.text = config.nvram
+                  end
+                end
+              elsif !nvram.nil?
+                descr_changed = true
+                nvram.parent.delete_element(nvram)
+              end
+
               # Apply
               if descr_changed
+                env[:ui].info(I18n.t('vagrant_libvirt.updating_domain'))
+                new_xml = String.new
+                xml_descr.write(new_xml)
+                begin
+                  # providing XML for the same name and UUID will update the existing domain
+                  libvirt_domain = env[:machine].provider.driver.connection.define_domain(new_xml)
+                rescue ::Libvirt::Error => e
+                  raise Errors::UpdateServerError, error_message: e.message
+                end
+
                 begin
-                  libvirt_domain.undefine
-                  new_descr = String.new
-                  xml_descr.write new_descr
-                  env[:machine].provider.driver.connection.servers.create(xml: new_descr)
-                rescue Fog::Errors::Error => e
-                  env[:machine].provider.driver.connection.servers.create(xml: descr)
-                  raise Errors::FogCreateServerError, error_message: e.message
+                  proposed = Nokogiri::XML(new_xml, &:noblanks)
+
+                  # This normalizes the attribute order to be consistent across both XML docs to eliminate differences
+                  # for subsequent comparison by diffy
+                  updated_xml_descr = REXML::Document.new(libvirt_domain.xml_desc(1))
+                  updated_xml = String.new
+                  updated_xml_descr.write(updated_xml)
+
+                  updated = Nokogiri::XML(updated_xml, &:noblanks)
+
+                  pretty_proposed = StringIO.new
+                  pretty_updated = StringIO.new
+                  proposed.write_xml_to(pretty_proposed, indent: 2)
+                  updated.write_xml_to(pretty_updated, indent: 2)
+
+                  diff = Diffy::Diff.new(pretty_proposed.string, pretty_updated.string, :context => 3).to_s(:text)
+
+                  unless diff.empty?
+                    error_msg = "Libvirt failed to fully update the domain with the specified XML. Result differs from requested:\n" +
+                      "--- requested\n+++ result\n#{diff}\n" +
+                      "Typically this means there is a bug in the XML being sent, please log an issue"
+
+                    raise Errors::UpdateServerError, error_message: error_msg
+                  end
+                rescue Exception => e
+                  env[:machine].provider.driver.connection.define_domain(descr)
+                  raise
                 end
               end
             rescue Errors::VagrantLibvirtError => e
               env[:ui].error("Error when updating domain settings: #{e.message}")
+              raise
             end
             # Autostart with host if enabled in Vagrantfile
             libvirt_domain.autostart = config.autostart
@@ -396,6 +464,7 @@ module VagrantPlugins
               "Starting Domain with XML:\n#{libvirt_domain.xml_desc}"
             }
             # Actually start the domain
+            env[:ui].info(I18n.t('vagrant_libvirt.starting_domain'))
             domain.start
           rescue Fog::Errors::Error, Errors::VagrantLibvirtError => e
             raise Errors::FogError, message: e.message

data/lib/vagrant-libvirt/action.rb

@@ -35,10 +35,17 @@ module VagrantPlugins
       autoload :ReadMacAddresses, action_root.join('read_mac_addresses')
       autoload :RemoveLibvirtImage, action_root.join('remove_libvirt_image')
       autoload :RemoveStaleVolume, action_root.join('remove_stale_volume')
+      autoload :ResolveDiskSettings, action_root.join('resolve_disk_settings')
       autoload :ResumeDomain, action_root.join('resume_domain')
       autoload :SetNameOfDomain, action_root.join('set_name_of_domain')
       autoload :SetBootOrder, action_root.join('set_boot_order')
       autoload :SetupComplete, action_root.join('cleanup_on_failure')
+      # Snapshot autoload
+      autoload :SnapshotDelete, action_root.join('snapshot_delete')
+      autoload :SnapshotSave, action_root.join('snapshot_save')
+      autoload :SnapshotRestore, action_root.join('snapshot_restore')
+
+
       # I don't think we need it anymore
       autoload :ShareFolders, action_root.join('share_folders')
       autoload :ShutdownDomain, action_root.join('shutdown_domain')
@@ -81,6 +88,7 @@ module VagrantPlugins
               b2.use SetNameOfDomain
 
               if !env[:machine].config.vm.box
+                b2.use ResolveDiskSettings
                 b2.use CreateDomain
                 b2.use CreateNetworks
                 b2.use CreateNetworkInterfaces
@@ -94,6 +102,7 @@ module VagrantPlugins
                 b2.use HandleBox
                 b2.use HandleBoxImage
                 b2.use CreateDomainVolume
+                b2.use ResolveDiskSettings
                 b2.use CreateDomain
                 b2.use CreateNetworks
                 b2.use CreateNetworkInterfaces
@@ -104,6 +113,7 @@ module VagrantPlugins
               end
             else
               env[:halt_on_error] = true
+              b2.use ResolveDiskSettings
               b2.use CreateNetworks
               b2.use action_start
             end
@@ -152,7 +162,7 @@ module VagrantPlugins
                 # Start it..
                 b3.use StartDomain
 
-                # Machine should gain IP address when comming up,
+                # Machine should gain IP address when coming up,
                 # so wait for dhcp lease and store IP into machines data_dir.
                 b3.use WaitTillUp
                 require 'vagrant/action/builtin/wait_for_communicator'
@@ -388,6 +398,48 @@ module VagrantPlugins
         end
       end
 
+      # This is the action that is primarily responsible for deleting a snapshot
+      def self.action_snapshot_delete
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              raise Vagrant::Errors::VMNotCreatedError
+            end
+
+            b2.use SnapshotDelete
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for restoring a snapshot
+      def self.action_snapshot_restore
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              raise Vagrant::Errors::VMNotCreatedError
+            end
+
+            b2.use SnapshotRestore
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for saving a snapshot
+      def self.action_snapshot_save
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              raise Vagrant::Errors::VMNotCreatedError
+            end
+
+            b2.use SnapshotSave
+          end
+        end
+      end
+
     end
   end
 end

data/lib/vagrant-libvirt/cap/snapshots.rb

@@ -0,0 +1,12 @@
+module VagrantPlugins
+  module ProviderLibvirt
+    module Cap
+      class Snapshots
+        def self.snapshot_list(machine)
+          return if machine.state.id == :not_created
+          machine.provider.driver.list_snapshots(machine)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/cap/synced_folder_9p.rb

@@ -34,6 +34,8 @@ module VagrantPlugins
         raise Vagrant::Errors::Error('No Libvirt connection') if machine.provider.driver.connection.nil?
         @conn = machine.provider.driver.connection.client
 
+        machine.ui.info I18n.t("vagrant_libvirt.cap.9p.preparing")
+
         begin
           # loop through folders
           folders.each do |id, folder_opts|
@@ -45,8 +47,6 @@ module VagrantPlugins
             mount_tag = Digest::MD5.new.update(folder_opts[:hostpath]).to_s[0, 31]
             folder_opts[:mount_tag] = mount_tag
 
-            machine.ui.info "================\nMachine id: #{machine.id}\nShould be mounting folders\n #{id}, opts: #{folder_opts}"
-
             xml = Nokogiri::XML::Builder.new do |xml|
               xml.filesystem(type: 'mount', accessmode: folder_opts[:accessmode]) do
                 xml.driver(type: 'path', wrpolicy: 'immediate')
@@ -74,7 +74,7 @@ module VagrantPlugins
       # once up, mount folders
       def enable(machine, folders, _opts)
         # Go through each folder and mount
-        machine.ui.info('mounting 9p share in guest')
+        machine.ui.info I18n.t("vagrant_libvirt.cap.9p.mounting")
         # Only mount folders that have a guest path specified.
         mount_folders = {}
         folders.each do |id, opts|
@@ -94,6 +94,7 @@ module VagrantPlugins
           raise Vagrant::Errors::Error('No Libvirt connection')
         end
         @conn = machine.provider.driver.connection.client
+        machine.ui.info I18n.t("vagrant_libvirt.cap.9p.cleanup")
         begin
           if machine.id && machine.id != ''
             dom = @conn.lookup_domain_by_uuid(machine.id)
@@ -101,7 +102,6 @@ module VagrantPlugins
               '/domain/devices/filesystem'
             ).each do |xml|
               dom.detach_device(xml.to_s)
-              machine.ui.info 'Cleaned up shared folders'
             end
           end
         rescue => e

data/lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb

@@ -34,6 +34,8 @@ module VagrantPlugins
         raise Vagrant::Errors::Error('No Libvirt connection') if machine.provider.driver.connection.nil?
         @conn = machine.provider.driver.connection.client
 
+        machine.ui.info I18n.t("vagrant_libvirt.cap.virtiofs.preparing")
+
         begin
           # loop through folders
           folders.each do |id, folder_opts|
@@ -44,8 +46,6 @@ module VagrantPlugins
             mount_tag = Digest::MD5.new.update(folder_opts[:hostpath]).to_s[0, 31]
             folder_opts[:mount_tag] = mount_tag
 
-            machine.ui.info "================\nMachine id: #{machine.id}\nShould be mounting folders\n #{id}, opts: #{folder_opts}"
-
             xml = Nokogiri::XML::Builder.new do |xml|
               xml.filesystem(type: 'mount', accessmode: 'passthrough') do
                 xml.driver(type: 'virtiofs')
@@ -73,7 +73,7 @@ module VagrantPlugins
       # once up, mount folders
       def enable(machine, folders, _opts)
         # Go through each folder and mount
-        machine.ui.info('mounting virtiofs share in guest')
+        machine.ui.info I18n.t("vagrant_libvirt.cap.virtiofs.mounting")
         # Only mount folders that have a guest path specified.
         mount_folders = {}
         folders.each do |id, opts|
@@ -91,6 +91,7 @@ module VagrantPlugins
           raise Vagrant::Errors::Error('No Libvirt connection')
         end
         @conn = machine.provider.driver.connection.client
+        machine.ui.info I18n.t("vagrant_libvirt.cap.virtiofs.cleanup")
         begin
           if machine.id && machine.id != ''
             dom = @conn.lookup_domain_by_uuid(machine.id)
@@ -98,7 +99,6 @@ module VagrantPlugins
               '/domain/devices/filesystem'
             ).each do |xml|
               dom.detach_device(xml.to_s)
-              machine.ui.info 'Cleaned up shared folders'
             end
           end
         rescue => e

data/lib/vagrant-libvirt/config.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
   module ProviderLibvirt
     class Config < Vagrant.plugin('2', :config)
       # manually specify URI
-      # will supercede most other options if provided
+      # will supersede most other options if provided
       attr_accessor :uri
 
       # A hypervisor name to access via Libvirt.
@@ -99,6 +99,7 @@ module VagrantPlugins
       attr_accessor :machine_virtual_size
       attr_accessor :disk_bus
       attr_accessor :disk_device
+      attr_accessor :disk_controller_model
       attr_accessor :disk_driver_opts
       attr_accessor :nic_model_type
       attr_accessor :nested
@@ -128,6 +129,9 @@ module VagrantPlugins
       attr_accessor :tpm_path
       attr_accessor :tpm_version
 
+      # Configure sysinfo values
+      attr_accessor :sysinfo
+
       # Configure the memballoon
       attr_accessor :memballoon_enabled
       attr_accessor :memballoon_model
@@ -195,6 +199,9 @@ module VagrantPlugins
       # serial consoles
       attr_accessor :serials
 
+      # internal helper attributes
+      attr_accessor :host_device_exclude_prefixes
+
       def initialize
         @uri               = UNSET_VALUE
         @driver            = UNSET_VALUE
@@ -253,6 +260,7 @@ module VagrantPlugins
         @machine_virtual_size = UNSET_VALUE
         @disk_bus          = UNSET_VALUE
         @disk_device       = UNSET_VALUE
+        @disk_controller_model = UNSET_VALUE
         @disk_driver_opts  = {}
         @nic_model_type    = UNSET_VALUE
         @nested            = UNSET_VALUE
@@ -280,6 +288,8 @@ module VagrantPlugins
         @tpm_path          = UNSET_VALUE
         @tpm_version       = UNSET_VALUE
 
+        @sysinfo           = UNSET_VALUE
+
         @memballoon_enabled = UNSET_VALUE
         @memballoon_model   = UNSET_VALUE
         @memballoon_pci_bus = UNSET_VALUE
@@ -342,6 +352,9 @@ module VagrantPlugins
         @qemu_use_agent  = UNSET_VALUE
 
         @serials           = UNSET_VALUE
+
+        # internal options to help override behaviour
+        @host_device_exclude_prefixes = UNSET_VALUE
       end
 
       def boot(device)
@@ -865,8 +878,15 @@ module VagrantPlugins
         @machine_type = nil if @machine_type == UNSET_VALUE
         @machine_arch = nil if @machine_arch == UNSET_VALUE
         @machine_virtual_size = nil if @machine_virtual_size == UNSET_VALUE
-        @disk_bus = 'virtio' if @disk_bus == UNSET_VALUE
-        @disk_device = 'vda' if @disk_device == UNSET_VALUE
+        @disk_device = @disk_bus == 'scsi' ? 'sda' : 'vda' if @disk_device == UNSET_VALUE
+        @disk_bus = @disk_device.start_with?('sd') ? 'scsi' : 'virtio' if @disk_bus == UNSET_VALUE
+        if @disk_controller_model == UNSET_VALUE
+          if @disk_bus == 'scsi' or @disk_device.start_with?('sd') == 'sd'
+            @disk_controller_model = 'virtio-scsi'
+          else
+            @disk_controller_model = nil
+          end
+        end
         @disk_driver_opts = {} if @disk_driver_opts == UNSET_VALUE
         @nic_model_type = nil if @nic_model_type == UNSET_VALUE
         @nested = false if @nested == UNSET_VALUE
@@ -902,6 +922,8 @@ module VagrantPlugins
         @nic_adapter_count = 8 if @nic_adapter_count == UNSET_VALUE
         @emulator_path = nil if @emulator_path == UNSET_VALUE
 
+        @sysinfo = {} if @sysinfo == UNSET_VALUE
+
         # Boot order
         @boot_order = [] if @boot_order == UNSET_VALUE
 
@@ -972,6 +994,8 @@ module VagrantPlugins
         @qemu_use_agent = false if @qemu_use_agent == UNSET_VALUE
 
         @serials = [{:type => 'pty', :source => nil}] if @serials == UNSET_VALUE
+
+        @host_device_exclude_prefixes = ['docker', 'macvtap', 'virbr', 'vnet'] if @host_device_exclude_prefixes == UNSET_VALUE
       end
 
       def validate(machine)
@@ -994,8 +1018,12 @@ module VagrantPlugins
           errors << "libvirt.qemu_use_agent must be a boolean."
         end
 
+        if !@nvram.nil? && @loader.nil?
+          errors << "use of 'nvram' requires a 'loader' to be specified, please add one to the configuration"
+        end
+
         if @qemu_use_agent == true
-          # if qemu agent is used to optain domain ip configuration, at least
+          # if qemu agent is used to obtain domain ip configuration, at least
           # one qemu channel has to be configured. As there are various options,
           # error out and leave configuration to the user
           unless machine.provider_config.channels.any? { |channel| channel[:target_name].start_with?("org.qemu.guest_agent") }
@@ -1025,7 +1053,9 @@ module VagrantPlugins
           errors << "#{e}"
         end
 
-        machine.config.vm.networks.each do |_type, opts|
+        machine.config.vm.networks.each_with_index do |network, index|
+          type, opts = network
+
           if opts[:mac]
             if opts[:mac] =~ /\A([0-9a-fA-F]{12})\z/
               opts[:mac] = opts[:mac].scan(/../).join(':')
@@ -1034,6 +1064,14 @@ module VagrantPlugins
               errors << "Configured NIC MAC '#{opts[:mac]}' is not in 'xx:xx:xx:xx:xx:xx' or 'xxxxxxxxxxxx' format"
             end
           end
+
+          # only interested in public networks where portgroup is nil, as then source will be a host device
+          if type == :public_network && opts[:portgroup] == nil
+            devices = host_devices(machine)
+            if !devices.include?(opts[:dev])
+              errors << "network configuration #{index} for machine #{machine.name} is a public_network referencing host device '#{opts[:dev]}' which does not exist, consider adding ':dev => ....' referencing one of #{devices.join(", ")}"
+            end
+          end
         end
 
         if !machine.provider_config.volume_cache.nil? and machine.provider_config.volume_cache != UNSET_VALUE
@@ -1044,6 +1082,8 @@ module VagrantPlugins
           end
         end
 
+        errors = validate_sysinfo(machine, errors)
+
         { 'Libvirt Provider' => errors }
       end
 
@@ -1058,7 +1098,11 @@ module VagrantPlugins
           result.cdroms = c
 
           result.disk_driver_opts = disk_driver_opts.merge(other.disk_driver_opts)
-          
+
+          c = sysinfo == UNSET_VALUE ? {} : sysinfo.dup
+          c.merge!(other.sysinfo) { |_k, x, y| x.respond_to?(:each_pair) ? x.merge(y) : x + y } if other.sysinfo != UNSET_VALUE
+          result.sysinfo = c
+
           c = clock_timers.dup
           c += other.clock_timers
           result.clock_timers = c
@@ -1166,6 +1210,60 @@ module VagrantPlugins
           @proxy_command = nil
         end
       end
+
+      def host_devices(machine)
+        @host_devices ||= begin
+          machine.provider.driver.connection.client.list_all_interfaces().map { |iface| iface.name }.uniq.select do |dev|
+            dev != "lo" && !@host_device_exclude_prefixes.any? { |exclude| dev.start_with?(exclude) }
+          end
+        end
+      end
+
+      def validate_sysinfo(machine, errors)
+        valid_sysinfo = {
+          'bios' => %w[vendor version date release],
+          'system' => %w[manufacturer product version serial uuid sku family],
+          'base board' => %w[manufacturer product version serial asset location],
+          'chassis' => %w[manufacturer version serial asset sku],
+          'oem strings' => nil,
+        }
+
+        machine.provider_config.sysinfo.each_pair do |block_name, entries|
+          block_name = block_name.to_s
+          unless valid_sysinfo.key?(block_name)
+            errors << "invalid sysinfo element '#{block_name}'; smbios sysinfo elements supported: #{valid_sysinfo.keys.join(', ')}"
+            next
+          end
+
+          if valid_sysinfo[block_name].nil?
+            # assume simple array of text entries
+            entries.each do |entry|
+              if entry.respond_to?(:to_str)
+                if entry.to_s.empty?
+                  machine.ui.warn("Libvirt Provider: 'sysinfo.#{block_name}' contains an empty or nil entry and will be discarded")
+                end
+              else
+                errors << "sysinfo.#{block_name} expects entries to be stringy, got #{entry.class} containing '#{entry}'"
+              end
+            end
+          else
+            entries.each_pair do |entry_name, entry_text|
+              entry_name = entry_name.to_s
+              unless valid_sysinfo[block_name].include?(entry_name)
+                errors << "'sysinfo.#{block_name}' does not support entry name '#{entry_name}'; entries supported: #{valid_sysinfo[block_name].join(', ')}"
+                next
+              end
+
+              # this allows removal of entries specified by other Vagrantfile's in the hierarchy
+              if entry_text.to_s.empty?
+                machine.ui.warn("Libvirt Provider: sysinfo.#{block_name}.#{entry_name} is nil or empty and therefore has no effect.")
+              end
+            end
+          end
+        end
+
+        errors
+      end
     end
   end
 end