vagrant-libvirt 0.5.3 → 0.6.0

data/spec/unit/action/package_domain_spec.rb

@@ -0,0 +1,304 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant-libvirt/action/clean_machine_folder'
+
+describe VagrantPlugins::ProviderLibvirt::Action::PackageDomain do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+  include_context 'temporary_dir'
+
+  let(:libvirt_client) { double('libvirt_client') }
+  let(:libvirt_domain) { double('libvirt_domain') }
+  let(:servers) { double('servers') }
+  let(:volumes) { double('volumes') }
+  let(:metadata_file) { double('file') }
+  let(:vagrantfile_file) { double('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)
+
+      allow(connection).to receive(:volumes).and_return(volumes)
+
+      allow(logger).to receive(:info)
+
+      env["package.directory"] = temp_dir
+    end
+
+    context 'with defaults' do
+      let(:root_disk) { double('libvirt_domain_disk') }
+      before do
+        allow(root_disk).to receive(:name).and_return('default_domain.img')
+        allow(domain).to receive(:volumes).and_return([root_disk])
+        allow(libvirt_domain).to receive(:name).and_return('default_domain')
+        allow(subject).to receive(:download_image).and_return(true)
+      end
+
+      it 'should succeed' do
+        expect(ui).to receive(:info).with('Packaging domain...')
+        expect(ui).to receive(:info).with(/Downloading default_domain.img to .*\/box.img/)
+        expect(ui).to receive(:info).with('Image has backing image, copying image and rebasing ...')
+        expect(subject).to receive(:`).with(/qemu-img info .*\/box.img | grep 'backing file:' | cut -d ':' -f2/).and_return("some image")
+        expect(subject).to receive(:`).with(/qemu-img rebase -p -b "" .*\/box.img/)
+        expect(subject).to receive(:`).with(/virt-sysprep --no-logfile --operations .* -a .*\/box.img .*/)
+        expect(subject).to receive(:`).with(/virt-sparsify --in-place .*\/box.img/)
+        expect(subject).to receive(:`).with(/qemu-img info --output=json .*\/box.img/).and_return(
+          { 'virtual-size': 5*1024*1024*1024 }.to_json
+        )
+        expect(File).to receive(:write).with(
+          /.*\/metadata.json/,
+          <<-EOF.unindent
+          {
+            "provider": "libvirt",
+            "format": "qcow2",
+            "virtual_size": 5
+          }
+          EOF
+        )
+        expect(File).to receive(:write).with(/.*\/Vagrantfile/, /.*/)
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'with nil volume' do
+      let(:root_disk) { double('libvirt_domain_disk') }
+      before do
+        allow(root_disk).to receive(:name).and_return('default_domain.img')
+        allow(domain).to receive(:volumes).and_return([nil, root_disk])
+        allow(libvirt_domain).to receive(:name).and_return('default_domain')
+        allow(subject).to receive(:download_image).and_return(true)
+      end
+
+      it 'should succeed' do
+        expect(ui).to receive(:info).with('Packaging domain...')
+        expect(ui).to receive(:info).with(/Downloading default_domain.img to .*\/box.img/)
+        expect(ui).to receive(:info).with('Image has backing image, copying image and rebasing ...')
+        expect(subject).to receive(:`).with(/qemu-img info .*\/box.img | grep 'backing file:' | cut -d ':' -f2/).and_return("some image")
+        expect(subject).to receive(:`).with(/qemu-img rebase -p -b "" .*\/box.img/)
+        expect(subject).to receive(:`).with(/virt-sysprep --no-logfile --operations .* -a .*\/box.img .*/)
+        expect(subject).to receive(:`).with(/virt-sparsify --in-place .*\/box.img/)
+        expect(subject).to receive(:`).with(/qemu-img info --output=json .*\/box.img/).and_return(
+          { 'virtual-size': 5*1024*1024*1024 }.to_json
+        )
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'when detecting the format' do
+      let(:root_disk) { double('libvirt_domain_disk') }
+      let(:disk2) { double('libvirt_additional_disk') }
+      let(:fake_env) { Hash.new }
+
+      before do
+        allow(root_disk).to receive(:name).and_return('default_domain.img')
+        allow(disk2).to receive(:name).and_return('disk2.img')
+        allow(libvirt_domain).to receive(:name).and_return('default_domain')
+      end
+
+      context 'with two disks' do
+        before do
+          allow(domain).to receive(:volumes).and_return([root_disk, disk2])
+        end
+
+        it 'should emit a warning' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(ui).to receive(:warn).with(/Detected more than one volume for machine.*\n.*/)
+          expect(subject).to receive(:package_v1)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'with format set to v1' do
+        before do
+          allow(domain).to receive(:volumes).and_return([root_disk])
+          stub_const("ENV", fake_env)
+          fake_env['VAGRANT_LIBVIRT_BOX_FORMAT_VERSION'] = "v1"
+        end
+
+        it 'should call v1 packaging' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(subject).to receive(:package_v1)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'with format set to v2' do
+        before do
+          allow(domain).to receive(:volumes).and_return([root_disk])
+          stub_const("ENV", fake_env)
+          fake_env['VAGRANT_LIBVIRT_BOX_FORMAT_VERSION'] = "v2"
+        end
+
+        it 'should call v1 packaging' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(subject).to receive(:package_v2)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'with invalid format' do
+        before do
+          allow(domain).to receive(:volumes).and_return([root_disk])
+          stub_const("ENV", fake_env)
+          fake_env['VAGRANT_LIBVIRT_BOX_FORMAT_VERSION'] = "bad format"
+        end
+
+        it 'should emit a warning and default to v1' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(ui).to receive(:warn).with(/Unrecognized value for.*defaulting to v1/)
+          expect(subject).to receive(:package_v1)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+
+    context 'with v2 format' do
+      let(:disk1) { double('libvirt_domain_disk') }
+      let(:disk2) { double('libvirt_additional_disk') }
+      let(:fake_env) { Hash.new }
+
+      before do
+        allow(disk1).to receive(:name).and_return('default_domain.img')
+        allow(disk2).to receive(:name).and_return('disk2.img')
+        allow(libvirt_domain).to receive(:name).and_return('default_domain')
+        allow(subject).to receive(:download_image).and_return(true).twice()
+
+        stub_const("ENV", fake_env)
+        fake_env['VAGRANT_LIBVIRT_BOX_FORMAT_VERSION'] = "v2"
+      end
+
+      context 'with 2 disks' do
+        before do
+          allow(domain).to receive(:volumes).and_return([disk1, disk2])
+        end
+
+        it 'should succeed' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(ui).to receive(:info).with(/Downloading default_domain.img to .*\/box_1.img/)
+          expect(ui).to receive(:info).with('Image has backing image, copying image and rebasing ...')
+          expect(subject).to receive(:`).with(/qemu-img info .*\/box_1.img | grep 'backing file:' | cut -d ':' -f2/).and_return("some image")
+          expect(subject).to receive(:`).with(/qemu-img rebase -p -b "" .*\/box_1.img/)
+          expect(subject).to receive(:`).with(/virt-sysprep --no-logfile --operations .* -a .*\/box_1.img .*/)
+          expect(subject).to receive(:`).with(/virt-sparsify --in-place .*\/box_1.img/)
+          expect(ui).to receive(:info).with(/Downloading disk2.img to .*\/box_2.img/)
+          expect(ui).to receive(:info).with('Image has backing image, copying image and rebasing ...')
+          expect(subject).to receive(:`).with(/qemu-img info .*\/box_2.img | grep 'backing file:' | cut -d ':' -f2/).and_return("some image")
+          expect(subject).to receive(:`).with(/qemu-img rebase -p -b "" .*\/box_2.img/)
+          expect(subject).to receive(:`).with(/virt-sparsify --in-place .*\/box_2.img/)
+
+          expect(File).to receive(:write).with(
+            /.*\/metadata.json/,
+            <<-EOF.unindent.rstrip()
+            {
+              "provider": "libvirt",
+              "format": "qcow2",
+              "disks": [
+                {
+                  "path": "box_1.img"
+                },
+                {
+                  "path": "box_2.img"
+                }
+              ]
+            }
+            EOF
+          )
+          expect(File).to receive(:write).with(/.*\/Vagrantfile/, /.*/)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      context 'with 1 disk' do
+        before do
+          allow(domain).to receive(:volumes).and_return([disk1])
+        end
+
+        it 'should succeed' do
+          expect(ui).to receive(:info).with('Packaging domain...')
+          expect(ui).to receive(:info).with(/Downloading default_domain.img to .*\/box_1.img/)
+          expect(ui).to receive(:info).with('Image has backing image, copying image and rebasing ...')
+          expect(subject).to receive(:`).with(/qemu-img info .*\/box_1.img | grep 'backing file:' | cut -d ':' -f2/).and_return("some image")
+          expect(subject).to receive(:`).with(/qemu-img rebase -p -b "" .*\/box_1.img/)
+          expect(subject).to receive(:`).with(/virt-sysprep --no-logfile --operations .* -a .*\/box_1.img .*/)
+          expect(subject).to receive(:`).with(/virt-sparsify --in-place .*\/box_1.img/)
+
+          expect(File).to receive(:write).with(
+            /.*\/metadata.json/,
+            <<-EOF.unindent.rstrip()
+            {
+              "provider": "libvirt",
+              "format": "qcow2",
+              "disks": [
+                {
+                  "path": "box_1.img"
+                }
+              ]
+            }
+            EOF
+          )
+          expect(File).to receive(:write).with(/.*\/Vagrantfile/, /.*/)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+  end
+
+  describe '#vagrantfile_content' do
+    context 'with defaults' do
+      it 'should output expected content' do
+        expect(subject.vagrantfile_content(env)).to eq(
+          <<-EOF.unindent
+          Vagrant.configure("2") do |config|
+            config.vm.provider :libvirt do |libvirt|
+              libvirt.driver = "kvm"
+            end
+
+          end
+          EOF
+        )
+      end
+    end
+
+    context 'with custom user vagrantfile' do
+      before do
+        env["package.vagrantfile"] = "_Vagrantfile"
+      end
+      it 'should output Vagrantfile containing reference' do
+        expect(subject.vagrantfile_content(env)).to eq(
+          <<-EOF.unindent
+          Vagrant.configure("2") do |config|
+            config.vm.provider :libvirt do |libvirt|
+              libvirt.driver = "kvm"
+            end
+
+            # Load include vagrant file if it exists after the auto-generated
+            # so it can override any of the settings
+            include_vagrantfile = File.expand_path("../include/_Vagrantfile", __FILE__)
+            load include_vagrantfile if File.exist?(include_vagrantfile)
+
+          end
+          EOF
+        )
+      end
+    end
+  end
+end

data/spec/unit/action/set_name_of_domain_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain do

data/spec/unit/action/shutdown_domain_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+require 'vagrant-libvirt/action/shutdown_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
+  subject { described_class.new(app, env, target_state, current_state) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:driver) { double('driver') }
+  let(:libvirt_domain) { double('libvirt_domain') }
+  let(:servers) { double('servers') }
+  let(:current_state) { :running }
+  let(:target_state) { :shutoff }
+
+  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(connection).to receive(:servers).and_return(servers)
+      allow(servers).to receive(:get).and_return(domain)
+      allow(ui).to receive(:info).with('Attempting direct shutdown of domain...')
+    end
+
+    context "when state is shutoff" do
+      before do
+        allow(driver).to receive(:state).and_return(:shutoff)
+      end
+
+      it "should not shutdown" do
+        expect(domain).not_to receive(:shutoff)
+        subject.call(env)
+      end
+
+      it "should not print shutdown message" do
+        expect(ui).not_to receive(:info)
+        subject.call(env)
+      end
+
+      it "should provide a true result" do
+        subject.call(env)
+        expect(env[:result]).to be_truthy
+      end
+    end
+
+    context "when state is running" do
+      before do
+        allow(driver).to receive(:state).and_return(:running)
+      end
+
+      it "should shutdown" do
+        expect(domain).to receive(:wait_for)
+        expect(domain).to receive(:shutdown)
+        subject.call(env)
+      end
+
+      it "should print shutdown message" do
+        expect(domain).to receive(:wait_for)
+        expect(domain).to receive(:shutdown)
+        expect(ui).to receive(:info).with('Attempting direct shutdown of domain...')
+        subject.call(env)
+      end
+
+      context "when final state is not shutoff" do
+        before do
+          expect(driver).to receive(:state).and_return(:running).exactly(3).times
+          expect(domain).to receive(:wait_for)
+          expect(domain).to receive(:shutdown)
+        end
+
+        it "should provide a false result" do
+          subject.call(env)
+          expect(env[:result]).to be_falsey
+        end
+      end
+
+      context "when final state is shutoff" do
+        before do
+          expect(driver).to receive(:state).and_return(:running).exactly(2).times
+          expect(driver).to receive(:state).and_return(:shutoff).exactly(1).times
+          expect(domain).to receive(:wait_for)
+          expect(domain).to receive(:shutdown)
+        end
+
+        it "should provide a true result" do
+          subject.call(env)
+          expect(env[:result]).to be_truthy
+        end
+      end
+
+      context "when timeout exceeded" do
+        before do
+          expect(machine).to receive_message_chain('config.vm.graceful_halt_timeout').and_return(1)
+          expect(app).to receive(:call) { sleep 1.5 }
+          expect(driver).to receive(:state).and_return(:running).exactly(1).times
+          expect(domain).to_not receive(:wait_for)
+          expect(domain).to_not receive(:shutdown)
+        end
+
+        it "should provide a false result" do
+          subject.call(env)
+          expect(env[:result]).to be_falsey
+        end
+      end
+
+      context "when timeout not exceeded" do
+        before do
+          expect(machine).to receive_message_chain('config.vm.graceful_halt_timeout').and_return(2)
+          expect(app).to receive(:call) { sleep 1 }
+          expect(driver).to receive(:state).and_return(:running).exactly(3).times
+          expect(domain).to receive(:wait_for) do |time|
+            expect(time).to be < 1
+            expect(time).to be > 0
+          end
+          expect(domain).to receive(:shutdown)
+        end
+
+        it "should wait for the reduced time" do
+          subject.call(env)
+          expect(env[:result]).to be_falsey
+        end
+      end
+    end
+  end
+end

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'