train 2.1.13 → 2.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f1acf1dad7c8f838071070a8d440d91d7ca2247ed58b30c9d2276efb9af120
-  data.tar.gz: ad583ee440c0e4b3ca19e719e333ab82f88ad8b0659b05b1a7ac19ab106496c6
+  metadata.gz: f4262fbc901f2d107019887434f1aade83d2341d8bbf113296a6bd5d72b1fc4d
+  data.tar.gz: ab8130c7b17d3bb245fdad4d1e5419b1325df364bdaecdc62c34ddbba27d3b8a
 SHA512:
-  metadata.gz: 81153fd511325cef5fc5d9ed031718c058b9a6330aecc49d22f9adced40493b5c7cad90b478a37e36751595fd4cc30aefc4d493bae076136d453d52343cfe1d9
-  data.tar.gz: 11f3b1494d0fc4e5971fa2f0112ac1320babe51a298952fd57d3bd9c00d2d73249f5b4eb4389e50cff269cefe1135f29f71957d6640337ee1e8756cfbd49c283
+  metadata.gz: 95f034184039cecf0bf4d78b02b65bed306ee46d953b25f6870fbbd58e65eebd71dcb3ebfd9381c1287322bfada1fd0d8a3d44be57275e6748fb8be9e6a744f6
+  data.tar.gz: 86bddfca26a15768245310f82814fdebb80cbfa0609530bf587cbc82b9edf95857fa1d6de4bd2f89283f197a16b965692ce84ef20fd4fa54a4b3b45d61edc712

data/lib/train.rb

@@ -76,6 +76,7 @@ module Train
 
     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
 
@@ -146,6 +147,7 @@ module Train
   # 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]
 
     # TODO: Determine if it is ever possible (or supported) for transport_name to be 'localhost'
@@ -155,16 +157,16 @@ module Train
         "To run this locally with elevated privileges, run the command with `sudo ...`."
     end
 
-    return transport_name if !transport_name.nil?
+    return transport_name unless transport_name.nil?
 
-    if !credentials[:target].nil?
+    unless credentials[:target].nil?
       # We should not get here, because if target_uri unpacking was successful,
       # it would have set credentials[:backend]
       raise Train::UserError, "Cannot determine backend from target "\
            "configuration #{credentials[:target]}. Valid example: ssh://192.168.0.1"
     end
 
-    if !credentials[:host].nil?
+    unless credentials[:host].nil?
       raise Train::UserError, "Host configured, but no backend was provided. Please "\
            "specify how you want to connect. Valid example: ssh://192.168.0.1"
     end

data/lib/train/extras/command_wrapper.rb

@@ -55,6 +55,7 @@ module Train::Extras
     def verify
       res = @backend.run_command(run("echo"))
       return nil if res.exit_status == 0
+
       rawerr = res.stdout + " " + res.stderr
 
       {
@@ -164,6 +165,7 @@ module Train::Extras
     def self.load(transport, options)
       if transport.platform.unix?
         return nil unless LinuxCommand.active?(options)
+
         res = LinuxCommand.new(transport, options)
         verification_res = res.verify
         if verification_res

data/lib/train/extras/stat.rb

@@ -26,6 +26,7 @@ module Train::Extras
       return bsd_stat(shell_escaped_path, backend, follow_symlink) if backend.os.bsd?
       # linux,solaris 11 and esx will use standard linux stats
       return linux_stat(shell_escaped_path, backend, follow_symlink) if backend.os.unix? || backend.os.esx?
+
       # all other cases we don't handle
       # TODO: print an error if we get here, as it shouldn't be invoked
       # on non-unix
@@ -77,7 +78,8 @@ module Train::Extras
       lstat = follow_symlink ? " -L" : ""
       res = backend.run_command(
         "stat#{lstat} -f '%z\n%p\n%Su\n%u\n%Sg\n%g\n%a\n%m' "\
-        "#{shell_escaped_path}")
+        "#{shell_escaped_path}"
+      )
 
       return {} if res.exit_status != 0
 
@@ -113,8 +115,10 @@ module Train::Extras
 
       res = backend.run_command(stat_cmd)
       return {} if res.exit_status != 0
+
       fields = res.stdout.split("\n")
       return {} if fields.length != 7
+
       tmask = fields[0].to_i(8)
       {
         type: find_type(tmask),

data/lib/train/file/local.rb

@@ -19,6 +19,7 @@ module Train
 
       def link_path
         return nil unless symlink?
+
         begin
           @link_path ||= ::File.realpath(@path)
         rescue Errno::ELOOP => _
@@ -29,6 +30,7 @@ module Train
 
       def shallow_link_path
         return nil unless symlink?
+
         @link_path ||= ::File.readlink(@path)
       end
 

data/lib/train/file/local/windows.rb

@@ -8,24 +8,29 @@ module Train
         # @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#naming_conventions
         def sanitize_filename(path)
           return if path.nil?
+
           # we do not filter :, backslash and forward slash, since they are part of the path
           @spath = path.gsub(/[<>"|?*]/, "")
         end
 
         def product_version
           @product_version ||= @backend.run_command(
-            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion").stdout.chomp
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion"
+          ).stdout.chomp
         end
 
         def file_version
           @file_version ||= @backend.run_command(
-            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion").stdout.chomp
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion"
+          ).stdout.chomp
         end
 
         def owner
           owner = @backend.run_command(
-            "Get-Acl \"#{@spath}\" | select -expand Owner").stdout.strip
+            "Get-Acl \"#{@spath}\" | select -expand Owner"
+          ).stdout.strip
           return if owner.empty?
+
           owner
         end
 

data/lib/train/file/remote.rb

@@ -5,11 +5,13 @@ module Train
     class Remote < Train::File
       def basename(suffix = nil, sep = "/")
         raise "Not yet supported: Suffix in file.basename" unless suffix.nil?
+
         @basename ||= detect_filename(path, sep || "/")
       end
 
       def stat
         return @stat if defined?(@stat)
+
         @stat = Train::Extras::Stat.stat(@spath, @backend, @follow_symlink)
       end
 
@@ -19,8 +21,10 @@ module Train
       def detect_filename(path, sep)
         idx = path.rindex(sep)
         return path if idx.nil?
+
         idx += 1
         return detect_filename(path[0..-2], sep) if idx == path.length
+
         path[idx..-1]
       end
     end

data/lib/train/file/remote/aix.rb

@@ -8,12 +8,14 @@ module Train
       class Aix < Train::File::Remote::Unix
         def link_path
           return nil unless symlink?
+
           @link_path ||=
             @backend.run_command("perl -e 'print readlink shift' #{@spath}").stdout.chomp
         end
 
         def shallow_link_path
           return nil unless symlink?
+
           @shallow_link_path ||=
             @backend.run_command("perl -e 'print readlink shift' #{@spath}").stdout.chomp
         end

data/lib/train/file/remote/linux.rb

@@ -8,8 +8,10 @@ module Train
       class Linux < Train::File::Remote::Unix
         def content
           return @content if defined?(@content)
+
           @content = @backend.run_command("cat #{@spath} || echo -n").stdout
           return @content unless @content.empty?
+
           @content = nil if directory? || size.nil? || (size > 0)
           @content
         end

data/lib/train/file/remote/unix.rb

@@ -23,7 +23,7 @@ module Train
           @exist ||= begin
             f = @follow_symlink ? "" : " || test -L #{@spath}"
             @backend.run_command("test -e #{@spath}" + f)
-                    .exit_status == 0
+              .exit_status == 0
           end
         end
 
@@ -58,6 +58,7 @@ module Train
 
         def shallow_link_path
           return nil unless symlink?
+
           @shallow_link_path ||=
             @backend.run_command("readlink #{@spath}").stdout.chomp
         end
@@ -74,6 +75,7 @@ module Train
 
         def path
           return @path unless @follow_symlink && symlink?
+
           @link_path ||= read_target_path
         end
 

data/lib/train/file/remote/windows.rb

@@ -9,6 +9,7 @@ module Train
         # @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#naming_conventions
         def sanitize_filename(path)
           return if path.nil?
+
           # we do not filter :, backslash and forward slash, since they are part of the path
           @spath = path.gsub(/[<>"|?*]/, "")
         end
@@ -19,22 +20,28 @@ module Train
 
         def content
           return @content if defined?(@content)
+
           @content = @backend.run_command("Get-Content(\"#{@spath}\") | Out-String").stdout
           return @content unless @content.empty?
+
           @content = nil if directory? # or size.nil? or size > 0
           @content
         end
 
         def exist?
           return @exist if defined?(@exist)
+
           @exist = @backend.run_command(
-            "(Test-Path -Path \"#{@spath}\").ToString()").stdout.chomp == "True"
+            "(Test-Path -Path \"#{@spath}\").ToString()"
+          ).stdout.chomp == "True"
         end
 
         def owner
           owner = @backend.run_command(
-            "Get-Acl \"#{@spath}\" | select -expand Owner").stdout.strip
+            "Get-Acl \"#{@spath}\" | select -expand Owner"
+          ).stdout.strip
           return if owner.empty?
+
           owner
         end
 
@@ -46,6 +53,7 @@ module Train
           elsif attributes.include?("Directory")
             return :directory
           end
+
           :unknown
         end
 
@@ -57,12 +65,14 @@ module Train
 
         def product_version
           @product_version ||= @backend.run_command(
-            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion").stdout.chomp
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion"
+          ).stdout.chomp
         end
 
         def file_version
           @file_version ||= @backend.run_command(
-            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion").stdout.chomp
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion"
+          ).stdout.chomp
         end
 
         %w{
@@ -89,8 +99,10 @@ module Train
 
         def attributes
           return @attributes if defined?(@attributes)
+
           @attributes = @backend.run_command(
-            "(Get-ItemProperty -Path \"#{@spath}\").attributes.ToString()").stdout.chomp.split(/\s*,\s*/)
+            "(Get-ItemProperty -Path \"#{@spath}\").attributes.ToString()"
+          ).stdout.chomp.split(/\s*,\s*/)
         end
       end
     end

data/lib/train/options.rb

@@ -15,14 +15,14 @@ module Train
         d = conf || {}
         unless d.is_a? Hash
           raise Train::ClientError,
-               "The transport plugin #{self} declared an option #{name} "\
-               "and didn't provide a valid configuration hash."
+            "The transport plugin #{self} declared an option #{name} "\
+            "and didn't provide a valid configuration hash."
         end
 
         if !conf.nil? && !conf[:default].nil? && block_given?
           raise Train::ClientError,
-               "The transport plugin #{self} declared an option #{name} "\
-               "with both a default value and block. Only use one of these."
+            "The transport plugin #{self} declared an option #{name} "\
+            "with both a default value and block. Only use one of these."
         end
 
         d[:default] = block if block_given?
@@ -56,6 +56,7 @@ module Train
         res = base.merge(opts || {})
         default_options.each do |field, hm|
           next unless res[field].nil? && hm.key?(:default)
+
           default = hm[:default]
           if default.is_a? Proc
             res[field] = default.call(res)
@@ -70,7 +71,7 @@ module Train
         default_options.each do |field, hm|
           if opts[field].nil? && hm[:required]
             raise Train::ClientError,
-                 "You must provide a value for #{field.to_s.inspect}."
+              "You must provide a value for #{field.to_s.inspect}."
           end
         end
         opts

data/lib/train/platforms.rb

@@ -10,32 +10,31 @@ require "train/platforms/family"
 require "train/platforms/platform"
 
 module Train::Platforms
-  class << self
-    # Retrieve the current platform list
-    #
-    # @return [Hash] map with platform names and their objects
-    def list
-      @list ||= {}
-    end
+  # Retrieve the current platform list
+  #
+  # @return [Hash] map with platform names and their objects
+  def self.list
+    @list ||= {}
+  end
 
-    # Retrieve the current family list
-    #
-    # @return [Hash] map with family names and their objects
-    def families
-      @families ||= {}
-    end
+  # Retrieve the current family list
+  #
+  # @return [Hash] map with family names and their objects
+  def self.families
+    @families ||= {}
+  end
 
-    # Clear all platform settings. Only used for testing.
-    def __reset
-      @list = {}
-      @families = {}
-    end
+  # Clear all platform settings. Only used for testing.
+  def self.__reset
+    @list = {}
+    @families = {}
   end
 
   # Create or update a platform
   #
   # @return Train::Platform
   def self.name(name, condition = {})
+    # TODO: refactor this against family. They're stupidly similar
     # Check the list to see if one is already created
     plat = list[name]
     unless plat.nil?
@@ -66,9 +65,10 @@ module Train::Platforms
   #
   # @return [Hash] with top level family and platforms
   def self.top_platforms
-    top_platforms = list.select { |_key, value| value.families.empty? }
-    top_platforms.merge!(families.select { |_key, value| value.families.empty? })
-    top_platforms
+    empty_list =     list.select { |_key, value| value.families.empty? }
+    empty_fams = families.select { |_key, value| value.families.empty? }
+
+    empty_list.merge empty_fams
   end
 
   # List all platforms and families in a readable output
@@ -83,7 +83,7 @@ module Train::Platforms
   def self.print_children(parent, pad = 2)
     parent.children.each do |key, value|
       obj = key
-      puts "#{' ' * pad}-> #{obj.title}#{value unless value.empty?}"
+      puts "#{" " * pad}-> #{obj.title}#{value unless value.empty?}"
       print_children(obj, pad + 2) if defined?(obj.children) && !obj.children.nil?
     end
   end

data/lib/train/platforms/detect/helpers/os_common.rb

@@ -37,27 +37,32 @@ module Train::Platforms::Detect::Helpers
       if @backend.class.to_s == "Train::Transports::SSH::Connection" && res =~ /Please login as the user/
         raise Train::UserError, "SSH failed: #{res}"
       end
+
       res.strip! unless res.nil?
       res
     end
 
     def unix_uname_s
       return @uname[:s] if @uname.key?(:s)
+
       @uname[:s] = command_output("uname -s")
     end
 
     def unix_uname_r
       return @uname[:r] if @uname.key?(:r)
+
       @uname[:r] = command_output("uname -r")
     end
 
     def unix_uname_m
       return @uname[:m] if @uname.key?(:m)
+
       @uname[:m] = command_output("uname -m")
     end
 
     def brocade_version
       return @cache[:brocade] if @cache.key?(:brocade)
+
       res = command_output("version")
 
       m = res.match(/^Fabric OS:\s+v(\S+)$/)
@@ -70,6 +75,7 @@ module Train::Platforms::Detect::Helpers
 
     def cisco_show_version
       return @cache[:cisco] if @cache.key?(:cisco)
+
       res = command_output("show version")
 
       m = res.match(/Cisco IOS Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+)/)
@@ -110,7 +116,7 @@ module Train::Platforms::Detect::Helpers
       # require 'pry';binding.pry
       %W{
         /etc/chef/chef_guid
-        #{ENV['HOME']}/.chef/chef_guid
+        #{ENV["HOME"]}/.chef/chef_guid
         /etc/machine-id
         /var/lib/dbus/machine-id
         /var/db/dbus/machine-id
@@ -118,6 +124,7 @@ module Train::Platforms::Detect::Helpers
         file = @backend.file(path)
         next unless file.exist? && file.size != 0
         return file.content.chomp if path =~ /guid/
+
         return uuid_from_string(file.content.chomp)
       end
       nil
@@ -128,6 +135,7 @@ module Train::Platforms::Detect::Helpers
     # we turn into a UUID.
     def uuid_from_command
       return unless @platform[:uuid_command]
+
       result = @backend.run_command(@platform[:uuid_command])
       uuid_from_string(result.stdout.chomp) if result.exit_status == 0 && !result.stdout.empty?
     end