vagrant-libvirt 0.0.42 → 0.2.1

data/lib/vagrant-libvirt/driver.rb

@@ -1,4 +1,5 @@
 require 'fog/libvirt'
+require 'libvirt'
 require 'log4r'
 
 module VagrantPlugins
@@ -10,6 +11,7 @@ module VagrantPlugins
       # settings as a key to allow per machine connection attributes
       # to be used.
       @@connection = nil
+      @@system_connection = nil
 
       def initialize(machine)
         @logger = Log4r::Logger.new('vagrant_libvirt::driver')
@@ -17,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
 
@@ -47,6 +49,17 @@ module VagrantPlugins
         @@connection
       end
 
+      def system_connection
+        # If already connected to Libvirt, just use it and don't connect
+        # again.
+        return @@system_connection if @@system_connection
+
+        config = @machine.provider_config
+
+        @@system_connection = Libvirt::open_read_only(config.system_uri)
+        @@system_connection
+      end
+
       def get_domain(mid)
         begin
           domain = connection.servers.get(mid)
@@ -70,6 +83,9 @@ module VagrantPlugins
       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
 
         if domain.nil?
           # The machine can't be found
@@ -99,6 +115,19 @@ module VagrantPlugins
         ip_address
       end
 
+      def get_ipaddress_system(mac)
+        ip_address = nil
+
+        system_connection.list_all_networks.each do |net|
+          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?
+          break if ip_address
+        end
+
+        return ip_address
+      end
+
       def state(machine)
         # may be other error states with initial retreival we can't handle
         begin

data/lib/vagrant-libvirt/errors.rb

@@ -33,6 +33,10 @@ module VagrantPlugins
         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)
@@ -50,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/templates/default_storage_pool.xml.erb

@@ -3,11 +3,11 @@
   <source>
   </source>
   <target>
-    <path>/var/lib/libvirt/images</path>
+    <path><%= @storage_pool_path %></path>
     <permissions>
       <mode>0755</mode>
-      <owner>-1</owner>
-      <group>-1</group>
+      <owner><%= @storage_pool_uid %></owner>
+      <group><%= @storage_pool_gid %></group>
     </permissions>
   </target>
 </pool>

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

@@ -1,16 +1,22 @@
 <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 %>'>
     <% if @cpu_mode != 'host-passthrough' %>
       <model fallback='<%= @cpu_fallback %>'><% if @cpu_mode == 'custom' %><%= @cpu_model %><% end %></model>
       <% if @nested %>
-        <feature policy='optional' name='vmx'/>
-        <feature policy='optional' name='svm'/>
+        <% if @cpu_features.select{|x| x[:name] == 'vmx'}.empty? %>
+          <feature policy='optional' name='vmx'/>
+        <% end %>
+        <% if @cpu_features.select{|x| x[:name] == 'svm'}.empty? %>
+          <feature policy='optional' name='svm'/>
+        <% end %>
       <% end %>
       <% @cpu_features.each do |cpu_feature| %>
         <feature name='<%= cpu_feature[:name] %>' policy='<%= cpu_feature[:policy] %>'/>
@@ -29,6 +35,11 @@
     <% end %>
   </cpu>
 
+<%- if @nodeset -%>
+  <numatune>
+    <memory nodeset='<%= @nodeset %>'/>
+  </numatune>
+<%- end -%>
 <% unless @memory_backing.empty? %>
   <memoryBacking>
   <% @memory_backing.each do |backing| %>
@@ -36,6 +47,11 @@
   <% end %>
   </memoryBacking>
 <% end%>
+<% if @shares %>
+  <cputune>
+    <shares><%= @shares %></shares>
+  </cputune>
+<% end %>
 
   <os>
     <% if @machine_type %>
@@ -52,7 +68,14 @@
       <% end %>
     <% end %>
     <% if @loader %>
-      <loader readonly='yes' type='rom'><%= @loader %></loader>
+      <% if @nvram %>
+        <loader readonly='yes' type='pflash'><%= @loader %></loader>
+      <% else %>
+        <loader readonly='yes' type='rom'><%= @loader %></loader>
+      <% end %>
+    <% end %>
+    <% if @nvram %>
+      <nvram><%= @nvram %></nvram>
     <% end %>
     <% if @boot_order.count >= 1 %>
       <bootmenu enable='yes'/>
@@ -73,6 +96,13 @@
         <hidden state='on'/>
       </kvm>
     <% end %>
+    <% if !@features_hyperv.empty? %>
+    <hyperv>
+      <% @features_hyperv.each do |feature| %>
+      <<%= feature[:name] %> state='<%= feature[:state] %>' />
+      <% end %>
+    </hyperv>
+    <% end %>
   </features>
   <clock offset='utc'/>
   <devices>
@@ -99,7 +129,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>
@@ -172,7 +205,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] %>'/>
@@ -232,13 +265,20 @@
       </backend>
     </tpm>
     <% end -%>
+    <% if not @usbctl_dev.empty? %>
+    <%# USB Controller -%>
+    <controller type='usb' model='<%= @usbctl_dev[:model] %>' <%= "ports=\"#{@usbctl_dev[:ports]}\" " if @usbctl_dev[:ports] %>/>
+    <% 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/util.rb

@@ -5,6 +5,7 @@ module VagrantPlugins
       autoload :Collection,  'vagrant-libvirt/util/collection'
       autoload :Timer, 'vagrant-libvirt/util/timer'
       autoload :NetworkUtil, 'vagrant-libvirt/util/network_util'
+      autoload :StorageUtil, 'vagrant-libvirt/util/storage_util'
       autoload :ErrorCodes, 'vagrant-libvirt/util/error_codes'
     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

@@ -8,6 +8,8 @@ module VagrantPlugins
         include Vagrant::Util::NetworkIP
 
         def configured_networks(env, logger)
+          qemu_use_session = env[:machine].provider_config.qemu_use_session
+          management_network_device = env[:machine].provider_config.management_network_device
           management_network_name = env[:machine].provider_config.management_network_name
           management_network_address = env[:machine].provider_config.management_network_address
           management_network_mode = env[:machine].provider_config.management_network_mode
@@ -16,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
@@ -33,23 +36,40 @@ module VagrantPlugins
                   error_message: "#{management_network_address} does not include both an address and subnet mask"
           end
 
-          management_network_options = {
-            iface_type: :private_network,
-            network_name: management_network_name,
-            ip: Regexp.last_match(1),
-            netmask: Regexp.last_match(2),
-            dhcp_enabled: true,
-            forward_mode: management_network_mode,
-            guest_ipv6: management_network_guest_ipv6,
-            autostart: management_network_autostart,
-            bus: management_network_pci_bus,
-            slot: management_network_pci_slot
-          }
+          if qemu_use_session
+            management_network_options = {
+              iface_type: :public_network,
+              dev: management_network_device,
+              mode: 'bridge',
+              type: 'bridge',
+              bus: management_network_pci_bus,
+              slot: management_network_pci_slot
+            }
+          else
+            management_network_options = {
+              iface_type: :private_network,
+              network_name: management_network_name,
+              ip: Regexp.last_match(1),
+              netmask: Regexp.last_match(2),
+              dhcp_enabled: true,
+              forward_mode: management_network_mode,
+              guest_ipv6: management_network_guest_ipv6,
+              autostart: management_network_autostart,
+              bus: management_network_pci_bus,
+              slot: management_network_pci_slot
+            }
+          end
+
+
 
           unless management_network_mac.nil?
             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
@@ -94,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
+

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

@@ -0,0 +1,27 @@
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      module StorageUtil
+        def storage_uid(env)
+          env[:machine].provider_config.qemu_use_session ? Process.uid : 0
+        end
+
+        def storage_gid(env)
+          env[:machine].provider_config.qemu_use_session ? Process.gid : 0
+        end
+
+        def storage_pool_path(env)
+          if env[:machine].provider_config.storage_pool_path
+            env[:machine].provider_config.storage_pool_path
+          elsif env[:machine].provider_config.qemu_use_session
+            File.expand_path('~/.local/share/libvirt/images')
+          else
+            '/var/lib/libvirt/images'
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProviderLibvirt
-    VERSION = '0.0.42'.freeze
+    VERSION = '0.2.1'.freeze
   end
 end

data/locales/en.yml

@@ -16,7 +16,7 @@ en:
       Created volume larger than box defaults, will require manual resizing of
       filesystems to utilize.
     uploading_volume: |-
-      Uploading base box image as volume into libvirt storage...
+      Uploading base box image as volume into Libvirt storage...
     creating_domain_volume: |-
       Creating image (snapshot of base box volume).
     removing_domain_volume: |-
@@ -35,6 +35,8 @@ en:
       Resuming domain...
     suspending_domain: |-
       Suspending domain...
+    package_domain: |-
+      Packaging domain...
     waiting_for_ready: |-
       Waiting for domain to become "ready"...
     waiting_for_ip: |-
@@ -58,7 +60,7 @@ en:
         Forwarding UDP ports is not supported. Ignoring.
 
     errors:
-      package_not_supported: No support for package with libvirt. Create box manually.
+      package_not_supported: No support for package with Libvirt. Create box manually.
       fog_error: |-
         There was an error talking to Libvirt. The error message is shown
         below:
@@ -95,7 +97,7 @@ en:
       wrong_box_format: |-
         Wrong image format specified for box.
       fog_libvirt_connection_error: |-
-        Error while connecting to libvirt: %{error_message}
+        Error while connecting to Libvirt: %{error_message}
       fog_create_volume_error: |-
         Error while creating a storage pool volume: %{error_message}
       fog_create_domain_volume_error: |-
@@ -106,9 +108,11 @@ en:
         Name `%{domain_name}` of domain about to create is already taken. Please try to run
         `vagrant up` command again.
       creating_storage_pool_error: |-
-        There was error while creating libvirt storage pool: %{error_message}
+        There was error while creating Libvirt storage pool: %{error_message}
       image_upload_error: |-
         Error while uploading image to storage pool: %{error_message}
+      image_download_error: |-
+        Error while downloading volume '%{volume_name}' from storage pool '%{pool_name}': %{error_message}
       no_domain_error: |-
         No domain found. %{error_message}
       attach_device_error: |-