vagrant-libvirt 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e37a27120aef75fdd73d704321b96c7c881b07fa3cbdd655855300bf11163a3
-  data.tar.gz: 4639827cc360b3f06304310f02dffea445f19d2f4b8675a6e0e05a9be3cea307
+  metadata.gz: d4e3e0061bb4ad5e0450c7707ce5e87d218b5c02420b9ba6d2f8c2f92760e247
+  data.tar.gz: ef229d196674e1e9771775eb917d3091b84853633356c1244a81be88f05d0a08
 SHA512:
-  metadata.gz: cb13d39445a95f3514cc1be73bcf6e81ec7924959ec86e6cc712c50050ac8211f6b5beb26bbd42c137020e98143794d7b67aa7241e2461cdf2d1ca5ed2a15c30
-  data.tar.gz: b341135cabad7d59963df62e9dd921470a43e4794fb203ff78b893bd058a38af877717f48b25a72135211e72d82082ec444227b97157e365903103240dfb1311
+  metadata.gz: 1067ed32c578df57810c451e95239c9e8d3e5dd8ef96719dd1cb835ff91e906357d391794ac9d0d300133c5b98bfe096b74f230d040f4a289275c28d459e933a
+  data.tar.gz: fcf09c0a02a054fbc10374361f69169c9a68434b4146473d7c3e150b813aa69e4172b9c5aad103124c2f3198f80f10a5ac0f59bd14d11458247851775dd5f2e9

data/lib/vagrant-libvirt/action/shutdown_domain.rb

@@ -1,5 +1,24 @@
 require 'log4r'
 
+module VagrantPlugins
+  module ProviderLibvirt
+    module Action
+      # To wrap GracefulShutdown need to track the time taken
+      class StartShutdownTimer
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          env[:shutdown_start_time] = Time.now
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end
+
 module VagrantPlugins
   module ProviderLibvirt
     module Action
@@ -15,21 +34,22 @@ module VagrantPlugins
         def call(env)
           timeout = env[:machine].config.vm.graceful_halt_timeout
 
-          start_time = Time.now
+          start_time = env[:shutdown_start_time]
 
-          # call nested action first under the assumption it should try to
-          # handle shutdown via client capabilities
-          @app.call(env)
+          if start_time.nil?
+            # this really shouldn't happen
+            raise Errors::CallChainError, require_action: StartShutdownTimer.name, current_action: ShutdownDomain.name
+          end
 
           # return if successful, otherwise will ensure result is set to false
           env[:result] = env[:machine].state.id == @target_state
 
-          return if env[:result]
+          return @app.call(env) if env[:result]
 
           current_time = Time.now
 
           # if we've already exceeded the timeout
-          return if current_time - start_time >= timeout
+          return @app.call(env) if current_time - start_time >= timeout
 
           # otherwise construct a new timeout.
           timeout = timeout - (current_time - start_time)
@@ -42,6 +62,8 @@ module VagrantPlugins
           end
 
           env[:result] = env[:machine].state.id == @target_state
+
+          @app.call(env)
         end
       end
     end

data/lib/vagrant-libvirt/action.rb

@@ -143,19 +143,17 @@ module VagrantPlugins
             b2.use Call, IsRunning do |env2, b3|
               next unless env2[:result]
 
-              b3.use Call, Message, "Attempting nice shutdowns..." do |_, b4|
-                # ShutdownDomain will perform the domain shutdown on the out calls
-                # so it runs after the remaining actions in the same action builder.
-                b4.use ShutdownDomain, :shutoff, :running
-                b4.use GracefulHalt, :shutoff, :running
+              b3.use StartShutdownTimer
+              b3.use Call, GracefulHalt, :shutoff, :running do |env3, b4|
+                if !env3[:result]
+                  b4.use Call, ShutdownDomain, :shutoff, :running do |env4, b5|
+                    if !env4[:result]
+                       b5.use HaltDomain
+                    end
+                  end
+                end
               end
 
-              # Only force halt if previous actions insufficient.
-              b3.use Call, IsRunning do |env3, b4|
-                next unless env3[:result]
-
-                b4.use HaltDomain
-              end
             end
           end
         end
@@ -360,6 +358,7 @@ module VagrantPlugins
       autoload :ForwardPorts, action_root.join('forward_ports')
       autoload :ClearForwardedPorts, action_root.join('forward_ports')
       autoload :HaltDomain, action_root.join('halt_domain')
+      autoload :StartShutdownTimer, action_root.join('shutdown_domain')
       autoload :ShutdownDomain, action_root.join('shutdown_domain')
       autoload :HandleBoxImage, action_root.join('handle_box_image')
       autoload :HandleStoragePool, action_root.join('handle_storage_pool')

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)

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.6.0
+0.6.1

data/locales/en.yml

@@ -62,6 +62,7 @@ en:
         Forwarding UDP ports is not supported. Ignoring.
 
     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

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
@@ -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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-libvirt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Lukas Stanek
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -324,9 +324,9 @@ test_files:
 - spec/unit/action/start_domain_spec.rb
 - spec/unit/action/destroy_domain_spec.rb
 - spec/unit/action/halt_domain_spec.rb
-- spec/unit/action/shutdown_domain_spec.rb
 - spec/unit/action/create_domain_spec.rb
 - spec/unit/action/package_domain_spec.rb
+- spec/unit/action/shutdown_domain_spec.rb
 - spec/unit/templates/tpm/version_1.2.xml
 - spec/unit/templates/tpm/version_2.0.xml
 - spec/unit/templates/domain_custom_cpu_model.xml