vagrant-libvirt 0.9.0 → 0.10.0

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

@@ -44,6 +44,7 @@ module VagrantPlugins
           @nvram = config.nvram
           @machine_type = config.machine_type
           @machine_arch = config.machine_arch
+          @disk_controller_model = config.disk_controller_model
           @disk_driver_opts = config.disk_driver_opts
           @nested = config.nested
           @memory_size = config.memory.to_i * 1024
@@ -73,6 +74,22 @@ module VagrantPlugins
           @tpm_path = config.tpm_path
           @tpm_version = config.tpm_version
 
+          @sysinfo = config.sysinfo.dup
+          @sysinfo.each do |section, _v|
+            if @sysinfo[section].respond_to?(:each_pair)
+              @sysinfo[section].delete_if { |_k, v| v.to_s.empty? }
+            else
+              @sysinfo[section].reject! { |e| e.to_s.empty? }
+            end
+          end.reject! { |_k, v| v.empty? }
+          @sysinfo_blocks = {
+            'bios' => {:ui => "BIOS", :xml => "bios"},
+            'system' => {:ui => "System", :xml => "system"},
+            'base board' => {:ui => "Base Board", :xml => "baseBoard"},
+            'chassis' => {:ui => "Chassis", :xml => "chassis"},
+            'oem strings' => {:ui => "OEM Strings", :xml => "oemStrings"},
+          }
+
           # Boot order
           @boot_order = config.boot_order
 
@@ -151,9 +168,11 @@ module VagrantPlugins
             rescue Libvirt::Error => e
               # It is hard to believe that e contains just a string
               # and no useful error code!
-              msg = "Call to virStorageVolCreateXML failed: " +
-                    "storage volume '#{disk[:absolute_path]}' exists already"
-              if e.message == msg and disk[:allow_existing]
+              msgs = [disk[:name], disk[:absolute_path]].map do |name|
+                "Call to virStorageVolCreateXML failed: " +
+                "storage volume '#{name}' exists already"
+              end
+              if msgs.include?(e.message) and disk[:allow_existing]
                 disk[:preexisting] = true
               else
                 raise Errors::FogCreateDomainVolumeError,
@@ -243,7 +262,7 @@ module VagrantPlugins
           env[:ui].info(" -- Video Type:        #{@video_type}")
           env[:ui].info(" -- Video VRAM:        #{@video_vram}")
           env[:ui].info(" -- Video 3D accel:    #{@video_accel3d}")
-          env[:ui].info(" -- Sound Type:	#{@sound_type}")
+          env[:ui].info(" -- Sound Type:        #{@sound_type}")
           env[:ui].info(" -- Keymap:            #{@keymap}")
           env[:ui].info(" -- TPM Backend:       #{@tpm_type}")
           if @tpm_type == 'emulator'
@@ -253,6 +272,22 @@ module VagrantPlugins
             env[:ui].info(" -- TPM Path:          #{@tpm_path}")
           end
 
+          unless @sysinfo.empty?
+            env[:ui].info(" -- Sysinfo:")
+            @sysinfo.each_pair do |block, values|
+              env[:ui].info("   -- #{@sysinfo_blocks[block.to_s][:ui]}:")
+              if values.respond_to?(:each_pair)
+                values.each_pair do |name, value|
+                  env[:ui].info("    -> #{name}: #{value}")
+                end
+              else
+                values.each do |value|
+                  env[:ui].info("    -> #{value}")
+                end
+              end
+            end
+          end
+
           if @memballoon_enabled
             env[:ui].info(" -- Memballoon model:  #{@memballoon_model}")
             env[:ui].info(" -- Memballoon bus:    #{@memballoon_pci_bus}")

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

@@ -41,7 +41,7 @@ module VagrantPlugins
           # Vagrant gives you adapter 0 by default
           # Assign interfaces to slots.
           configured_networks(env, @logger).each do |options|
-            # dont need to create interface for this type
+            # don't need to create interface for this type
             next if options[:iface_type] == :forwarded_port
 
             # TODO: fill first ifaces with adapter option specified.

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

@@ -44,7 +44,7 @@ module VagrantPlugins
           end
 
           # only one vm at a time should try to set up networks
-          # otherwise they'll have inconsitent views of current state
+          # otherwise they'll have inconsistent views of current state
           # and conduct redundant operations that cause errors
           @@lock.synchronize do
             # Iterate over networks If some network is not
@@ -124,7 +124,7 @@ module VagrantPlugins
         # Throw an error if dhcp setting for an existing network does not
         # match what was configured in the vagrantfile
         # since we always enable dhcp for the management network
-        # this ensures we wont start a vm vagrant cant reach
+        # this ensures we won't start a vm vagrant can't reach
         # Allow the situation where DHCP is not requested (:libvirt__dhcp_enabled == false)
         # but where it is enabled on the virtual network
         def verify_dhcp
@@ -321,7 +321,7 @@ module VagrantPlugins
 
           @network_ipv6_address = @interface_network[:ipv6_address]
           @network_ipv6_prefix = @interface_network[:ipv6_prefix]
-          
+
           @network_bridge_stp = @options[:bridge_stp].nil? || @options[:bridge_stp] ? 'on' : 'off'
           @network_bridge_delay = @options[:bridge_delay] ? @options[:bridge_delay] : 0
 

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

@@ -34,7 +34,7 @@ module VagrantPlugins
               begin
                 libvirt_domain.lookup_snapshot_by_name(name).delete
               rescue => e
-                raise Errors::DeleteSnapshotError, error_message: e.message
+                raise Errors::SnapshotDeletionError, error_message: e.message
               end
             end
           rescue

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

@@ -50,7 +50,7 @@ module VagrantPlugins
               if e.libvirt_code == ProviderLibvirt::Util::ErrorCodes::VIR_ERR_NO_NETWORK
                 @logger.info 'It is already undefined'
                 next
-              # some other error occured, so raise it again
+              # some other error occurred, so raise it again
               else
                 raise e
               end

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

@@ -134,7 +134,7 @@ module VagrantPlugins
                       ''
                     end
 
-          if version.empty?
+          if version.empty? || version == '0'
             ui.warn(I18n.t('vagrant_libvirt.box_version_missing', name: box.name.to_s))
 
             version = "0_#{File.mtime(path).to_i}"

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

@@ -3,11 +3,7 @@
 require 'fileutils'
 require 'log4r'
 
-class String
-  def unindent
-    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
-  end
-end
+require 'vagrant-libvirt/util/unindent'
 
 module VagrantPlugins
   module ProviderLibvirt

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

@@ -12,7 +12,9 @@ module VagrantPlugins
         end
 
         def call(env)
-          env[:ui].info('Vagrant-libvirt plugin removed box only from your LOCAL ~/.vagrant/boxes directory')
+          return @app.call(env) unless env[:box_removed].provider == :libvirt
+
+          env[:ui].info("Vagrant-libvirt plugin removed box only from #{env[:env].boxes.directory} directory")
           env[:ui].info('From Libvirt storage pool you have to delete image manually(virsh, virt-manager or by any other tool)')
           @app.call(env)
         end

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
 require 'log4r'
-require 'rexml'
+
+begin
+  require 'rexml'
+rescue LoadError
+  require 'rexml/rexml'
+end
 
 require 'vagrant-libvirt/util/resolvers'
 
@@ -97,13 +102,15 @@ module VagrantPlugins
             # the default storage prefix is typically: /var/lib/libvirt/images/
             storage_prefix = "#{File.dirname(domain_volumes[0][:absolute_path])}/" # steal
           else
-            # Ensure domain name is set for subsequent steps if restarting a machine without a box
-            libvirt_domain = env[:machine].provider.driver.connection.client.lookup_domain_by_uuid(
-              env[:machine].id
-            )
-            domain_xml = libvirt_domain.xml_desc(1)
-            xml_descr = REXML::Document.new(domain_xml)
-            domain_name = xml_descr.elements['domain'].elements['name'].text
+            if domain_name.nil?
+              # Ensure domain name is set for subsequent steps if restarting a machine without a box
+              libvirt_domain = env[:machine].provider.driver.connection.client.lookup_domain_by_uuid(
+                env[:machine].id
+              )
+              domain_xml = libvirt_domain.xml_desc(1)
+              xml_descr = REXML::Document.new(domain_xml)
+              domain_name = xml_descr.elements['domain'].elements['name'].text
+            end
 
             storage_prefix = get_disk_storage_prefix(env[:machine], storage_pool_name)
           end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Action
+      class SnapshotDelete
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.deleting",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.delete_snapshot(env[:machine], env[:snapshot_name])
+
+          env[:ui].success(I18n.t(
+            "vagrant.actions.vm.snapshot.deleted",
+            name: env[:snapshot_name]))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Action
+      class SnapshotRestore
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.restoring",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.restore_snapshot(env[:machine], env[:snapshot_name])
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Action
+      class SnapshotSave
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.saving",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.create_snapshot(
+            env[:machine], env[:snapshot_name])
+
+          env[:ui].success(I18n.t(
+            "vagrant.actions.vm.snapshot.saved",
+            name: env[:snapshot_name]))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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
@@ -394,7 +394,6 @@ module VagrantPlugins
                 loader.parent.delete_element(loader)
               end
 
-              undefine_flags = 0
               nvram = REXML::XPath.first(xml_descr, '/domain/os/nvram')
               if config.nvram
                 if nvram.nil?
@@ -407,28 +406,57 @@ module VagrantPlugins
                     descr_changed = true
                     nvram.text = config.nvram
                   end
-                  undefine_flags |= ProviderLibvirt::Util::DomainFlags::VIR_DOMAIN_UNDEFINE_KEEP_NVRAM
                 end
               elsif !nvram.nil?
                 descr_changed = true
-                undefine_flags |= ProviderLibvirt::Util::DomainFlags::VIR_DOMAIN_UNDEFINE_NVRAM
                 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(undefine_flags)
-                  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
@@ -436,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

@@ -40,6 +40,12 @@ module VagrantPlugins
       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')
@@ -156,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'
@@ -392,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