remotus 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b07dbe42ab741bdb688bed9f6ce1d09ed2af8643291c57ec9aeedaaad0a19a
-  data.tar.gz: a39ecf434564157c1e72d98cf840abadc1a406f91988ee7c47cf7c22d9643760
+  metadata.gz: 1a1fb83a5d4a7a15d98860a8342f71c5377f5c91ec842883a62cc2b6678baa96
+  data.tar.gz: db221756c55c43a5c0492cf8668c36e07f6e58d323b9a1b83b3688a0a9c8c92c
 SHA512:
-  metadata.gz: f48c3e374b870a60664cf35838204755a83599a534113309abfecb40e5a5862f10091bd7bc19d8353a8a5716c71fe02dea043f891db998dd521451a998be4419
-  data.tar.gz: 0c3d1f3e5dfbae5c2aeaec9d18f3eb4f4b99759b4c883e3298691e7cad7a91fa71d03f595cffb9bab07f9191844284a211c5fb76ff7900af56791ea6ed9a6f2a
+  metadata.gz: b2a57cbf28230b41b64c6e084511fa45536c8b020c7425b89d504e5ae764b16429911f5a2ff5458b2168b7ae46355e66c14279dad780d8ca38b525da66bd1694
+  data.tar.gz: 0bd543003bde4641d2d9527b88a72a550e700bcc65c73b76c2ef5ff0b2811c1eaae8013bb9bff34c5802b1e8fc2aa754557534908672c25eb814c8a281169788

data/.rubocop.yml

@@ -46,3 +46,6 @@ Metrics/ParameterLists:
 
 Gemspec/RequireMFA:
   Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.2.0] - 2023-10-23
+* Add `:ip` option to connection methods to accommodate credential stores that require the hostname where DNS is not available.
+
+## [1.1.1] - 2023-05-26
+* Handle close failures and improve logging around connection status.
+
 ## [1.1.0] - 2023-05-25
 * Improve exponential backoff during SSH retries.
 * Force connection close on IOError (closed stream).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remotus (1.1.0)
+    remotus (1.2.0)
       connection_pool (~> 2.4)
       net-scp (~> 4.0)
       net-ssh (~> 7.1)
@@ -15,10 +15,10 @@ GEM
   specs:
     ast (2.4.2)
     builder (3.2.4)
-    connection_pool (2.4.0)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
     gyoku (1.4.0)
@@ -33,7 +33,7 @@ GEM
     multi_json (1.15.0)
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
-    net-ssh (7.1.0)
+    net-ssh (7.2.0)
     net-ssh-gateway (2.0.0)
       net-ssh (>= 4.0.0)
     nori (2.6.0)
@@ -57,7 +57,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -67,15 +67,18 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.20.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     rubyntlm (0.6.3)
     rubyzip (2.3.2)

data/lib/remotus/host_pool.rb

@@ -42,12 +42,16 @@ module Remotus
     # @param [Hash] metadata metadata for this connection. Useful for providing additional information to various authentication stores
     #                        should be specified using snake_case symbol keys. If keys are not snake_case, they will be converted.
     #
+    #                        To connect to a host via IP, the following metadata entry can be provided to the host pool:
+    #                          :ip
+    #
     #                        To configure a connection gateway, the following metadata entries can be provided to the host pool:
-    #                          :gateway_host
+    #                          :gateway_host (required to use gateway)
     #                          :gateway_port
     #                          :gateway_metadata
+    #                          :gateway_ip
     #
-    #                        These function similarly to the host, port, and host_pool metadata fields.
+    #                        These function similarly to the host, port, host_pool metadata, and ip fields.
     #
     def initialize(host, size: DEFAULT_POOL_SIZE, timeout: DEFAULT_EXPIRATION_SECONDS, port: nil, proto: nil, **metadata)
       Remotus.logger.debug { "Creating host pool for #{host}" }

data/lib/remotus/pool.rb

@@ -20,6 +20,9 @@ module Remotus
       # @option options [Integer] :timeout amount of time to wait for a connection from the pool
       # @option options [Integer] :port port to use for the connection
       # @option options [Symbol]  :proto protocol to use for the connection (:winrm, :ssh), must be specified if port is specified
+      # @option options [String]  :ip IP to use for the connection, preferred over the hostname if set.
+      #                               This should be used if the hostname is required for credential retrieval
+      #                               but the hostname cannot be resolved by DNS.
       #
       # @return [Remotus::HostPool] Host pool for the given host
       #

data/lib/remotus/ssh_connection.rb

@@ -74,13 +74,18 @@ module Remotus
     # @param [String] host hostname
     # @param [Integer] port remote port
     # @param [Remotus::HostPool] host_pool associated host pool
+    #                                      To connect to a host via IP, the following metadata
+    #                                      entry can be provided to the host pool:
+    #                                        :ip
+    #
     #                                      To configure the gateway, the following metadata
     #                                      entries can be provided to the host pool:
     #                                        :gateway_host
     #                                        :gateway_port
     #                                        :gateway_metadata
+    #                                        :gateway_ip
     #
-    #                                      These function similarly to the host, port, and host_pool metadata fields.
+    #                                      These function similarly to the host, port, host_pool metadata, and ip fields.
     #
     def initialize(host, port = REMOTE_PORT, host_pool: nil)
       Remotus.logger.debug { "Creating SshConnection #{object_id} for #{host}" }
@@ -143,10 +148,10 @@ 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)
-        @connection = @gateway.connection.ssh(@host, target_cred.user, **target_options)
+        @gateway.connection = Net::SSH::Gateway.new(remote_gateway_host, gateway_cred.user, **gateway_options)
+        @connection = @gateway.connection.ssh(remote_host, target_cred.user, **target_options)
       else
-        @connection = Net::SSH.start(@host, target_cred.user, **target_options)
+        @connection = Net::SSH.start(remote_host, target_cred.user, **target_options)
       end
     end
 
@@ -154,9 +159,21 @@ module Remotus
     # Closes the current SSH connection if it is active
     #
     def close
-      @connection&.close
+      Remotus.logger.debug { "Closing SSH connection." }
+
+      begin
+        @connection&.close
+      rescue StandardError => e
+        Remotus.logger.warn { "Failed to close existing SSH connection with error #{e}" }
+      end
+
+      begin
+        @gateway&.connection&.shutdown! if via_gateway?
+      rescue StandardError => e
+        Remotus.logger.warn { "Failed to close existing SSH gateway connection with error #{e}" }
+      end
 
-      @gateway&.connection&.shutdown! if via_gateway?
+      Remotus.logger.debug { "Setting @gateway and @connection to nil." }
 
       @gateway = nil
       @connection = nil
@@ -168,7 +185,7 @@ module Remotus
     # @return [Boolean] true if available, false otherwise
     #
     def port_open?
-      Remotus.port_open?(@host, @port)
+      Remotus.port_open?(remote_host, @port)
     end
 
     #
@@ -465,7 +482,7 @@ module Remotus
     def restart_connection?
       return true unless @connection
       return true if @connection.closed?
-      return true if @host != @connection.host
+      return true if remote_host != @connection.host
 
       target_cred = Remotus::Auth.credential(self)
 
@@ -481,7 +498,7 @@ module Remotus
         gateway_session = @gateway.connection.instance_variable_get(:@session)
 
         return true if gateway_session.closed?
-        return true if @host_pool[:gateway_host] != gateway_session.host
+        return true if remote_gateway_host != gateway_session.host
 
         gateway_cred = Remotus::Auth.credential(@gateway)
 
@@ -572,5 +589,43 @@ module Remotus
     def via_gateway?
       host_pool && host_pool[:gateway_host]
     end
+
+    #
+    # Whether connecting via IP instead of hostname
+    #
+    # @return [Boolean] true if using an IP, false otherwise
+    #
+    def via_ip?
+      host_pool && !host_pool[:ip].to_s.empty?
+    end
+
+    #
+    # Remote host used for the connection. Will use the ip if specified, otherwise uses the hostname.
+    #
+    # @return [String] Remote host
+    #
+    def remote_host
+      via_ip? ? host_pool[:ip] : @host
+    end
+
+    #
+    # Whether connecting via gateway IP instead of gateway hostname
+    #
+    # @return [Boolean] true if using an IP, false otherwise
+    #
+    def via_gateway_ip?
+      host_pool && !host_pool[:gateway_ip].to_s.empty?
+    end
+
+    #
+    # Remote gateway host used for the connection. Will use the gateway_ip if specified, otherwise uses the hostname.
+    #
+    # @return [String] Remote gateway host
+    #
+    def remote_gateway_host
+      return nil unless via_gateway?
+
+      via_gateway_ip? ? host_pool[:gateway_ip] : host_pool[:gateway_host]
+    end
   end
 end

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/remotus/winrm_connection.rb

@@ -69,7 +69,7 @@ module Remotus
 
       Remotus.logger.debug { "Initializing WinRM connection to #{Remotus::Auth.credential(self).user}@#{@host}:#{@port}" }
       @base_connection = WinRM::Connection.new(
-        endpoint: "http://#{@host}:#{@port}/wsman",
+        endpoint: "http://#{remote_host}:#{@port}/wsman",
         transport: :negotiate,
         user: Remotus::Auth.credential(self).user,
         password: Remotus::Auth.credential(self).password
@@ -106,7 +106,7 @@ module Remotus
     # @return [Boolean] true if available, false otherwise
     #
     def port_open?
-      Remotus.port_open?(@host, @port)
+      Remotus.port_open?(remote_host, @port)
     end
 
     #
@@ -195,7 +195,7 @@ module Remotus
     def restart_base_connection?
       return restart_connection?(shell: @shell) if @connection
       return true unless @base_connection
-      return true if @host != @base_connection.instance_values["connection_opts"][:endpoint].scan(%r{//(.*):}).flatten.first
+      return true if remote_host != @base_connection.instance_values["connection_opts"][:endpoint].scan(%r{//(.*):}).flatten.first
       return true if Remotus::Auth.credential(self).user != @base_connection.instance_values["connection_opts"][:user]
       return true if Remotus::Auth.credential(self).password != @base_connection.instance_values["connection_opts"][:password]
 
@@ -213,11 +213,29 @@ module Remotus
     def restart_connection?(**options)
       return true unless @connection
       return true if shell && !options[:shell].casecmp?(@shell)
-      return true if @host != @connection.connection_opts[:endpoint].scan(%r{//(.*):}).flatten.first
+      return true if remote_host != @connection.connection_opts[:endpoint].scan(%r{//(.*):}).flatten.first
       return true if Remotus::Auth.credential(self).user != @connection.connection_opts[:user]
       return true if Remotus::Auth.credential(self).password != @connection.connection_opts[:password]
 
       false
     end
+
+    #
+    # Whether connecting via IP instead of hostname
+    #
+    # @return [Boolean] true if using an IP, false otherwise
+    #
+    def via_ip?
+      host_pool && !host_pool[:ip].to_s.empty?
+    end
+
+    #
+    # Remote host used for the connection. Will use the ip if specified, otherwise uses the hostname.
+    #
+    # @return [String] Remote host
+    #
+    def remote_host
+      via_ip? ? host_pool[:ip] : @host
+    end
   end
 end

data/lib/remotus.rb

@@ -18,6 +18,9 @@ module Remotus
   # @option options [Integer] :timeout amount of time to wait for a connection from the pool
   # @option options [Integer] :port port to use for the connection
   # @option options [Symbol]  :proto protocol to use for the connection (:winrm, :ssh), must be specified if port is specified
+  # @option options [String]  :ip IP to use for the connection, preferred over the hostname if set.
+  #                               This should be used if the hostname is required for credential retrieval
+  #                               but the hostname cannot be resolved by DNS.
   #
   # @return [Remotus::HostPool] Newly created or retrieved host pool
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool