vagrant-libvirt 0.5.0 → 0.6.0

data/spec/unit/action/start_domain_spec/existing.xml

@@ -0,0 +1,62 @@
+<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>
+    <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='9216' 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/start_domain_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
@@ -19,6 +21,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
   let(:updated_domain_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), updated_test_file)) }
 
   describe '#call' do
+    let(:test_file) { 'default.xml' }
+
     before do
       allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
         .to receive(:connection).and_return(connection)
@@ -28,23 +32,29 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
       allow(connection).to receive(:servers).and_return(servers)
       allow(servers).to receive(:get).and_return(domain)
 
+      allow(logger).to receive(:debug)
       expect(logger).to receive(:info)
       expect(ui).to_not receive(:error)
+
+      allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
+
+      allow(libvirt_domain).to receive(:max_memory).and_return(512*1024)
+      allow(libvirt_domain).to receive(:num_vcpus).and_return(1)
     end
 
-    context 'default config' do
-      let(:test_file) { 'default.xml' }
+    it 'should execute without changing' do
+      allow(libvirt_domain).to receive(:undefine)
+      expect(libvirt_domain).to receive(:autostart=)
+      expect(domain).to receive(:start)
 
-      before do
-        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
+      expect(subject.call(env)).to be_nil
+    end
 
-        allow(libvirt_domain).to receive(:max_memory).and_return(512*1024)
-        allow(libvirt_domain).to receive(:num_vcpus).and_return(1)
-      end
+    context 'when previously running default config' do
+      let(:test_file) { 'existing.xml' }
 
       it 'should execute without changing' do
         allow(libvirt_domain).to receive(:undefine)
-        expect(logger).to_not receive(:debug)
         expect(libvirt_domain).to receive(:autostart=)
         expect(domain).to receive(:start)
 
@@ -53,15 +63,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
     end
 
     context 'tpm' do
-      let(:test_file) { 'default.xml' }
-
-      before do
-        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
-
-        allow(libvirt_domain).to receive(:max_memory).and_return(512*1024)
-        allow(libvirt_domain).to receive(:num_vcpus).and_return(1)
-      end
-
       context 'passthrough tpm added' do
         let(:updated_test_file) { 'default_added_tpm_path.xml' }
         let(:vagrantfile_providerconfig) do
@@ -116,7 +117,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
         end
 
         it 'should execute without changing' do
-          expect(logger).to_not receive(:debug)
           expect(libvirt_domain).to receive(:autostart=)
           expect(domain).to receive(:start)
 
@@ -136,7 +136,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
         end
 
         it 'should execute without changing' do
-          expect(logger).to_not receive(:debug)
           expect(libvirt_domain).to receive(:autostart=)
           expect(domain).to receive(:start)
 
@@ -170,13 +169,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
     context 'clock_timers' do
       let(:test_file) { 'clock_timer_rtc.xml' }
 
-      before do
-        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
-
-        allow(libvirt_domain).to receive(:max_memory).and_return(512*1024)
-        allow(libvirt_domain).to receive(:num_vcpus).and_return(1)
-      end
-
       context 'timers unchanged' do
         let(:vagrantfile_providerconfig) do
           <<-EOF
@@ -214,8 +206,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
       end
 
       context 'timers removed' do
-        let(:updated_test_file) { 'default.xml' }
-
         it 'should modify the domain' do
           expect(libvirt_domain).to receive(:undefine)
           expect(logger).to receive(:debug).with('clock timers config changed')

data/spec/unit/action/wait_till_up_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vagrant-libvirt/action/wait_till_up'
 require 'vagrant-libvirt/errors'
 

data/spec/unit/action_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant/action/runner'
+
+require 'vagrant-libvirt/action'
+
+
+describe VagrantPlugins::ProviderLibvirt::Action do
+  subject { described_class }
+
+  include_context 'libvirt'
+  include_context 'unit'
+
+  let(:libvirt_domain) { double('libvirt_domain') }
+  let(:runner) { Vagrant::Action::Runner.new(env) }
+  let(:state) { double('state') }
+
+  before do
+    allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
+      .to receive(:connection).and_return(connection)
+    allow(machine).to receive(:id).and_return('test-machine-id')
+    allow(machine).to receive(:state).and_return(state)
+
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:debug)
+    allow(logger).to receive(:error)
+  end
+
+  def allow_action_env_result(action, *responses)
+    results = responses.dup
+
+    allow_any_instance_of(action).to receive(:call) do |cls, env|
+      app = cls.instance_variable_get(:@app)
+
+      env[:result] = results[0]
+      if results.length > 1
+        results.shift
+      end
+
+      app.call(env)
+    end
+  end
+
+  describe '#action_halt' do
+    context 'not created' do
+      before do
+        expect(state).to receive(:id).and_return(:not_created)
+      end
+
+      it 'should execute without error' do
+        expect(ui).to receive(:info).with('Domain is not created. Please run `vagrant up` first.')
+
+        expect { runner.run(subject.action_halt) }.not_to raise_error
+      end
+    end
+
+    context 'running' do
+      before do
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsCreated, true)
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsSuspended, false)
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, true)
+      end
+
+      context 'when shutdown domain works' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain, true)
+          allow_action_env_result(Vagrant::Action::Builtin::GracefulHalt, true)
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, true, false)
+        end
+
+        it 'should skip calling HaltDomain' do
+          expect(ui).to_not receive(:info).with('Domain is not created. Please run `vagrant up` first.')
+          expect_any_instance_of(VagrantPlugins::ProviderLibvirt::Action::HaltDomain).to_not receive(:call)
+
+          expect { runner.run(subject.action_halt) }.not_to raise_error
+        end
+      end
+
+      context 'when shutdown domain fails' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain, false)
+          allow_action_env_result(Vagrant::Action::Builtin::GracefulHalt, false)
+        end
+
+        it 'should call halt' do
+          expect_any_instance_of(VagrantPlugins::ProviderLibvirt::Action::HaltDomain).to receive(:call)
+
+          expect { runner.run(subject.action_halt) }.not_to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/unit/config_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'support/binding_proc'
 
 require 'spec_helper'
@@ -190,14 +192,14 @@ describe VagrantPlugins::ProviderLibvirt::Config do
         ],
         [ # when username explicitly set without ssh
           {:username => 'my_user' },
-          {:uri => 'qemu:///system'},
+          {:uri => 'qemu:///system', :username => 'my_user'},
           {
             :env => {'LIBVIRT_DEFAULT_URI' => 'qemu://session'},
           }
         ],
         [ # when username explicitly set with host but without ssh
           {:username => 'my_user', :host => 'remote'},
-          {:uri => 'qemu://remote/system'},
+          {:uri => 'qemu://remote/system', :username => 'my_user'},
           {
             :env => {'LIBVIRT_DEFAULT_URI' => 'qemu://session'},
           }
@@ -358,6 +360,10 @@ describe VagrantPlugins::ProviderLibvirt::Config do
           {:connect_via_ssh => true, :host => 'remote', :username => 'myuser'},
           "ssh 'remote' -l 'myuser' -W %h:%p",
         ],
+        [ # remote contains port
+          {:connect_via_ssh => true, :host => 'remote:2222'},
+          "ssh 'remote' -p 2222 -W %h:%p",
+        ],
         [ # include user and default ssh key exists
           {:connect_via_ssh => true, :host => 'remote', :username => 'myuser'},
           "ssh 'remote' -l 'myuser' -i '/home/tests/.ssh/id_rsa' -W %h:%p",
@@ -390,7 +396,6 @@ describe VagrantPlugins::ProviderLibvirt::Config do
         [
           {:uri => 'qemu+ssh://remote/system?keyfile=/some/path/to/keyfile'},
           "ssh 'remote' -i '/some/path/to/keyfile' -W %h:%p",
-          {:allow_failure => "keyfile not yet inferred from uri"},
         ],
 
         # provide custom template
@@ -430,6 +435,54 @@ describe VagrantPlugins::ProviderLibvirt::Config do
         end
       end
     end
+
+    context '@usbctl_dev' do
+      it 'should be empty by default' do
+        subject.finalize!
+
+        expect(subject.usbctl_dev).to eq({})
+      end
+
+      context 'when usb devices added' do
+        it 'should inject a default controller' do
+          subject.usb :vendor => '0x1234', :product => '0xabcd'
+
+          subject.finalize!
+
+          expect(subject.usbctl_dev).to eq({:model => 'qemu-xhci'})
+        end
+
+        context 'when user specified a controller' do
+          it 'should retain the user setting' do
+            subject.usb :vendor => '0x1234', :product => '0xabcd'
+            subject.usb_controller :model => 'pii3-uchi'
+
+            subject.finalize!
+            expect(subject.usbctl_dev).to eq({:model => 'pii3-uchi'})
+          end
+        end
+      end
+
+      context 'when redirdevs entries added' do
+        it 'should inject a default controller' do
+          subject.redirdev :type => 'spicevmc'
+
+          subject.finalize!
+
+          expect(subject.usbctl_dev).to eq({:model => 'qemu-xhci'})
+        end
+
+        context 'when user specified a controller' do
+          it 'should retain the user setting' do
+            subject.redirdev :type => 'spicevmc'
+            subject.usb_controller :model => 'pii3-uchi'
+
+            subject.finalize!
+            expect(subject.usbctl_dev).to eq({:model => 'pii3-uchi'})
+          end
+        end
+      end
+    end
   end
 
   def assert_invalid

data/spec/unit/driver_spec.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/binding_proc'
+require 'support/sharedcontext'
+
+require 'vagrant-libvirt/driver'
+
+describe VagrantPlugins::ProviderLibvirt::Driver do
+  include_context 'unit'
+
+  subject { described_class.new(machine) }
+
+  let(:vagrantfile) do
+    <<-EOF
+    Vagrant.configure('2') do |config|
+      config.vm.define :test1 do |node|
+        node.vm.provider :libvirt do |domain|
+          domain.uri = "qemu+ssh://user@remote1/system"
+        end
+      end
+      config.vm.define :test2 do |node|
+        node.vm.provider :libvirt do |domain|
+          domain.uri = "qemu+ssh://vms@remote2/system"
+        end
+      end
+    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") } 
+
+  describe '#connection' do
+    it 'should configure a separate connection per machine' do
+      expect(Fog::Compute).to receive(:new).with(
+        hash_including({:libvirt_uri => 'qemu+ssh://user@remote1/system'})).and_return(connection1)
+      expect(Fog::Compute).to receive(:new).with(
+        hash_including({:libvirt_uri => 'qemu+ssh://vms@remote2/system'})).and_return(connection2)
+
+      expect(machine.provider.driver.connection).to eq(connection1)
+      expect(machine2.provider.driver.connection).to eq(connection2)
+    end
+
+    it 'should configure the connection once' do
+      expect(Fog::Compute).to receive(:new).once().and_return(connection1)
+
+      expect(machine.provider.driver.connection).to eq(connection1)
+      expect(machine.provider.driver.connection).to eq(connection1)
+      expect(machine.provider.driver.connection).to eq(connection1)
+    end
+  end
+
+  describe '#system_connection' do
+    # note that the urls for the two tests are currently
+    # incorrect here as they should be the following:
+    #   qemu+ssh://user@remote1/system
+    #   qemu+ssh://vms@remote2/system
+    #
+    # In that the system uri should be resolved based on
+    # the provider uri so that for:
+    #   uri => qemu+ssh://user@remote1/session
+    # 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(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(machine.provider.driver.system_connection).to eq(system_connection1)
+      expect(machine.provider.driver.system_connection).to eq(system_connection1)
+      expect(machine.provider.driver.system_connection).to eq(system_connection1)
+    end
+  end
+
+  describe '#state' do
+    let(:domain) { double('domain') }
+
+    before do
+      allow(subject).to receive(:get_domain).and_return(domain)
+    end
+
+    [
+      [
+        'not found',
+        :not_created,
+        {
+          :setup => ProcWithBinding.new do
+            expect(subject).to receive(:get_domain).and_return(nil)
+          end,
+        }
+      ],
+      [
+        'libvirt error',
+        :not_created,
+        {
+          :setup => ProcWithBinding.new do
+            expect(subject).to receive(:get_domain).and_raise(Libvirt::RetrieveError, 'missing')
+          end,
+        }
+      ],
+      [
+        'terminated',
+        :not_created,
+        {
+          :setup => ProcWithBinding.new do
+            expect(domain).to receive(:state).and_return('terminated')
+          end,
+        }
+      ],
+      [
+        'no IP returned',
+        :inaccessible,
+        {
+          :setup => ProcWithBinding.new do
+            expect(domain).to receive(:state).and_return('running').twice()
+            expect(subject).to receive(:get_domain_ipaddress).and_raise(Fog::Errors::TimeoutError)
+          end,
+        }
+      ],
+      [
+        'running',
+        :running,
+        {
+          :setup => ProcWithBinding.new do
+            expect(domain).to receive(:state).and_return('running').twice()
+            expect(subject).to receive(:get_domain_ipaddress).and_return('192.168.121.2')
+          end,
+        }
+      ],
+    ].each do |name, expected, options|
+      opts = {}
+      opts.merge!(options) if options
+
+      it "should handle '#{name}' by returning '#{expected}'" do
+        if !opts[:setup].nil?
+          opts[:setup].apply_binding(binding)
+        end
+
+        expect(subject.state(machine)).to eq(expected)
+      end
+    end
+  end
+end

data/spec/unit/templates/domain_all_settings.xml

@@ -44,21 +44,25 @@
   <devices>
     <emulator>/usr/bin/kvm-spice</emulator>
     <disk type='file' device='disk'>
+      <alias name='ua-box-volume-0'/>
       <driver name='qemu' type='qcow2' cache='unsafe' io='threads' copy_on_read='on' discard='unmap' detect_zeroes='on'/>
       <source file='/var/lib/libvirt/images/test.qcow2'/>
       <target dev='vda' bus='ide'/>
     </disk>
     <disk type='file' device='disk'>
+      <alias name='ua-box-volume-1'/>
       <driver name='qemu' type='qcow2' cache='unsafe' io='threads' copy_on_read='on' discard='unmap' detect_zeroes='on'/>
       <source file='/var/lib/libvirt/images/test2.qcow2'/>
       <target dev='vdb' bus='ide'/>
     </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/test-disk1.qcow2'/>
       <target dev='vdb' 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'/>

data/spec/unit/templates/domain_spec.rb

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

data/spec/unit/util/byte_number_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'vagrant-libvirt/util/byte_number'
+
+
+describe ByteNumber do
+  describe '#ByteNumber to Gigrabyte' do
+    it 'should return bigger size' do
+      expect( ByteNumber.new("10737423360").to_GB).to eq(11)
+      expect( ByteNumber.new("737423360").to_GB).to eq(1)
+      expect( ByteNumber.new("110737423360").to_GB).to eq(104)
+    end
+  end
+
+  describe '#ByteNumber from Gigrabyte' do
+    it 'should convert' do
+      expect( ByteNumber.from_GB(5).to_i).to eq(5368709120)
+    end
+  end
+
+  describe '#ByteNumber pow' do
+    it 'should be work like interger' do
+      expect( ByteNumber.new(5).pow(5).to_i).to eq(5**5)
+    end
+  end
+end