vagrant-libvirt 0.5.0 → 0.6.0

data/spec/support/matchers/have_file_content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/expectations/version"
 #
 # Taken from https://github.com/cucumber/aruba/blob/main/lib/aruba/matchers/file/have_file_content.rb

data/spec/support/sharedcontext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_context 'unit' do
@@ -7,6 +9,7 @@ shared_context 'unit' do
   let(:vagrantfile) do
     <<-EOF
     Vagrant.configure('2') do |config|
+      config.vm.box = "vagrant-libvirt/test"
       config.vm.define :test
       config.vm.provider :libvirt do |libvirt|
         #{vagrantfile_providerconfig}

data/spec/support/temporary_dir.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+shared_context 'temporary_dir' do
+  around do |example|
+    Dir.mktmpdir("rspec-") do |dir|
+      @temp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :temp_dir
+end

data/spec/unit/action/clean_machine_folder_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 
@@ -9,12 +11,18 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
   include_context 'unit'
 
   describe '#call' do
+    before do
+      FileUtils.touch(File.join(machine.data_dir, "box.meta"))
+    end
+
     context 'with default options' do
       it 'should verbosely remove the folder' do
         expect(ui).to receive(:info).with('Deleting the machine folder')
-        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
 
         expect(subject.call(env)).to be_nil
+
+        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end
 
@@ -22,15 +30,17 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
       before do
         Dir.mktmpdir do |d|
           # returns a temporary directory that has been already deleted when running
-          expect(machine).to receive(:data_dir).and_return(d.to_s).exactly(2).times
+          expect(machine).to receive(:data_dir).and_return(d.to_s).exactly(3).times
         end
       end
 
       it 'should remove the folder' do
         expect(ui).to receive(:info).with('Deleting the machine folder')
-        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
 
         expect(subject.call(env)).to be_nil
+
+        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end
 
@@ -39,9 +49,11 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
 
       it 'should quietly remove the folder' do
         expect(ui).to_not receive(:info).with('Deleting the machine folder')
-        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
 
         expect(subject.call(env)).to be_nil
+
+        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end
   end

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

@@ -0,0 +1,61 @@
+<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
+  <name>vagrant-test_default</name>
+  <title></title>
+  <description>Source: /rootpath/Vagrantfile</description>
+  <uuid></uuid>
+  <memory>524288</memory>
+  <vcpu>1</vcpu>
+
+
+  <cpu mode='host-model'>
+      <model fallback='allow'></model>
+  </cpu>
+
+
+  <os>
+        <type>hvm</type>
+    <kernel></kernel>
+    <initrd></initrd>
+    <cmdline></cmdline>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'>
+  </clock>
+  <devices>
+    <disk type='file' device='disk'>
+      <alias name='ua-box-volume-0'/>
+      <driver name='qemu' type='qcow2' cache='default'/>
+      <source file='/var/lib/libvirt/images/vagrant-test_default.img'/>
+      <target dev='vda' bus='virtio'/>
+    </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/vagrant-test_default-vdb.qcow2'/>
+      <target dev='vdb' bus='virtio'/>
+    </disk>
+
+
+    <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>
+
+
+  </devices>
+
+</domain>

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

@@ -0,0 +1,55 @@
+<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
+  <name>vagrant-test_default</name>
+  <title></title>
+  <description>Source: /rootpath/Vagrantfile</description>
+  <uuid></uuid>
+  <memory>524288</memory>
+  <vcpu>1</vcpu>
+
+
+  <cpu mode='host-model'>
+      <model fallback='allow'></model>
+  </cpu>
+
+
+  <os>
+        <type>hvm</type>
+    <kernel></kernel>
+    <initrd></initrd>
+    <cmdline></cmdline>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'>
+  </clock>
+  <devices>
+    <disk type='file' device='disk'>
+      <alias name='ua-box-volume-0'/>
+      <driver name='qemu' type='qcow2' cache='default'/>
+      <source file='/var/lib/libvirt/images/vagrant-test_default.img'/>
+      <target dev='vda' bus='virtio'/>
+    </disk>
+
+
+    <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>
+
+
+  </devices>
+
+</domain>

data/spec/unit/action/create_domain_spec.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
 
 require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/util/byte_number'
 require 'vagrant-libvirt/action/create_domain'
 
 describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
@@ -14,8 +17,10 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
   let(:libvirt_client) { double('libvirt_client') }
   let(:servers) { double('servers') }
   let(:volumes) { double('volumes') }
+  let(:domain_volume) { double('domain_volume') }
 
-  let(:storage_pool_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), test_file)) }
+  let(:domain_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), domain_xml_file)) }
+  let(:storage_pool_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), storage_pool_xml_file)) }
   let(:libvirt_storage_pool) { double('storage_pool') }
 
   describe '#call' do
@@ -26,8 +31,15 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
 
       allow(connection).to receive(:servers).and_return(servers)
       allow(connection).to receive(:volumes).and_return(volumes)
+      allow(volumes).to receive(:all).and_return([domain_volume])
+      allow(domain_volume).to receive(:pool_name).and_return('default')
+      allow(domain_volume).to receive(:[]).with('name').and_return('vagrant-test_default.img')
+      allow(domain_volume).to receive(:path).and_return('/var/lib/libvirt/images/vagrant-test_default.img')
+      allow(machine).to receive_message_chain("box.name") { 'vagrant-libvirt/test' }
 
       allow(logger).to receive(:info)
+      allow(logger).to receive(:debug)
+      allow(ui).to receive(:info)
 
       env[:domain_name] = "vagrant-test_default"
 
@@ -35,7 +47,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
       env[:box_volumes].push({
         :path=>"/test/box.img",
         :name=>"test_vagrant_box_image_1.1.1_0.img", 
-        :virtual_size=>5
+        :virtual_size=> ByteNumber.new(5),
       })
       # should be ignored for system session and used for user session
       allow(Process).to receive(:uid).and_return(9999)
@@ -43,34 +55,44 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
     end
 
     context 'connection => qemu:///system' do
-      context 'default pool' do
-        let(:test_file) { 'default_system_storage_pool.xml' }
+      let(:domain_xml_file) { 'default_domain.xml' }
 
+      context 'default pool' do
         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(servers).to receive(:create).with(xml: domain_xml).and_return(machine)
           expect(volumes).to_not receive(:create) # additional disks only
 
           expect(subject.call(env)).to be_nil
         end
 
-        context 'additional disks' do
+        context 'with no box' do
+          let(:storage_pool_xml_file) { 'default_system_storage_pool.xml' }
           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
 
+          it 'should query for the storage pool path' 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
+        end
+
+        context 'additional disks' do
+          let(:vagrantfile_providerconfig) do
+            <<-EOF
+            libvirt.storage :file, :size => '20G'
+            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)
@@ -78,9 +100,9 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
           end
 
           context 'volume create succeeded' do
+            let(:domain_xml_file) { 'additional_disks_domain.xml' }
+
             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",
@@ -89,7 +111,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
                   :pool_name   => "default",
                 )
               )
-              expect(servers).to receive(:create).and_return(machine)
+              expect(servers).to receive(:create).with(xml: domain_xml).and_return(machine)
 
               expect(subject.call(env)).to be_nil
             end
@@ -98,6 +120,14 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
       end
 
       context 'no default pool' do
+        let(:vagrantfile) do
+          <<-EOF
+          Vagrant.configure('2') do |config|
+            config.vm.define :test
+          end
+          EOF
+        end
+
         it 'should raise an exception' do
           expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(nil)
 
@@ -107,45 +137,51 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
     end
 
     context 'connection => qemu:///session' do
-      let(:vagrantfile) do
+      let(:vagrantfile_providerconfig) do
         <<-EOF
-        Vagrant.configure('2') do |config|
-          config.vm.define :test
-          config.vm.provider :libvirt do |libvirt|
-            libvirt.qemu_use_session = true
-          end
-        end
+        libvirt.qemu_use_session = true
         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
+        context 'with no box' do
+          let(:storage_pool_xml_file) { 'default_user_storage_pool.xml' }
           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'
+                #{vagrantfile_providerconfig}
               end
             end
             EOF
           end
 
+          it 'should query for the storage pool path' 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
+        end
+
+        context 'additional disks' do
+          let(:vagrantfile_providerconfig) do
+            <<-EOF
+            libvirt.qemu_use_session = true
+            libvirt.storage :file, :size => '20G'
+            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",

data/spec/unit/action/create_domain_volume_spec/one_disk_in_storage.xml

@@ -1,6 +1,6 @@
 <volume>
   <name>test.img</name>
-  <capacity unit="G">5</capacity>
+  <capacity unit="B">5368709120</capacity>
   <target>
     <format type="qcow2"></format>
     <permissions>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_0.xml

@@ -1,6 +1,6 @@
 <volume>
   <name>test.img</name>
-  <capacity unit="G">5</capacity>
+  <capacity unit="B">5368709120</capacity>
   <target>
     <format type="qcow2"></format>
     <permissions>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_1.xml

@@ -1,6 +1,6 @@
 <volume>
   <name>test_1.img</name>
-  <capacity unit="G">10</capacity>
+  <capacity unit="B">10737423360</capacity>
   <target>
     <format type="qcow2"></format>
     <permissions>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_2.xml

@@ -1,6 +1,6 @@
 <volume>
   <name>test_2.img</name>
-  <capacity unit="G">20</capacity>
+  <capacity unit="B">21474836480</capacity>
   <target>
     <format type="qcow2"></format>
     <permissions>

data/spec/unit/action/create_domain_volume_spec.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
 
 require 'vagrant-libvirt/action/destroy_domain'
+require 'vagrant-libvirt/util/byte_number'
+
 
 describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
   subject { described_class.new(app, env) }
@@ -30,6 +34,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
       allow(all).to receive(:first).and_return(box_volume)
       allow(box_volume).to receive(:id).and_return(nil)
       env[:domain_name] = 'test'
+
+      allow(logger).to receive(:debug)
     end
 
     context 'when one disk' do
@@ -38,7 +44,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
         env[:box_volumes] = [
           {
             :name=>"test_vagrant_box_image_1.1.1_0.img",
-            :virtual_size=>5
+            :virtual_size=>ByteNumber.new(5368709120)
           }
         ]
       end
@@ -65,15 +71,15 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
         env[:box_volumes] = [
           {
             :name=>"test_vagrant_box_image_1.1.1_0.img",
-            :virtual_size=>5
+            :virtual_size=>ByteNumber.new(5368709120)
           },
           {
             :name=>"test_vagrant_box_image_1.1.1_1.img",
-            :virtual_size=>10
+            :virtual_size=>ByteNumber.new(10737423360)
           },
           {
             :name=>"test_vagrant_box_image_1.1.1_2.img",
-            :virtual_size=>20
+            :virtual_size=>ByteNumber.new(21474836480)
           }
         ]
       end

data/spec/unit/action/destroy_domain_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
@@ -10,14 +12,18 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
   include_context 'unit'
   include_context 'libvirt'
 
+  let(:driver) { double('driver') }
   let(:libvirt_domain) { double('libvirt_domain') }
   let(:libvirt_client) { double('libvirt_client') }
   let(:servers) { double('servers') }
 
+  before do
+    allow(machine.provider).to receive('driver').and_return(driver)
+    allow(driver).to receive(:connection).and_return(connection)
+  end
+
   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)

data/spec/unit/action/forward_ports_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'

data/spec/unit/action/halt_domain_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
-require 'vagrant-libvirt/action/destroy_domain'
+require 'vagrant-libvirt/action/halt_domain'
 
 describe VagrantPlugins::ProviderLibvirt::Action::HaltDomain do
   subject { described_class.new(app, env) }
@@ -9,81 +11,52 @@ describe VagrantPlugins::ProviderLibvirt::Action::HaltDomain do
   include_context 'unit'
   include_context 'libvirt'
 
+  let(:driver) { double('driver') }
   let(:libvirt_domain) { double('libvirt_domain') }
   let(:servers) { double('servers') }
 
+  before do
+    allow(machine.provider).to receive('driver').and_return(driver)
+    allow(driver).to receive(:created?).and_return(true)
+    allow(driver).to receive(:connection).and_return(connection)
+  end
+
   describe '#call' do
     before do
-      allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
-        .to receive(:connection).and_return(connection)
       allow(connection).to receive(:servers).and_return(servers)
       allow(servers).to receive(:get).and_return(domain)
-      # always see this at the start of #call
-      expect(ui).to receive(:info).with('Halting domain...')
+      allow(ui).to receive(:info).with('Halting domain...')
     end
 
-    context 'with graceful timeout' do
-      it "should shutdown" do
-        expect(guest).to receive(:capability).with(:halt).and_return(true)
-        expect(domain).to receive(:wait_for).with(60).and_return(false)
-        expect(subject.call(env)).to be_nil
-      end
-
-      context 'when halt fails' do
-        before do
-          expect(logger).to receive(:info).with('Trying Libvirt graceful shutdown.')
-          expect(guest).to receive(:capability).with(:halt).and_raise(IOError)
-          expect(domain).to receive(:state).and_return('running')
-        end
+    context "when state is not running" do
+      before { expect(driver).to receive(:state).at_least(1).
+          and_return(:not_created) }
 
-        it "should call shutdown" do
-          expect(domain).to receive(:shutdown)
-          expect(domain).to receive(:wait_for).with(60).and_return(false)
-          expect(subject.call(env)).to be_nil
-        end
-
-        context 'when shutdown fails' do
-          it "should call power off" do
-            expect(logger).to receive(:error).with('Failed to shutdown cleanly. Calling force poweroff.')
-            expect(domain).to receive(:shutdown).and_raise(IOError)
-            expect(domain).to receive(:poweroff)
-            expect(subject.call(env)).to be_nil
-          end
-        end
-
-        context 'when shutdown exceeds the timeout' do
-          it "should call poweroff" do
-            expect(logger).to receive(:info).with('VM is still running. Calling force poweroff.')
-            expect(domain).to receive(:shutdown).and_raise(Timeout::Error)
-            expect(domain).to receive(:poweroff)
-            expect(subject.call(env)).to be_nil
-          end
-        end
+      it "should not poweroff when state is not running" do
+        expect(domain).not_to receive(:poweroff)
+        subject.call(env)
       end
 
-      context 'when halt exceeds the timeout' do
-        before do
-          expect(logger).to_not receive(:info).with('Trying Libvirt graceful shutdown.')
-          expect(guest).to receive(:capability).with(:halt).and_raise(Timeout::Error)
-        end
-
-        it "should call poweroff" do
-          expect(logger).to receive(:info).with('VM is still running. Calling force poweroff.')
-          expect(domain).to receive(:poweroff)
-          expect(subject.call(env)).to be_nil
-        end
+      it "should not print halting message" do
+        expect(ui).not_to receive(:info)
+        subject.call(env)
       end
     end
 
-    context 'with force halt enabled' do
+    context "when state is running" do
       before do
-        allow(env).to receive(:[]).and_call_original
-        expect(env).to receive(:[]).with(:force_halt).and_return(true)
+        expect(driver).to receive(:state).and_return(:running)
       end
 
-      it "should just call poweroff" do
+      it "should poweroff" do
         expect(domain).to receive(:poweroff)
-        expect(subject.call(env)).to be_nil
+        subject.call(env)
+      end
+
+      it "should print halting message" do
+        allow(domain).to receive(:poweroff)
+        expect(ui).to receive(:info).with('Halting domain...')
+        subject.call(env)
       end
     end
   end