vagrant-libvirt 0.6.0 → 0.7.0

data/lib/vagrant-libvirt/errors.rb

@@ -9,6 +9,10 @@ module VagrantPlugins
         error_namespace('vagrant_libvirt.errors')
       end
 
+      class CallChainError < VagrantLibvirtError
+        error_key(:call_chain_error)
+      end
+
       # package not supported
       class PackageNotSupported < VagrantLibvirtError
         error_key(:package_not_supported)
@@ -177,6 +181,10 @@ module VagrantPlugins
       class DeleteSnapshotError < VagrantLibvirtError
         error_key(:delete_snapshot_error)
       end
+
+      class SerialCannotCreatePathError < VagrantLibvirtError
+        error_key(:serial_cannot_create_path_error)
+      end
     end
   end
 end

data/lib/vagrant-libvirt/templates/domain.xml.erb

@@ -162,10 +162,19 @@
     </disk>
 <% end %>
 
-    <serial type='pty'>
-      <target port='0'/>
+<% @serials.each_with_index do |serial, port| %>
+    <serial type='<%= serial[:type] %>'>
+      <% unless serial[:source].nil? %>
+      <source path='<%= serial[:source][:path] %>'/>
+      <% end %>
+      <target port='<%= port %>'/>
     </serial>
-    <console type='pty'>
+    <% end %>
+    <% console_log = @serials.first %>
+    <console type='<%= console_log[:type] %>'>
+      <% unless console_log[:source].nil? %>
+      <source path='<%= console_log[:source][:path] %>'/>
+<% end %>
       <target port='0'/>
     </console>
 
@@ -207,9 +216,13 @@
     <% end %>
     <% if @graphics_type != 'none' %>
       <%# Video device -%>
-      <graphics type='<%= @graphics_type %>' port='<%= @graphics_port %>' autoport='<%= @graphics_autoport %>' listen='<%= @graphics_ip %>' keymap='<%= @keymap %>' <%= @graphics_passwd%> />
+      <graphics type='<%= @graphics_type %>' port='<%= @graphics_port %>' autoport='<%= @graphics_autoport %>' listen='<%= @graphics_ip %>' keymap='<%= @keymap %>' <%= @graphics_passwd %> <% if not @graphics_gl %>/><% else %>>
+        <gl enable='yes' />
+      </graphics><% end %>
       <video>
-        <model type='<%= @video_type %>' vram='<%= @video_vram %>' heads='1'/>
+        <model type='<%= @video_type %>' vram='<%= @video_vram %>' heads='1'<% if not @video_accel3d %>/><% else %>>
+          <acceleration accel3d='yes'/>
+        </model><% end %>
       </video>
       <%#End Video -%>
     <% end %>

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

@@ -119,7 +119,8 @@ module VagrantPlugins
                             IPAddr.new(options[:network_address]).get_mask :
                             '255.255.255.0',
               dhcp_enabled: true,
-              forward_mode: 'nat'
+              forward_mode: 'nat',
+              always_destroy: true
             }.merge(options)
 
             if options[:type].to_s == 'dhcp' && options[:ip].nil?

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'vagrant/action/builtin/mixin_synced_folders'
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.6.0
+0.7.0

data/locales/en.yml

@@ -15,6 +15,10 @@ en:
     manual_resize_required: |-
       Created volume larger than box defaults, will require manual resizing of
       filesystems to utilize.
+    box_version_missing: |-
+      No verison detected for %{name}, using timestamp to watch for modifications. Consider
+      generating a local metadata for the box with a version to allow better handling.
+      See https://www.vagrantup.com/docs/boxes/format#box-metadata for further details.
     uploading_volume: |-
       Uploading base box image as volume into Libvirt storage...
     creating_domain_volume: |-
@@ -60,8 +64,11 @@ en:
         the minimum box image size of '%{minimum}'.
       forwarding_udp: |-
         Forwarding UDP ports is not supported. Ignoring.
+      creating_domain_console_access_disabled: |-
+        Serial console is being redirected, access via virsh will be disabled.
 
     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.
       fog_error: |-
         There was an error talking to Libvirt. The error message is shown
@@ -161,6 +168,8 @@ en:
       management_network_required: |-
         Management network can't be disabled when VM use box.
         Please fix your configuration and run vagrant again.
+      serial_cannot_create_path_error: |-
+        Error creating path for serial port output log: %{path}
 
     states:
       paused: |-

data/spec/spec_helper.rb

@@ -42,4 +42,12 @@ RSpec.configure do |config|
   config.before(:suite) do
     ENV.delete('LIBVIRT_DEFAULT_URI')
   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
+  end
 end

data/spec/support/libvirt_context.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'fog/libvirt'
+require 'fog/libvirt/models/compute/server'
+require 'libvirt'
 
 shared_context 'libvirt' do
   include_context 'unit'
@@ -8,7 +10,9 @@ shared_context 'libvirt' do
   let(:libvirt_context) { true                      }
   let(:id)              { 'dummy-vagrant_dummy'     }
   let(:connection)      { double('connection') }
-  let(:domain)          { double('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 = {})
@@ -22,11 +26,10 @@ shared_context 'libvirt' do
     stub_const('::Fog::Compute', connection)
 
     # drivers also call vm_exists? during init;
-    allow(connection).to receive(:servers).with(kind_of(String))
+    allow(connection).to receive(:servers)
       .and_return(connection_result(result: nil))
 
-    # return some information for domain when needed
-    allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
+    allow(connection).to receive(:client).and_return(libvirt_client)
 
     allow(machine).to receive(:id).and_return(id)
     allow(Log4r::Logger).to receive(:new).and_return(logger)

data/spec/support/sharedcontext.rb

@@ -36,6 +36,6 @@ shared_context 'unit' do
 
   before (:each) do
     allow(machine).to receive(:guest).and_return(guest)
-    allow(machine).to receive(:communicator).and_return(communicator)
+    allow(machine).to receive(:communicate).and_return(communicator)
   end
 end

data/spec/unit/action/handle_box_image_spec.rb

@@ -98,6 +98,36 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
         )
       end
 
+      context 'when no box version set' do
+        let(:box_mtime) { Time.now }
+
+        before do
+          expect(env[:machine]).to receive_message_chain("box.version") { nil }
+          expect(File).to receive(:mtime).and_return(box_mtime)
+        end
+
+        it 'should use the box file timestamp' do
+          expect(ui).to receive(:warn).with(
+            "No verison detected for test, using timestamp to watch for modifications. Consider\n" +
+            "generating a local metadata for the box with a version to allow better handling.\n" +
+            'See https://www.vagrantup.com/docs/boxes/format#box-metadata for further details.'
+          )
+
+          expect(subject.call(env)).to be_nil
+          expect(env[:box_volume_number]).to eq(1)
+          expect(env[:box_volumes]).to eq(
+            [
+              {
+                :path=>"/test/box.img",
+                :name=>"test_vagrant_box_image_0_#{box_mtime.to_i}_box.img",
+                :virtual_size=>byte_number_5G,
+                :format=>"qcow2"
+              }
+            ]
+          )
+        end
+      end
+
       context 'When config.machine_virtual_size is set and smaller than box_virtual_size' do
         before do
           allow(env[:machine]).to receive_message_chain("provider_config.machine_virtual_size").and_return(1)

data/spec/unit/action/prepare_nfs_settings_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant-libvirt/action/prepare_nfs_settings'
+
+
+describe VagrantPlugins::ProviderLibvirt::Action::PrepareNFSSettings do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+
+  describe '#call' do
+    before do
+      # avoid requiring nfsd installed to run tests
+      allow(machine.env.host).to receive(:capability?).with(:nfs_installed).and_return(true)
+      allow(machine.env.host).to receive(:capability).with(:nfs_installed).and_return(true)
+    end
+
+    context 'when enabled' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.box = "vagrant-libvirt/test"
+          config.vm.define :test
+          config.vm.synced_folder ".", "/vagrant", type: "nfs"
+          config.vm.provider :libvirt do |libvirt|
+            #{vagrantfile_providerconfig}
+          end
+        end
+        EOF
+      end
+      let(:socket) { double('socket') }
+
+      before do
+        allow(::TCPSocket).to receive(:new).and_return(socket)
+        allow(socket).to receive(:close)
+      end
+
+      it 'should retrieve the guest IP address' do
+        times_called = 0
+        expect(::TCPSocket).to receive(:new) do
+          # force reaching later code
+          times_called += 1
+          times_called < 2 ? raise("StandardError") : socket
+        end
+        expect(machine).to receive(:ssh_info).and_return({:host => '192.168.1.2'})
+        expect(communicator).to receive(:execute).and_yield(:stdout, "192.168.1.2\n192.168.2.2")
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/action/shutdown_domain_spec.rb

@@ -3,6 +3,20 @@ require 'support/sharedcontext'
 require 'support/libvirt_context'
 require 'vagrant-libvirt/action/shutdown_domain'
 
+describe VagrantPlugins::ProviderLibvirt::Action::StartShutdownTimer do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+
+  describe '#call' do
+    it 'should set shutdown_start_time' do
+      expect(env[:shutdown_start_time]).to eq(nil)
+      expect(subject.call(env)).to eq(nil)
+      expect(env[:shutdown_start_time]).to_not eq(nil)
+    end
+  end
+end
+
 describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
   subject { described_class.new(app, env, target_state, current_state) }
 
@@ -26,6 +40,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain 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...')
+      allow(env).to receive(:[]).and_call_original
+      allow(env).to receive(:[]).with(:shutdown_start_time).and_return(Time.now)
     end
 
     context "when state is shutoff" do
@@ -34,7 +50,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
       end
 
       it "should not shutdown" do
-        expect(domain).not_to receive(:shutoff)
+        expect(domain).not_to receive(:poweroff)
         subject.call(env)
       end
 
@@ -97,7 +113,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
       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(Time).to receive(:now).and_return(env[:shutdown_start_time] + 2)
           expect(driver).to receive(:state).and_return(:running).exactly(1).times
           expect(domain).to_not receive(:wait_for)
           expect(domain).to_not receive(:shutdown)
@@ -112,7 +128,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
       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(Time).to receive(:now).and_return(env[:shutdown_start_time] + 1.5)
           expect(driver).to receive(:state).and_return(:running).exactly(3).times
           expect(domain).to receive(:wait_for) do |time|
             expect(time).to be < 1
@@ -127,5 +143,18 @@ describe VagrantPlugins::ProviderLibvirt::Action::ShutdownDomain do
         end
       end
     end
+
+    context "when required action not run" do
+      before do
+        expect(env).to receive(:[]).with(:shutdown_start_time).and_call_original
+      end
+
+      it "should raise an exception" do
+        expect { subject.call(env) }.to raise_error(
+          VagrantPlugins::ProviderLibvirt::Errors::CallChainError,
+          /Invalid action chain, must ensure that '.*ShutdownTimer' is called prior to calling '.*ShutdownDomain'/
+        )
+      end
+    end
   end
 end

data/spec/unit/action/wait_till_up_spec.rb

@@ -22,6 +22,8 @@ describe VagrantPlugins::ProviderLibvirt::Action::WaitTillUp do
         .and_return(driver)
       allow(driver).to receive(:get_domain).and_return(domain)
       allow(driver).to receive(:state).and_return(:running)
+      # return some information for domain when needed
+      allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
     end
 
     context 'when machine does not exist' do
@@ -62,7 +64,6 @@ describe VagrantPlugins::ProviderLibvirt::Action::WaitTillUp do
           expect(app).to_not receive(:call)
           expect(ui).to receive(:info).with('Waiting for domain to get an IP address...')
           expect(ui).to_not receive(:info).with('Waiting for SSH to become available...')
-          expect(env[:machine].communicate).to_not receive(:ready?)
           expect {subject.call(env) }.to raise_error(::Fog::Errors::TimeoutError)
         end
       end

data/spec/unit/action_spec.rb

@@ -93,4 +93,82 @@ describe VagrantPlugins::ProviderLibvirt::Action do
       end
     end
   end
+
+  describe '#action_ssh' do
+    context 'when not created' do
+      before do
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsCreated, false)
+      end
+
+      it 'should cause an error' do
+        expect{ machine.action(:ssh, ssh_opts: {})}.to raise_error(Vagrant::Errors::VMNotCreatedError)
+      end
+    end
+
+    context 'when created' do
+      before do
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsCreated, true)
+      end
+
+      context 'when not running' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, false)
+        end
+
+        it 'should cause an error' do
+          expect{ machine.action(:ssh, ssh_opts: {})}.to raise_error(Vagrant::Errors::VMNotRunningError)
+        end
+      end
+
+      context 'when running' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, true)
+        end
+
+        it 'should call SSHExec' do
+          expect_any_instance_of(Vagrant::Action::Builtin::SSHExec).to receive(:call).and_return(0)
+          expect(machine.action(:ssh, ssh_opts: {})).to match(hash_including({:action_name => :machine_action_ssh}))
+        end
+      end
+    end
+  end
+
+  describe '#action_ssh_run' do
+    context 'when not created' do
+      before do
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsCreated, false)
+      end
+
+      it 'should cause an error' do
+        expect{ machine.action(:ssh_run, ssh_opts: {})}.to raise_error(Vagrant::Errors::VMNotCreatedError)
+      end
+    end
+
+    context 'when created' do
+      before do
+        allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsCreated, true)
+      end
+
+      context 'when not running' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, false)
+        end
+
+        it 'should cause an error' do
+          expect{ machine.action(:ssh_run, ssh_opts: {})}.to raise_error(Vagrant::Errors::VMNotRunningError)
+        end
+      end
+
+      context 'when running' do
+        before do
+          allow_action_env_result(VagrantPlugins::ProviderLibvirt::Action::IsRunning, true)
+        end
+
+        it 'should call SSHRun' do
+          expect_any_instance_of(Vagrant::Action::Builtin::SSHRun).to receive(:call).and_return(0)
+          expect(machine.action(:ssh_run, ssh_opts: {})).to match(hash_including({:action_name => :machine_action_ssh_run}))
+        end
+      end
+    end
+  end
 end

data/spec/unit/config_spec.rb

@@ -338,6 +338,54 @@ describe VagrantPlugins::ProviderLibvirt::Config do
       end
     end
 
+    context '@system_uri' do
+      [
+        # system uri
+        [ # transport and hostname
+          {:uri => "qemu+ssh://localhost/session"},
+          {:uri => "qemu+ssh://localhost/session", :system_uri => "qemu+ssh://localhost/system"},
+        ],
+        [ # explicitly set
+          {:qemu_use_session => true, :system_uri => "custom://remote/system"},
+          {:uri => "qemu:///session", :system_uri => "custom://remote/system"},
+        ],
+      ].each do |inputs, outputs, options|
+        opts = {}
+        opts.merge!(options) if options
+
+        it "should handle inputs #{inputs} with env (#{opts[:env]})" do
+          # allow some of these to fail for now if marked as such
+          if !opts[:allow_failure].nil?
+            pending(opts[:allow_failure])
+          end
+
+          if !opts[:setup].nil?
+            opts[:setup].apply_binding(binding)
+          end
+
+          inputs.each do |k, v|
+            subject.instance_variable_set("@#{k}", v)
+          end
+
+          if !opts[:env].nil?
+            opts[:env].each do |k, v|
+              fake_env[k] = v
+            end
+          end
+
+          subject.finalize!
+
+          # ensure failed output indicates which settings are incorrect in the failed test
+          got = subject.instance_variables.each_with_object({}) do |name, hash|
+            if outputs.key?(name.to_s[1..-1].to_sym)
+              hash["#{name.to_s[1..-1]}".to_sym] =subject.instance_variable_get(name)
+            end
+          end
+          expect(got).to eq(outputs)
+        end
+      end
+    end
+
     context '@proxy_command' do
       before(:example) do
         stub_const("ENV", fake_env)