remotus 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b375e9a93879a30b113991e9b653e602f30d970743925527af92a964298d7a27
-  data.tar.gz: 97bab3f384551a63e665d173e9b90330f03d3e8b56e6e89a9c216b18e37c2a66
+  metadata.gz: 86bb2b7b3be25ec98b48372e32f75f6ae70471bdb72635a44a1f50b20c1f5421
+  data.tar.gz: a2f1b203c618ffb909bc55f7edd0718bd960d53b968ea5418f1a80c7ff05b9a6
 SHA512:
-  metadata.gz: 6b3ded8d0ceb3c4b36736e875ca9ed80a85d77d388d1fb26f5a9659350622230c4f17efaee017e7765ddc081cd0ba52e767af960514a54c4061f667b38f1933c
-  data.tar.gz: 53aaf5d724c91a5639ce5f7928c6049b5912c21a523f2d1e5697191fb2511611e384fa5ce14fe92a53affaa8e707e42f5a5539ce83c93a16549bc1ac0fb3e5e5
+  metadata.gz: 28acc8709f9bcc670d175471973f309f76af530e4fb9cf1b566f58405ef4516fddc20dec63ca318c768c8f6247f6314d64838d2314fc5cf3f18a736f8fc24d38
+  data.tar.gz: e8d1a7cb11844225214b55fb59de52c0af958e8640db57c15eefac3e92dc3cae63a8186165108158ca93da134961a08f163fd7e2d7ec381f84524587a2881e98

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.0.0] - 2023-04-25
+* Update SSH dependencies to handle `pkeys are immutable on OpenSSL 3.0` errors on newer Ruby versions
+* Remove Ruby 2.5 support
+
+## [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,10 +1,10 @@
 PATH
   remote: .
   specs:
-    remotus (0.5.0)
-      connection_pool (~> 2.2)
-      net-scp (~> 3.0)
-      net-ssh (~> 6.1)
+    remotus (1.0.0)
+      connection_pool (~> 2.4)
+      net-scp (~> 4.0)
+      net-ssh (~> 7.1)
       net-ssh-gateway (~> 2.0)
       winrm (~> 2.3)
       winrm-elevated (~> 1.2)
@@ -15,9 +15,9 @@ GEM
   specs:
     ast (2.4.2)
     builder (3.2.4)
-    connection_pool (2.3.0)
+    connection_pool (2.4.0)
     diff-lcs (1.5.0)
-    erubi (1.11.0)
+    erubi (1.12.0)
     ffi (1.15.5)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
@@ -25,59 +25,61 @@ GEM
       builder (>= 2.1.2)
       rexml (~> 3.0)
     httpclient (2.8.3)
-    json (2.6.2)
+    json (2.6.3)
     little-plugger (1.1.4)
     logging (2.3.1)
       little-plugger (~> 1.1)
       multi_json (~> 1.14)
     multi_json (1.15.0)
-    net-scp (3.0.0)
-      net-ssh (>= 2.6.5, < 7.0.0)
-    net-ssh (6.1.0)
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-ssh (7.1.0)
     net-ssh-gateway (2.0.0)
       net-ssh (>= 4.0.0)
     nori (2.6.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.13.1)
+    rubocop-rspec (2.20.0)
       rubocop (~> 1.33)
-    ruby-progressbar (1.11.0)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
     rubyntlm (0.6.3)
     rubyzip (2.3.2)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
+    unicode-display_width (2.4.2)
     winrm (2.3.6)
       builder (>= 2.1.2)
       erubi (~> 1.8)
@@ -96,8 +98,7 @@ GEM
       logging (>= 1.6.1, < 3.0)
       rubyzip (~> 2.0)
       winrm (~> 2.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    yard (0.9.34)
 
 PLATFORMS
   ruby

data/docker/ssh_integration_spec.rb

@@ -16,12 +16,15 @@ 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
 
-  let(:test_script) { ::File.join(__dir__, "ssh_integration_script.sh") }
-  let(:test_script_dest) { ::File.join("/home/testuser", ::File.basename(test_script)) }
+  let(:test_script) { File.join(__dir__, "ssh_integration_script.sh") }
+  let(:test_script_dest) { File.join("/home/testuser", File.basename(test_script)) }
 
   context "when a gateway and inaccessible target host exist" do
     let(:gateway_hostname) { `docker ps | grep remotus_gateway`.split.first }

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 = "1.0.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
     #

data/remotus.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Ruby gem for connecting to remote systems seamlessly via WinRM or SSH."
   spec.homepage      = "https://github.com/wheatevo/remotus"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/wheatevo/remotus"
@@ -29,9 +29,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Dependencies
-  spec.add_dependency "connection_pool", "~> 2.2"
-  spec.add_dependency "net-scp", "~> 3.0"
-  spec.add_dependency "net-ssh", "~> 6.1"
+  spec.add_dependency "connection_pool", "~> 2.4"
+  spec.add_dependency "net-scp", "~> 4.0"
+  spec.add_dependency "net-ssh", "~> 7.1"
   spec.add_dependency "net-ssh-gateway", "~> 2.0"
   spec.add_dependency "winrm", "~> 2.3"
   spec.add_dependency "winrm-elevated", "~> 1.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: net-ssh-gateway
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="