vagrant-libvirt 0.5.3 → 0.6.0

data/lib/vagrant-libvirt/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 require 'vagrant'
@@ -5,10 +7,10 @@ require 'vagrant'
 class Numeric
   Alphabet = ('a'..'z').to_a
   def vdev
-    s = ''
+    s = String.new
     q = self
     (q, r = (q - 1).divmod(26)) && s.prepend(Alphabet[r]) until q.zero?
-    'vd' + s
+    "vd#{s}"
   end
 end
 
@@ -191,6 +193,9 @@ module VagrantPlugins
       # Use QEMU session instead of system
       attr_accessor :qemu_use_session
 
+      # Use QEMU Agent to get ip address
+      attr_accessor :qemu_use_agent
+
       def initialize
         @uri               = UNSET_VALUE
         @driver            = UNSET_VALUE
@@ -330,6 +335,9 @@ module VagrantPlugins
         @qemu_env          = UNSET_VALUE
 
         @qemu_use_session  = UNSET_VALUE
+
+        # Use Qemu agent to get ip address
+        @qemu_use_agent  = UNSET_VALUE
       end
 
       def boot(device)
@@ -352,7 +360,7 @@ module VagrantPlugins
         # hda - hdc
         curr = 'a'.ord
         while curr <= 'd'.ord
-          dev = 'hd' + curr.chr
+          dev = "hd#{curr.chr}"
           if exist[dev]
             curr += 1
             next
@@ -555,7 +563,7 @@ module VagrantPlugins
         end
 
         @usbctl_dev[:model] = options[:model]
-        @usbctl_dev[:ports] = options[:ports]
+        @usbctl_dev[:ports] = options[:ports] if options[:ports]
       end
 
       def usb(options = {})
@@ -745,24 +753,24 @@ module VagrantPlugins
         if @connect_via_ssh == true
           finalize_id_ssh_key_file
 
-          uri << '+ssh://'
-          uri << @username + '@' if @username && @username != UNSET_VALUE
+          uri += '+ssh://'
+          uri += "#{@username}@" if @username && @username != UNSET_VALUE
 
-          uri << ( @host && @host != UNSET_VALUE ? @host : 'localhost' )
+          uri += (@host && @host != UNSET_VALUE ? @host : 'localhost')
 
           params['no_verify'] = '1'
           params['keyfile'] = @id_ssh_key_file if @id_ssh_key_file
         else
-          uri << '://'
-          uri << @host if @host && @host != UNSET_VALUE
+          uri += '://'
+          uri += @host if @host && @host != UNSET_VALUE
         end
 
-        uri << virt_path
+        uri += virt_path
 
         # set path to Libvirt socket
         params['socket'] = @socket if @socket
 
-        uri << "?" + params.map{|pair| pair.join('=')}.join('&') if !params.empty?
+        uri += '?' + params.map { |pair| pair.join('=') }.join('&') unless params.empty?
         uri
       end
 
@@ -907,9 +915,6 @@ module VagrantPlugins
         # Watchdog device
         @watchdog_dev = {} if @watchdog_dev == UNSET_VALUE
 
-        # USB controller
-        @usbctl_dev = {} if @usbctl_dev == UNSET_VALUE
-
         # USB device passthrough
         @usbs = [] if @usbs == UNSET_VALUE
 
@@ -917,6 +922,11 @@ module VagrantPlugins
         @redirdevs = [] if @redirdevs == UNSET_VALUE
         @redirfilters = [] if @redirfilters == UNSET_VALUE
 
+        # USB controller
+        if @usbctl_dev == UNSET_VALUE
+          @usbctl_dev = if !@usbs.empty? or !@redirdevs.empty? then {:model => 'qemu-xhci'} else {} end
+        end
+
         # smartcard device
         @smartcard_dev = {} if @smartcard_dev == UNSET_VALUE
 
@@ -934,6 +944,8 @@ module VagrantPlugins
 
         # Additional QEMU commandline environment variables
         @qemu_env = {} if @qemu_env == UNSET_VALUE
+
+        @qemu_use_agent = true if @qemu_use_agent != UNSET_VALUE
       end
 
       def validate(machine)
@@ -947,6 +959,17 @@ module VagrantPlugins
           end
         end
 
+
+        if @qemu_use_agent == true
+          # if qemu agent is used to optain 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") }
+            errors << "qemu agent option enabled, but no qemu agent channel configured: please add at least one qemu agent channel to vagrant config"
+          end
+        end
+
+
         machine.provider_config.disks.each do |disk|
           if disk[:path] && (disk[:path][0] == '/')
             errors << "absolute volume paths like '#{disk[:path]}' not yet supported"
@@ -955,11 +978,10 @@ module VagrantPlugins
 
         machine.config.vm.networks.each do |_type, opts|
           if opts[:mac]
-            opts[:mac].downcase!
-            if opts[:mac] =~ /\A([0-9a-f]{12})\z/
+            if opts[:mac] =~ /\A([0-9a-fA-F]{12})\z/
               opts[:mac] = opts[:mac].scan(/../).join(':')
             end
-            unless opts[:mac] =~ /\A([0-9a-f]{2}:){5}([0-9a-f]{2})\z/
+            unless opts[:mac] =~ /\A([0-9a-fA-F]{2}:){5}([0-9a-fA-F]{2})\z/
               errors << "Configured NIC MAC '#{opts[:mac]}' is not in 'xx:xx:xx:xx:xx:xx' or 'xxxxxxxxxxxx' format"
             end
           end
@@ -1017,10 +1039,12 @@ module VagrantPlugins
           end
         end
 
-        # Extract host and username values from uri if provided, otherwise nil
+        # Extract host values from uri if provided, otherwise nil
         @host = uri.host
         @port = uri.port
-        @username = uri.user
+        # only override username if there is a value provided
+        @username = nil if @username == UNSET_VALUE
+        @username = uri.user if uri.user
         if uri.query
           params = CGI.parse(uri.query)
           @id_ssh_key_file = params['keyfile'].first if params.has_key?('keyfile')
@@ -1032,7 +1056,7 @@ module VagrantPlugins
       def resolve_ssh_key_file(key_file)
         # set ssh key for access to Libvirt host
         # if no slash, prepend $HOME/.ssh/
-        key_file.prepend("#{ENV['HOME']}/.ssh/") if key_file && key_file !~ /\A\//
+        key_file = "#{ENV['HOME']}/.ssh/#{key_file}" if key_file && key_file !~ /\A\//
 
         key_file
       end
@@ -1061,17 +1085,17 @@ module VagrantPlugins
         if @connect_via_ssh
           if @proxy_command == UNSET_VALUE
             proxy_command = "ssh '#{@host}' "
-            proxy_command << "-p #{@port} " if @port
-            proxy_command << "-l '#{@username}' " if @username
-            proxy_command << "-i '#{@id_ssh_key_file}' " if @id_ssh_key_file
-            proxy_command << '-W %h:%p'
+            proxy_command += "-p #{@port} " if @port
+            proxy_command += "-l '#{@username}' " if @username
+            proxy_command += "-i '#{@id_ssh_key_file}' " if @id_ssh_key_file
+            proxy_command += '-W %h:%p'
           else
             inputs = { host: @host }
             inputs << { port: @port } if @port
             inputs[:username] = @username if @username
             inputs[:id_ssh_key_file] = @id_ssh_key_file if @id_ssh_key_file
 
-            proxy_command = @proxy_command
+            proxy_command = String.new(@proxy_command)
             # avoid needing to escape '%' symbols
             inputs.each do |key, value|
               proxy_command.gsub!("{#{key}}", value)

data/lib/vagrant-libvirt/driver.rb

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
+
 require 'fog/libvirt'
 require 'libvirt'
 require 'log4r'
+require 'json'
 
 module VagrantPlugins
   module ProviderLibvirt
     class Driver
-      # store the connection at the process level
+      # store the connection at the instance level as this will be per
+      # thread and allows for individual machines to use different
+      # connection settings.
       #
       # possibly this should be a connection pool using the connection
-      # settings as a key to allow per machine connection attributes
-      # to be used.
-      @@connection = nil
-      @@system_connection = nil
+      # settings as a key to allow identical connections to be reused
+      # across machines.
+      @connection = nil
+      @system_connection = nil
 
       def initialize(machine)
         @logger = Log4r::Logger.new('vagrant_libvirt::driver')
@@ -21,7 +26,7 @@ module VagrantPlugins
       def connection
         # If already connected to Libvirt, just use it and don't connect
         # again.
-        return @@connection if @@connection
+        return @connection if @connection
 
         # Get config options for Libvirt provider.
         config = @machine.provider_config
@@ -40,24 +45,24 @@ module VagrantPlugins
 
         @logger.info("Connecting to Libvirt (#{uri}) ...")
         begin
-          @@connection = Fog::Compute.new(conn_attr)
+          @connection = Fog::Compute.new(conn_attr)
         rescue Fog::Errors::Error => e
           raise Errors::FogLibvirtConnectionError,
                 error_message: e.message
         end
 
-        @@connection
+        @connection
       end
 
       def system_connection
         # If already connected to Libvirt, just use it and don't connect
         # again.
-        return @@system_connection if @@system_connection
+        return @system_connection if @system_connection
 
         config = @machine.provider_config
 
-        @@system_connection = Libvirt::open_read_only(config.system_uri)
-        @@system_connection
+        @system_connection = Libvirt::open(config.system_uri)
+        @system_connection
       end
 
       def get_domain(machine)
@@ -97,6 +102,12 @@ module VagrantPlugins
           return get_ipaddress_from_system domain.mac
         end
 
+        # attempt to get ip address from qemu agent
+        if @machine.provider_config.qemu_use_agent == true
+          @logger.info('Get IP via qemu agent')
+          return get_ipaddress_from_qemu_agent(domain, machine.id)
+        end
+
         # Get IP address from dhcp leases table
         begin
           ip_address = get_ipaddress_from_domain(domain)
@@ -126,7 +137,17 @@ module VagrantPlugins
         # 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
+        state = domain.state.tr('-', '_').to_sym
+        if state == :running
+          begin
+            get_domain_ipaddress(machine, domain)
+          rescue Fog::Errors::TimeoutError => e
+            @logger.debug("Machine #{machine.id} running but no IP address available: #{e}.")
+            return :inaccessible
+          end
+        end
+
+        return state
       end
 
       private
@@ -144,6 +165,40 @@ module VagrantPlugins
         ip_address
       end
 
+      def get_ipaddress_from_qemu_agent(domain, machine_id)
+        ip_address = nil
+        addresses = nil
+        dom = system_connection.lookup_domain_by_uuid(machine_id)
+        begin
+          response = dom.qemu_agent_command('{"execute":"guest-network-get-interfaces"}', timeout=10)
+          @logger.debug("Got Response from qemu agent")
+          @logger.debug(response)
+          addresses = JSON.parse(response)
+        rescue => e
+          @logger.debug("Unable to receive IP via qemu agent: [%s]" % e.message)
+        end
+
+        unless addresses.nil?
+          addresses["return"].each{ |interface|
+            if domain.mac == interface["hardware-address"]
+              @logger.debug("Found mathing interface: [%s]" % interface["name"])
+              if interface.has_key?("ip-addresses")
+                interface["ip-addresses"].each{ |ip|
+                  # returning ipv6 addresses might break windows guests because
+                  # winrm cant handle connection, winrm fails with "invalid uri"
+                  if ip["ip-address-type"] == "ipv4"
+                    ip_address = ip["ip-address"]
+                    @logger.debug("Return IP: [%s]" % ip_address)
+                    break
+                  end
+                  }
+              end
+            end
+          }
+        end
+        ip_address
+      end
+
       def get_ipaddress_from_domain(domain)
         ip_address = nil
         domain.wait_for(2) do

data/lib/vagrant-libvirt/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vagrant'
 
 module VagrantPlugins

data/lib/vagrant-libvirt/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'vagrant'
 rescue LoadError

data/lib/vagrant-libvirt/provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vagrant'
 
 module VagrantPlugins

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

@@ -113,8 +113,9 @@
     <% if @emulator_path %>
     <emulator><%= @emulator_path %></emulator>
     <% end %>
-<% @domain_volumes.each do |volume| -%>
+<% @domain_volumes.each_with_index do |volume, index| -%>
     <disk type='file' device='disk'>
+      <alias name='ua-box-volume-<%= index -%>'/>
       <driver name='qemu' type='qcow2' <%=
         @disk_driver_opts.empty? ? "cache='#{volume[:cache]}'" :
             @disk_driver_opts.reject { |k,v| v.nil? }
@@ -126,8 +127,9 @@
     </disk>
 <% end -%>
 <%# additional disks -%>
-<% @disks.each do |d| -%>
+<% @disks.each_with_index do |d, index| -%>
     <disk type='file' device='disk'>
+      <alias name='ua-disk-volume-<%= index -%>'/>
       <driver name='qemu' type='<%= d[:type] %>' <%=
         d.select { |k,_| [:cache, :io, :copy_on_read, :discard, :detect_zeroes].include? k }
          .reject { |k,v| v.nil? }

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

@@ -1,4 +1,5 @@
 <interface type='<%= @type %>'<% if @trust_guest_rx_filters %> trustGuestRxFilters='yes'<% end %>>
+  <alias name='ua-net-<%= @iface_number %>'/>
   <% if @mac %>
   <mac address='<%= @mac %>'/>
   <% end %>

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ripped from http://libvirt.org/html/libvirt-virterror.html#virErrorNumber.
 module VagrantPlugins
   module ProviderLibvirt

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddr'
 require 'nokogiri'
 require 'vagrant/util/network_ip'
@@ -18,6 +20,7 @@ module VagrantPlugins
 
         def configured_networks(env, logger)
           qemu_use_session = env[:machine].provider_config.qemu_use_session
+          qemu_use_agent = env[:machine].provider_config.qemu_use_agent
           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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module VagrantPlugins
   module ProviderLibvirt

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module VagrantPlugins
   module ProviderLibvirt

data/lib/vagrant-libvirt/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.5.3
+0.6.0

data/lib/vagrant-libvirt/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 require 'tmpdir'
 

data/lib/vagrant-libvirt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module VagrantPlugins

data/locales/en.yml

@@ -29,6 +29,8 @@ en:
       Poweroff domain.
     destroy_domain: |-
       Removing domain...
+    shutdown_domain: |-
+      Attempting direct shutdown of domain...
     halt_domain: |-
       Halting domain...
     resuming_domain: |-

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'simplecov-lcov'
 

data/spec/support/binding_proc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # A simple extension of the Proc class that supports setting a custom binding
 # and evaluates everything in the Proc using the new binding.

data/spec/support/environment_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 require 'pathname'
 

data/spec/support/libvirt_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fog/libvirt'
 
 shared_context 'libvirt' do

data/spec/support/matchers/have_file_content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/expectations/version"
 #
 # Taken from https://github.com/cucumber/aruba/blob/main/lib/aruba/matchers/file/have_file_content.rb

data/spec/support/sharedcontext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_context 'unit' do
@@ -7,6 +9,7 @@ shared_context 'unit' do
   let(:vagrantfile) do
     <<-EOF
     Vagrant.configure('2') do |config|
+      config.vm.box = "vagrant-libvirt/test"
       config.vm.define :test
       config.vm.provider :libvirt do |libvirt|
         #{vagrantfile_providerconfig}

data/spec/support/temporary_dir.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+shared_context 'temporary_dir' do
+  around do |example|
+    Dir.mktmpdir("rspec-") do |dir|
+      @temp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :temp_dir
+end

data/spec/unit/action/clean_machine_folder_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 

data/spec/unit/action/create_domain_spec/additional_disks_domain.xml

@@ -27,6 +27,13 @@
   </clock>
   <devices>
     <disk type='file' device='disk'>
+      <alias name='ua-box-volume-0'/>
+      <driver name='qemu' type='qcow2' cache='default'/>
+      <source file='/var/lib/libvirt/images/vagrant-test_default.img'/>
+      <target dev='vda' bus='virtio'/>
+    </disk>
+    <disk type='file' device='disk'>
+      <alias name='ua-disk-volume-0'/>
       <driver name='qemu' type='qcow2' cache='default'/>
       <source file='/var/lib/libvirt/images/vagrant-test_default-vdb.qcow2'/>
       <target dev='vdb' bus='virtio'/>

data/spec/unit/action/create_domain_spec/default_domain.xml

@@ -26,6 +26,12 @@
   <clock offset='utc'>
   </clock>
   <devices>
+    <disk type='file' device='disk'>
+      <alias name='ua-box-volume-0'/>
+      <driver name='qemu' type='qcow2' cache='default'/>
+      <source file='/var/lib/libvirt/images/vagrant-test_default.img'/>
+      <target dev='vda' bus='virtio'/>
+    </disk>
 
 
     <serial type='pty'>