vagrant-libvirt 0.10.4 → 0.10.7

data/lib/vagrant-libvirt/cap/synced_folder_9p.rb

@@ -7,7 +7,9 @@ require 'digest/md5'
 
 require 'vagrant/util/subprocess'
 require 'vagrant/errors'
+
 require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/util/erb_template'
 
 module VagrantPlugins
   module SyncedFolder9P

data/lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb

@@ -5,9 +5,11 @@ require 'ostruct'
 require 'nokogiri'
 require 'digest/md5'
 
-require 'vagrant/util/subprocess'
 require 'vagrant/errors'
+require 'vagrant/util/subprocess'
+
 require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/util/erb_template'
 
 module VagrantPlugins
   module SyncedFolderVirtioFS

data/lib/vagrant-libvirt/config.rb

@@ -896,8 +896,7 @@ module VagrantPlugins
         @initrd = '' if @initrd == UNSET_VALUE
         @dtb = nil if @dtb == UNSET_VALUE
         @graphics_type = 'vnc' if @graphics_type == UNSET_VALUE
-        @graphics_autoport = 'yes' if @graphics_port == UNSET_VALUE
-        @graphics_autoport = 'no' if @graphics_port != UNSET_VALUE
+        @graphics_autoport = @graphics_port == UNSET_VALUE ? 'yes' : nil
         if (@graphics_type != 'vnc' && @graphics_type != 'spice') ||
            @graphics_passwd == UNSET_VALUE
           @graphics_passwd = nil

data/lib/vagrant-libvirt/errors.rb

@@ -178,6 +178,10 @@ module VagrantPlugins
         error_key(:no_domain_error)
       end
 
+      class DomainStartError < VagrantLibvirtError
+        error_key(:domain_start_error)
+      end
+
       class AttachDeviceError < VagrantLibvirtError
         error_key(:attach_device_error)
       end

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

@@ -11,7 +11,7 @@ module VagrantPlugins
       module Compat
         def self.action_hook_args(name, action)
           # handle different number of arguments for action_hook depending on vagrant version
-          if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('2.2.11')
+          if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('2.2.6')
             return name, action
           end
 

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

@@ -120,7 +120,7 @@ module VagrantPlugins
             logger.debug "In config found network type #{type} options #{original_options}"
             # Options can be specified in Vagrantfile in short format (:ip => ...),
             # or provider format # (:libvirt__network_name => ...).
-            # https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/scoped_hash_override.rb
+            # https://github.com/mitchellh/vagrant/blob/main/lib/vagrant/util/scoped_hash_override.rb
             options = scoped_hash_override(original_options, :libvirt)
             # store type in options
             # use default values if not already set

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'xmlsimple'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      class Xml
+        attr_reader :xml
+
+        def initialize(xmlstr)
+          @xml = compact_content(XmlSimple.xml_in(xmlstr, {'NormaliseSpace' => 2}))
+        end
+
+        def to_str
+          XmlSimple.xml_out(@xml)
+        end
+
+        def ==(other)
+          @xml == other.xml
+        end
+
+        private
+
+        # content elements that are empty are preserved by xml-simple and will result
+        # in the structures being considered different even if functionality the same
+        # strip any empty ones to avoid.
+        def compact_content(node)
+          if node.is_a?(Array)
+            node.map! do |element|
+              compact_content(element)
+            end
+          elsif node.is_a?(Hash)
+            if node['content'] and node['content'].empty?
+              node.delete('content')
+            end
+            node.each do |k, v|
+              node[k] = compact_content(v)
+            end
+          else
+            return node
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.10.4
+0.10.7

data/locales/en.yml

@@ -153,6 +153,8 @@ en:
         Error while downloading volume '%{volume_name}' from storage pool '%{pool_name}': %{error_message}
       no_domain_error: |-
         No domain found. %{error_message}
+      domain_start_error: |-
+        Failed to start domain: %{error_message}
       attach_device_error: |-
         Error while attaching new device to domain. %{error_message}
       detach_device_error: |-

data/spec/spec_helper.rb

@@ -38,13 +38,12 @@ rescue LoadError
   end
 end
 
-
-require 'vagrant-libvirt'
-require 'vagrant-spec/unit'
-
-Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
-
 RSpec.configure do |config|
+  # set VAGRANT_HOME before any thing that requires vagrant is loaded to prevent
+  # the global plugin manager from trying to use the default VAGRANT_HOME.
+  temp_dir = Dir.mktmpdir("rspec-")
+  ENV['VAGRANT_HOME'] = temp_dir
+
   # ensure that setting of LIBVIRT_DEFAULT_URI in the environment is not picked
   # up directly by tests, instead they must set as needed. Some build envs will
   # may have it set to 'qemu:///session'.
@@ -52,6 +51,10 @@ RSpec.configure do |config|
     ENV.delete('LIBVIRT_DEFAULT_URI')
   end
 
+  config.after(:suite) do
+    FileUtils.remove_entry temp_dir
+  end
+
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
@@ -59,3 +62,7 @@ RSpec.configure do |config|
   # don't run acceptance tests by default
   config.filter_run_excluding :acceptance => true
 end
+
+require 'vagrant-spec/unit'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }

data/spec/unit/action/set_boot_order_spec/default.xml

@@ -0,0 +1,76 @@
+<domain type="qemu">
+  <name>vagrant-libvirt_default</name>
+  <uuid>881a931b-0110-4d10-81aa-47a1a19f5726</uuid>
+  <description>Source: /home/test/vagrant-libvirt/Vagrantfile</description>
+  <memory unit="KiB">2097152</memory>
+  <currentMemory unit="KiB">2097152</currentMemory>
+  <vcpu placement="static">2</vcpu>
+  <os>
+    <type arch="x86_64" machine="pc-i440fx-6.0">hvm</type>
+    <boot dev="hd"/>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <cpu mode="host-model" check="partial"/>
+  <clock offset="utc"/>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>destroy</on_crash>
+  <devices>
+    <emulator>/usr/bin/qemu-system-x86_64</emulator>
+    <disk type="file" device="disk">
+      <driver name="qemu" type="qcow2"/>
+      <source file="/var/lib/libvirt/images/vagrant-libvirt_default.img"/>
+      <target dev="vda" bus="virtio"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x0"/>
+    </disk>
+    <disk type="file" device="cdrom">
+      <driver name="qemu" type="raw"/>
+      <source file=""/>
+      <target dev="hda" bus="ide"/>
+      <readonly/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x06" function="0x0"/>
+    </disk>
+    <disk type="file" device="cdrom">
+      <driver name="qemu" type="raw"/>
+      <source file=""/>
+      <target dev="hdb" bus="ide"/>
+      <readonly/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x07" function="0x0"/>
+    </disk>
+    <controller type="usb" index="0" model="piix3-uhci">
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x01" function="0x2"/>
+    </controller>
+    <controller type="pci" index="0" model="pci-root"/>
+    <interface type="network">
+      <mac address="52:54:00:7d:14:0e"/>
+      <source network="vagrant-libvirt"/>
+      <model type="virtio"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x05" function="0x0"/>
+    </interface>
+    <serial type="pty">
+      <target type="isa-serial" port="0">
+        <model name="isa-serial"/>
+      </target>
+    </serial>
+    <console type="pty">
+      <target type="serial" port="0"/>
+    </console>
+    <input type="mouse" bus="ps2"/>
+    <input type="keyboard" bus="ps2"/>
+    <graphics type="vnc" port="-1" autoport="yes" listen="127.0.0.1" keymap="en-us">
+      <listen type="address" address="127.0.0.1"/>
+    </graphics>
+    <audio id="1" type="none"/>
+    <video>
+      <model type="cirrus" vram="16384" heads="1" primary="yes"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x0"/>
+    </video>
+    <memballoon model="virtio">
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x04" function="0x0"/>
+    </memballoon>
+  </devices>
+</domain>

data/spec/unit/action/set_boot_order_spec/explicit_boot_order.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<domain type="qemu">
+  <name>vagrant-libvirt_default</name>
+  <uuid>881a931b-0110-4d10-81aa-47a1a19f5726</uuid>
+  <description>Source: /home/test/vagrant-libvirt/Vagrantfile</description>
+  <memory unit="KiB">2097152</memory>
+  <currentMemory unit="KiB">2097152</currentMemory>
+  <vcpu placement="static">2</vcpu>
+  <os>
+    <type arch="x86_64" machine="pc-i440fx-6.0">hvm</type>
+    
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <cpu mode="host-model" check="partial"/>
+  <clock offset="utc"/>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>destroy</on_crash>
+  <devices>
+    <emulator>/usr/bin/qemu-system-x86_64</emulator>
+    <disk type="file" device="disk">
+      <driver name="qemu" type="qcow2"/>
+      <source file="/var/lib/libvirt/images/vagrant-libvirt_default.img"/>
+      <target dev="vda" bus="virtio"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x0"/>
+    <boot order="1"/></disk>
+    <disk type="file" device="cdrom">
+      <driver name="qemu" type="raw"/>
+      <source file=""/>
+      <target dev="hda" bus="ide"/>
+      <readonly/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x06" function="0x0"/>
+    <boot order="2"/></disk>
+    <disk type="file" device="cdrom">
+      <driver name="qemu" type="raw"/>
+      <source file=""/>
+      <target dev="hdb" bus="ide"/>
+      <readonly/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x07" function="0x0"/>
+    <boot order="3"/></disk>
+    <controller type="usb" index="0" model="piix3-uhci">
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x01" function="0x2"/>
+    </controller>
+    <controller type="pci" index="0" model="pci-root"/>
+    <interface type="network">
+      <mac address="52:54:00:7d:14:0e"/>
+      <source network="vagrant-libvirt"/>
+      <model type="virtio"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x05" function="0x0"/>
+    <boot order="4"/></interface>
+    <serial type="pty">
+      <target type="isa-serial" port="0">
+        <model name="isa-serial"/>
+      </target>
+    </serial>
+    <console type="pty">
+      <target type="serial" port="0"/>
+    </console>
+    <input type="mouse" bus="ps2"/>
+    <input type="keyboard" bus="ps2"/>
+    <graphics type="vnc" port="-1" autoport="yes" listen="127.0.0.1" keymap="en-us">
+      <listen type="address" address="127.0.0.1"/>
+    </graphics>
+    <audio id="1" type="none"/>
+    <video>
+      <model type="cirrus" vram="16384" heads="1" primary="yes"/>
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x0"/>
+    </video>
+    <memballoon model="virtio">
+      <address type="pci" domain="0x0000" bus="0x00" slot="0x04" function="0x0"/>
+    </memballoon>
+  </devices>
+</domain>

data/spec/unit/action/set_boot_order_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/action/set_boot_order'
+
+describe VagrantPlugins::ProviderLibvirt::Action::SetBootOrder do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  #before do
+  #  allow(driver).to receive(:created?).and_return(true)
+  #end
+
+  describe '#call' do
+    it 'should return early' do
+      expect(connection).to_not receive(:client)
+
+      expect(subject.call(env)).to be_nil
+    end
+
+    context 'with boot_order defined' do
+      let(:domain_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), test_file)) }
+      let(:updated_domain_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), updated_test_file)) }
+      let(:test_file) { 'default.xml' }
+      let(:updated_test_file) { 'explicit_boot_order.xml' }
+      let(:vagrantfile_providerconfig) do
+        <<-EOF
+        libvirt.boot "hd"
+        libvirt.boot "cdrom"
+        libvirt.boot "network" => 'vagrant-libvirt'
+        EOF
+      end
+
+      before do
+        allow(connection).to receive(:client).and_return(libvirt_client)
+        allow(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
+        allow(logger).to receive(:debug)
+      end
+
+      it 'should configure the boot order' do
+        expect(libvirt_client).to receive(:define_domain_xml).with(updated_domain_xml)
+        expect(subject.call(env)).to be_nil
+      end
+
+      context 'with multiple networks in bootorder' do
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.boot "hd"
+          libvirt.boot "cdrom"
+          libvirt.boot "network" => 'vagrant-libvirt'
+          libvirt.boot "network" => 'vagrant-libvirt'
+          EOF
+        end
+
+        it 'should raise an exception' do
+          expect { subject.call(env) }.to raise_error('Defined only for 1 network for boot')
+        end
+      end
+    end
+  end
+end

data/spec/unit/action/start_domain_spec.rb

@@ -72,7 +72,33 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
 
         expect(subject.call(env)).to be_nil
       end
+    end
 
+    context 'when xml not applied' do
+      let(:test_file) { 'default_with_different_formatting.xml' }
+      let(:updated_domain_xml) {
+        new_xml = domain_xml.dup
+        new_xml.gsub!(/<cpu .*<\/cpu>/m, '<cpu mode="host-passthrough"/>')
+        new_xml
+      }
+      let(:vagrantfile_providerconfig) do
+        <<-EOF
+        libvirt.cpu_mode = "host-passthrough"
+        EOF
+      end
+
+      it 'should error and revert the update' do
+        expect(ui).to receive(:warn).with(/\+  <cpu mode="host-passthrough" \/>.*Typically this means there is a bug in the XML being sent, please log an issue/m)
+        expect(connection).to receive(:define_domain).and_return(libvirt_domain)
+        #expect(connection).to receive(:define_domain).with(domain_xml) # undo
+        expect(libvirt_domain).to receive(:xml_desc).and_return(domain_xml, updated_domain_xml)
+        #expect(domain).to_not receive(:start)
+
+        #expect { subject.call(env) }.to raise_error(VagrantPlugins::ProviderLibvirt::Errors::UpdateServerError)
+        expect(libvirt_domain).to receive(:autostart=)
+        expect(domain).to receive(:start)
+        expect(subject.call(env)).to be_nil
+      end
     end
 
     context 'when any setting changed' do

data/spec/unit/plugin_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 require 'support/sharedcontext'
 
+require 'vagrant-libvirt'
 require 'vagrant-libvirt/plugin'