vagrant-libvirt 0.1.0 → 0.4.1

data/spec/support/binding_proc.rb

@@ -0,0 +1,24 @@
+##
+# A simple extension of the Proc class that supports setting a custom binding
+# and evaluates everything in the Proc using the new binding.
+
+class ProcWithBinding < Proc
+  ##
+  # Set the binding for this instance
+
+  def apply_binding(bind, *args)
+    @binding = bind
+    instance_exec(*args, &self)
+  end
+
+  def method_missing(method, *args)
+    begin
+      method_from_binding = eval("method(#{method.inspect})", @binding)
+      return method_from_binding.call(*args)
+    rescue NameError
+      # fall through on purpose
+    end
+
+    super
+  end
+end

data/spec/support/libvirt_context.rb

@@ -7,6 +7,7 @@ shared_context 'libvirt' do
   let(:id)              { 'dummy-vagrant_dummy'     }
   let(:connection)      { double('connection') }
   let(:domain)          { double('domain') }
+  let(:logger)          { double('logger') }
 
   def connection_result(options = {})
     result = options.fetch(:result, nil)
@@ -25,6 +26,7 @@ shared_context 'libvirt' do
     # return some information for domain when needed
     allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
 
-    machine.stub(id: id)
+    allow(machine).to receive(:id).and_return(id)
+    allow(Log4r::Logger).to receive(:new).and_return(logger)
   end
 end

data/spec/support/sharedcontext.rb

@@ -3,10 +3,14 @@ require 'spec_helper'
 shared_context 'unit' do
   include_context 'vagrant-unit'
 
+  let(:vagrantfile_providerconfig) { '' }
   let(:vagrantfile) do
     <<-EOF
     Vagrant.configure('2') do |config|
       config.vm.define :test
+      config.vm.provider :libvirt do |libvirt|
+        #{vagrantfile_providerconfig}
+      end
     end
     EOF
   end
@@ -17,7 +21,7 @@ shared_context 'unit' do
   end
   let(:env)              { { env: iso_env, machine: machine, ui: ui, root_path: '/rootpath' } }
   let(:conf)             { Vagrant::Config::V2::DummyConfig.new }
-  let(:ui)               { Vagrant::UI::Basic.new }
+  let(:ui)               { Vagrant::UI::Silent.new }
   let(:iso_env)          { test_env.create_vagrant_env ui_class: Vagrant::UI::Basic }
   let(:machine)          { iso_env.machine(:test, :libvirt) }
   # Mock the communicator to prevent SSH commands for being executed.
@@ -28,7 +32,7 @@ shared_context 'unit' do
   let(:plugin)           { register_plugin }
 
   before (:each) do
-    machine.stub(guest: guest)
-    machine.stub(communicator: communicator)
+    allow(machine).to receive(:guest).and_return(guest)
+    allow(machine).to receive(:communicator).and_return(communicator)
   end
 end

data/spec/unit/action/create_domain_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/create_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:libvirt_client) { double('libvirt_client') }
+  let(:servers) { double('servers') }
+  let(:volumes) { double('volumes') }
+
+  let(:storage_pool_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), test_file)) }
+  let(:libvirt_storage_pool) { double('storage_pool') }
+
+  describe '#call' do
+    before do
+      allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
+        .to receive(:connection).and_return(connection)
+      allow(connection).to receive(:client).and_return(libvirt_client)
+
+      allow(connection).to receive(:servers).and_return(servers)
+      allow(connection).to receive(:volumes).and_return(volumes)
+
+      allow(logger).to receive(:info)
+
+      env[:domain_name] = "vagrant-test_default"
+
+      # should be ignored for system session and used for user session
+      allow(Process).to receive(:uid).and_return(9999)
+      allow(Process).to receive(:gid).and_return(9999)
+    end
+
+    context 'connection => qemu:///system' do
+      context 'default pool' do
+        let(:test_file) { 'default_system_storage_pool.xml' }
+
+        it 'should execute correctly' do
+          expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+          expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+          expect(servers).to receive(:create).and_return(machine)
+          expect(volumes).to_not receive(:create) # additional disks only
+
+          expect(subject.call(env)).to be_nil
+        end
+
+        context 'additional disks' do
+          let(:vagrantfile) do
+            <<-EOF
+            Vagrant.configure('2') do |config|
+              config.vm.define :test
+              config.vm.provider :libvirt do |libvirt|
+                libvirt.storage :file, :size => '20G'
+              end
+            end
+            EOF
+          end
+
+          context 'volume create failed' do
+            it 'should raise an exception' do
+              expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+              expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+              expect(volumes).to receive(:create).and_raise(Libvirt::Error)
+
+              expect{ subject.call(env) }.to raise_error(VagrantPlugins::ProviderLibvirt::Errors::FogCreateDomainVolumeError)
+            end
+          end
+
+          context 'volume create succeeded' do
+            it 'should complete' do
+              expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+              expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+              expect(volumes).to receive(:create).with(
+                hash_including(
+                  :path        => "/var/lib/libvirt/images/vagrant-test_default-vdb.qcow2",
+                  :owner       => 0,
+                  :group       => 0,
+                  :pool_name   => "default",
+                )
+              )
+              expect(servers).to receive(:create).and_return(machine)
+
+              expect(subject.call(env)).to be_nil
+            end
+          end
+        end
+      end
+
+      context 'no default pool' do
+        it 'should raise an exception' do
+          expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(nil)
+
+          expect{ subject.call(env) }.to raise_error(VagrantPlugins::ProviderLibvirt::Errors::NoStoragePool)
+        end
+      end
+    end
+
+    context 'connection => qemu:///session' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.define :test
+          config.vm.provider :libvirt do |libvirt|
+            libvirt.qemu_use_session = true
+          end
+        end
+        EOF
+      end
+
+      context 'default pool' do
+        let(:test_file) { 'default_user_storage_pool.xml' }
+
+        it 'should execute correctly' do
+          expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+          expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+          expect(servers).to receive(:create).and_return(machine)
+
+          expect(subject.call(env)).to be_nil
+        end
+
+        context 'additional disks' do
+          let(:vagrantfile) do
+            <<-EOF
+            Vagrant.configure('2') do |config|
+              config.vm.define :test
+              config.vm.provider :libvirt do |libvirt|
+                libvirt.qemu_use_session = true
+                libvirt.storage :file, :size => '20G'
+              end
+            end
+            EOF
+          end
+
+          context 'volume create succeeded' do
+            it 'should complete' do
+              expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+              expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+              expect(volumes).to receive(:create).with(
+                hash_including(
+                  :path        => "/var/lib/libvirt/images/vagrant-test_default-vdb.qcow2",
+                  :owner       => 9999,
+                  :group       => 9999,
+                  :pool_name   => "default",
+                )
+              )
+              expect(servers).to receive(:create).and_return(machine)
+
+              expect(subject.call(env)).to be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/action/create_domain_spec/default_system_storage_pool.xml

@@ -0,0 +1,17 @@
+<pool type='dir'>
+  <name>default</name>
+  <uuid>434e1b75-4a72-45d7-8a98-ebd90c125d22</uuid>
+  <capacity unit='bytes'>10737418240</capacity>
+  <allocation unit='bytes'>10737418240</allocation>
+  <available unit='bytes'>10737418240</available>
+  <source>
+  </source>
+  <target>
+    <path>/var/lib/libvirt/images</path>
+    <permissions>
+      <mode>0755</mode>
+      <owner>0</owner>
+      <group>0</group>
+    </permissions>
+  </target>
+</pool>

data/spec/unit/action/create_domain_spec/default_user_storage_pool.xml

@@ -0,0 +1,17 @@
+<pool type='dir'>
+  <name>default</name>
+  <uuid>434e1b75-4a72-45d7-8a98-ebd90c125d22</uuid>
+  <capacity unit='bytes'>10737418240</capacity>
+  <allocation unit='bytes'>10737418240</allocation>
+  <available unit='bytes'>10737418240</available>
+  <source>
+  </source>
+  <target>
+    <path>/var/lib/libvirt/images</path>
+    <permissions>
+      <mode>0755</mode>
+      <owner>0</owner>
+      <group>0</group>
+    </permissions>
+  </target>
+</pool>

data/spec/unit/action/destroy_domain_spec.rb

@@ -33,7 +33,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
       before do
         allow(libvirt_domain).to receive(:list_snapshots).and_return([])
         allow(libvirt_domain).to receive(:has_managed_save?).and_return(nil)
-        root_disk.stub(name: 'test.img')
+        allow(root_disk).to receive(:name).and_return('test.img')
       end
 
       context 'when only has root disk' do
@@ -57,7 +57,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
 
         let(:extra_disk) { double('libvirt_extra_disk') }
         before do
-          extra_disk.stub(name: 'test-vdb.qcow2')
+          allow(extra_disk).to receive(:name).and_return('test-vdb.qcow2')
         end
 
         it 'destroys disks individually' do

data/spec/unit/action/set_name_of_domain_spec.rb

@@ -10,12 +10,12 @@ describe VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain do
     dmn = VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain.new(Object.new, @env)
     first  = dmn.build_domain_name(@env)
     second = dmn.build_domain_name(@env)
-    first.should_not eq(second)
+    expect(first).to_not eq(second)
   end
 
   it 'builds simple domain name' do
     @env.default_prefix = 'pre_'
     dmn = VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain.new(Object.new, @env)
-    dmn.build_domain_name(@env).should eq('pre_')
+    expect(dmn.build_domain_name(@env)).to eq('pre_')
   end
 end

data/spec/unit/action/start_domain_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/start_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:libvirt_domain) { double('libvirt_domain') }
+  let(:libvirt_client) { double('libvirt_client') }
+  let(:servers) { double('servers') }
+
+  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)) }
+
+  describe '#call' do
+    before do
+      allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
+        .to receive(:connection).and_return(connection)
+      allow(connection).to receive(:client).and_return(libvirt_client)
+      allow(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+
+      allow(connection).to receive(:servers).and_return(servers)
+      allow(servers).to receive(:get).and_return(domain)
+
+      expect(logger).to receive(:info)
+      expect(ui).to_not receive(:error)
+    end
+
+    context 'default config' 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
+
+      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)
+
+        expect(subject.call(env)).to be_nil
+      end
+    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
+          <<-EOF
+          libvirt.tpm_path = '/dev/tpm0'
+          libvirt.tpm_type = 'passthrough'
+          libvirt.tpm_model = 'tpm-tis'
+          EOF
+        end
+
+        it 'should modify the domain tpm_path' do
+          expect(libvirt_domain).to receive(:undefine)
+          expect(logger).to receive(:debug).with('tpm config changed')
+          expect(servers).to receive(:create).with(xml: updated_domain_xml)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'emulated tpm added' do
+        let(:updated_test_file) { 'default_added_tpm_version.xml' }
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.tpm_type = 'emulator'
+          libvirt.tpm_model = 'tpm-crb'
+          libvirt.tpm_version = '2.0'
+          EOF
+        end
+
+        it 'should modify the domain tpm_path' do
+          expect(libvirt_domain).to receive(:undefine)
+          expect(logger).to receive(:debug).with('tpm config changed')
+          expect(servers).to receive(:create).with(xml: updated_domain_xml)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'same passthrough tpm config' do
+        let(:test_file) { 'default_added_tpm_path.xml' }
+        let(:updated_test_file) { 'default_added_tpm_path.xml' }
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.tpm_path = '/dev/tpm0'
+          libvirt.tpm_type = 'passthrough'
+          libvirt.tpm_model = 'tpm-tis'
+          EOF
+        end
+
+        it 'should execute without changing' do
+          expect(logger).to_not receive(:debug)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'same emulated tpm config' do
+        let(:test_file) { 'default_added_tpm_version.xml' }
+        let(:updated_test_file) { 'default_added_tpm_version.xml' }
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.tpm_type = 'emulator'
+          libvirt.tpm_model = 'tpm-crb'
+          libvirt.tpm_version = '2.0'
+          EOF
+        end
+
+        it 'should execute without changing' do
+          expect(logger).to_not receive(:debug)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'change from passthrough to emulated' do
+        let(:test_file) { 'default_added_tpm_path.xml' }
+        let(:updated_test_file) { 'default_added_tpm_version.xml' }
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.tpm_type = 'emulator'
+          libvirt.tpm_model = 'tpm-crb'
+          libvirt.tpm_version = '2.0'
+          EOF
+        end
+
+        it 'should modify the domain' do
+          expect(libvirt_domain).to receive(:undefine)
+          expect(logger).to receive(:debug).with('tpm config changed')
+          expect(servers).to receive(:create).with(xml: updated_domain_xml)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+
+    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
+          libvirt.clock_timer(:name => "rtc")
+          EOF
+        end
+
+        it 'should not modify the domain' do
+          expect(logger).to_not receive(:debug).with('clock timers config changed')
+          expect(servers).to_not receive(:create)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'timers added' do
+        let(:vagrantfile_providerconfig) do
+          <<-EOF
+          libvirt.clock_timer(:name => "rtc")
+          libvirt.clock_timer(:name => "tsc")
+          EOF
+        end
+
+        it 'should modify the domain' do
+          expect(libvirt_domain).to receive(:undefine)
+          expect(logger).to receive(:debug).with('clock timers config changed')
+          expect(servers).to receive(:create).with(xml: match(/<clock offset='utc'>\s*<timer name='rtc'\/>\s*<timer name='tsc'\/>\s*<\/clock>/))
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      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')
+          expect(servers).to receive(:create).with(xml: match(/<clock offset='utc'>\s*<\/clock>/))
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+  end
+end