train 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9584715b895615e0a5f3462971856c35b43898d1329b18657b8fee5a07375de
-  data.tar.gz: 2f293c8a2620a662a361e2b1d09d2b2979dc817484bc369eca30b5fc36b568ab
+  metadata.gz: 90cfe2b9d2a7ff8e247729ed8f7e7fac0ad3ced66eb98de9265b00170ae3e609
+  data.tar.gz: cd9c481520c62e3ffe6c5bef2553a16f0b2685d312cb68517101a221a35136b7
 SHA512:
-  metadata.gz: c9e5eccbc7975365d13bb2eb4eb451520ed0f2a48949218d679d02983560cf95f2ecf9321121fbf563fbc29d8246c1da469fd990b4debb6df94535b7477816d5
-  data.tar.gz: 3d1b0e300b67d64268e7cb2657c495332dd0cbfedfe264f4ea7e25db126b97a558256d0664917892a3273a8517c17f8993b0bd4cda49994c9bbe1cd3d18e4c40
+  metadata.gz: c66b8d1b3d903b1efd079a49ff0a6007a247468c3a46df4b00b594cf78b1342a6ac138aea119752a49c8c3e196291cbabd9bf10da146d0176cde25345ea5aa17
+  data.tar.gz: 3054b59b175c6fe70dc08099cf505092fb860c3c3323ed9c77c2c7a67a5d27a4f95c811238caaa3014fdd673626a77a2d02da583c953415b9a38013ab6accdde

data/lib/train.rb

@@ -61,53 +61,61 @@ module Train
     raise ex
   end
 
-  # Resolve target configuration in URI-scheme into
-  # all respective fields and merge with existing configuration.
-  # e.g. ssh://bob@remote  =>  backend: ssh, user: bob, host: remote
-  def self.target_config(config = nil) # rubocop:disable Metrics/AbcSize
-    conf = config.nil? ? {} : config.dup
-    conf = symbolize_keys(conf)
-
-    group_keys_and_keyfiles(conf)
+  # Legacy code to unpack a series of items from an incoming Hash
+  # Inspec::Config.unpack_train_credentials now handles this in most cases that InSpec needs
+  # If you need to unpack a URI, use unpack_target_from_uri
+  # TODO: deprecate; can't issue a warning because train doesn't have a logger until the connection is setup (See base_connection.rb)
+  def self.target_config(config = nil)
+    conf = config.dup
+    # Symbolize keys
+    conf.keys.each do |key|
+      unless key.is_a? Symbol
+        conf[key.to_sym] = conf.delete(key)
+      end
+    end
 
+    group_keys_and_keyfiles(conf) # TODO: move logic into SSH plugin
     return conf if conf[:target].to_s.empty?
+    unpack_target_from_uri(conf[:target], conf).merge(conf)
+  end
+
+  # Given a string that looks like a URI, unpack connection credentials.
+  # The name of the desired transport is always taken from the 'scheme' slot of the URI;
+  # the remaining portion of the URI is parsed as if it were an HTTP URL, and then
+  # the URL components are stored in the credentials hash.  It is up to the transport
+  # to interpret the fields in a sensible way for that transport.
+  # New transport authors are encouraged to use transport://credset format (see
+  # inspec/inspec/issues/3661) rather than inventing a new field mapping.
+  def self.unpack_target_from_uri(uri_string, opts = {}) # rubocop: disable Metrics/AbcSize
+    creds = {}
+    return creds if uri_string.empty?
 
     # split up the target's host/scheme configuration
-    uri = parse_uri(conf[:target].to_s)
+    uri = parse_uri(uri_string)
     unless uri.host.nil? and uri.scheme.nil?
-      conf[:backend]  ||= uri.scheme
-      conf[:host]     ||= uri.hostname
-      conf[:port]     ||= uri.port
-      conf[:user]     ||= uri.user
-      conf[:path]     ||= uri.path
-      conf[:password] ||=
-        if conf[:www_form_encoded_password] && !uri.password.nil?
+      creds[:backend]  ||= uri.scheme
+      creds[:host]     ||= uri.hostname
+      creds[:port]     ||= uri.port
+      creds[:user]     ||= uri.user
+      creds[:path]     ||= uri.path
+      creds[:password] ||=
+        if opts[:www_form_encoded_password] && !uri.password.nil?
           URI.decode_www_form_component(uri.password)
         else
           uri.password
         end
     end
 
-    # ensure path is nil, if its empty; e.g. required to reset defaults for winrm
-    conf[:path] = nil if !conf[:path].nil? && conf[:path].to_s.empty?
+    # ensure path is nil, if its empty; e.g. required to reset defaults for winrm # TODO: move logic into winrm plugin
+    creds[:path] = nil if !creds[:path].nil? && creds[:path].to_s.empty?
 
-    # return the updated config
-    conf
-  end
+    # compact! is available in ruby 2.4+
+    # TODO: rewrite next line using compact! once we drop support for ruby 2.3
+    creds = creds.delete_if { |_, value| value.nil? }
 
-  # Takes a map of key-value pairs and turns all keys into symbols. For this
-  # to work, only keys are supported that can be turned into symbols.
-  # Example: { 'a' => 123 }  ==>  { a: 123 }
-  #
-  # @param map [Hash]
-  # @return [Hash] new map with all keys being symbols
-  def self.symbolize_keys(map)
-    map.each_with_object({}) do |(k, v), acc|
-      acc[k.to_sym] = v
-      acc
-    end
+    # return the updated config
+    creds
   end
-  private_class_method :symbolize_keys
 
   # Parse a URI. Supports empty URI's with paths, e.g. `mock://`
   #
@@ -127,34 +135,41 @@ module Train
       raise Train::UserError, e
     end
 
-    u = URI.parse(string)
-    u.host = nil
-    u
+    uri = URI.parse(string)
+    uri.host = nil
+    uri
   end
   private_class_method :parse_uri
 
-  def self.validate_backend(conf, default = :local)
-    return default if conf.nil?
-    res = conf[:backend]
+  # Examine the given credential information, and if all is well,
+  # return the transport name.
+  # TODO: this actually does no validation of the credential options whatsoever
+  def self.validate_backend(credentials, default_transport_name = 'local')
+    return default_transport_name if credentials.nil?
+    transport_name = credentials[:backend]
 
-    if (res.nil? || res == 'localhost') && conf[:sudo]
+    # TODO: Determine if it is ever possible (or supported) for transport_name to be 'localhost'
+    # TODO: After inspec/inspec/pull/3750 is merged, should be able to remove nil from the list
+    if credentials[:sudo] && [nil, 'local', 'localhost'].include?(transport_name)
       fail Train::UserError, 'Sudo is only valid when running against a remote host. '\
         'To run this locally with elevated privileges, run the command with `sudo ...`.'
     end
 
-    return res if !res.nil?
+    return transport_name if !transport_name.nil?
 
-    if !conf[:target].nil?
+    if !credentials[:target].nil?
+      # We should not get here, because if target_uri unpacking was successful,
+      # it would have set credentials[:backend]
       fail Train::UserError, 'Cannot determine backend from target '\
-           "configuration #{conf[:target].inspect}. Valid example: ssh://192.168.0.1."
+           "configuration #{credentials[:target]}. Valid example: ssh://192.168.0.1"
     end
 
-    if !conf[:host].nil?
+    if !credentials[:host].nil?
       fail Train::UserError, 'Host configured, but no backend was provided. Please '\
-           'specify how you want to connect. Valid example: ssh://192.168.0.1.'
+           'specify how you want to connect. Valid example: ssh://192.168.0.1'
     end
 
-    conf[:backend] = default
+    credentials[:backend] = default_transport_name
   end
 
   def self.group_keys_and_keyfiles(conf)

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.7.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-26 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json