vagrant-libvirt 0.0.45 → 0.4.0

data/lib/vagrant-libvirt/driver.rb

@@ -19,11 +19,11 @@ module VagrantPlugins
       end
 
       def connection
-        # If already connected to libvirt, just use it and don't connect
+        # If already connected to Libvirt, just use it and don't connect
         # again.
         return @@connection if @@connection
 
-        # Get config options for libvirt provider.
+        # Get config options for Libvirt provider.
         config = @machine.provider_config
         uri = config.uri
 
@@ -50,7 +50,7 @@ module VagrantPlugins
       end
 
       def system_connection
-        # If already connected to libvirt, just use it and don't connect
+        # If already connected to Libvirt, just use it and don't connect
         # again.
         return @@system_connection if @@system_connection
 
@@ -60,12 +60,12 @@ module VagrantPlugins
         @@system_connection
       end
 
-      def get_domain(mid)
+      def get_domain(machine)
         begin
-          domain = connection.servers.get(mid)
+          domain = connection.servers.get(machine.id)
         rescue Libvirt::RetrieveError => e
           if e.libvirt_code == ProviderLibvirt::Util::ErrorCodes::VIR_ERR_NO_DOMAIN
-            @logger.debug("machine #{mid} not found #{e}.")
+            @logger.debug("machine #{machine.name} domain not found #{e}.")
             return nil
           else
             raise e
@@ -75,34 +75,31 @@ module VagrantPlugins
         domain
       end
 
-      def created?(mid)
-        domain = get_domain(mid)
+      def created?(machine)
+        domain = get_domain(machine)
         !domain.nil?
       end
 
       def get_ipaddress(machine)
         # Find the machine
-        domain = get_domain(machine.id)
-        if @machine.provider_config.qemu_use_session
-          return get_ipaddress_system domain.mac
-        end
+        domain = get_domain(machine)
 
         if domain.nil?
           # The machine can't be found
           return nil
         end
 
+        get_domain_ipaddress(machine, domain)
+      end
+
+      def get_domain_ipaddress(machine, domain)
+        if @machine.provider_config.qemu_use_session
+          return get_ipaddress_from_system domain.mac
+        end
+
         # Get IP address from arp table
-        ip_address = nil
         begin
-          domain.wait_for(2) do
-            addresses.each_pair do |_type, ip|
-              # Multiple leases are separated with a newline, return only
-              # the most recent address
-              ip_address = ip[0].split("\n").first unless ip[0].nil?
-            end
-            !ip_address.nil?
-          end
+          ip_address = get_ipaddress_from_domain(domain)
         rescue Fog::Errors::TimeoutError
           @logger.info('Timeout at waiting for an ip address for machine %s' % machine.name)
         end
@@ -115,7 +112,24 @@ module VagrantPlugins
         ip_address
       end
 
-      def get_ipaddress_system(mac)
+      def state(machine)
+        # may be other error states with initial retreival we can't handle
+        begin
+          domain = get_domain(machine)
+        rescue Libvirt::RetrieveError => e
+          @logger.debug("Machine #{machine.id} not found #{e}.")
+          return :not_created
+        end
+
+        # TODO: terminated no longer appears to be a valid fog state, remove?
+        return :not_created if domain.nil? || domain.state.to_sym == :terminated
+
+        domain.state.tr('-', '_').to_sym
+      end
+
+      private
+
+      def get_ipaddress_from_system(mac)
         ip_address = nil
 
         system_connection.list_all_networks.each do |net|
@@ -125,23 +139,24 @@ module VagrantPlugins
           break if ip_address
         end
 
-        return ip_address
+        ip_address
       end
 
-      def state(machine)
-        # may be other error states with initial retreival we can't handle
-        begin
-          domain = get_domain(machine.id)
-        rescue Libvirt::RetrieveError => e
-          @logger.debug("Machine #{machine.id} not found #{e}.")
-          return :not_created
-        end
+      def get_ipaddress_from_domain(domain)
+        ip_address = nil
+        domain.wait_for(2) do
+          addresses.each_pair do |type, ip|
+            # Multiple leases are separated with a newline, return only
+            # the most recent address
+            ip_address = ip[0].split("\n").first if ip[0] != nil
+          end
 
-        # TODO: terminated no longer appears to be a valid fog state, remove?
-        return :not_created if domain.nil? || domain.state.to_sym == :terminated
+          ip_address != nil
+        end
 
-        domain.state.tr('-', '_').to_sym
+        ip_address
       end
+
     end
   end
 end

data/lib/vagrant-libvirt/errors.rb

@@ -29,14 +29,14 @@ module VagrantPlugins
         error_key(:creating_storage_pool_error)
       end
 
-      class CreatingVolumeError < VagrantLibvirtError
-        error_key(:creating_volume_error)
-      end
-
       class ImageUploadError < VagrantLibvirtError
         error_key(:image_upload_error)
       end
 
+      class ImageDownloadError < VagrantLibvirtError
+        error_key(:image_download_error)
+      end
+
       # Box exceptions
       class NoBoxVolume < VagrantLibvirtError
         error_key(:no_box_volume)
@@ -54,7 +54,7 @@ module VagrantPlugins
         error_key(:wrong_box_format)
       end
 
-      # Fog libvirt exceptions
+      # Fog Libvirt exceptions
       class FogError < VagrantLibvirtError
         error_key(:fog_error)
       end

data/lib/vagrant-libvirt/plugin.rb

@@ -4,7 +4,7 @@ rescue LoadError
   raise 'The Vagrant Libvirt plugin must be run within Vagrant.'
 end
 
-# compatibility fix to define constant not available vagrant <1.6
+# compatibility fix to define constant not available Vagrant <1.6
 ::Vagrant::MachineState::NOT_CREATED_ID ||= :not_created
 
 module VagrantPlugins
@@ -12,7 +12,7 @@ module VagrantPlugins
     class Plugin < Vagrant.plugin('2')
       name 'libvirt'
       description <<-DESC
-      Vagrant plugin to manage VMs in libvirt.
+      Vagrant plugin to manage VMs in Libvirt.
       DESC
 
       config('libvirt', :provider) do
@@ -39,6 +39,11 @@ module VagrantPlugins
         Cap::NicMacAddresses
       end
 
+      provider_capability(:libvirt, :public_address) do
+        require_relative 'cap/public_address'
+        Cap::PublicAddress
+      end
+
       # lower priority than nfs or rsync
       # https://github.com/vagrant-libvirt/vagrant-libvirt/pull/170
       synced_folder('9p', 4) do

data/lib/vagrant-libvirt/provider.rb

@@ -68,14 +68,7 @@ module VagrantPlugins
           forward_x11: @machine.config.ssh.forward_x11
         }
 
-        if @machine.provider_config.connect_via_ssh
-          ssh_info[:proxy_command] =
-            "ssh '#{@machine.provider_config.host}' " \
-            "-l '#{@machine.provider_config.username}' " \
-            "-i '#{@machine.provider_config.id_ssh_key_file}' " \
-            'nc %h %p'
-
-        end
+        ssh_info[:proxy_command] = @machine.provider_config.proxy_command if @machine.provider_config.proxy_command
 
         ssh_info
       end
@@ -98,7 +91,7 @@ module VagrantPlugins
         state_id = nil
         state_id = :not_created unless @machine.id
         state_id = :not_created if
-          !state_id && (!@machine.id || !driver.created?(@machine.id))
+          !state_id && (!@machine.id || !driver.created?(@machine))
         # Query the driver for the current state of the machine
         state_id = driver.state(@machine) if @machine.id && !state_id
         state_id = :unknown unless state_id

data/lib/vagrant-libvirt/templates/domain.xml.erb

@@ -1,8 +1,10 @@
 <domain type='<%= @domain_type %>' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
   <name><%= @name %></name>
+  <title><%= @title %></title>
+  <description><%= @description %></description>
   <uuid><%= @uuid %></uuid>
   <memory><%= @memory_size %></memory>
-  <vcpu><%= @cpus %></vcpu>
+  <vcpu<% if @cpuset %> cpuset='<%= @cpuset %>'<% end %>><%= @cpus %></vcpu>
 
 
   <cpu mode='<%= @cpu_mode %>'>
@@ -33,6 +35,11 @@
     <% end %>
   </cpu>
 
+<%- if @nodeset -%>
+  <numatune>
+    <memory nodeset='<%= @nodeset %>'/>
+  </numatune>
+<%- end -%>
 <% unless @memory_backing.empty? %>
   <memoryBacking>
   <% @memory_backing.each do |backing| %>
@@ -40,6 +47,11 @@
   <% end %>
   </memoryBacking>
 <% end%>
+<% if @shares %>
+  <cputune>
+    <shares><%= @shares %></shares>
+  </cputune>
+<% end %>
 
   <os>
     <% if @machine_type %>
@@ -92,14 +104,22 @@
     </hyperv>
     <% end %>
   </features>
-  <clock offset='utc'/>
+  <clock offset='<%= @clock_offset %>'>
+  <% @clock_timers.each do |clock_timer| %>
+    <timer<% clock_timer.each do |attr, value| %> <%= attr %>='<%= value %>'<% end %>/>
+  <% end %>
+  </clock>
   <devices>
     <% if @emulator_path %>
     <emulator><%= @emulator_path %></emulator>
     <% end %>
     <% if @domain_volume_path %>
     <disk type='file' device='disk'>
-      <driver name='qemu' type='qcow2' cache='<%= @domain_volume_cache %>'/>
+      <driver name='qemu' type='qcow2' <%=
+        @disk_driver_opts.empty? ? "cache='#{@domain_volume_cache}'" :
+            @disk_driver_opts.reject { |k,v| v.nil? }
+                             .map { |k,v| "#{k}='#{v}'"}
+                             .join(' ') -%>/>
       <source file='<%= @domain_volume_path %>'/>
       <%# we need to ensure a unique target dev -%>
       <target dev='<%= @disk_device %>' bus='<%= @disk_bus %>'/>
@@ -108,7 +128,12 @@
 <%# additional disks -%>
 <% @disks.each do |d| -%>
     <disk type='file' device='disk'>
-      <driver name='qemu' type='<%= d[:type] %>' cache='<%= d[:cache] %>'/>
+      <driver name='qemu' type='<%= d[:type] %>' <%=
+        d.select { |k,_| [:cache, :io, :copy_on_read, :discard, :detect_zeroes].include? k }
+         .reject { |k,v| v.nil? }
+         .map { |k,v| "#{k}='#{v}'"}
+         .join(' ')
+      -%>/>
       <source file='<%= d[:absolute_path] %>'/>
       <target dev='<%= d[:device] %>' bus='<%= d[:bus] %>'/>
       <% if d[:shareable] %>
@@ -117,7 +142,10 @@
       <% if d[:serial] %>
         <serial><%= d[:serial] %></serial>
       <% end %>
-<%# this will get auto generated by libvirt
+      <% if d[:wwn] %>
+        <wwn><%= d[:wwn] %></wwn>
+      <% end %>
+<%# this will get auto generated by Libvirt
       <address type='pci' domain='0x0000' bus='0x00' slot='???' function='0x0'/>
 -%>
     </disk>
@@ -190,7 +218,7 @@
     <% @pcis.each do |pci| %>
       <hostdev mode='subsystem' type='pci' managed='yes'>
         <source>
-          <address domain='0x0000'
+          <address domain='<%= pci[:domain] %>'
             bus='<%= pci[:bus] %>'
             slot='<%= pci[:slot] %>'
             function='<%= pci[:function] %>'/>
@@ -242,11 +270,13 @@
       <% end %>
     <% end -%>
 
-    <% if @tpm_path -%>
+    <% if @tpm_path || @tpm_version -%>
     <%# TPM Device -%>
     <tpm model='<%= @tpm_model %>'>
-      <backend type='<%= @tpm_type %>'>
+      <backend type='<%= @tpm_type %>'<% if @tpm_version %> version='<%= @tpm_version %>'<% end %>>
+        <% if @tpm_path -%>
         <device path='<%= @tpm_path %>'/>
+        <% end -%>
       </backend>
     </tpm>
     <% end -%>
@@ -254,13 +284,25 @@
     <%# USB Controller -%>
     <controller type='usb' model='<%= @usbctl_dev[:model] %>' <%= "ports=\"#{@usbctl_dev[:ports]}\" " if @usbctl_dev[:ports] %>/>
     <% end %>
+    <% unless @memballoon_enabled.nil? %>
+    <% if @memballoon_enabled %>
+    <memballoon model='<%= @memballoon_model %>'>
+      <address type='pci' domain='0x0000' bus='<%= @memballoon_pci_bus %>' slot='<%= @memballoon_pci_slot %>' function='0x0'/>
+    </memballoon>
+    <% else %>
+    <memballoon model='none'/>
+    <% end %>
+    <% end %>
   </devices>
 
-  <% unless @qargs.empty? %>
+  <% if not @qemu_args.empty? or not @qemu_env.empty? %>
   <qemu:commandline>
-    <% @qargs.each do |arg| %>
+    <% @qemu_args.each do |arg| %>
     <qemu:arg value='<%= arg[:value] %>'/>
     <% end %>
+    <% @qemu_env.each do |env_var, env_value| %>
+    <qemu:env name='<%= env_var.to_s %>' value='<%= env_value %>'/>
+    <% end %>
   </qemu:commandline>
   <% end %>
 </domain>

data/lib/vagrant-libvirt/templates/public_interface.xml.erb

@@ -18,7 +18,11 @@
     <driver name='<%=@driver_name%>'/>
   <% end %>
   <% if @ovs %>
-  <virtualport type='openvswitch'/>
+  <virtualport type='openvswitch'>
+    <% if @ovs_interfaceid %>
+      <parameters interfaceid='<%=@ovs_interfaceid%>'/>
+    <% end %>
+  </virtualport>
   <% end %>
   <% if @pci_bus and @pci_slot %>
   <address type='pci' bus='<%=@pci_bus%>' slot='<%=@pci_slot%>' />

data/lib/vagrant-libvirt/util.rb

@@ -7,6 +7,7 @@ module VagrantPlugins
       autoload :NetworkUtil, 'vagrant-libvirt/util/network_util'
       autoload :StorageUtil, 'vagrant-libvirt/util/storage_util'
       autoload :ErrorCodes, 'vagrant-libvirt/util/error_codes'
+      autoload :Ui, 'vagrant-libvirt/util/ui'
     end
   end
 end

data/lib/vagrant-libvirt/util/erb_template.rb

@@ -1,20 +1,19 @@
-require 'erubis'
-
 module VagrantPlugins
   module ProviderLibvirt
     module Util
       module ErbTemplate
         # TODO: remove and use nokogiri builder
-        # TODO: might be a chance to use vagrant template system according to https://github.com/mitchellh/vagrant/issues/3231
         def to_xml(template_name = nil, data = binding)
           erb = template_name || self.class.to_s.split('::').last.downcase
-          path = File.join(File.dirname(__FILE__), '..', 'templates',
-                           "#{erb}.xml.erb")
-          template = File.read(path)
+          path = File.join(File.dirname(__FILE__), '..', 'templates')
+          template = "#{erb}.xml"
 
           # TODO: according to erubis documentation, we should rather use evaluate and forget about
           # binding since the template may then change variables values
-          Erubis::Eruby.new(template, trim: true).result(data)
+          Vagrant::Util::TemplateRenderer.render_with(:render, template, template_root: path) do |renderer|
+            iv = data.eval ("instance_variables.collect {|i| [i, instance_variable_get(i.to_sym)]}")
+            iv.each {|k, v| renderer.instance_variable_set(k, v)}
+          end
         end
       end
     end

data/lib/vagrant-libvirt/util/network_util.rb

@@ -18,6 +18,7 @@ module VagrantPlugins
           management_network_autostart = env[:machine].provider_config.management_network_autostart
           management_network_pci_bus = env[:machine].provider_config.management_network_pci_bus
           management_network_pci_slot = env[:machine].provider_config.management_network_pci_slot
+          management_network_domain = env[:machine].provider_config.management_network_domain
           logger.info "Using #{management_network_name} at #{management_network_address} as the management network #{management_network_mode} is the mode"
 
           begin
@@ -65,6 +66,10 @@ module VagrantPlugins
             management_network_options[:mac] = management_network_mac
           end
 
+          unless management_network_domain.nil?
+            management_network_options[:domain_name] = management_network_domain
+          end
+
           unless management_network_pci_bus.nil? and management_network_pci_slot.nil?
             management_network_options[:bus] = management_network_pci_bus
             management_network_options[:slot] = management_network_pci_slot
@@ -109,7 +114,7 @@ module VagrantPlugins
           networks
         end
 
-        # Return a list of all (active and inactive) libvirt networks as a list
+        # Return a list of all (active and inactive) Libvirt networks as a list
         # of hashes with their name, network address and status (active or not)
         def libvirt_networks(libvirt_client)
           libvirt_networks = []

data/lib/vagrant-libvirt/util/nfs.rb

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      module Nfs
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+
+        # We're using NFS if we have any synced folder with NFS configured. If
+        # we are not using NFS we don't need to do the extra work to
+        # populate these fields in the environment.
+        def using_nfs?
+          !!synced_folders(@machine)[:nfs]
+        end
+      end
+    end
+  end
+end
+