vagrant-libvirt 0.5.3 → 0.6.0

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'},
           }
@@ -433,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'vagrant-libvirt/util/byte_number'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Lukas Stanek
@@ -11,50 +11,50 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +197,7 @@ files:
 - lib/vagrant-libvirt/action/set_boot_order.rb
 - lib/vagrant-libvirt/action/set_name_of_domain.rb
 - lib/vagrant-libvirt/action/share_folders.rb
+- lib/vagrant-libvirt/action/shutdown_domain.rb
 - lib/vagrant-libvirt/action/start_domain.rb
 - lib/vagrant-libvirt/action/suspend_domain.rb
 - lib/vagrant-libvirt/action/wait_till_up.rb
@@ -234,6 +235,7 @@ files:
 - spec/support/libvirt_context.rb
 - spec/support/matchers/have_file_content.rb
 - spec/support/sharedcontext.rb
+- spec/support/temporary_dir.rb
 - spec/unit/action/clean_machine_folder_spec.rb
 - spec/unit/action/create_domain_spec.rb
 - spec/unit/action/create_domain_spec/additional_disks_domain.xml
@@ -249,14 +251,19 @@ files:
 - spec/unit/action/forward_ports_spec.rb
 - 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/set_name_of_domain_spec.rb
+- spec/unit/action/shutdown_domain_spec.rb
 - spec/unit/action/start_domain_spec.rb
 - 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/wait_till_up_spec.rb
+- 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
@@ -284,46 +291,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.11
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: libvirt provider for Vagrant.
 test_files:
-- spec/unit/action/start_domain_spec.rb
-- spec/unit/action/create_domain_spec.rb
-- spec/unit/action/forward_ports_spec.rb
-- spec/unit/action/wait_till_up_spec.rb
-- spec/unit/action/clean_machine_folder_spec.rb
-- spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_2.xml
+- 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/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/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_1.xml
 - spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_0.xml
-- spec/unit/action/start_domain_spec/default_added_tpm_version.xml
+- 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_2.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/destroy_domain_spec.rb
-- 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/additional_disks_domain.xml
-- spec/unit/action/create_domain_spec/default_domain.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/handle_box_image_spec.rb
 - spec/unit/action/set_name_of_domain_spec.rb
-- spec/unit/action/halt_domain_spec.rb
+- spec/unit/action/wait_till_up_spec.rb
 - spec/unit/action/create_domain_volume_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/util/byte_number_spec.rb
-- spec/unit/provider_spec.rb
-- spec/unit/templates/domain_defaults.xml
-- spec/unit/templates/domain_all_settings.xml
-- spec/unit/templates/domain_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/shutdown_domain_spec.rb
+- spec/unit/action/create_domain_spec.rb
+- spec/unit/action/package_domain_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/support/libvirt_context.rb
-- spec/support/matchers/have_file_content.rb
-- spec/support/environment_helper.rb
-- spec/support/binding_proc.rb
-- spec/support/sharedcontext.rb
+- 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/action_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/driver_spec.rb
 - spec/spec_helper.rb