vagrant-libvirt 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cdcf747d5d28e485d660d025beefdd8c3f58c107816ce719bcb0ba14559913a
-  data.tar.gz: 71026dbb9ada779894dd0d5136f91e0da2c986ee279c320919817aaea511bdce
+  metadata.gz: 696535927498f1996c3fd02f6e5503bd8ac47e92eb226d03cd28c46329232b93
+  data.tar.gz: 73cfeb05a09dad74122a6f09f562b5d56ac7c43a7ec029f2e8f5c8dcfa2a9413
 SHA512:
-  metadata.gz: 7dc8d355a72f309322630617dbb3be94536969637bc3f6d7c9fa907aebbbd1b96bcc49aad3501dd5dd3a1220d17d5d12a14f7cd87d57e43c2790238e5099622d
-  data.tar.gz: ded86b4e49bfb44e3d257936373b804d918a1eb34b956e2a02c9d99e60a7f5140cdc5241740720461a505897b74690589e0ba8c9a4656ce430be9164b86541c3
+  metadata.gz: b4237cc046b138f9fbd5efad00bcc80d97b964d6a374e68b94c20cc19fd668e6eda2ea2939d8782ca05b9ea80478907a9728c3b34692b1b2adbb6305f1798cf4
+  data.tar.gz: 5a3e8094b553fd2557be01514f782139bfa52edca8c7dc811138932a84c7f3bffe44e7c0a5a5b322868e648016146efc9b67f5e3a7356e98b2d58b0e6ca2db74

data/README.md

@@ -1,8 +1,9 @@
 # Vagrant Libvirt Provider
 
 [![Join the chat at https://gitter.im/vagrant-libvirt/vagrant-libvirt](https://badges.gitter.im/vagrant-libvirt/vagrant-libvirt.svg)](https://gitter.im/vagrant-libvirt/vagrant-libvirt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Build Status](https://travis-ci.org/vagrant-libvirt/vagrant-libvirt.svg)](https://travis-ci.org/vagrant-libvirt/vagrant-libvirt)
+[![Build Status](https://github.com/vagrant-libvirt/vagrant-libvirt/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/vagrant-libvirt/vagrant-libvirt/actions/workflows/unit-tests.yml)
 [![Coverage Status](https://coveralls.io/repos/github/vagrant-libvirt/vagrant-libvirt/badge.svg?branch=master)](https://coveralls.io/github/vagrant-libvirt/vagrant-libvirt?branch=master)
+[![Gem Version](https://badge.fury.io/rb/vagrant-libvirt.svg)](https://badge.fury.io/rb/vagrant-libvirt)
 
 This is a [Vagrant](http://www.vagrantup.com) plugin that adds a
 [Libvirt](http://libvirt.org) provider to Vagrant, allowing Vagrant to
@@ -49,6 +50,7 @@ can help a lot :-)
   * [USB Redirector Devices](#usb-redirector-devices)
     * [Filter for USB Redirector Devices](#filter-for-usb-redirector-devices)
 * [Random number generator passthrough](#random-number-generator-passthrough)
+* [Serial Console Devices](#serial-console-devices)
 * [Watchdog device](#watchdog-device)
 * [Smartcard device](#smartcard-device)
 * [Hypervisor Features](#hypervisor-features)
@@ -137,12 +139,6 @@ docker pull vagrantlibvirt/vagrant-libvirt:edge
 ```
 ---
 
-Preparing the docker run, only once:
-
-```bash
-mkdir -p ~/.vagrant.d/{boxes,data,tmp}
-```
-
 Running the image:
 ```bash
 docker run -it --rm \
@@ -173,6 +169,14 @@ vagrant(){
 ```
 
 ### Using Podman
+
+Preparing the podman run, only once:
+
+```bash
+mkdir -p ~/.vagrant.d/{boxes,data,tmp}
+```
+_N.B. This is needed until the entrypoint works for podman to only mount the `~/.vagrant.d` directory_
+
 To run with Podman you need to include
 
 ```bash
@@ -180,6 +184,7 @@ To run with Podman you need to include
   --security-opt label=disable \
   -v ~/.vagrant.d/boxes:/vagrant/boxes \
   -v ~/.vagrant.d/data:/vagrant/data \
+  -v ~/.vagrant.d/data:/vagrant/tmp \
 ```
 
 for example:
@@ -191,6 +196,7 @@ vagrant(){
     -v /var/run/libvirt/:/var/run/libvirt/ \
     -v ~/.vagrant.d/boxes:/vagrant/boxes \
     -v ~/.vagrant.d/data:/vagrant/data \
+    -v ~/.vagrant.d/data:/vagrant/tmp \
     -v $(realpath "${PWD}"):${PWD} \
     -w $(realpath "${PWD}") \
     --network host \
@@ -232,7 +238,7 @@ installed](http://docs.vagrantup.com/v2/installation/index.html).
 Vagrant-libvirt supports Vagrant 2.0, 2.1 & 2.2. It should also work with earlier
 releases from 1.5 onwards but they are not actively tested.
 
-Check the [.travis.yml](https://github.com/vagrant-libvirt/vagrant-libvirt/blob/master/.travis.yml)
+Check the [unit tests](https://github.com/vagrant-libvirt/vagrant-libvirt/blob/master/.github/workflows/unit-tests.yml)
 for the current list of tested versions.
 
 *We only test with the upstream version!* If you decide to install your distro's
@@ -593,6 +599,8 @@ end
 * `graphics_autoport` - Sets autoport for graphics, Libvirt in this case
   ignores graphics_port value, Defaults to 'yes'. Possible value are "yes" and
   "no"
+* `graphics_gl` - Set to `true` to enable OpenGL. Defaults to `true` if
+`video_accel3d` is `true`.
 * `keymap` - Set keymap for vm. default: en-us
 * `kvm_hidden` - [Hide the hypervisor from the
   guest](https://libvirt.org/formatdomain.html#elementsFeatures). Useful for
@@ -603,6 +611,8 @@ end
   "cirrus", "vmvga", "xen", "vbox", or "qxl".
 * `video_vram` - Used by some graphics card types to vary the amount of RAM
   dedicated to video.  Defaults to 9216.
+* `video_accel3d` - Set to `true` to enable 3D acceleration. Defaults to
+`false`.
 * `sound_type` - [Set the virtual sound card](https://libvirt.org/formatdomain.html#elementsSound)
   Defaults to "ich6".
 * `machine_type` - Sets machine type. Equivalent to qemu `-machine`. Use
@@ -657,6 +667,9 @@ end
   it is not possible to communicate with VM through `vagrant ssh` or run
   provisioning. Setting to 'false' is only possible when VM doesn't use box.
   Defaults set to 'true'.
+* `serial` - [libvirt serial devices](https://libvirt.org/formatdomain.html#elementsConsole).
+  Configure a serial/console port to communicate with the guest. Can be used
+  to log to file boot time messages sent to ttyS0 console by the guest.
 
 Specific domain settings can be set for each domain separately in multi-VM
 environment. Example below shows a part of Vagrantfile, where specific options
@@ -906,6 +919,9 @@ starts with `libvirt__` string. Here is a list of those options:
   If not specified the default is 'false'.
 * `:bus` - The bus of the PCI device. Both :bus and :slot have to be defined.
 * `:slot` - The slot of the PCI device. Both :bus and :slot have to be defined.
+* `:libvirt__always_destroy` - Allow domains that use but did not create a
+  network to destroy it when the domain is destroyed (default: `true`). Set to
+  `false` to only allow the domain that created the network to destroy it.
 
 When the option `:libvirt__dhcp_enabled` is to to 'false' it shouldn't matter
 whether the virtual network contains a DHCP server or not and vagrant-libvirt
@@ -1249,6 +1265,26 @@ Vagrant.configure("2") do |config|
 end
 ```
 
+## Serial Console Devices
+You can define settings to redirect output from the serial console of any VM brought up with libvirt to a file or other devices that are listening. [See libvirt documentation](https://libvirt.org/formatdomain.html#elementCharSerial).
+
+Currently only redirecting to a file is supported.
+
+* `type` - only value that has an effect is file, in the future support may be added for virtual console, pty, dev, pipe, tcp, udp, unix socket, spiceport & nmdm.
+* `source` - options pertaining to how the connection attaches to the host, contains sub-settings dependent on `type`.
+  `source` options for type `file`
+  * `path` - file on host to connect to the serial port to record all output. May be created by qemu system user causing some permissions issues.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.define :test do |test|
+    test.vm.provider :libvirt do |domain|
+      domain.serial :type => "file", :source => {:path => "/var/log/vm_consoles/test.log}
+    end
+  end
+end
+```
+
 ## Random number generator passthrough
 
 You can pass through `/dev/random` to your VM by configuring the domain like this:

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

@@ -78,9 +78,11 @@ module VagrantPlugins
                              else
                                "passwd='#{config.graphics_passwd}'"
                               end
+          @graphics_gl = config.graphics_gl
           @video_type = config.video_type
           @sound_type = config.sound_type
           @video_vram = config.video_vram
+          @video_accel3d = config.video_accel3d
           @keymap = config.keymap
           @kvm_hidden = config.kvm_hidden
 
@@ -171,6 +173,20 @@ module VagrantPlugins
             storage_prefix = get_disk_storage_prefix(env, @storage_pool_name)
           end
 
+          @serials = config.serials
+
+          @serials.each do |serial|
+            next unless serial[:source] && serial[:source][:path]
+
+            dir = File.dirname(serial[:source][:path])
+            begin
+              FileUtils.mkdir_p(dir)
+            rescue ::Errno::EACCES
+              raise Errors::SerialCannotCreatePathError,
+                    path: dir
+            end
+          end
+
           @disks.each do |disk|
             disk[:path] ||= _disk_name(@name, disk)
 
@@ -285,6 +301,7 @@ module VagrantPlugins
           env[:ui].info(" -- Graphics Password: #{@graphics_passwd.empty? ? 'Not defined' : 'Defined'}")
           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(" -- Keymap:            #{@keymap}")
           env[:ui].info(" -- TPM Backend:       #{@tpm_type}")
@@ -379,6 +396,13 @@ module VagrantPlugins
             env[:ui].info(" -- smartcard device:  mode=#{@smartcard_dev[:mode]}, type=#{@smartcard_dev[:type]}")
           end
 
+          @serials.each_with_index do |serial, port|
+            if serial[:source]
+              env[:ui].info(" -- SERIAL(COM#{port}:       redirect to #{serial[:source][:path]}")
+              env[:ui].warn(I18n.t('vagrant_libvirt.warnings.creating_domain_console_access_disabled'))
+            end
+          end
+
           unless @qemu_args.empty?
             env[:ui].info(' -- Command line args: ')
             @qemu_args.each do |arg|

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

@@ -208,6 +208,9 @@ module VagrantPlugins
 
             # Create a private network.
             create_private_network(env)
+            write_created_network(env)
+          else
+            write_created_network(env) unless @options[:always_destroy] == false
           end
         end
 
@@ -247,6 +250,9 @@ module VagrantPlugins
 
             # Create a private network.
             create_private_network(env)
+            write_created_network(env)
+          else
+            write_created_network(env) unless @options[:always_destroy] == false
           end
         end
 
@@ -273,6 +279,9 @@ module VagrantPlugins
 
             # Create a private network.
             create_private_network(env)
+            write_created_network(env)
+          else
+            write_created_network(env) unless @options[:always_destroy] == false
           end
         end
 
@@ -347,7 +356,9 @@ module VagrantPlugins
           rescue => e
             raise Errors::CreateNetworkError, error_message: e.message
           end
+        end
 
+        def write_created_network(env)
           created_networks_file = env[:machine].data_dir + 'created_networks'
 
           message = 'Saving information about created network ' \

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

@@ -59,7 +59,7 @@ module VagrantPlugins
           command = "ip=$(which ip); ${ip:-/sbin/ip} addr show | grep -i 'inet ' | grep -v '127.0.0.1' | tr -s ' ' | cut -d' ' -f3 | cut -d'/' -f 1"
           result  = ''
           machine.communicate.execute(command) do |type, data|
-            result << data if type == :stdout
+            result += data if type == :stdout
           end
 
           ips = result.chomp.split("\n").uniq

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

@@ -222,6 +222,24 @@ module VagrantPlugins
                     graphics.attributes['passwd'] = config.graphics_passwd
                   end
                 end
+                graphics_gl = REXML::XPath.first(xml_descr, '/domain/devices/graphics/gl')
+                if graphics_gl.nil?
+                  if config.graphics_gl
+                    graphics_gl = REXML::Element.new('gl', REXML::XPath.first(xml_descr, '/domain/devices/graphics'))
+                    graphics_gl.attributes['enable'] = 'yes'
+                    descr_changed = true
+                  end
+                else
+                  if config.graphics_gl
+                    if graphics_gl.attributes['enable'] != 'yes'
+                      graphics_gl.attributes['enable'] = 'yes'
+                      descr_changed = true
+                    end
+                  else
+                    graphics_gl.parent.delete_element(graphics_gl)
+                    descr_changed = true
+                  end
+                end
               else
                 # graphics_type = none, remove entire element
                 graphics.parent.delete_element(graphics) unless graphics.nil?
@@ -280,6 +298,24 @@ module VagrantPlugins
                     video_model.attributes['vram'] = config.video_vram
                   end
                 end
+                video_accel = REXML::XPath.first(xml_descr, '/domain/devices/video/model/acceleration')
+                if video_accel.nil?
+                  if config.video_accel3d
+                    video_accel = REXML::Element.new('acceleration', REXML::XPath.first(xml_descr, '/domain/devices/video/model'))
+                    video_accel.attributes['accel3d'] = 'yes'
+                    descr_changed = true
+                  end
+                else
+                  if config.video_accel3d
+                    if video_accel.attributes['accel3d'] != 'yes'
+                      video_accel.attributes['accel3d'] = 'yes'
+                      descr_changed = true
+                    end
+                  else
+                    video_accel.parent.delete_element(video_accel)
+                    descr_changed = true
+                  end
+                end
               end
 
               # Sound device

data/lib/vagrant-libvirt/config.rb

@@ -119,8 +119,10 @@ module VagrantPlugins
       attr_accessor :graphics_port
       attr_accessor :graphics_passwd
       attr_accessor :graphics_ip
+      attr_accessor :graphics_gl
       attr_accessor :video_type
       attr_accessor :video_vram
+      attr_accessor :video_accel3d
       attr_accessor :keymap
       attr_accessor :kvm_hidden
       attr_accessor :sound_type
@@ -196,6 +198,9 @@ module VagrantPlugins
       # Use QEMU Agent to get ip address
       attr_accessor :qemu_use_agent
 
+      # serial consoles
+      attr_accessor :serials
+
       def initialize
         @uri               = UNSET_VALUE
         @driver            = UNSET_VALUE
@@ -267,8 +272,10 @@ module VagrantPlugins
         @graphics_port     = UNSET_VALUE
         @graphics_ip       = UNSET_VALUE
         @graphics_passwd   = UNSET_VALUE
+        @graphics_gl       = UNSET_VALUE
         @video_type        = UNSET_VALUE
         @video_vram        = UNSET_VALUE
+        @video_accel3d     = UNSET_VALUE
         @sound_type        = UNSET_VALUE
         @keymap            = UNSET_VALUE
         @kvm_hidden        = UNSET_VALUE
@@ -338,6 +345,8 @@ module VagrantPlugins
 
         # Use Qemu agent to get ip address
         @qemu_use_agent  = UNSET_VALUE
+
+        @serials           = []
       end
 
       def boot(device)
@@ -705,6 +714,20 @@ module VagrantPlugins
         @qemu_env.merge!(options)
       end
 
+      def serial(options={})
+        options = {
+          :type => "pty",
+          :source => nil,
+        }.merge(options)
+
+        serial = {
+          :type => options[:type],
+          :source => options[:source],
+        }
+
+        @serials << serial
+      end
+
       def _default_uri
         # Determine if any settings except driver provided explicitly, if not
         # and the LIBVIRT_DEFAULT_URI var is set, use that.
@@ -817,7 +840,6 @@ module VagrantPlugins
         @management_network_pci_slot = nil if @management_network_pci_slot == UNSET_VALUE
         @management_network_domain = nil if @management_network_domain == UNSET_VALUE
         @management_network_mtu = nil if @management_network_mtu == UNSET_VALUE
-        @system_uri      = 'qemu:///system' if @system_uri == UNSET_VALUE
 
         # Domain specific settings.
         @title = '' if @title == UNSET_VALUE
@@ -871,6 +893,8 @@ module VagrantPlugins
         @graphics_ip = '127.0.0.1' if @graphics_ip == UNSET_VALUE
         @video_type = 'cirrus' if @video_type == UNSET_VALUE
         @video_vram = 9216 if @video_vram == UNSET_VALUE
+        @video_accel3d = false if @video_accel3d == UNSET_VALUE
+        @graphics_gl = @video_accel3d if @graphics_gl == UNSET_VALUE
         @sound_type = nil if @sound_type == UNSET_VALUE
         @keymap = 'en-us' if @keymap == UNSET_VALUE
         @kvm_hidden = false if @kvm_hidden == UNSET_VALUE
@@ -945,7 +969,9 @@ module VagrantPlugins
         # Additional QEMU commandline environment variables
         @qemu_env = {} if @qemu_env == UNSET_VALUE
 
-        @qemu_use_agent = true if @qemu_use_agent != UNSET_VALUE
+        @qemu_use_agent = false if @qemu_use_agent == UNSET_VALUE
+
+        @serials = [{:type => 'pty', :source => nil}] if @serials == []
       end
 
       def validate(machine)
@@ -959,6 +985,9 @@ module VagrantPlugins
           end
         end
 
+        unless @qemu_use_agent == true || @qemu_use_agent == false
+          errors << "libvirt.qemu_use_agent must be a boolean."
+        end
 
         if @qemu_use_agent == true
           # if qemu agent is used to optain domain ip configuration, at least
@@ -976,6 +1005,12 @@ module VagrantPlugins
           end
         end
 
+        machine.provider_config.serials.each do |serial|
+          if serial[:source] and serial[:source][:path].nil?
+            errors << "serial :source requires :path to be defined"
+          end
+        end
+
         machine.config.vm.networks.each do |_type, opts|
           if opts[:mac]
             if opts[:mac] =~ /\A([0-9a-fA-F]{12})\z/
@@ -1017,6 +1052,10 @@ module VagrantPlugins
           c = qemu_env != UNSET_VALUE ? qemu_env.dup : {}
           c.merge!(other.qemu_env) if other.qemu_env != UNSET_VALUE
           result.qemu_env = c
+
+          s = serials.dup
+          s += other.serials
+          result.serials = s
         end
       end
 
@@ -1026,6 +1065,10 @@ module VagrantPlugins
         # Parse uri to extract individual components
         uri = _parse_uri(@uri)
 
+        system_uri = uri.dup
+        system_uri.path = '/system'
+        @system_uri = system_uri.to_s if @system_uri == UNSET_VALUE
+
         # only set @connect_via_ssh if not explicitly to avoid overriding
         # and allow an error to occur if the @uri and @connect_via_ssh disagree
         @connect_via_ssh = uri.scheme.include? "ssh" if @connect_via_ssh == UNSET_VALUE

data/lib/vagrant-libvirt/driver.rb

@@ -61,7 +61,7 @@ module VagrantPlugins
 
         config = @machine.provider_config
 
-        @system_connection = Libvirt::open(config.system_uri)
+        @system_connection = Libvirt::open_read_only(config.system_uri)
         @system_connection
       end
 
@@ -98,16 +98,16 @@ module VagrantPlugins
       end
 
       def get_domain_ipaddress(machine, domain)
-        if @machine.provider_config.qemu_use_session
-          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
 
+        if @machine.provider_config.qemu_use_session
+          return get_ipaddress_from_system domain.mac
+        end
+
         # Get IP address from dhcp leases table
         begin
           ip_address = get_ipaddress_from_domain(domain)
@@ -168,9 +168,9 @@ module VagrantPlugins
       def get_ipaddress_from_qemu_agent(domain, machine_id)
         ip_address = nil
         addresses = nil
-        dom = system_connection.lookup_domain_by_uuid(machine_id)
+        libvirt_domain = connection.client.lookup_domain_by_uuid(machine_id)
         begin
-          response = dom.qemu_agent_command('{"execute":"guest-network-get-interfaces"}', timeout=10)
+          response = libvirt_domain.qemu_agent_command('{"execute":"guest-network-get-interfaces"}', timeout=10)
           @logger.debug("Got Response from qemu agent")
           @logger.debug(response)
           addresses = JSON.parse(response)
@@ -180,7 +180,7 @@ module VagrantPlugins
 
         unless addresses.nil?
           addresses["return"].each{ |interface|
-            if domain.mac == interface["hardware-address"]
+            if domain.mac.downcase == interface["hardware-address"].downcase
               @logger.debug("Found mathing interface: [%s]" % interface["name"])
               if interface.has_key?("ip-addresses")
                 interface["ip-addresses"].each{ |ip|

data/lib/vagrant-libvirt/errors.rb

@@ -181,6 +181,10 @@ module VagrantPlugins
       class DeleteSnapshotError < VagrantLibvirtError
         error_key(:delete_snapshot_error)
       end
+
+      class SerialCannotCreatePathError < VagrantLibvirtError
+        error_key(:serial_cannot_create_path_error)
+      end
     end
   end
 end

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

@@ -162,10 +162,19 @@
     </disk>
 <% end %>
 
-    <serial type='pty'>
-      <target port='0'/>
+<% @serials.each_with_index do |serial, port| %>
+    <serial type='<%= serial[:type] %>'>
+      <% unless serial[:source].nil? %>
+      <source path='<%= serial[:source][:path] %>'/>
+      <% end %>
+      <target port='<%= port %>'/>
     </serial>
-    <console type='pty'>
+    <% end %>
+    <% console_log = @serials.first %>
+    <console type='<%= console_log[:type] %>'>
+      <% unless console_log[:source].nil? %>
+      <source path='<%= console_log[:source][:path] %>'/>
+<% end %>
       <target port='0'/>
     </console>
 
@@ -207,9 +216,13 @@
     <% end %>
     <% if @graphics_type != 'none' %>
       <%# Video device -%>
-      <graphics type='<%= @graphics_type %>' port='<%= @graphics_port %>' autoport='<%= @graphics_autoport %>' listen='<%= @graphics_ip %>' keymap='<%= @keymap %>' <%= @graphics_passwd%> />
+      <graphics type='<%= @graphics_type %>' port='<%= @graphics_port %>' autoport='<%= @graphics_autoport %>' listen='<%= @graphics_ip %>' keymap='<%= @keymap %>' <%= @graphics_passwd %> <% if not @graphics_gl %>/><% else %>>
+        <gl enable='yes' />
+      </graphics><% end %>
       <video>
-        <model type='<%= @video_type %>' vram='<%= @video_vram %>' heads='1'/>
+        <model type='<%= @video_type %>' vram='<%= @video_vram %>' heads='1'<% if not @video_accel3d %>/><% else %>>
+          <acceleration accel3d='yes'/>
+        </model><% end %>
       </video>
       <%#End Video -%>
     <% end %>

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

@@ -119,7 +119,8 @@ module VagrantPlugins
                             IPAddr.new(options[:network_address]).get_mask :
                             '255.255.255.0',
               dhcp_enabled: true,
-              forward_mode: 'nat'
+              forward_mode: 'nat',
+              always_destroy: true
             }.merge(options)
 
             if options[:type].to_s == 'dhcp' && options[:ip].nil?

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'vagrant/action/builtin/mixin_synced_folders'
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.6.3
+0.7.0

data/locales/en.yml

@@ -64,6 +64,8 @@ en:
         the minimum box image size of '%{minimum}'.
       forwarding_udp: |-
         Forwarding UDP ports is not supported. Ignoring.
+      creating_domain_console_access_disabled: |-
+        Serial console is being redirected, access via virsh will be disabled.
 
     errors:
       call_chain_error: Invalid action chain, must ensure that '%{require_action}' is called prior to calling '%{current_action}'
@@ -166,6 +168,8 @@ en:
       management_network_required: |-
         Management network can't be disabled when VM use box.
         Please fix your configuration and run vagrant again.
+      serial_cannot_create_path_error: |-
+        Error creating path for serial port output log: %{path}
 
     states:
       paused: |-

data/spec/spec_helper.rb

@@ -42,4 +42,12 @@ RSpec.configure do |config|
   config.before(:suite) do
     ENV.delete('LIBVIRT_DEFAULT_URI')
   end
+
+  config.mock_with :rspec do |mocks|
+    # This option should be set when all dependencies are being loaded
+    # before a spec run, as is the case in a typical spec helper. It will
+    # cause any verifying double instantiation for a class that does not
+    # exist to raise, protecting against incorrectly spelt names.
+    mocks.verify_doubled_constant_names = true
+  end
 end

data/spec/support/libvirt_context.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'fog/libvirt'
+require 'fog/libvirt/models/compute/server'
+require 'libvirt'
 
 shared_context 'libvirt' do
   include_context 'unit'
@@ -8,7 +10,9 @@ shared_context 'libvirt' do
   let(:libvirt_context) { true                      }
   let(:id)              { 'dummy-vagrant_dummy'     }
   let(:connection)      { double('connection') }
-  let(:domain)          { double('domain') }
+  let(:domain)          { instance_double('::Fog::Libvirt::Compute::Server') }
+  let(:libvirt_client)  { instance_double('::Libvirt::Connect') }
+  let(:libvirt_domain)  { instance_double('::Libvirt::Domain') }
   let(:logger)          { double('logger') }
 
   def connection_result(options = {})
@@ -22,11 +26,10 @@ shared_context 'libvirt' do
     stub_const('::Fog::Compute', connection)
 
     # drivers also call vm_exists? during init;
-    allow(connection).to receive(:servers).with(kind_of(String))
+    allow(connection).to receive(:servers)
       .and_return(connection_result(result: nil))
 
-    # return some information for domain when needed
-    allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
+    allow(connection).to receive(:client).and_return(libvirt_client)
 
     allow(machine).to receive(:id).and_return(id)
     allow(Log4r::Logger).to receive(:new).and_return(logger)

data/spec/support/sharedcontext.rb

@@ -36,6 +36,6 @@ shared_context 'unit' do
 
   before (:each) do
     allow(machine).to receive(:guest).and_return(guest)
-    allow(machine).to receive(:communicator).and_return(communicator)
+    allow(machine).to receive(:communicate).and_return(communicator)
   end
 end

data/spec/unit/action/prepare_nfs_settings_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant-libvirt/action/prepare_nfs_settings'
+
+
+describe VagrantPlugins::ProviderLibvirt::Action::PrepareNFSSettings do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+
+  describe '#call' do
+    before do
+      # avoid requiring nfsd installed to run tests
+      allow(machine.env.host).to receive(:capability?).with(:nfs_installed).and_return(true)
+      allow(machine.env.host).to receive(:capability).with(:nfs_installed).and_return(true)
+    end
+
+    context 'when enabled' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.box = "vagrant-libvirt/test"
+          config.vm.define :test
+          config.vm.synced_folder ".", "/vagrant", type: "nfs"
+          config.vm.provider :libvirt do |libvirt|
+            #{vagrantfile_providerconfig}
+          end
+        end
+        EOF
+      end
+      let(:socket) { double('socket') }
+
+      before do
+        allow(::TCPSocket).to receive(:new).and_return(socket)
+        allow(socket).to receive(:close)
+      end
+
+      it 'should retrieve the guest IP address' do
+        times_called = 0
+        expect(::TCPSocket).to receive(:new) do
+          # force reaching later code
+          times_called += 1
+          times_called < 2 ? raise("StandardError") : socket
+        end
+        expect(machine).to receive(:ssh_info).and_return({:host => '192.168.1.2'})
+        expect(communicator).to receive(:execute).and_yield(:stdout, "192.168.1.2\n192.168.2.2")
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/action/shutdown_domain_spec.rb

@@ -50,7 +50,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
       end
 
       it "should not shutdown" do
-        expect(domain).not_to receive(:shutoff)
+        expect(domain).not_to receive(:poweroff)
         subject.call(env)
       end
 

data/spec/unit/action/wait_till_up_spec.rb

@@ -22,6 +22,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::WaitTillUp do
         .and_return(driver)
       allow(driver).to receive(:get_domain).and_return(domain)
       allow(driver).to receive(:state).and_return(:running)
+      # return some information for domain when needed
+      allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
     end
 
     context 'when machine does not exist' do
@@ -62,7 +64,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::WaitTillUp do
           expect(app).to_not receive(:call)
           expect(ui).to receive(:info).with('Waiting for domain to get an IP address...')
           expect(ui).to_not receive(:info).with('Waiting for SSH to become available...')
-          expect(env[:machine].communicate).to_not receive(:ready?)
           expect {subject.call(env) }.to raise_error(::Fog::Errors::TimeoutError)
         end
       end

data/spec/unit/config_spec.rb

@@ -338,6 +338,54 @@ describe VagrantPlugins::ProviderLibvirt::Config do
       end
     end
 
+    context '@system_uri' do
+      [
+        # system uri
+        [ # transport and hostname
+          {:uri => "qemu+ssh://localhost/session"},
+          {:uri => "qemu+ssh://localhost/session", :system_uri => "qemu+ssh://localhost/system"},
+        ],
+        [ # explicitly set
+          {:qemu_use_session => true, :system_uri => "custom://remote/system"},
+          {:uri => "qemu:///session", :system_uri => "custom://remote/system"},
+        ],
+      ].each do |inputs, outputs, options|
+        opts = {}
+        opts.merge!(options) if options
+
+        it "should handle inputs #{inputs} with env (#{opts[:env]})" do
+          # allow some of these to fail for now if marked as such
+          if !opts[:allow_failure].nil?
+            pending(opts[:allow_failure])
+          end
+
+          if !opts[:setup].nil?
+            opts[:setup].apply_binding(binding)
+          end
+
+          inputs.each do |k, v|
+            subject.instance_variable_set("@#{k}", v)
+          end
+
+          if !opts[:env].nil?
+            opts[:env].each do |k, v|
+              fake_env[k] = v
+            end
+          end
+
+          subject.finalize!
+
+          # ensure failed output indicates which settings are incorrect in the failed test
+          got = subject.instance_variables.each_with_object({}) do |name, hash|
+            if outputs.key?(name.to_s[1..-1].to_sym)
+              hash["#{name.to_s[1..-1]}".to_sym] =subject.instance_variable_get(name)
+            end
+          end
+          expect(got).to eq(outputs)
+        end
+      end
+    end
+
     context '@proxy_command' do
       before(:example) do
         stub_const("ENV", fake_env)

data/spec/unit/driver_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fog/libvirt/requests/compute/dhcp_leases'
+
 require 'spec_helper'
 require 'support/binding_proc'
 require 'support/sharedcontext'
@@ -8,6 +10,7 @@ require 'vagrant-libvirt/driver'
 
 describe VagrantPlugins::ProviderLibvirt::Driver do
   include_context 'unit'
+  include_context 'libvirt'
 
   subject { described_class.new(machine) }
 
@@ -27,6 +30,7 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
     end
     EOF
   end
+
   # need to override the default package iso_env as using a different
   # name for the test machines above.
   let(:machine)    { iso_env.machine(:test1, :libvirt) }
@@ -36,6 +40,14 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
   let(:system_connection1) { double("system connection 1") } 
   let(:system_connection2) { double("system connection 2") } 
 
+  # make it easier for distros that want to switch the default value for
+  # qemu_use_session to true by ensuring it is explicitly false for tests.
+  before do
+    allow(machine.provider_config).to receive(:qemu_use_session).and_return(false)
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:debug)
+  end
+
   describe '#connection' do
     it 'should configure a separate connection per machine' do
       expect(Fog::Compute).to receive(:new).with(
@@ -68,15 +80,15 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
     # system_uri should be 'qemu+ssh://user@remote1/system'
     # and not 'qemu:///system'.
     it 'should configure a separate connection per machine' do
-      expect(Libvirt).to receive(:open).with('qemu:///system').and_return(system_connection1)
-      expect(Libvirt).to receive(:open).with('qemu:///system').and_return(system_connection2)
+      expect(Libvirt).to receive(:open_read_only).with('qemu+ssh://user@remote1/system').and_return(system_connection1)
+      expect(Libvirt).to receive(:open_read_only).with('qemu+ssh://vms@remote2/system').and_return(system_connection2)
 
       expect(machine.provider.driver.system_connection).to eq(system_connection1)
       expect(machine2.provider.driver.system_connection).to eq(system_connection2)
     end
 
     it 'should configure the connection once' do
-      expect(Libvirt).to receive(:open).with('qemu:///system').and_return(system_connection1)
+      expect(Libvirt).to receive(:open_read_only).with('qemu+ssh://user@remote1/system').and_return(system_connection1)
 
       expect(machine.provider.driver.system_connection).to eq(system_connection1)
       expect(machine.provider.driver.system_connection).to eq(system_connection1)
@@ -84,6 +96,129 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
     end
   end
 
+  describe '#get_ipaddress' do
+    context 'when domain exists' do
+      # not used yet, but this is the form that is returned from addresses
+      let(:addresses) { {
+        :public => ["192.168.122.111"],
+        :private => ["192.168.122.111"],
+      } }
+
+      before do
+        allow(subject).to receive(:get_domain).and_return(domain)
+      end
+
+      it 'should retrieve the address via domain fog-libvirt API' do
+        # ideally should be able to yield a block to wait_for and check that
+        # the 'addresses' function on the domain is called correctly.
+        expect(domain).to receive(:wait_for).and_return(nil)
+        expect(subject.get_ipaddress(machine)).to eq(nil)
+      end
+
+      context 'when qemu_use_agent is enabled' do
+        let(:qemu_agent_interfaces) {
+          <<-EOF
+          {
+            "return": [
+              {
+                "name": "lo",
+                "ip-addresses": [
+                  {
+                    "ip-address-type": "ipv4",
+                    "ip-address": "127.0.0.1",
+                    "prefix": 8
+                  }
+                ],
+                "hardware-address": "00:00:00:00:00:00"
+              },
+              {
+                "name": "eth0",
+                "ip-addresses": [
+                  {
+                    "ip-address-type": "ipv4",
+                    "ip-address": "192.168.122.42",
+                    "prefix": 24
+                  }
+                ],
+                "hardware-address": "52:54:00:f8:67:98"
+              }
+            ]
+          }
+          EOF
+        }
+
+        before do
+          allow(machine.provider_config).to receive(:qemu_use_agent).and_return(true)
+        end
+
+        it 'should retrieve the address via the agent' do
+          expect(subject).to receive(:connection).and_return(connection)
+          expect(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+          expect(libvirt_domain).to receive(:qemu_agent_command).and_return(qemu_agent_interfaces)
+          expect(domain).to receive(:mac).and_return("52:54:00:f8:67:98").exactly(2).times
+
+          expect(subject.get_ipaddress(machine)).to eq("192.168.122.42")
+        end
+
+        context 'when qemu_use_session is enabled' do
+          before do
+            allow(machine.provider_config).to receive(:qemu_use_session).and_return(true)
+          end
+
+          it 'should still retrieve the address via the agent' do
+            expect(subject).to receive(:connection).and_return(connection)
+            expect(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+            expect(libvirt_domain).to receive(:qemu_agent_command).and_return(qemu_agent_interfaces)
+            expect(domain).to receive(:mac).and_return("52:54:00:f8:67:98").exactly(2).times
+
+            expect(subject.get_ipaddress(machine)).to eq("192.168.122.42")
+          end
+        end
+      end
+
+      context 'when qemu_use_session is enabled' do
+        let(:networks) { [instance_double('::Fog::Libvirt::Compute::Real')] }
+        let(:dhcp_leases) {
+          {
+            "iface"      =>"virbr0",
+            "expirytime" =>1636287162,
+            "type"       =>0,
+            "mac"        =>"52:54:00:8b:dc:5f",
+            "ipaddr"     =>"192.168.122.43",
+            "prefix"     =>24,
+            "hostname"   =>"vagrant-default_test",
+            "clientid"   =>"ff:00:8b:dc:5f:00:01:00:01:29:1a:65:42:52:54:00:8b:dc:5f",
+          }
+        }
+
+        before do
+          allow(machine.provider_config).to receive(:qemu_use_session).and_return(true)
+        end
+
+        it 'should retreive the address via the system dhcp-leases API' do
+          expect(domain).to receive(:mac).and_return("52:54:00:8b:dc:5f")
+          expect(subject).to receive(:system_connection).and_return(system_connection1)
+          expect(system_connection1).to receive(:list_all_networks).and_return(networks)
+          expect(networks[0]).to receive(:dhcp_leases).and_return([dhcp_leases])
+
+          expect(subject.get_ipaddress(machine)).to eq("192.168.122.43")
+        end
+
+        context 'when qemu_use_agent is enabled' do
+          before do
+            allow(machine.provider_config).to receive(:qemu_use_agent).and_return(true)
+          end
+
+          it 'should retrieve the address via the agent' do
+            expect(subject).to receive(:get_ipaddress_from_qemu_agent).and_return("192.168.122.44")
+
+            expect(subject.get_ipaddress(machine)).to eq("192.168.122.44")
+          end
+        end
+      end
+    end
+  end
+
   describe '#state' do
     let(:domain) { double('domain') }
 

data/spec/unit/templates/domain_all_settings.xml

@@ -81,10 +81,12 @@
       <readonly/>
     </disk>
 
-    <serial type='pty'>
+    <serial type='file'>
+      <source path='/var/log/vm_consoles/machine.log'/>
       <target port='0'/>
     </serial>
-    <console type='pty'>
+    <console type='file'>
+      <source path='/var/log/vm_consoles/machine.log'/>
       <target port='0'/>
     </console>
 
@@ -110,9 +112,13 @@
 
     <input type='mouse' bus='ps2'/>
 
-      <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'  />
+      <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'  >
+        <gl enable='yes' />
+      </graphics>
       <video>
-        <model type='cirrus' vram='9216' heads='1'/>
+        <model type='cirrus' vram='9216' heads='1'>
+          <acceleration accel3d='yes'/>
+        </model>
       </video>
       <rng model='virtio'>
         <backend model='random'>/dev/random</backend>

data/spec/unit/templates/domain_spec.rb

@@ -89,6 +89,7 @@ describe 'templates/domain' do
                      target_port: '4242',
                      source_path: '/tmp/foo')
       domain.random(model: 'random')
+      domain.serial(:type => 'file', :source => {:path => '/var/log/vm_consoles/machine.log'})
       domain.pci(bus: '0x06', slot: '0x12', function: '0x5')
       domain.pci(domain: '0x0001', bus: '0x03', slot: '0x00', function: '0x0')
       domain.usb_controller(model: 'nec-xhci', ports: '4')
@@ -111,6 +112,8 @@ describe 'templates/domain' do
       domain.shares = '1024'
       domain.cpuset = '1-4,^3,6'
       domain.nodeset = '1-4,^3,6'
+
+      domain.video_accel3d = true
     end
     let(:test_file) { 'domain_all_settings.xml' }
     it 'renders template' do

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Lukas Stanek
 - Dima Vasilets
 - Brian Pitts
 - Darragh Bailey
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-17 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -252,6 +252,7 @@ files:
 - spec/unit/action/halt_domain_spec.rb
 - spec/unit/action/handle_box_image_spec.rb
 - spec/unit/action/package_domain_spec.rb
+- spec/unit/action/prepare_nfs_settings_spec.rb
 - spec/unit/action/set_name_of_domain_spec.rb
 - spec/unit/action/shutdown_domain_spec.rb
 - spec/unit/action/start_domain_spec.rb
@@ -264,7 +265,6 @@ files:
 - spec/unit/action_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/driver_spec.rb
-- spec/unit/provider_spec.rb
 - spec/unit/templates/domain_all_settings.xml
 - spec/unit/templates/domain_custom_cpu_model.xml
 - spec/unit/templates/domain_defaults.xml
@@ -275,8 +275,9 @@ files:
 homepage: https://github.com/vagrant-libvirt/vagrant-libvirt
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/vagrant-libvirt/vagrant-libvirt
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -291,51 +292,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: libvirt provider for Vagrant.
 test_files:
-- spec/support/matchers/have_file_content.rb
-- spec/support/binding_proc.rb
-- spec/support/environment_helper.rb
-- spec/support/libvirt_context.rb
 - spec/support/temporary_dir.rb
+- spec/support/libvirt_context.rb
+- spec/support/binding_proc.rb
 - spec/support/sharedcontext.rb
-- spec/unit/action/create_domain_spec/default_system_storage_pool.xml
-- spec/unit/action/create_domain_spec/default_user_storage_pool.xml
+- spec/support/matchers/have_file_content.rb
+- spec/support/environment_helper.rb
+- spec/unit/action_spec.rb
+- spec/unit/templates/domain_all_settings.xml
+- spec/unit/templates/domain_custom_cpu_model.xml
+- spec/unit/templates/domain_defaults.xml
+- spec/unit/templates/domain_spec.rb
+- spec/unit/templates/tpm/version_1.2.xml
+- spec/unit/templates/tpm/version_2.0.xml
 - spec/unit/action/create_domain_spec/additional_disks_domain.xml
 - spec/unit/action/create_domain_spec/default_domain.xml
-- spec/unit/action/create_domain_volume_spec/one_disk_in_storage.xml
-- spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_0.xml
+- spec/unit/action/create_domain_spec/default_system_storage_pool.xml
+- spec/unit/action/create_domain_spec/default_user_storage_pool.xml
+- spec/unit/action/create_domain_spec.rb
+- spec/unit/action/wait_till_up_spec.rb
+- spec/unit/action/package_domain_spec.rb
+- spec/unit/action/forward_ports_spec.rb
+- spec/unit/action/destroy_domain_spec.rb
+- spec/unit/action/halt_domain_spec.rb
+- spec/unit/action/start_domain_spec.rb
+- spec/unit/action/shutdown_domain_spec.rb
+- spec/unit/action/clean_machine_folder_spec.rb
+- spec/unit/action/create_domain_volume_spec.rb
+- spec/unit/action/set_name_of_domain_spec.rb
+- spec/unit/action/prepare_nfs_settings_spec.rb
 - spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_1.xml
+- spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_0.xml
 - spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_2.xml
+- spec/unit/action/create_domain_volume_spec/one_disk_in_storage.xml
+- spec/unit/action/start_domain_spec/default_added_tpm_path.xml
 - spec/unit/action/start_domain_spec/clock_timer_rtc.xml
 - spec/unit/action/start_domain_spec/default.xml
-- spec/unit/action/start_domain_spec/default_added_tpm_path.xml
-- spec/unit/action/start_domain_spec/default_added_tpm_version.xml
 - spec/unit/action/start_domain_spec/existing.xml
-- spec/unit/action/clean_machine_folder_spec.rb
-- spec/unit/action/forward_ports_spec.rb
-- spec/unit/action/set_name_of_domain_spec.rb
-- spec/unit/action/wait_till_up_spec.rb
-- spec/unit/action/create_domain_volume_spec.rb
-- spec/unit/action/start_domain_spec.rb
-- spec/unit/action/destroy_domain_spec.rb
-- spec/unit/action/halt_domain_spec.rb
-- spec/unit/action/create_domain_spec.rb
-- spec/unit/action/package_domain_spec.rb
-- spec/unit/action/shutdown_domain_spec.rb
+- spec/unit/action/start_domain_spec/default_added_tpm_version.xml
 - spec/unit/action/handle_box_image_spec.rb
-- spec/unit/templates/tpm/version_1.2.xml
-- spec/unit/templates/tpm/version_2.0.xml
-- spec/unit/templates/domain_custom_cpu_model.xml
-- spec/unit/templates/domain_defaults.xml
-- spec/unit/templates/domain_spec.rb
-- spec/unit/templates/domain_all_settings.xml
-- spec/unit/util/byte_number_spec.rb
-- spec/unit/provider_spec.rb
 - spec/unit/config_spec.rb
+- spec/unit/util/byte_number_spec.rb
 - spec/unit/driver_spec.rb
-- spec/unit/action_spec.rb
 - spec/spec_helper.rb

data/spec/unit/provider_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-require 'support/sharedcontext'
-
-describe 'VagrantPlugins::ProviderLibvirt::Provider' do
-  require 'vagrant-libvirt/provider'
-
-  include_context 'unit'
-
-  describe '#ssh_info' do
-  end
-end