train-core 3.8.5 → 3.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f18f7c68501c5b726aa917009507d012e8c31022bedb829a2b4c90636137cb9
-  data.tar.gz: 939cc8932cf9b94c88785e5d3efd0c3e8b3ef0b47948e2f80fe5c7baa434d40d
+  metadata.gz: 677b8d64465040ada12f33f5c2fe7689b81922b10482ca7c78e0b57e10b5139a
+  data.tar.gz: 8c3f7518f0453329897de457e4ea4e6f24d6262dd77f5731b42b5cd44ea706c5
 SHA512:
-  metadata.gz: 00176b461c853b0d1167451fa43aea79159b696a3e0be0a0cd8a10934ee426d60b6fc463e0cd62643a7c53a6ead8100ec423ab8c1f18c3f48a3085601abf93fc
-  data.tar.gz: ccacf527642f27d7a84782050f0c05f2f0e617ea82b3bac2f5be258a17a2572cdbc0b7212e1eafba48003204012cb616e29daf88649e9349d7b726f59576df41
+  metadata.gz: 8998652d978144993b1768c71d25d8b06f6501c661e827576ecbb06d3e2d8748296d26d68578d6c451a2a20617c1750a5cb66c096adb020b5bc3c0e2ad6bfb4e
+  data.tar.gz: 68cad9574d5282fea0d90fc00104506d0d33ecfd5e5d6879f33f88109aec9b881d0c9d49748e178c4b8ca05896827425d4bb283bb7d52aedbcc722d2817b6b27

data/lib/train/transports/ssh.rb

@@ -43,7 +43,7 @@ module Train::Transports
 
     # common target configuration
     option :host, required: true
-    option :ssh_config_file, default: false
+    option :ssh_config_file, default: true
     option :port, default: 22, coerce: proc { |v| read_options_from_ssh_config(v, :port) }, required: true
     option :user, default: "root", coerce: proc { |v| read_options_from_ssh_config(v, :user) }, required: true
     option :key_files, default: nil
@@ -87,29 +87,30 @@ module Train::Transports
       end
     end
 
+    # Returns the ssh config option like user, port from config files
+    # Params options [Hash], option_type [String]
+    # Return String
     def self.read_options_from_ssh_config(options, option_type)
-      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
-        files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
-        config_options = Net::SSH::Config.for(options[:host], files)
-        config_options[option_type]
-      end
+      files = options[:ssh_config_file].nil? || options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+      config_options = Net::SSH::Config.for(options[:host], files)
+      config_options[option_type]
     end
 
     def apply_ssh_config_file(host)
-      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
-        files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
-        host_cfg = ssh_config_file_for_host(host, files)
-        host_cfg.each do |key, value|
-          # setting the key_files option to the private keys set in ssh config file
-          if key == :keys && options[:key_files].nil? && !host_cfg[:keys].nil? && options[:password].nil?
-            options[:key_files] = host_cfg[key]
-          elsif options[key].nil?
-            # Give precedence to config file when ssh_config_file options is set to true or to the path of the config file.
-            # This is required as there are default values set for some of the opitons and we unable to
-            # identify whether the values are set from the cli option or those are default so either we should give
-            # precedence to config file or otherwise we need to check each options default values and then set the value for that option.
-            options[key] = host_cfg[key]
-          end
+      files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+      host_cfg = ssh_config_file_for_host(host, files)
+      host_cfg.each do |key, value|
+        # setting the key_files option to the private keys set in ssh config file
+        if key == :keys && options[:key_files].nil? && !host_cfg[:keys].nil? && options[:password].nil?
+          options[:key_files] = host_cfg[key]
+        elsif options[key].nil?
+          # Precedence is given to the option set by the user manually.
+          # And only assigning value to the option from the ssh config file when it is not set by the user
+          # in the option. When the option has a default value for e.g. option "keepalive_interval" has the "60" as the default
+          # value, then the default value will be used even though the value for "user" is present in the ssh
+          # config file. That is because the precedence is to the options set manually, and currently we don't have
+          # any way to differentiate between the value set by the user or is it the default. This has a future of improvement.
+          options[key] = host_cfg[key]
         end
       end
     end
@@ -133,14 +134,18 @@ module Train::Transports
       key_files = Array(options[:key_files])
       options[:auth_methods] ||= ["none"]
 
-      unless key_files.empty?
-        options[:auth_methods].push("publickey")
+      # by default auth_methods has a default values [none publickey password keyboard-interactive]
+      # REF: https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/authentication/session.rb#L48
+      if key_files.empty?
+        options[:auth_methods].delete("publickey")
+      else
         options[:keys_only] = true if options[:password].nil?
         options[:key_files] = key_files
       end
 
-      unless options[:password].nil?
-        options[:auth_methods].push("password", "keyboard-interactive")
+      if options[:password].nil?
+        options[:auth_methods].delete("password")
+        options[:auth_methods].delete("keyboard-interactive")
       end
 
       if options[:auth_methods] == ["none"]

data/lib/train/version.rb

@@ -2,5 +2,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = "3.8.5".freeze
+  VERSION = "3.8.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.8.5
+  version: 3.8.6
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable