vagrant-libvirt 0.6.3 → 0.8.1

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,14 +30,23 @@ 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) }
   let(:machine2)   { iso_env.machine(:test2, :libvirt) }
-  let(:connection1) { double("connection 1") } 
-  let(:connection2) { double("connection 2") } 
-  let(:system_connection1) { double("system connection 1") } 
-  let(:system_connection2) { double("system connection 2") } 
+  let(:connection1) { double("connection 1") }
+  let(:connection2) { double("connection 2") }
+  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
@@ -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') }
 
@@ -110,12 +245,21 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
           end,
         }
       ],
+      [
+        nil,
+        :unknown,
+        {
+          :setup => ProcWithBinding.new do
+            expect(domain).to receive(:state).and_return('unknown').at_least(:once)
+          end,
+        }
+      ],
       [
         'terminated',
         :not_created,
         {
           :setup => ProcWithBinding.new do
-            expect(domain).to receive(:state).and_return('terminated')
+            expect(domain).to receive(:state).and_return('terminated').at_least(:once)
           end,
         }
       ],
@@ -124,7 +268,7 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
         :inaccessible,
         {
           :setup => ProcWithBinding.new do
-            expect(domain).to receive(:state).and_return('running').twice()
+            expect(domain).to receive(:state).and_return('running').at_least(:once)
             expect(subject).to receive(:get_domain_ipaddress).and_raise(Fog::Errors::TimeoutError)
           end,
         }
@@ -134,7 +278,7 @@ describe VagrantPlugins::ProviderLibvirt::Driver do
         :running,
         {
           :setup => ProcWithBinding.new do
-            expect(domain).to receive(:state).and_return('running').twice()
+            expect(domain).to receive(:state).and_return('running').at_least(:once)
             expect(subject).to receive(:get_domain_ipaddress).and_return('192.168.121.2')
           end,
         }

data/spec/unit/templates/domain_all_settings.xml

@@ -5,25 +5,21 @@
   <uuid></uuid>
   <memory></memory>
   <vcpu cpuset='1-4,^3,6'>1</vcpu>
-
-
   <cpu mode='custom'>
-      <model fallback='allow'>qemu64</model>
-        <feature name='AAA' policy='required'/>
-        <topology sockets='1' cores='3' threads='2'/>
+    <model fallback='allow'>qemu64</model>
+    <feature name='AAA' policy='required'/>
+    <topology sockets='1' cores='3' threads='2'/>
   </cpu>
-
   <numatune>
     <memory nodeset='1-4,^3,6'/>
   </numatune>
   <cputune>
     <shares>1024</shares>
   </cputune>
-
   <os>
-        <type arch='x86_64' machine='pc-compatible'>hvm</type>
-        <loader readonly='yes' type='rom'>/efi/loader</loader>
-      <bootmenu enable='yes'/>
+    <type arch='x86_64' machine='pc-compatible'>hvm</type>
+    <loader readonly='yes' type='rom'>/efi/loader</loader>
+    <bootmenu enable='yes'/>
     <kernel></kernel>
     <initrd></initrd>
     <cmdline></cmdline>
@@ -59,15 +55,14 @@
       <alias name='ua-disk-volume-0'/>
       <driver name='qemu' type='qcow2' cache='default'/>
       <source file='/var/lib/libvirt/images/test-disk1.qcow2'/>
-      <target dev='vdb' bus='virtio'/>
+      <target dev='vdc' bus='virtio'/>
     </disk>
     <disk type='file' device='disk'>
       <alias name='ua-disk-volume-1'/>
       <driver name='qemu' type='qcow2' cache='default' io='threads' copy_on_read='on' discard='unmap' detect_zeroes='on'/>
       <source file='/var/lib/libvirt/images/test-disk2.qcow2'/>
-      <target dev='vdc' bus='virtio'/>
+      <target dev='vdd' bus='virtio'/>
     </disk>
-
     <disk type='file' device='cdrom'>
       <driver name='qemu' type='raw' />
       <source file=''/>
@@ -80,75 +75,60 @@
       <target dev='hdb' bus='ide'/>
       <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>
-
-  <channel type='unix' >
-      <target type='virtio'
-               name="org.qemu.guest_agent.0"
-      />
-  </channel>
-  <channel type='spicevmc' >
-      <target type='virtio'
-               name="com.redhat.spice.0"
-      />
-  </channel>
-  <channel type='unix' >
-      <source
-               path="/tmp/foo"
-      />
-      <target type='guestfwd'
-               address="192.0.2.42"
-               port="4242"
-      />
-  </channel>
-
+    <channel type='unix' >
+      <target type='virtio' name='org.qemu.guest_agent.0'/>
+    </channel>
+    <channel type='spicevmc' >
+      <target type='virtio' name='com.redhat.spice.0'/>
+    </channel>
+    <channel type='unix' >
+      <source path='/tmp/foo'/>
+      <target type='guestfwd' address='192.0.2.42' port='4242'/>
+    </channel>
     <input type='mouse' bus='ps2'/>
-
-      <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'  />
-      <video>
-        <model type='cirrus' vram='9216' heads='1'/>
-      </video>
-      <rng model='virtio'>
-        <backend model='random'>/dev/random</backend>
-      </rng>
-      <hostdev mode='subsystem' type='pci' managed='yes'>
-        <source>
-          <address domain='0x0000'
-            bus='0x06'
-            slot='0x12'
-            function='0x5'/>
-        </source>
-      </hostdev>
-      <hostdev mode='subsystem' type='pci' managed='yes'>
-        <source>
-          <address domain='0x0001'
-            bus='0x03'
-            slot='0x00'
-            function='0x0'/>
-        </source>
-      </hostdev>
-      <hostdev mode='subsystem' type='usb'>
-        <source startupPolicy='mandatory'>
-          <vendor id='0x1234'/>
-          <product id='0xabcd'/>
-          <address bus='1' device='2'/>
-        </source>
-      </hostdev>
-        <redirdev bus='usb' type='tcp'>
-        </redirdev>
-        <redirfilter>
-          <usbdev class='0x0b' vendor='0x08e6' product='0x3437' version='2.00' allow='yes'/>
-        </redirfilter>
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'>
+      <gl enable='yes'/>
+    </graphics>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'>
+	<acceleration accel3d='yes'/>
+      </model>
+    </video>
+    <rng model='virtio'>
+      <backend model='random'>/dev/random</backend>
+    </rng>
+    <hostdev mode='subsystem' type='pci' managed='yes'>
+      <source>
+	<address domain='0x0000' bus='0x06' slot='0x12' function='0x5'/>
+      </source>
+    </hostdev>
+    <hostdev mode='subsystem' type='pci' managed='yes'>
+      <source>
+	<address domain='0x0001' bus='0x03' slot='0x00' function='0x0'/>
+      </source>
+    </hostdev>
+    <hostdev mode='subsystem' type='usb'>
+      <source startupPolicy='mandatory'>
+	<vendor id='0x1234'/>
+	<product id='0xabcd'/>
+	<address bus='1' device='2'/>
+      </source>
+    </hostdev>
+    <redirdev bus='usb' type='tcp'>
+    </redirdev>
+    <redirfilter>
+      <usbdev class='0x0b' vendor='0x08e6' product='0x3437' version='2.00' allow='yes'/>
+    </redirfilter>
     <watchdog model='i6300esb' action='reset'/>
-
-        <smartcard mode='passthrough' type='spicevmc'/>
-
+    <smartcard mode='passthrough' type='spicevmc'/>
     <tpm model='tpm-tis'>
       <backend type='passthrough'>
         <device path='/dev/tpm0'/>
@@ -156,7 +136,6 @@
     </tpm>
     <controller type='usb' model='nec-xhci' ports="4" />
   </devices>
-
   <qemu:commandline>
     <qemu:arg value='-device'/>
     <qemu:arg value='dummy-device'/>

data/spec/unit/templates/domain_cpu_mode_passthrough.xml

@@ -0,0 +1,39 @@
+<domain type='' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
+  <name></name>
+  <title></title>
+  <description></description>
+  <uuid></uuid>
+  <memory></memory>
+  <vcpu>1</vcpu>
+  <cpu mode='host-passthrough'>
+    <feature policy='optional' name='vmx'/>
+    <feature policy='optional' name='svm'/>
+    <topology sockets='1' cores='2' threads='1'/>
+  </cpu>
+  <os>
+    <type>hvm</type>
+    <kernel></kernel>
+    <initrd></initrd>
+    <cmdline></cmdline>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'>
+  </clock>
+  <devices>
+    <serial type='pty'>
+      <target port='0'/>
+    </serial>
+    <console type='pty'>
+      <target port='0'/>
+    </console>
+    <input type='mouse' bus='ps2'/>
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'/>
+    </video>
+  </devices>
+</domain>

data/spec/unit/templates/domain_custom_cpu_model.xml

@@ -5,15 +5,11 @@
   <uuid></uuid>
   <memory></memory>
   <vcpu>1</vcpu>
-
-
   <cpu mode='custom'>
-      <model fallback='allow'>SandyBridge</model>
+    <model fallback='allow'>SandyBridge</model>
   </cpu>
-
-
   <os>
-        <type>hvm</type>
+    <type>hvm</type>
     <kernel></kernel>
     <initrd></initrd>
     <cmdline></cmdline>
@@ -26,24 +22,16 @@
   <clock offset='utc'>
   </clock>
   <devices>
-
-
     <serial type='pty'>
       <target port='0'/>
     </serial>
     <console type='pty'>
       <target port='0'/>
     </console>
-
-
     <input type='mouse' bus='ps2'/>
-
-      <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'  />
-      <video>
-        <model type='cirrus' vram='9216' heads='1'/>
-      </video>
-
-
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'/>
+    </video>
   </devices>
-
 </domain>

data/spec/unit/templates/domain_defaults.xml

@@ -5,15 +5,11 @@
   <uuid></uuid>
   <memory></memory>
   <vcpu>1</vcpu>
-
-
   <cpu mode='host-model'>
-      <model fallback='allow'></model>
+    <model fallback='allow'></model>
   </cpu>
-
-
   <os>
-        <type>hvm</type>
+    <type>hvm</type>
     <kernel></kernel>
     <initrd></initrd>
     <cmdline></cmdline>
@@ -26,24 +22,16 @@
   <clock offset='utc'>
   </clock>
   <devices>
-
-
     <serial type='pty'>
       <target port='0'/>
     </serial>
     <console type='pty'>
       <target port='0'/>
     </console>
-
-
     <input type='mouse' bus='ps2'/>
-
-      <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'  />
-      <video>
-        <model type='cirrus' vram='9216' heads='1'/>
-      </video>
-
-
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'/>
+    </video>
   </devices>
-
 </domain>

data/spec/unit/templates/domain_spec.rb

@@ -59,13 +59,13 @@ describe 'templates/domain' do
       domain.disk_device = 'vda'
       domain.disk_driver(:cache => 'unsafe', :io => 'threads', :copy_on_read => 'on', :discard => 'unmap', :detect_zeroes => 'on')
       domain.domain_volumes.push({
-        :dev => 1.vdev.to_s,
+        :dev => 'vda',
         :cache => 'unsafe',
         :bus => domain.disk_bus,
         :path => '/var/lib/libvirt/images/test.qcow2'
       })
       domain.domain_volumes.push({
-        :dev => 2.vdev.to_s,
+        :dev => 'vdb',
         :cache => 'unsafe',
         :bus => domain.disk_bus,
         :path => '/var/lib/libvirt/images/test2.qcow2'
@@ -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,23 +112,48 @@ 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
       domain.finalize!
+      # resolving is now done during create domain, so need to recreate
+      # the same behaviour before calling the template until that
+      # is separated out from create domain.
+      resolver = ::VagrantPlugins::ProviderLibvirt::Util::DiskDeviceResolver.new(prefix=domain.disk_device[0..1])
+      resolver.resolve!(domain.domain_volumes.dup.each { |volume| volume[:device] = volume[:dev] })
+      resolver.resolve!(domain.disks)
+
       expect(domain.to_xml('domain')).to eq xml_expected
     end
   end
 
-  context 'when custom cpu model enabled' do
-    before do
-      domain.cpu_mode = 'custom'
-      domain.cpu_model = 'SandyBridge'
+  context 'when cpu mode is set' do
+    context 'to host-passthrough' do
+      before do
+        domain.cpu_mode = 'host-passthrough'
+        domain.cpu_model = 'SandyBridge'
+        domain.cputopology :sockets => '1', :cores => '2', :threads => '1'
+        domain.nested = true
+      end
+      let(:test_file) { 'domain_cpu_mode_passthrough.xml' }
+      it 'should allow features and topology and ignore model' do
+        domain.finalize!
+        expect(domain.to_xml('domain')).to eq xml_expected
+      end
     end
-    let(:test_file) { 'domain_custom_cpu_model.xml' }
-    it 'renders template' do
-      domain.finalize!
-      expect(domain.to_xml('domain')).to eq xml_expected
+
+    context 'to custom and model is set' do
+      before do
+        domain.cpu_mode = 'custom'
+        domain.cpu_model = 'SandyBridge'
+      end
+      let(:test_file) { 'domain_custom_cpu_model.xml' }
+      it 'renders template' do
+        domain.finalize!
+        expect(domain.to_xml('domain')).to eq xml_expected
+      end
     end
   end
 
@@ -164,12 +190,12 @@ describe 'templates/domain' do
       end
     end
 
-    context 'memballon enabled' do
+    context 'memballoon enabled' do
       before do
         domain.memballoon_enabled = true
       end
 
-      it 'renders with memballon element' do
+      it 'renders with memballoon element' do
         domain.finalize!
 
         expect(domain.to_xml('domain')).to match(/<memballoon model='virtio'>/)
@@ -192,7 +218,7 @@ describe 'templates/domain' do
       end
     end
 
-    context 'memballon disabled' do
+    context 'memballoon disabled' do
       before do
         domain.memballoon_enabled = false
       end