remotus 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b375e9a93879a30b113991e9b653e602f30d970743925527af92a964298d7a27
-  data.tar.gz: 97bab3f384551a63e665d173e9b90330f03d3e8b56e6e89a9c216b18e37c2a66
+  metadata.gz: ca295a9d011d1c64d48612e24df9e8ecb1b377ffde82010532c4bfa893d9f4ed
+  data.tar.gz: 808051a8602029e898047a51e4e689e28d3ce50c629a20dc08de3a1349f89b49
 SHA512:
-  metadata.gz: 6b3ded8d0ceb3c4b36736e875ca9ed80a85d77d388d1fb26f5a9659350622230c4f17efaee017e7765ddc081cd0ba52e767af960514a54c4061f667b38f1933c
-  data.tar.gz: 53aaf5d724c91a5639ce5f7928c6049b5912c21a523f2d1e5697191fb2511611e384fa5ce14fe92a53affaa8e707e42f5a5539ce83c93a16549bc1ac0fb3e5e5
+  metadata.gz: 0e5268b157fc283afb2bc830838da9bba8b04f6055396123422d8bed43b97797f02cee6974f01b6d6db4658b00c99e77cc13474cc60ba8fdd9fa72dfa87e4f18
+  data.tar.gz: 5681064618614505ce74388725a03f8ab2f3e442d5feaa8ee1be4539ed9e9170f9f8e374fe6f9ce8f2ebeaeafc72624814f51f0280799b2820b1334aa955da62

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.6.0] - 2022-09-26
+* Add `#close` method to all connection types
+* Fix SSH gateway connection caching
+* Ensure SSH gateway connections are closed gracefully before reinitializing a connection
+
 ## [0.5.0] - 2022-09-21
 * Ensure port argument is respected in `Remotus::SshConnection`
 * Add SSH gateway support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remotus (0.5.0)
+    remotus (0.6.0)
       connection_pool (~> 2.2)
       net-scp (~> 3.0)
       net-ssh (~> 6.1)

data/docker/ssh_integration_spec.rb

@@ -16,6 +16,9 @@ RSpec.describe "Remotus::SshConnection Integration Tests" do
   end
 
   after(:all) do
+    # Close all active connections
+    Remotus.clear
+
     # docker-compose cleanup
     `docker-compose -f "docker-compose.yml" down -v`
   end

data/lib/remotus/host_pool.rb

@@ -87,6 +87,15 @@ module Remotus
       @expiration_time = Time.now
     end
 
+    #
+    # Closes all open connections in the pool.
+    # @see Remotus::SshConnection#close
+    # @see Remotus::WinrmConnection#close
+    #
+    def close
+      @pool.reload(&:close)
+    end
+
     #
     # Provides an SSH or WinRM connection to a given block of code
     #

data/lib/remotus/pool.rb

@@ -58,7 +58,11 @@ module Remotus
           return 0 unless @pool
 
           num_pools = count
-          @pool.reject! { |_hostname, _host_pool| true }
+
+          # Force connection close
+          @pool.each { |_hostname, host_pool| host_pool.close }
+          @pool = {}
+
           return num_pools
         end
       end
@@ -77,13 +81,18 @@ module Remotus
         # If the pool is not yet initialized, no processes can be reaped
         return 0 unless @pool
 
-        # reap all expired host pools
-        pre_reap_num_pools = count
-        @pool.reject! { |_hostname, host_pool| host_pool.expired? }
-        post_reap_num_pools = count
+        pools_reaped = 0
 
-        # Calculate the number of pools reaped
-        pools_reaped = pre_reap_num_pools - post_reap_num_pools
+        # Force connection close for expired host pools
+        @pool.each do |hostname, host_pool|
+          next unless host_pool.expired?
+
+          # Close and delete the host pool if it is expired
+          Remotus.logger.debug { "Reaping #{hostname} host pool" }
+          host_pool.close
+          @pool.delete(hostname)
+          pools_reaped += 1
+        end
 
         Remotus.logger.debug { "Reaped #{pools_reaped} expired host pools" }
 

data/lib/remotus/ssh_connection.rb

@@ -119,6 +119,9 @@ module Remotus
     def connection
       return @connection unless restart_connection?
 
+      # Close any active connections
+      close
+
       target_cred = Remotus::Auth.credential(self)
 
       Remotus.logger.debug { "Initializing SSH connection to #{target_cred.user}@#{@host}:#{@port}" }
@@ -141,12 +144,24 @@ module Remotus
         Remotus.logger.debug { "Initializing SSH gateway connection to #{gateway_cred.user}@#{@gateway.host}:#{gateway_options[:port]}" }
 
         @gateway.connection = Net::SSH::Gateway.new(@gateway.host, gateway_cred.user, **gateway_options)
-        @gateway.connection.ssh(@host, target_cred.user, **target_options)
+        @connection = @gateway.connection.ssh(@host, target_cred.user, **target_options)
       else
         @connection = Net::SSH.start(@host, target_cred.user, **target_options)
       end
     end
 
+    #
+    # Closes the current SSH connection if it is active
+    #
+    def close
+      @connection&.close
+
+      @gateway&.connection&.shutdown! if via_gateway?
+
+      @gateway = nil
+      @connection = nil
+    end
+
     #
     # Whether the remote host's SSH port is available
     #
@@ -462,10 +477,10 @@ module Remotus
 
         gateway_cred = Remotus::Auth.credential(@gateway)
 
-        return true if gateway_cred.user != @connection.options[:user]
-        return true if gateway_cred.password != @connection.options[:password]
-        return true if Array(gateway_cred.private_key) != Array(@connection.options[:keys])
-        return true if Array(gateway_cred.private_key_data) != Array(@connection.options[:key_data])
+        return true if gateway_cred.user != gateway_session.options[:user]
+        return true if gateway_cred.password != gateway_session.options[:password]
+        return true if Array(gateway_cred.private_key) != Array(gateway_session.options[:keys])
+        return true if Array(gateway_cred.private_key_data) != Array(gateway_session.options[:key_data])
       end
 
       false

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/remotus/winrm_connection.rb

@@ -64,6 +64,9 @@ module Remotus
     def base_connection(reload: false)
       return @base_connection if !reload && !restart_base_connection?
 
+      # Close any active connections
+      close
+
       Remotus.logger.debug { "Initializing WinRM connection to #{Remotus::Auth.credential(self).user}@#{@host}:#{@port}" }
       @base_connection = WinRM::Connection.new(
         endpoint: "http://#{@host}:#{@port}/wsman",
@@ -88,6 +91,15 @@ module Remotus
       @connection = base_connection(reload: true).shell(@shell)
     end
 
+    #
+    # Closes the current WinRM connection if it is active
+    #
+    def close
+      @connection&.close
+      @connection = nil
+      @base_connection = nil
+    end
+
     #
     # Whether the remote host's WinRM port is available
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool