vagrant-libvirt 0.7.0 → 0.8.0

data/lib/vagrant-libvirt/util/resolvers.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'log4r'
+
+require 'vagrant-libvirt/errors'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      class DiskDeviceResolver
+        attr_reader :existing
+
+        def initialize(prefix='vd')
+          @default_prefix = prefix
+
+          @device_indicies = Hash.new
+          @existing = Hash.new
+        end
+
+        def resolve!(disks, options={})
+          # check for duplicate device entries and raise an exception if one found
+          # with enough details that the user should be able to determine what
+          # to do to resolve.
+          disks.select { |x| !x[:device].nil? }.each do |x|
+            if @existing.has_key?(x[:device])
+              raise Errors::DuplicateDiskDevice, new_disk: x, existing_disk: @existing[x[:device]]
+            end
+
+            @existing[x[:device]] = x
+          end
+
+          disks.each_index do |index|
+            dev = disks[index][:device]
+            if dev.nil?
+              prefix = options.fetch(:prefix, @default_prefix)
+              dev = next_device(prefix=prefix)
+              if dev.nil?
+                raise Errors::NoDiskDeviceAvailable, prefix: prefix
+              end
+
+              disks[index][:device] = dev
+              @existing[dev] = disks[index]
+            end
+          end
+        end
+
+        def resolve(disks)
+          new_disks = []
+          disks.each do |disk|
+            new_disks.push disk.dup
+          end
+
+          resolve!(new_disks)
+
+          new_disks
+        end
+
+        private
+
+        def next_device(prefix)
+          curr = device_index(prefix)
+          while curr <= 'z'.ord
+            dev = prefix + curr.chr
+            if !@existing[dev].nil?
+              curr += 1
+              next
+            else
+              @device_indicies[prefix] = curr
+              return dev
+            end
+          end
+        end
+
+        def device_index(prefix)
+          @device_indicies[prefix] ||= 'a'.ord
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.7.0
+0.8.0

data/locales/en.yml

@@ -58,6 +58,17 @@ en:
     remove_stale_volume: |-
       Remove stale volume...
 
+    destroy:
+      obsolete_method: |
+        Destroying machine that was originally created without device aliases (pre 0.6.0), using fallback approach.
+      unexpected_volumes: |
+        Unexpected number of volumes detected, possibly additional volumes attached outside of vagrant-libvirt.
+        Attempting to handle this correctly, however may experience unexpected behaviour in the domain destroy.
+      expected_removal_mismatch: |
+        mismatch of volumes associated with box to number removed, may be stray box volumes left
+      box_metadata_unavailable: |
+        box metadata not available to get volume list during destroy, assuming inferred list
+
     warnings:
       ignoring_virtual_size_too_small: |-
         Ignoring requested virtual disk size of '%{requested}' as it is below
@@ -70,6 +81,8 @@ en:
     errors:
       call_chain_error: Invalid action chain, must ensure that '%{require_action}' is called prior to calling '%{current_action}'
       package_not_supported: No support for package with Libvirt. Create box manually.
+      duplicate_disk_device: Disk with details '%{new_disk}' duplicates :device attribute of disk '%{existing_disk}'
+      no_disk_device_available: All available devices allocated under '%{prefix}x', try a different type
       fog_error: |-
         There was an error talking to Libvirt. The error message is shown
         below:

data/spec/spec_helper.rb

@@ -1,36 +1,45 @@
 # frozen_string_literal: true
 
-require 'simplecov'
-require 'simplecov-lcov'
-
-# patch simplecov configuration
-if ! SimpleCov::Configuration.method_defined? :branch_coverage?
-  module SimpleCov
-    module Configuration
-      def branch_coverage?
-        return false
+# make simplecov optional
+begin
+  require 'simplecov'
+  require 'simplecov-lcov'
+
+  # patch simplecov configuration
+  if ! SimpleCov::Configuration.method_defined? :branch_coverage?
+    module SimpleCov
+      module Configuration
+        def branch_coverage?
+          return false
+        end
       end
     end
   end
-end
 
-SimpleCov::Formatter::LcovFormatter.config do |config|
-  config.report_with_single_file = true
-  config.single_report_path = 'coverage/lcov.info'
-end
+  SimpleCov::Formatter::LcovFormatter.config do |config|
+    config.report_with_single_file = true
+    config.single_report_path = 'coverage/lcov.info'
+  end
 
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
-  [
-    SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::LcovFormatter,
-  ]
-)
-SimpleCov.start do
-  add_filter 'spec/'
+  SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::LcovFormatter,
+    ]
+  )
+  SimpleCov.start do
+    add_filter 'spec/'
+  end
+rescue LoadError
+  TRUTHY_VALUES = %w(t true yes y 1).freeze
+  require_simplecov = ENV.fetch('VAGRANT_LIBVIRT_REQUIRE_SIMPLECOV', 'false').to_s.downcase
+  if TRUTHY_VALUES.include?(require_simplecov)
+    raise
+  end
 end
 
+
 require 'vagrant-libvirt'
-require 'support/environment_helper'
 require 'vagrant-spec/unit'
 
 Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
@@ -44,10 +53,6 @@ RSpec.configure do |config|
   end
 
   config.mock_with :rspec do |mocks|
-    # This option should be set when all dependencies are being loaded
-    # before a spec run, as is the case in a typical spec helper. It will
-    # cause any verifying double instantiation for a class that does not
-    # exist to raise, protecting against incorrectly spelt names.
-    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
   end
 end

data/spec/support/libvirt_context.rb

@@ -10,9 +10,9 @@ shared_context 'libvirt' do
   let(:libvirt_context) { true                      }
   let(:id)              { 'dummy-vagrant_dummy'     }
   let(:connection)      { double('connection') }
-  let(:domain)          { instance_double('::Fog::Libvirt::Compute::Server') }
-  let(:libvirt_client)  { instance_double('::Libvirt::Connect') }
-  let(:libvirt_domain)  { instance_double('::Libvirt::Domain') }
+  let(:domain)          { instance_double(::Fog::Libvirt::Compute::Server) }
+  let(:libvirt_client)  { instance_double(::Libvirt::Connect) }
+  let(:libvirt_domain)  { instance_double(::Libvirt::Domain) }
   let(:logger)          { double('logger') }
 
   def connection_result(options = {})

data/spec/unit/action/cleanup_on_failure_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant/action/runner'
+
+require 'vagrant-libvirt/action'
+require 'vagrant-libvirt/action/cleanup_on_failure'
+
+
+describe VagrantPlugins::ProviderLibvirt::Action::CleanupOnFailure do
+  subject { described_class }
+  let(:callable_error) do
+    Class.new do
+      def initialize(app, env)
+      end
+
+      def self.name
+        "TestAction"
+      end
+
+      def call(env)
+        raise Exception, "some action failed"
+      end
+    end
+  end
+
+  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)
+
+    allow(runner).to receive(:run).and_call_original
+    env[:action_runner] = runner
+    env[:destroy_on_error] = true
+  end
+
+  describe '#recover' do
+    let(:action_chain) do
+      Vagrant::Action::Builder.new.tap do |b|
+        b.use subject
+        b.use callable_error
+      end
+    end
+
+    context 'not created' do
+      before do
+        expect(state).to receive(:id).and_return(:not_created)
+      end
+
+      it 'should return early' do
+        expect(logger).to_not receive(:info).with('VM completed provider setup, no need to teardown')
+
+        expect { runner.run(action_chain) }.to raise_error(Exception, "some action failed")
+      end
+    end
+
+    context 'running' do
+      before do
+        allow(state).to receive(:id).and_return(:running)
+      end
+
+      it 'should destroy' do
+        expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_halt)
+        expect(VagrantPlugins::ProviderLibvirt::Action).to receive(:action_destroy).and_return(Vagrant::Action::Builder.new)
+        expect(logger).to_not receive(:info).with('VM completed provider setup, no need to teardown')
+
+        expect { runner.run(action_chain) }.to raise_error(Exception, "some action failed")
+      end
+
+      context 'halt on error enabled' do
+        before do
+          env[:halt_on_error] = true
+        end
+
+        it 'should halt' do
+          expect(VagrantPlugins::ProviderLibvirt::Action).to receive(:action_halt).and_return(Vagrant::Action::Builder.new)
+          expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_destroy)
+          expect(logger).to_not receive(:info).with('VM completed provider setup, no need to teardown')
+
+          expect { runner.run(action_chain) }.to raise_error(Exception, "some action failed")
+        end
+      end
+
+      context 'destroy on error disabled' do
+        before do
+          env[:destroy_on_error] = false
+        end
+
+        it 'should not destroy' do
+          expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_halt)
+          expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_destroy)
+          expect(logger).to_not receive(:info).with('VM completed provider setup, no need to teardown')
+
+          expect { runner.run(action_chain) }.to raise_error(Exception, "some action failed")
+        end
+      end
+
+      context 'completed setup' do
+        let(:action_chain) do
+          Vagrant::Action::Builder.new.tap do |b|
+            b.use subject
+            b.use VagrantPlugins::ProviderLibvirt::Action::SetupComplete
+            b.use callable_error
+          end
+        end
+
+        it 'should not perform halt or destroy' do
+          expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_halt)
+          expect(VagrantPlugins::ProviderLibvirt::Action).to_not receive(:action_destroy)
+          expect(logger).to receive(:debug).with('VM provider setup was completed, no need to halt/destroy')
+
+          expect { runner.run(action_chain) }.to raise_error(Exception, "some action failed")
+        end
+      end
+    end
+  end
+end

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

@@ -5,15 +5,11 @@
   <uuid></uuid>
   <memory>524288</memory>
   <vcpu>1</vcpu>
-
-
   <cpu mode='host-model'>
-      <model fallback='allow'></model>
+    <model fallback='allow'></model>
   </cpu>
-
-
   <os>
-        <type>hvm</type>
+    <type>hvm</type>
     <kernel></kernel>
     <initrd></initrd>
     <cmdline></cmdline>
@@ -38,24 +34,16 @@
       <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>
-
-
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'/>
+    </video>
   </devices>
-
 </domain>

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

@@ -0,0 +1,43 @@
+<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='sda' 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='16384' heads='1'/>
+    </video>
+  </devices>
+</domain>

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

@@ -5,15 +5,11 @@
   <uuid></uuid>
   <memory>524288</memory>
   <vcpu>1</vcpu>
-
-
   <cpu mode='host-model'>
-      <model fallback='allow'></model>
+    <model fallback='allow'></model>
   </cpu>
-
-
   <os>
-        <type>hvm</type>
+    <type>hvm</type>
     <kernel></kernel>
     <initrd></initrd>
     <cmdline></cmdline>
@@ -32,24 +28,16 @@
       <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>
-
-
+    <graphics type='vnc' port='-1' autoport='yes' listen='127.0.0.1' keymap='en-us'/>
+    <video>
+      <model type='cirrus' vram='16384' heads='1'/>
+    </video>
   </devices>
-
 </domain>

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

@@ -0,0 +1,49 @@
+<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-box-volume-1'/>
+      <driver name='qemu' type='qcow2' cache='default'/>
+      <source file='/var/lib/libvirt/images/vagrant-test_default_1.img'/>
+      <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='16384' heads='1'/>
+    </video>
+  </devices>
+</domain>

data/spec/unit/action/create_domain_spec.rb

@@ -4,6 +4,8 @@ require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
 
+require 'fog/libvirt/models/compute/volume'
+
 require 'vagrant-libvirt/errors'
 require 'vagrant-libvirt/util/byte_number'
 require 'vagrant-libvirt/action/create_domain'
@@ -14,10 +16,9 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
   include_context 'unit'
   include_context 'libvirt'
 
-  let(:libvirt_client) { double('libvirt_client') }
   let(:servers) { double('servers') }
   let(:volumes) { double('volumes') }
-  let(:domain_volume) { double('domain_volume') }
+  let(:domain_volume) { instance_double(::Fog::Libvirt::Compute::Volume) }
 
   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)) }
@@ -33,7 +34,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
       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' }
 
@@ -57,6 +57,10 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
     context 'connection => qemu:///system' do
       let(:domain_xml_file) { 'default_domain.xml' }
 
+      before do
+        allow(machine.provider_config).to receive(:qemu_use_session).and_return(false)
+      end
+
       context 'default pool' do
         it 'should execute correctly' do
           expect(servers).to receive(:create).with(xml: domain_xml).and_return(machine)
@@ -117,6 +121,48 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
             end
           end
         end
+
+        context 'with custom disk device setting' do
+          let(:domain_xml_file) { 'custom_disk_settings.xml' }
+          let(:vagrantfile_providerconfig) {
+            <<-EOF
+              libvirt.disk_device = 'sda'
+            EOF
+          }
+
+          it 'should set the domain device' do
+            expect(ui).to receive(:info).with(/ -- Image\(sda\):.*/)
+            expect(servers).to receive(:create).with(xml: domain_xml).and_return(machine)
+
+            expect(subject.call(env)).to be_nil
+          end
+        end
+
+        context 'with two domain disks' do
+          let(:domain_xml_file) { 'two_disk_settings.xml' }
+          let(:domain_volume_2) { double('domain_volume 2') }
+
+          before do
+            expect(volumes).to receive(:all).and_return([domain_volume])
+            expect(volumes).to receive(:all).and_return([domain_volume_2])
+            expect(domain_volume_2).to receive(:pool_name).and_return('default')
+            expect(domain_volume_2).to receive(:path).and_return('/var/lib/libvirt/images/vagrant-test_default_1.img')
+
+            env[:box_volumes].push({
+              :path=>"/test/box_1.img",
+              :name=>"test_vagrant_box_image_1.1.1_1.img",
+              :virtual_size=> ByteNumber.new(5),
+            })
+          end
+
+          it 'should correctly assign device entries' do
+            expect(ui).to receive(:info).with(/ -- Image\(vda\):.*/)
+            expect(ui).to receive(:info).with(/ -- Image\(vdb\):.*/)
+            expect(servers).to receive(:create).with(xml: domain_xml).and_return(machine)
+
+            expect(subject.call(env)).to be_nil
+          end
+        end
       end
 
       context 'no default pool' do
@@ -137,10 +183,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
     end
 
     context 'connection => qemu:///session' do
-      let(:vagrantfile_providerconfig) do
-        <<-EOF
-        libvirt.qemu_use_session = true
-        EOF
+      before do
+        allow(machine.provider_config).to receive(:qemu_use_session).and_return(true)
       end
 
       context 'default pool' do

data/spec/unit/action/create_domain_volume_spec.rb

@@ -4,6 +4,8 @@ require 'spec_helper'
 require 'support/sharedcontext'
 require 'support/libvirt_context'
 
+require 'fog/libvirt/models/compute/volume'
+
 require 'vagrant-libvirt/action/destroy_domain'
 require 'vagrant-libvirt/util/byte_number'
 
@@ -14,11 +16,9 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
   include_context 'unit'
   include_context 'libvirt'
 
-  let(:libvirt_domain) { double('libvirt_domain') }
-  let(:libvirt_client) { double('libvirt_client') }
   let(:volumes) { double('volumes') }
   let(:all) { double('all') }
-  let(:box_volume) { double('box_volume') }
+  let(:box_volume) { instance_double(::Fog::Libvirt::Compute::Volume) }
 
   def read_test_file(name)
     File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), name))
@@ -35,6 +35,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
       allow(box_volume).to receive(:id).and_return(nil)
       env[:domain_name] = 'test'
 
+      allow(machine.provider_config).to receive(:qemu_use_session).and_return(false)
+
       allow(logger).to receive(:debug)
     end